NodeOPCUA API Documentation
    Preparing search index...

    Interface ClientSessionBase

    interface ClientSessionBase {
        authenticationToken?: NodeId;
        endpoint: EndpointDescription;
        isReconnecting: boolean;
        lastActivateSessionStatusCode: StatusCode;
        lastRequestSentTime: Date;
        lastResponseReceivedTime: Date;
        name: string;
        serverCertificate: DER;
        sessionId: NodeId;
        subscriptionCount: number;
        timeout: number;
        close(callback: ErrorCallback): void;
        close(deleteSubscription: boolean, callback: ErrorCallback): void;
        close(deleteSubscription?: boolean): Promise<void>;
    }

    Hierarchy (View Summary)

    Index
    authenticationToken? endpoint isReconnecting lastActivateSessionStatusCode lastRequestSentTime lastResponseReceivedTime name serverCertificate sessionId subscriptionCount timeout
    close
    authenticationToken?: NodeId
    endpoint: EndpointDescription
    isReconnecting: boolean
    lastActivateSessionStatusCode: StatusCode

    the StatusCode returned by the last ActivateSession — usually Good, but e.g. Good_PasswordChangeRequired when the user must change the password (OPC 10000-18 §5.2.8). Lets a Client react without server-side access.

    lastRequestSentTime: Date

    the time of the latest request sent by the client to the server

    lastResponseReceivedTime: Date

    the time of the latest response received by the client from the server.

    this is only updated when the server has actually answered. A transaction that fails on a timeout or on a broken channel does not update this value, whereas a ServiceFault does: a fault means the server answered and rejected the request, so the session is still in contact with it.

    before the first answer, this holds the session creation sentinel rather than a real date.

    name: string

    the session name

    serverCertificate: DER

    the server certificate as provided by the server

    sessionId: NodeId
    subscriptionCount: number
    timeout: number

    the session Id

    • Close the session.

      Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      • OptionaldeleteSubscription: boolean

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods