NodeOPCUA API Documentation
    Preparing search index...

    Interface OPCUAClientBaseEvents

    interface OPCUAClientBaseEvents {
        abort: [];
        after_reconnection: [err?: Error | null];
        backoff: [count: number, delay: number];
        close: [err?: Error | null];
        connected: [];
        connection_failed: [err: Error];
        connection_lost: [];
        connection_reestablished: [];
        keepalive: [];
        lifetime_75: [token: ChannelSecurityToken];
        receive_chunk: [chunk: Buffer<ArrayBufferLike>];
        receive_response: [response: Response];
        reconnecting: [];
        reconnection_attempt_has_failed: [err: Error, message: string];
        reconnection_canceled: [];
        repairConnectionStarted: [];
        secure_channel_created: [secureChannel: ClientSecureChannelLayer];
        security_token_renewed: [
            channel: ClientSecureChannelLayer,
            token: ChannelSecurityToken,
        ];
        send_chunk: [chunk: Buffer<ArrayBufferLike>];
        send_request: [request: Request];
        start_reconnection: [err?: Error];
        startingDelayBeforeReconnection: [duration: number];
        timed_out_request: [request: Request];
    }
    Index

    Properties

    abort after_reconnection backoff close connected connection_failed connection_lost connection_reestablished keepalive lifetime_75 receive_chunk receive_response reconnecting reconnection_attempt_has_failed reconnection_canceled repairConnectionStarted secure_channel_created security_token_renewed send_chunk send_request start_reconnection startingDelayBeforeReconnection timed_out_request

    Properties

    abort: []

    the event is raised when the connection has been aborted by the remote OPCUA Server

    after_reconnection: [err?: Error | null]

    this event is raised after the client has successfully managed to re-establish the connection with the remote OPCUA Server. You can intercept after_reconnection event to resume your interaction with the remote OPCUA server.

    backoff: [count: number, delay: number]

    this Event is raised when a failing connection is about to be tried again

    close: [err?: Error | null]

    this event is raised when the connection is closed

    connected: []

    this Event is raised when the initial connection has succeeded

    connection_failed: [err: Error]

    this Event is raised when the initial connection has failed

    connection_lost: []

    this event is raised when the connection has been broken

    connection_reestablished: []

    this event is raised when a broken connection with the remote Server has been reestablished

    keepalive: []
    lifetime_75: [token: ChannelSecurityToken]

    this event is raised when the current security token has reached 75% of its lifetime and is therefore about to expired.

    receive_chunk: [chunk: Buffer<ArrayBufferLike>]

    this event is raised when the client has received a new message chunk from the servers (advanced use only)

    receive_response: [response: Response]
    reconnecting: []
    reconnection_attempt_has_failed: [err: Error, message: string]

    this event is raised when the client has failed one attempt to reconnect to the server This event will be raised if the socket has successfully being created to the server but if something went wrong during the reconnection process.

    reconnection_canceled: []
    repairConnectionStarted: []
    secure_channel_created: [secureChannel: ClientSecureChannelLayer]

    this event is raised when the secure channel has been created

    security_token_renewed: [
        channel: ClientSecureChannelLayer,
        token: ChannelSecurityToken,
    ]

    this event is raised after the (about ) security token as been renewed and renegotiated with the server.to expire

    send_chunk: [chunk: Buffer<ArrayBufferLike>]

    this event is raised when the client is sending a message chunk to the server (advanced use only)

    send_request: [request: Request]
    start_reconnection: [err?: Error]

    this event is raised when the client has encountered a connection failure and and is going to reconnection mode.

    It notifies the observer that the OPCUA is now trying to reestablish the connection after having received a connection break...

    You can intercept start_reconnection event to pause your interaction with the remote OPCUA server.

    startingDelayBeforeReconnection: [duration: number]
    timed_out_request: [request: Request]

    This event is raised when a request sent to the remote OPCUA server has reach it's timeout value without a Response from the server.

    Settings

    Member Visibility

    On This Page

    Properties