Struct ConnectedPulsarBroker 

pub struct ConnectedPulsarBroker { /* private fields */ }

The typed witness that connect succeeded: holds the live client directly.

Implementations

impl ConnectedPulsarBroker

pub fn publisher(&self) -> PulsarPublisher

A publisher from the connected form. It rides the same cell-backed publisher type as the early path; by now connect has filled the cell, so it resolves immediately.

pub async fn subscribe_descriptor( &self, descriptor: PulsarSubscription, ) -> Result<PulsarSubscriber, PulsarError>

Opens the subscription described by descriptor.

Errors

Returns PulsarError when the descriptor is invalid, the consumer cannot be created, or the broker is shut down.

Trait Implementations

impl ConnectedBroker for ConnectedPulsarBroker

type Error = PulsarError

The error type returned by connected-broker operations.

type Closed = ()

The terminal witness returned by shutdown.

async fn shutdown(self) -> Result<(), Self::Error>

Closes the broker connection, flushing in-flight publishes and stopping background tasks, consuming the connected form.

impl Debug for ConnectedPulsarBroker

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DefaultPublish for ConnectedPulsarBroker

type Policy = PulsarPublish

The broker’s plain publish policy, constructible with its defaults.

impl PublishPolicy<ConnectedPulsarBroker> for PulsarPublish

type Live = PulsarPublisher

The live form this policy pairs into: a Publisher for a leaf policy, or the live wiring form for a combinator stack (a typed publisher over a policy pairs into the same typed publisher over the live leaf).

fn pair( self, connected: &ConnectedPulsarBroker, ) -> impl Future<Output = Result<Self::Live, PairError>>

Pairs the policy with a connected broker, producing the live publisher.

fn channel_bindings(&self, channel: &str) -> Bindings

What a publish through this policy adds to its channel in the generated AsyncAPI document.

fn operation_bindings(&self, channel: &str) -> Bindings

What a publish through this policy adds to its send operation in the document.

fn message_bindings(&self, channel: &str) -> Bindings

What a publish through this policy adds to the messages that leave through it.

fn reply_address_location(&self) -> Option<&'static str>

Where a client finds the address of a reply this policy publishes, as a runtime expression.

impl Subscribe for ConnectedPulsarBroker

type Copies = BrokerMoves

A bare name opens the same consumer a descriptor does, so a spent delivery moves at the client here too, under the policy the registration declared.

async fn subscribe(&self, name: &str) -> Result<Self::Subscriber, Self::Error>

A bare name joins the broker’s default subscription, so the handlers mounted by name compete on one durable cursor. A broker that names none refuses with PulsarError::Invalid naming the setting.

fn declare_retry( &self, name: &str, declaration: &RetryDeclaration, ) -> Result<(), DeclareRetryError>

Maps the declaration onto the consumer this name opens: the limit and the topic become the client’s own DeadLetterPolicy, built in subscribe where the connection exists.

type Subscriber = PulsarSubscriber

The subscriber type opened by a by-name subscription.

impl SubscriptionSource<ConnectedPulsarBroker> for PulsarSubscription

The Pulsar client moves a spent delivery itself: it counts the redeliveries of a message and, past the consumer’s limit, produces it to the dead-letter topic and acknowledges the original. Nothing is republished from the service, on any of the three addressing forms, so out_retry(..) over this descriptor is a compile error and the registration’s declaration reaches the consumer instead.

fn declare_retry(self, declaration: &RetryDeclaration) -> Self

Records the declaration; the consumer is built from it in subscribe, where the connection exists.

type Subscriber = PulsarSubscriber

The subscriber type this source opens.

type Copies = BrokerMoves

Who publishes the copies this subscription’s retries are made of, and who names where they go: AddressedCopies, NamedCopies or BrokerMoves.

fn name(&self) -> &str

The name (subject / channel) this subscription binds to.

async fn subscribe( self, connected: &ConnectedPulsarBroker, ) -> Result<PulsarSubscriber, PulsarError>

Opens the subscription against the connected broker. Called once at startup.

fn channel_bindings(&self) -> Bindings

What this subscription adds to its channel in the generated AsyncAPI document.

fn operation_bindings(&self) -> Bindings

What this subscription adds to its receive operation in the document.

fn declare_retry_on( &self, connected: &C, declaration: &RetryDeclaration, ) -> Result<(), DeclareRetryError>

Carries the registration’s declaration to the broker, at the same point and before the subscription opens.

fn message_bindings(&self) -> Bindings

What this subscription adds to the messages that arrive on it.

impl TestableBroker for ConnectedPulsarBroker

Available on crate feature testing only.

The harness’s view of the connected broker: what it injects and reads back on the in-process transport, and, on either transport, which subscriptions a publish reaches.

Panics

inject and published panic on a broker connected with connect: the harness drives only the transport connect_in_process produced, and a live connection has no log to read and no synchronous way to take a message. inject panics on a message a server refuses (a destination that is no topic name, a header value that is not UTF-8), which the trait gives no way to report.

fn routes(&self, destination: &str, subscriptions: &[&str]) -> Vec<usize>

Pulsar’s routing: a message reaches every subscription over its topic once, and within one subscription one of its consumers, so each durable subscription the topic reaches is owed the message once, by one of its consumers in subscriptions. In process that is the consumer the transport picks for the next message; against a server, which picks its consumer itself, it is the first of them. A topic reads the same under either spelling, and a pattern matches the fully qualified names of the namespace its prefix names.

fn install_coordinator(&self, coordinator: Coordinator)

Installs the harness coordinator into this broker’s bus for a test run. Idempotent: a second install on the same broker is ignored.

fn inject(&self, message: OutgoingMessage<'_>)

Injects a message onto the bus as an external producer would, synchronously (no awaiting). Routes through the broker’s normal fanout, so it is recorded and counted like any publish.

fn published(&self, name: &str) -> Vec<RawMessage>

Returns every message published to name on this broker, in publish order, after the evicted ones. Backs the harness’s published::<T>(name) assertions and expect_published.

fn evicted(&self, name: &str) -> usize

How many of the oldest messages published to name this broker no longer holds, so published starts after them.

fn backlog(&self) -> Backlog

What a subscription opened by name receives of the messages published to that name before it opened, as the real broker answers it: Backlog::Missed for publish/subscribe, Backlog::Delivered for a queue or a log that keeps them.