Class InMemoryBroker

In-memory message broker implementation.

Provides fanout delivery to subscribers without a queue, and load-balanced (round-robin) delivery to subscribers within a queue.

Since

0.1.0

Implements

MessageBrokerAdapter

Index

Constructors

constructor

Methods

connect disconnect isHealthy isReady publish publishWithHeaders reachability request requestWithHeaders respond subscribe subscribeWithHeaders

Constructors

constructor

new InMemoryBroker(
    runtime: IRuntimeServices,
    serializer: ISerializer,
    options?: InMemoryBrokerOptions,
): InMemoryBroker
Creates a new in-memory broker.
Parameters
- runtime: IRuntimeServices
  Runtime services for uuid, timestamps, and timers
- serializer: ISerializer
  Serializer for message payloads
- Optionaloptions: InMemoryBrokerOptions
  Optional behaviour, currently the dispatch-error reporter
Returns InMemoryBroker
- Defined in packages/messaging-plugin/src/brokers/in-memory-broker.ts:51

Methods

connect

connect(): Promise<void>
Connects the broker (idempotent no-op for in-memory).

Returns Promise<void>
Resolves when connected

Since
0.1.0
Implementation of MessageBrokerAdapter.connect
- Defined in packages/messaging-plugin/src/brokers/in-memory-broker.ts:77

disconnect

disconnect(): Promise<void>
Disconnects the broker and clears all subscriptions.

Returns Promise<void>
Resolves when disconnected

Since
0.1.0
Implementation of MessageBrokerAdapter.disconnect
- Defined in packages/messaging-plugin/src/brokers/in-memory-broker.ts:87

isHealthy

isHealthy(): Promise<boolean>
Boolean port member (M70c).

Returns Promise<boolean>
true when the broker is running, false otherwise

Since
0.1.0
Implementation of MessageBrokerAdapter.isHealthy
- Defined in packages/messaging-plugin/src/brokers/in-memory-broker.ts:124

isReady

isReady(): boolean
Checks if the broker is connected.

Returns boolean
true if connected, false otherwise

Since
0.1.0
Implementation of MessageBrokerAdapter.isReady
- Defined in packages/messaging-plugin/src/brokers/in-memory-broker.ts:100

publish

publish<T>(topic: string, message: T, options?: PublishOptions): Promise<void>
Publishes a message to a topic.

Delivers to all subscribers without a queue (fanout), and to one subscriber per queue (round-robin load balancing).
Type Parameters
- T
  The message payload type
Parameters
- topic: string
  The topic to publish to
- message: T
  The message payload
- Optionaloptions: PublishOptions
Returns Promise<void>
Resolves once every matching subscription's work item has been handed to dispatch — NOT once every handler has returned. A handler's rejection reaches the configured onDispatchError (or is observed and dropped when none is configured); it never rejects the publish and never becomes an unhandled rejection. This is the guarantee real brokers give — publish returns before delivery — so the in-memory double honours it too. Since M89c it also means one slow or throwing fan-out handler no longer delays or aborts delivery to its siblings.

Since
0.1.0
Implementation of MessageBrokerAdapter.publish
- Defined in packages/messaging-plugin/src/brokers/in-memory-broker.ts:147

publishWithHeaders

publishWithHeaders<T>(
    topic: string,
    message: T,
    headers: Readonly<Record<string, string>>,
    options?: PublishOptions,
): Promise<void>
Internal
Publishes a message with framework-owned transport headers. Resolves on dispatch hand-off (see publish); each invoked handler's promise is RETAINED and its rejection routed to the failure path below — never dropped, never unhandled.
Type Parameters
- T
Parameters
- topic: string
- message: T
- headers: Readonly<Record<string, string>>
- Optionaloptions: PublishOptions
Returns Promise<void>
Implementation of MessageBrokerAdapter.publishWithHeaders
- Defined in packages/messaging-plugin/src/brokers/in-memory-broker.ts:159

reachability

reachability(): Promise<boolean>
Tri-state backend reachability (M70c).

There is no backend to be unreachable: the bus is in-process, so the answer is simply whether the broker is running. true while ready, false before connect() or after disconnect().

Returns Promise<boolean>
true when the broker is running, false otherwise

Since
0.1.0
Implementation of MessageBrokerAdapter.reachability
- Defined in packages/messaging-plugin/src/brokers/in-memory-broker.ts:114

request

request<TReq, TRes>(
    topic: string,
    message: TReq,
    options?: RequestOptions,
): Promise<TRes>
Sends a request and awaits a single correlated reply.
Type Parameters
- TReq
  The request payload type
- TRes
  The reply payload type
Parameters
- topic: string
  Destination topic a responder is listening on
- message: TReq
  The request payload
- Optionaloptions: RequestOptions
  Reply timeout behavior
Returns Promise<TRes>
The reply payload

Since
0.1.0
Implementation of MessageBrokerAdapter.request
- Defined in packages/messaging-plugin/src/brokers/in-memory-broker.ts:338

requestWithHeaders

requestWithHeaders<TReq, TRes>(
    topic: string,
    message: TReq,
    headers: Readonly<Record<string, string>>,
    options?: RequestOptions,
): Promise<TRes>
Internal
Sends request-reply traffic with framework-owned headers.
Type Parameters
- TReq
- TRes
Parameters
- topic: string
- message: TReq
- headers: Readonly<Record<string, string>>
- Optionaloptions: RequestOptions
Returns Promise<TRes>
Implementation of MessageBrokerAdapter.requestWithHeaders
- Defined in packages/messaging-plugin/src/brokers/in-memory-broker.ts:343

respond

respond<TReq, TRes>(
    topic: string,
    handler: RequestHandler<TReq, TRes>,
    options?: SubscribeOptions,
): Promise<ISubscription>
Registers a responder whose result is returned to the requesting caller.
Type Parameters
- TReq
  The request payload type
- TRes
  The reply payload type
Parameters
- topic: string
  The request topic to respond on
- handler: RequestHandler<TReq, TRes>
  Invoked per request; its result is returned to the caller
- Optionaloptions: SubscribeOptions
  Consumer group behavior
Returns Promise<ISubscription>
The active subscription

Since
0.1.0
Implementation of MessageBrokerAdapter.respond
- Defined in packages/messaging-plugin/src/brokers/in-memory-broker.ts:363

subscribe<T>(
    topic: string,
    handler: MessageHandler<T>,
    options?: SubscribeOptions,
): Promise<ISubscription>
Subscribes to a topic.
Type Parameters
- T
  The message payload type
Parameters
- topic: string
  The topic to subscribe to
- handler: MessageHandler<T>
  The handler to invoke for each message
- Optionaloptions: SubscribeOptions
  Optional subscription options (queue for load balancing)
Returns Promise<ISubscription>
The subscription handle

Since
0.1.0
Implementation of MessageBrokerAdapter.subscribe
- Defined in packages/messaging-plugin/src/brokers/in-memory-broker.ts:287

subscribeWithHeaders

subscribeWithHeaders<T>(
    topic: string,
    handler: MessageHandler<T>,
    options?: SubscribeOptions,
): Promise<ISubscription>
Internal
Subscribes through the header-aware internal path.
Type Parameters
- T
Parameters
- topic: string
- handler: MessageHandler<T>
- Optionaloptions: SubscribeOptions
Returns Promise<ISubscription>
Implementation of MessageBrokerAdapter.subscribeWithHeaders
- Defined in packages/messaging-plugin/src/brokers/in-memory-broker.ts:319

Class InMemoryBroker

Since

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns InMemoryBroker

Methods

connect

Returns Promise<void>

Since

disconnect

Returns Promise<void>

Since

isHealthy

Returns Promise<boolean>

Since

isReady

Returns boolean

Since

publish

Type Parameters

Parameters

Returns Promise<void>

Since

publishWithHeaders

Type Parameters

Parameters

Returns Promise<void>

reachability

Returns Promise<boolean>

Since

request

Type Parameters

Parameters

Returns Promise<TRes>

Since

requestWithHeaders

Type Parameters

Parameters

Returns Promise<TRes>

respond

Type Parameters

Parameters

Returns Promise<ISubscription>

Since

subscribe

Type Parameters

Parameters

Returns Promise<ISubscription>

Since

subscribeWithHeaders

Type Parameters

Parameters

Returns Promise<ISubscription>

Settings

On This Page