NodeOPCUA API Documentation
    Preparing search index...

    Interface ISessionBase

    interface ISessionBase {
        channel?: IChannelBase;
        continuationPointManager: IContinuationPointManager;
        localeIds?: readonly string[];
        userIdentityToken?: UserIdentityToken;
        getEndpointUrl?(): string | undefined;
        getSessionId(): NodeId;
        getSubscription?(subscriptionId: number): ISubscriptionBase | null;
        registerSessionShutdownTask?(task: SessionShutdownTask): void;
    }
    Index
    channel? continuationPointManager localeIds? userIdentityToken?
    getEndpointUrl? getSessionId getSubscription? registerSessionShutdownTask?
    channel?: IChannelBase
    continuationPointManager: IContinuationPointManager
    localeIds?: readonly string[]

    The localeIds of the Session's last successful ActivateSession, most preferred first. OPC 10000-4 v1.05.07 §5.7.3: a later ActivateSession with a null/empty localeIds keeps this list unchanged. Empty (or absent) until the Session has been activated once.

    userIdentityToken?: UserIdentityToken

    • The URL of the Endpoint the Session was created on, if known.

      Returns string | undefined

    • Returns NodeId

    • The Subscription with that id owned by this Session, or null.

      A SubscriptionId is only meaningful inside the Session that created it (Part 4), so a Subscription of another Session is null here as much as one that never existed. Optional: an in-process caller (PseudoSession, tests) has no Subscriptions to check against, and a Method validating its SubscriptionId argument then lets it through.

      Parameters

      • subscriptionId: number

      Returns ISubscriptionBase | null

    • Registers a task that runs once when the Session closes, for whatever reason (CloseSession, timeout, server shutdown). Use it to release a resource that the Session holds. A task that fails does not stop the other tasks. A task that returns a Promise delays the CloseSession response and the server shutdown until it settles, so it must settle. A task registered after the Session closed runs immediately. Optional: an in-process caller (PseudoSession, tests) has no Session lifetime to follow.

      Parameters

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods