Class GcpPubSubBroker

GCP Pub/Sub message broker.

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 GcpPubSubBroker(
    runtime: IRuntimeServices,
    serializer: ISerializer,
    options?: PubSubOptions,
): GcpPubSubBroker
Parameters
- runtime: IRuntimeServices
- serializer: ISerializer
- Optionaloptions: PubSubOptions
Returns GcpPubSubBroker
- Defined in packages/messaging-plugin/src/brokers/pubsub-broker.ts:490

Methods

connect

connect(): Promise<void>
Opens the broker connection.

Returns Promise<void>
Implementation of MessageBrokerAdapter.connect
- Defined in packages/messaging-plugin/src/brokers/pubsub-broker.ts:583

disconnect

disconnect(): Promise<void>
Closes the broker connection.

Returns Promise<void>
Implementation of MessageBrokerAdapter.disconnect
- Defined in packages/messaging-plugin/src/brokers/pubsub-broker.ts:619

isHealthy

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

Returns Promise<boolean>
true when reachable or unprobeable, false when the transport reports unreachable

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

isReady

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

Returns boolean
true if the broker is connected, false otherwise

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

publish

publish<T>(topic: string, message: T, options?: PublishOptions): Promise<void>
Publishes a payload under the configured acknowledgement bound.
Type Parameters
- T
Parameters
- topic: string
  Destination topic
- message: T
  Payload to serialize
- Optionaloptions: PublishOptions
  Caller headers, ordering key and de-duplication id
Returns Promise<void>
Resolves when Pub/Sub acknowledges the publish

Throws
When publishTimeoutMs expires; delivery remains possible

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

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/pubsub-broker.ts:690

reachability

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

The GCP SDK owns streaming-pull reconnection, so the broker issues no reconnect loop of its own. The transport's isHealthy round trip is cached for 5 s and bounded at 2 s. The real adapter uses getTopics: gRPC 14 → false, 4 → undefined, other numeric codes → true, no code → false. An expired bound or an absent transport probe means unknown reachability.

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

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

request

request<TReq, TRes>(
    topic: string,
    message: TReq,
    options?: RequestOptions,
): Promise<TRes>
Sends a request to a topic and awaits a single correlated reply, providing brokered request-reply (RPC) over the message broker.

A responder registered with respond on the same topic returns the reply. The call rejects with a RequestTimeoutError when no reply arrives within options.timeoutMs, and with a RemoteHandlerError when the responder throws.

Request traffic rides a channel derived from topic, disjoint from plain publish/subscribe on that same topic — a pub/sub consumer never observes an RPC request, and vice versa.
Type Parameters
- TReq
  The request payload type
- TRes
  The reply payload type
Parameters
- topic: string
  Destination topic the responder is listening on
- message: TReq
  The request payload (serialized by the broker adapter)
- Optionaloptions: RequestOptions
  Reply timeout behavior
Returns Promise<TRes>
The reply payload
Implementation of MessageBrokerAdapter.request
- Defined in packages/messaging-plugin/src/brokers/pubsub-broker.ts:788

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/pubsub-broker.ts:793

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 requesting caller, correlated to the originating request.

Pass options.queue to load-balance requests across competing responders.
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
Implementation of MessageBrokerAdapter.respond
- Defined in packages/messaging-plugin/src/brokers/pubsub-broker.ts:802

subscribe<T>(
    topic: string,
    handler: MessageHandler<T>,
    options?: SubscribeOptions,
): Promise<ISubscription>
Subscribes to a topic.
Type Parameters
- T
  The payload type
Parameters
- topic: string
  Source topic
- handler: MessageHandler<T>
  Invoked per delivered message
- Optionaloptions: SubscribeOptions
  Consumer group behavior
Returns Promise<ISubscription>
The active subscription
Implementation of MessageBrokerAdapter.subscribe
- Defined in packages/messaging-plugin/src/brokers/pubsub-broker.ts:715

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/pubsub-broker.ts:780

Class GcpPubSubBroker

Since

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns GcpPubSubBroker

Methods

connect

Returns Promise<void>

disconnect

Returns Promise<void>

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>

requestWithHeaders

Type Parameters

Parameters

Returns Promise<TRes>

respond

Type Parameters

Parameters

Returns Promise<ISubscription>

subscribe

Type Parameters

Parameters

Returns Promise<ISubscription>

subscribeWithHeaders

Type Parameters

Parameters

Returns Promise<ISubscription>

Settings

On This Page