NodeOPCUA API Documentation
    Preparing search index...

    Interface ClientSecureChannelLayerEvents

    interface ClientSecureChannelLayerEvents {
        abort: [];
        backoff: [retryCount: number, delay: number];
        beforePerformTransaction: [msgType: string, request: Request];
        close: [err?: Error | null];
        end_transaction: [transactionStatistics: ClientTransactionStatistics];
        lifetime_75: [securityToken: ChannelSecurityToken];
        message: [
            response: BaseUAObject,
            msgType: string,
            securityHeader: SecurityHeader,
            requestId: number,
            channelId: number,
        ];
        receive_chunk: [chunk: Buffer<ArrayBufferLike>];
        receive_response: [response: Response];
        security_token_created: [token: ChannelSecurityToken];
        security_token_renewed: [token: ChannelSecurityToken];
        send_chunk: [chunk: Buffer<ArrayBufferLike>];
        send_request: [
            request: Request,
            msgType: string,
            securityHeader: SecurityHeader,
        ];
        timed_out_request: [request: Request];
    }
    Index

    Properties

    abort backoff beforePerformTransaction end_transaction message security_token_created

    Events

    close lifetime_75 receive_chunk receive_response security_token_renewed send_chunk send_request timed_out_request

    Properties

    abort: []
    backoff: [retryCount: number, delay: number]
    beforePerformTransaction: [msgType: string, request: Request]
    end_transaction: [transactionStatistics: ClientTransactionStatistics]
    message: [
        response: BaseUAObject,
        msgType: string,
        securityHeader: SecurityHeader,
        requestId: number,
        channelId: number,
    ]

    emitting when a message is received from the server

    security_token_created: [token: ChannelSecurityToken]

    Events

    close: [err?: Error | null]

    notify the observers that the transport connection has ended. The error object is null or undefined if the disconnection was initiated by the ClientSecureChannelLayer. A Error object is provided if the disconnection has been initiated by an external cause.

    close

    lifetime_75: [securityToken: ChannelSecurityToken]

    notify the observer that the secure channel has now reach 75% of its allowed live time and that a new token is going to be requested. lifetime_75

    {Object} : the security token that is about to expire.

    receive_chunk: [chunk: Buffer<ArrayBufferLike>]

    notify the observers that ClientSecureChannelLayer has received a message chunk receive_chunk

    receive_response: [response: Response]

    notify the observers that a server response has been received on the channel receive_response

    security_token_renewed: [token: ChannelSecurityToken]

    notify the observers that the security has been renewed security_token_renewed

    send_chunk: [chunk: Buffer<ArrayBufferLike>]

    notify the observer that a message chunk is about to be sent to the server send_chunk

    send_request: [
        request: Request,
        msgType: string,
        securityHeader: SecurityHeader,
    ]

    notify the observer that a client request is being sent the server send_request

    timed_out_request: [request: Request]

    notify the observer that the response from the request has not been received within the timeoutHint specified timed_out_request

    Settings

    Member Visibility

    On This Page

    Properties
    Events