The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.5.4

    • APIs

    Show:

    OPCUAServerEndPoint Class

    Defined in: packages\node-opcua-server\src\server_end_point.js:30
    Module: opcua.server

    OPCUAServerEndPoint a Server EndPoint. A sever end point is listening to one port

    Constructor

    OPCUAServerEndPoint

    (
    • options
    )

    Defined in packages\node-opcua-server\src\server_end_point.js:30

    Parameters:

    • options Object
      • port Number

        the tcp port

      • certificateChain Buffer

        the DER certificate chain

      • privateKey String

        PEM string of the private key

      • [defaultSecureTokenLifetime=600000] Number optional

        the default secure token lifetime

      • [timeout=30000] Number optional

        the timeout for the TCP HEL/ACK transaction (in ms)

      • [maxConnections= 20] Number optional

        the maximum number of connection allowed on the TCP server socket

      • serverInfo ApplicationDescription
        • [applicationUri] String optional
        • [productUri] String optional
        • [applicationName] LocalizedText optional
        • [gatewayServerUri] String | Null optional
        • [discoveryProfileUri] String | Null optional
        • [discoveryUrls] String optional
      • objectFactory

    Methods

    _makeEndpointDescription

    (
    • options.port
    • options.serverCertificate
    • options.securityMode
    • options.securityPolicy
    • options.securityLevel
    • options.server.applicationUri
    • options.server.productUri
    • options.server.applicationName
    • options.server.applicationType
    • options.server.gatewayServerUri
    • options.server.discoveryProfileUri
    • options.server.discoveryUrls
    • [options.resourcePath=""]
    • [options.hostname=get_fully_qualified_domain_name()]
    )
    EndpointDescription private

    Defined in packages\node-opcua-server\src\server_end_point.js:334

    Parameters:

    • options.port Object
    • options.serverCertificate Object
    • options.securityMode Object
    • options.securityPolicy Object
    • options.securityLevel Number
    • options.server.applicationUri String
    • options.server.productUri String
    • options.server.applicationName LocalizedText

      // {text: "SampleServer", locale: null},

    • options.server.applicationType ApplicationType
    • options.server.gatewayServerUri String
    • options.server.discoveryProfileUri String
    • options.server.discoveryUrls String
    • [options.resourcePath=""] String optional

      resource Path is a string added at the end of the url such as "/UA/Server"

    • [options.hostname=get_fully_qualified_domain_name()] String optional

      default hostname

    Returns:

    EndpointDescription:

    _prevent_DOS_Attack

    (
    • self
    • establish_connection
    )
    private async

    Defined in packages\node-opcua-server\src\server_end_point.js:182

    Parameters:

    • self Object
    • establish_connection Object

    _registerChannel

    (
    • channel
    )
    private

    Defined in packages\node-opcua-server\src\server_end_point.js:618

    Parameters:

    • channel Object

    _unregisterChannel

    (
    • channel
    )
    private

    Defined in packages\node-opcua-server\src\server_end_point.js:653

    Parameters:

    • channel Object

    endpointDescriptions

    () Array

    Defined in packages\node-opcua-server\src\server_end_point.js:572

    returns the list of end point descriptions.

    Returns:

    Array:

    getCertificate Returns the X509 DER form of the server certificate

    () Buffer

    Defined in packages\node-opcua-server\src\server_end_point.js:293

    Returns:

    Buffer:

    getCertificateChain Returns the X509 DER form of the server certificate

    () Buffer

    Defined in packages\node-opcua-server\src\server_end_point.js:301

    Returns:

    Buffer:

    getEndpointDescription

    (
    • securityMode
    • securityPolicy
    )
    EndpointDescription | Null

    Defined in packages\node-opcua-server\src\server_end_point.js:463

    Parameters:

    • securityMode Object
    • securityPolicy Object

    Returns:

    EndpointDescription | Null:

    endpoint_description

    getPrivateKey

    () Buffer

    Defined in packages\node-opcua-server\src\server_end_point.js:309

    Returns:

    Buffer:

    the privateKey

    matching_endpoint

    (
    • endpoint
    • securityMode
    • securityPolicy
    )
    Boolean

    Defined in packages\node-opcua-server\src\server_end_point.js:446

    Parameters:

    • endpoint Object
    • securityMode Object
    • securityPolicy Object

    Returns:

    Boolean:

    shutdown

    (
    • callback
    )
    async

    Defined in packages\node-opcua-server\src\server_end_point.js:776

    Parameters:

    • callback Function

    shutdown_channel

    (
    • channel
    • inner_callback
    )

    Defined in packages\node-opcua-server\src\server_end_point.js:756

    Parameters:

    • channel Object
    • inner_callback Object

    start

    (
    • callback
    )
    async

    Defined in packages\node-opcua-server\src\server_end_point.js:804

    Parameters:

    • callback Function

    Properties

    currentChannelCount

    Number

    Defined in packages\node-opcua-server\src\server_end_point.js:318

    The number of active channel on this end point.

    Events

    closeChannel

    Defined in packages\node-opcua-server\src\server_end_point.js:668

    Event Payload:

    • channel Object

    newChannel

    Defined in packages\node-opcua-server\src\server_end_point.js:635

    Event Payload:

    • channel Object