NodeOPCUA API Documentation
    Preparing search index...

    Interface OPCUAServerEvents

    interface OPCUAServerEvents {
        channelSecured: [
            channel: ServerSecureChannelLayer,
            endpoint: OPCUAServerEndPoint,
        ];
        closeChannel: [
            channel: ServerSecureChannelLayer,
            endpoint: OPCUAServerEndPoint,
        ];
        connectionRefused: [socketData: ISocketData, endpoint: OPCUAServerEndPoint];
        create_session: [session: ServerSession];
        event: [eventData: unknown];
        newChannel: [
            channel: ServerSecureChannelLayer,
            endpoint: OPCUAServerEndPoint,
        ];
        openSecureChannelFailure: [
            socketData: ISocketData,
            channelData: IChannelData,
            endpoint: OPCUAServerEndPoint,
        ];
        openSecureChannelRequest: [
            request: OpenSecureChannelRequest,
            channel: ServerSecureChannelLayer,
        ];
        openSecureChannelResponse: [
            response: Response,
            channel: ServerSecureChannelLayer,
        ];
        post_initialize: [];
        request: [request: Request, channel: ServerSecureChannelLayer];
        response: [response: Response, channel: ServerSecureChannelLayer];
        serverRegistered: [];
        serverRegistrationPending: [];
        serverRegistrationRenewed: [];
        serverUnregistered: [];
        session_activated: [
            session: ServerSession,
            userIdentityToken: UserIdentityToken,
        ];
        session_closed: [session: ServerSession, deleteSubscriptions: boolean];
    }
    Index
    channelSecured closeChannel connectionRefused create_session event newChannel openSecureChannelFailure openSecureChannelRequest openSecureChannelResponse post_initialize request response serverRegistered serverRegistrationPending serverRegistrationRenewed serverUnregistered session_activated session_closed
    channelSecured: [
        channel: ServerSecureChannelLayer,
        endpoint: OPCUAServerEndPoint,
    ]

    event raised when a secure channel has completed the OpenSecureChannel handshake. At this point securityPolicy, securityMode, and clientCertificate are available.

    closeChannel: [channel: ServerSecureChannelLayer, endpoint: OPCUAServerEndPoint]

    event raised when a secure channel is closed

    connectionRefused: [socketData: ISocketData, endpoint: OPCUAServerEndPoint]

    event raised when the server refused a TCP connection from a client (for instance because too many connections)

    create_session: [session: ServerSession]

    event raised when a new session is created

    event: [eventData: unknown]

    event raised after the server has raised an OPCUA event toward a client

    newChannel: [channel: ServerSecureChannelLayer, endpoint: OPCUAServerEndPoint]

    event raised when a new secure channel transport is initialized (HEL/ACK complete). Note: securityPolicy and securityMode are NOT yet established at this point. Use "channelSecured" for post-handshake notifications.

    openSecureChannelFailure: [
        socketData: ISocketData,
        channelData: IChannelData,
        endpoint: OPCUAServerEndPoint,
    ]

    event raised when an OpenSecureChannel has failed, e.g. invalid certificate or malformed message

    openSecureChannelRequest: [
        request: OpenSecureChannelRequest,
        channel: ServerSecureChannelLayer,
    ]

    event raised when a client sends an OpenSecureChannelRequest (Issue or Renew), before the server processes it. The request is decoded: SecurityMode, RequestType, RequestedLifetime and ClientNonce.

    openSecureChannelResponse: [
        response: Response,
        channel: ServerSecureChannelLayer,
    ]

    event raised when the server answers an OpenSecureChannelRequest: the OpenSecureChannelResponse, or the ServiceFault that refuses the channel.

    post_initialize

    post_initialize: []

    event raised after the server address space has been initialized

    request: [request: Request, channel: ServerSecureChannelLayer]

    event raised when the server receives a request from a connected client. Useful for trace/diagnostics.

    response: [response: Response, channel: ServerSecureChannelLayer]

    event raised when the server sends a response to a connected client. Useful for trace/diagnostics.

    serverRegistered: []

    event raised when server has been successfully registered on the LDS

    serverRegistrationPending: []

    emitted when the server is trying to register with the LDS but the connection has failed (backoff signal)

    serverRegistrationRenewed: []

    event raised when server registration has been successfully renewed on the LDS

    serverUnregistered: []

    event raised when server has been successfully unregistered from the LDS

    session_activated: [
        session: ServerSession,
        userIdentityToken: UserIdentityToken,
    ]

    event raised when a session is activated

    session_closed: [session: ServerSession, deleteSubscriptions: boolean]

    event raised when a session is closed

    Settings
    Member Visibility

    On This Page
    Properties