Interface WorkQueueHostEngine

The structural subset of the server WorkQueueEngine this host needs; WorkQueueEngine satisfies it. The metadata members are proxies the server engine forwards to WorkQueueEngineBase (03 §11), so the base/engine split is invisible to the host.

interface WorkQueueHostEngine {
    Subscriptions: MJWorkQueueSubscriptionEntity[];
    Topics: MJWorkQueueTopicEntity[];
    Transports: MJWorkQueueTransportEntity[];
    BuildSubscriptionBinding(
        subscription: MJWorkQueueSubscriptionEntity,
    ): SubscriptionBinding;
    GetDriver(transportID: string): Promise<ITransportDriver>;
    NotifyDeadLettered(event: DeadLetteredEvent): void;
    OnPublished(listener: (topicName: string) => void): () => void;
}

Index

Properties

Subscriptions Topics Transports

Methods

BuildSubscriptionBinding GetDriver NotifyDeadLettered OnPublished

Properties

`Readonly`Subscriptions

Subscriptions: MJWorkQueueSubscriptionEntity[]

`Readonly`Topics

Topics: MJWorkQueueTopicEntity[]

`Readonly`Transports

Transports: MJWorkQueueTransportEntity[]

Methods

BuildSubscriptionBinding

BuildSubscriptionBinding(
subscription: MJWorkQueueSubscriptionEntity,
): SubscriptionBinding
Parameters
- subscription: MJWorkQueueSubscriptionEntity
Returns SubscriptionBinding
- Defined in WorkQueue/engine/src/host/HostedSubscriptionPlanner.ts:27

GetDriver

GetDriver(transportID: string): Promise<ITransportDriver>
One cached driver instance per transport (03 §11).
Parameters
- transportID: string
Returns Promise<ITransportDriver>
- Defined in WorkQueue/engine/src/host/HostedSubscriptionPlanner.ts:26

NotifyDeadLettered

NotifyDeadLettered(event: DeadLetteredEvent): void
Raises a dead-letter event to the engine's OnDeadLettered listeners (03 §11); the sweeper calls it.
Parameters
- event: DeadLetteredEvent
Returns void
- Defined in WorkQueue/engine/src/host/HostedSubscriptionPlanner.ts:30

OnPublished

OnPublished(listener: (topicName: string) => void): () => void
Parameters
- listener: (topicName: string) => void
Returns () => void
- Defined in WorkQueue/engine/src/host/HostedSubscriptionPlanner.ts:28