edgeport - v1.0.3
    Preparing search index...

    Interface SmppSession

    A live SMPP session over a single bound transport.

    Obtain one from connect. A background pump reads PDUs and routes them, so a submission's response, inbound deliveries, and the keep-alive exchange can all be in flight at once. It is an AsyncDisposable, so await using unbinds and closes it cleanly.

    1.0.3

    interface SmppSession {
        bindMode: BindMode;
        systemId: string;
        "[asyncDispose]"(): PromiseLike<void>;
        close(): Promise<void>;
        enquireLink(): Promise<void>;
        messages(): AsyncIterable<SmppDeliverMessage>;
        submit(opts: SubmitOptions): Promise<string>;
        unbind(): Promise<void>;
    }

    Hierarchy

    • AsyncDisposable
      • SmppSession
    Index
    bindMode systemId
    [asyncDispose] close enquireLink messages submit unbind
    bindMode: BindMode

    The mode this session bound with.

    systemId: string

    The SMSC's system id, as returned in the bind response.

    • Returns PromiseLike<void>

    • Sends a best-effort unbind and closes the underlying socket.

      Returns Promise<void>

    • Sends an enquire_link and awaits its response (an explicit liveness check on top of the automatic keep-alive).

      Returns Promise<void>

      Resolves once the enquire_link_resp arrives.

      If no response arrives within the configured deadline.

      If the session is closed.

    • Submits a short message and resolves with the SMSC-assigned message id.

      Sends submit_sm and awaits its submit_sm_resp. A message body larger than 254 octets is carried in a message_payload TLV automatically. Only valid on a transmitter or transceiver bind.

      Parameters

      • opts: SubmitOptions

        Source/destination addresses, the body, and delivery options.

      Returns Promise<string>

      The message_id assigned by the SMSC.

      If the bind is receive-only, or the SMSC rejects the submission.

      If no response arrives within the configured deadline.

      If the session is closed.

    • Sends unbind and awaits unbind_resp (best-effort), without closing the socket.

      Returns Promise<void>

      Resolves once the unbind round-trip completes or fails.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods