The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.4.5

    • APIs

    Show:

    OPCUAClientBase Class

    Extends EventEmitter
    Defined in: packages\node-opcua-client\src\client_base.js:41
    Module: opcua.client

    Constructor

    OPCUAClientBase

    (
    • options
    )

    Defined in packages\node-opcua-client\src\client_base.js:41

    Parameters:

    • options Object
      • defaultSecureTokenLifetime Number

        default secure token lifetime in ms

      • [securityMode=MessageSecurityMode.None] MessageSecurityMode optional

        the default security mode.

      • [securityPolicy=SecurityPolicy.NONE] SecurityPolicy optional

        the security mode.

      • [serverCertificate=null] Certificate optional

        the server certificate.

      • [certificateFile="certificates/client_selfsigned_cert_1024.pem"] String optional

        client certificate pem file.

      • [privateKeyFile="certificates/client_key_1024.pem"] String optional

        client private key pem file.

      • [connectionStrategy] Object optional
      • [keepSessionAlive=false] Boolean optional
      • [tokenRenewalInterval=0] Number optional

        if not specify or set to 0 , token renewal will happen around 75% of the defaultSecureTokenLifetime

      • [keepPendingSessionsOnDisconnect=false] optional

        if set to true, pending session will not be automatically closed * when disconnect is called

      • [clientName=""] optional

        the client Name

    Methods

    connect

    (
    • endpointUrl
    • callback
    )
    async

    Defined in packages\node-opcua-client\src\client_base.js:582

    connect the OPC-UA client to a server end point.

    Parameters:

    • endpointUrl String
    • callback Function

    connect

    (
    • endpointUrl
    )
    Promise async

    Defined in packages\node-opcua-client\src\client_base.js:1046

    Parameters:

    • endpointUrl String

    Returns:

    Promise:

    disconnect

    (
    • callback
    )
    async

    Defined in packages\node-opcua-client\src\client_base.js:917

    disconnect client from server

    Parameters:

    • callback Object

      [Function}

    findEndpoint

    () EndPoint

    Defined in packages\node-opcua-client\src\client_base.js:685

    return the endpoint information matching security mode and security policy.

    Returns:

    EndPoint:

    findEndpoint

    () EndPoint

    Defined in packages\node-opcua-client\src\client_base.js:701

    return the endpoint information matching the specified url , security mode and security policy.

    Returns:

    EndPoint:

    findServers

    (
    • callback
    )
    async

    Defined in packages\node-opcua-client\src\client_base.js:769

    send a FindServers request to a discovery server

    Parameters:

    • callback Object

      [Function}

    findServers

    (
    • options
    • callback
    )

    Defined in packages\node-opcua-client\src\client_base.js:783

    Parameters:

    • options Object
      • [endpointUrl] optional
      • [localeIds] optional

        Array

      • [serverUris] optional

        Array

    • callback Object

    getEndpoints

    (
    • [options]
    • [options.localeIds}
    • [options.profileUris}
    • callback
    )
    async

    Defined in packages\node-opcua-client\src\client_base.js:717

    Parameters:

    • [options] Object optional
      • [endpointUrl] String optional

        the network address that the Client used to access the Discovery Endpoint .

    • [options.localeIds} Array

      List of locales to use.

    • [options.profileUris} Array

      List of transport profiles that the returned Endpoints shall support.

    • callback Function
      • err Error | Null
      • serverEndpoints Array

        the array of endpoint descriptions

    perform_findServers

    (
    • discovery_server_endpointUrl
    • callback
    )
    async

    Defined in packages\node-opcua-client\src\tools\findservers.js:4

    extract the server endpoints exposed by a discovery server

    Parameters:

    • discovery_server_endpointUrl Object
    • callback Object

    perform_findServers

    (
    • discovery_server_endpointUrl
    • callback
    )
    async

    Defined in packages\node-opcua-client\src\tools\findservers.js:44

    extract the server endpoints exposed by a discovery server

    Parameters:

    • discovery_server_endpointUrl Object
    • callback Object

    Properties

    bytesRead

    Number

    Defined in packages\node-opcua-client\src\client_base.js:983

    total number of bytes read by the client

    bytesWritten

    Number

    Defined in packages\node-opcua-client\src\client_base.js:993

    total number of bytes written by the client

    connectionStrategy

    options.connectionStrategy | MaxRetry, initialDelay, maxDelay, randomisationFactor | | MaxRetry: number, initialDelay: number, maxDelay: number, randomisationFactor: number

    Defined in packages\node-opcua-client\src\client_base.js:129

    isReconnecting

    Boolean true if the client is trying to reconnect to the server after a connection break.

    Defined in packages\node-opcua-client\src\client_base.js:256

    keepPendingSessionsOnDisconnect²

    Boolean

    Defined in packages\node-opcua-client\src\client_base.js:135

    keepSessionAlive

    Boolean

    Defined in packages\node-opcua-client\src\client_base.js:116

    true if session shall periodically probe the server to keep the session alive and prevent timeout

    knowsServerEndpoint

    Boolean

    Defined in packages\node-opcua-client\src\client_base.js:151

    is true when the client has already requested the server end points.

    reconnectOnFailure

    Boolean

    Defined in packages\node-opcua-client\src\client_base.js:445

    true if the connection strategy is set to automatically try to reconnect in case of failure

    securityMode

    MessageSecurityMode

    Defined in packages\node-opcua-client\src\client_base.js:96

    serverCertificate

    Certificate

    Defined in packages\node-opcua-client\src\client_base.js:110

    transactionsPerformed

    Number

    Defined in packages\node-opcua-client\src\client_base.js:1003

    total number of transactions performed by the client

    Events

    after_reconnection

    Defined in packages\node-opcua-client\src\client_base.js:323

    notify the observers that the reconnection process has been completed

    Event Payload:

    • err Object

    close

    Defined in packages\node-opcua-client\src\client_base.js:516

    Event Payload:

    • error Error

    connection_reestablished send when the connection is reestablished after a connection break

    Defined in packages\node-opcua-client\src\client_base.js:542

    receive_chunk

    Defined in packages\node-opcua-client\src\client_base.js:470

    notify the observer that a message_chunk has been received

    Event Payload:

    • message_chunk Object

    receive_response

    Defined in packages\node-opcua-client\src\client_base.js:488

    notify the observer that a response has been received from the server.

    Event Payload:

    • message Object

    send_chunk

    Defined in packages\node-opcua-client\src\client_base.js:461

    notify the observer that a message_chunk has been sent

    Event Payload:

    • message_chunk Object

    send_request

    Defined in packages\node-opcua-client\src\client_base.js:479

    notify the observer that a request has been sent to the server.

    Event Payload:

    • message Object

    start_reconnection

    Defined in packages\node-opcua-client\src\client_base.js:295

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

    timed_out_request

    Defined in packages\node-opcua-client\src\client_base.js:569

    send when a request has timed out without receiving a response

    Event Payload:

    • request Object