Class KafkaBroker

Kafka message broker implementation.

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 KafkaBroker(
    runtime: IRuntimeServices,
    serializer: ISerializer,
    options?: KafkaOptions,
): KafkaBroker
Creates a new Kafka broker.
Parameters
- runtime: IRuntimeServices
  Runtime services for uuid, timestamps, and timers
- serializer: ISerializer
  Serializer for message payloads
- Optionaloptions: KafkaOptions
  Kafka connection and configuration options
Returns KafkaBroker
- Defined in packages/messaging-plugin/src/brokers/kafka-broker.ts:458

Methods

connect

connect(): Promise<void>
Connects to Kafka and creates producer.

Returns Promise<void>
Resolves when connected

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

disconnect

disconnect(): Promise<void>
Disconnects from Kafka.

Returns Promise<void>
Resolves when disconnected

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

isHealthy

isHealthy(): Promise<boolean>
Boolean port member (M70c): false only when positively unreachable.

Returns Promise<boolean>
true when reachable or unprobeable, false when the fault window is active

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

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/kafka-broker.ts:682

publish

publish<T>(topic: string, message: T, options?: PublishOptions): Promise<void>
Publishes a message to a topic.
Type Parameters
- T
  The message payload type
Parameters
- topic: string
  The topic to publish to
- message: T
  The message payload
- Optionaloptions: PublishOptions
  Caller headers, ordering key and de-duplication id
Returns Promise<void>
Resolves when published

Throws
When publishTimeoutMs expires; delivery remains possible

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

publishWithHeaders

publishWithHeaders<T>(
    topic: string,
    message: T,
    headers: Readonly<Record<string, string>>,
    options?: PublishOptions,
): Promise<void>
Internal
Publishes with framework-owned headers under the configured acknowledgement bound.
Type Parameters
- T
Parameters
- topic: string
  Destination topic
- message: T
  Payload to serialize
- headers: Readonly<Record<string, string>>
  Framework-owned transport headers
- Optionaloptions: PublishOptions
  Caller headers, ordering key and de-duplication id
Returns Promise<void>
Resolves when the transport acknowledges the publish

Throws
When publishTimeoutMs expires; delivery remains possible
Implementation of MessageBrokerAdapter.publishWithHeaders
- Defined in packages/messaging-plugin/src/brokers/kafka-broker.ts:769

reachability

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

Faulted supervisor → false immediately. Otherwise a dedicated admin's describeCluster round trip is cached for 5 s and bounded at 2 s. A KafkaJSRequestTimeoutError (including a nested cause) or an expired bound yields undefined; other errors yield false. Without admin on an injected factory reachability is unknown. Injected admin timeouts are the application's.

Returns Promise<boolean | undefined>
true/false/undefined as described

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

request

request<TReq, TRes>(
    topic: string,
    message: TReq,
    options?: RequestOptions,
): Promise<TRes>
Sends a request and awaits its single correlated reply.

Replies arrive on the shared reply topic (KafkaOptions.replyTopic, default 'messaging.replies'), which must exist — this broker creates no topics; its admin is used only for metadata and group offsets. Either pre-create it or enable auto.create.topics.enable; otherwise the underlying producer error surfaces from this call rather than hanging until the timeout.
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

Throws
When no reply arrives within timeoutMs

Throws
When the responder throws

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

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/kafka-broker.ts:1309

respond

respond<TReq, TRes>(
    topic: string,
    handler: RequestHandler<TReq, TRes>,
    options?: SubscribeOptions,
): Promise<ISubscription>
Registers a responder for a request topic. The handler's resolved value is sent back to the caller, correlated to the originating request.
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 (load-balance competing responders)
Returns Promise<ISubscription>
The active subscription

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

subscribe<T>(
    topic: string,
    handler: MessageHandler<T>,
    options?: SubscribeOptions,
): Promise<ISubscription>
Subscribes to a topic using a consumer group.
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 consumer group ID)
Returns Promise<ISubscription>
The subscription handle

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

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/kafka-broker.ts:1276

Class KafkaBroker

Since

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns KafkaBroker

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>

Throws

Since

publishWithHeaders

Type Parameters

Parameters

Returns Promise<void>

Throws

reachability

Returns Promise<boolean | undefined>

Since

request

Type Parameters

Parameters

Returns Promise<TRes>

Throws

Throws

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