Setu-TS
    Preparing search index...

    Interface IngressContext<TPayload>

    Transport-neutral envelope for ONE unit of non-HTTP work.

    Built per work item by the dispatch site (never reused across concurrent invocations) and handed to every behaviour in the chain. The wrapped handler keeps its NATIVE argument (IJob, ScheduledJob, (message, metadata), (conn, data)); only the behaviour chain sees this envelope.

    There is deliberately no state slot and no services member: the envelope is a per-item read-only value, and a behaviour needing a capability closes over it via its RegistryFactory arm instead. That closed-over capability is also how a TENANT concern is written: the tenant id is read from payload and scoped through the ctx-free members of IMultiTenancyService (getRepositoryFor/prefixCacheKey) — its IRequestContext-taking members are unreachable from an ingress path, which carries no request.

    The optional consumer member added in M109a is a DISPATCH identity, not a capability and not a state bag: it names which subscriber a work item was dispatched to, so per-consumer state (an idempotency record) is keyed per subscriber rather than per topic. The "no state, no services" rule above stands unchanged — a behaviour still reaches a capability through its RegistryFactory arm, and a consumer value is read by the dispatch site, not resolved by the behaviour.

    0.3.0

    interface IngressContext<TPayload = unknown> {
        attempt?: number;
        consumer?: string;
        headers?: Readonly<Record<string, string>>;
        kind: IngressKind;
        name: string;
        payload: TPayload;
    }

    Type Parameters

    • TPayload = unknown

      The native work item the ingress carries

    Index
    attempt? consumer? headers? kind name payload
    attempt?: number

    1-based delivery attempt. Present for 'queue' (from IJob.attempts) and 'scheduler' (from ScheduledJob.attempts); ABSENT for 'messaging' and 'websocket'. Absent means "this ingress cannot tell you" — never "first try": brokers redeliver and none tracks a delivery count, so a fabricated 1 would lie on a fifth redelivery.

    consumer?: string

    Identity of the CONSUMER this work item was dispatched to, so per-consumer state (an idempotency record) does not collide when one topic has several subscribers.

    'messaging': the subscription's SubscribeOptions.queue when given, otherwise subscription:<instance>:<n> — unique per subscription per process. 'queue': the job name. ABSENT on 'scheduler' and 'websocket'.

    A DISPATCH identity, not a capability and not a state bag — the envelope's "no state, no services" rule stands (see the interface JSDoc).

    0.9.0

    headers?: Readonly<Record<string, string>>

    Transport headers, populated on the 'messaging' arm from MessageMetadata.headers and on the 'queue' arm from IJob.headers. {} means the channel carried none; absent means there was no channel.

    ABSENT on 'scheduler' deliberately, and that is a statement rather than an omission: a tick has no upstream request, so there is no header to carry and no trace to join. Adding the member "for symmetry" would erase the distinction the three states exist for — an operator could no longer tell "this work had no cause" from "the cause was lost".

    ABSENT on 'websocket' for the different reason that a frame carries no per-frame headers; the upgrade request's headers are the connection's.

    0.5.0 — the 'queue' arm. Before that the member was populated on 'messaging' only, because the queue contract had no header channel to read.

    kind: IngressKind

    Which ingress path produced this work item — the discriminator a behaviour branches on.

    name: string

    The route the work is addressed by: the queue job name, the scheduler job name, the broker topic, or the WebSocket route path.

    payload: TPayload

    The native work item: an IJob, a ScheduledJob, the message payload, or the frame data.

    Settings
    Member Visibility

    On This Page
    Properties