The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.1.0-pre

    • APIs

    Show:

    OPCUAServer Class

    Uses
    Extends OPCUABaseServer
    Defined in: packages\node-opcua-server\src\opcua_server.js:173
    Module: opcua.server

    Constructor

    OPCUAServer

    (
    • options
    )

    Defined in packages\node-opcua-server\src\opcua_server.js:173

    Parameters:

    • options Object
      • [defaultSecureTokenLifetime= 60000] Number optional

        the default secure token life time in ms.

      • [timeout=10000] Number optional

        the HEL/ACK transaction timeout in ms. Use a large value ( i.e 15000 ms) for slow connections or embedded devices.

      • [port= 26543] Number optional

        the TCP port to listen to.

      • [maxAllowedSessionNumber= 10] optional

        the maximum number of concurrent sessions allowed.

      • [nodeset_filename] Array | String optional

        the nodeset.xml files to load

      • [serverInfo= null] optional

        the information used in the end point description

        • [applicationUri= "urn:NodeOPCUA-Server"] String optional
        • [productUri= "NodeOPCUA-Server"] String optional
        • [applicationName] Text: "applicationName" optional
          {LocalizedText}
        • [gatewayServerUri= null] String optional
        • [discoveryProfileUri= null] String optional
        • [discoveryUrls= []] Array optional
      • [securityPolicies= [SecurityPolicy.None,SecurityPolicy.Basic128Rsa15,SecurityPolicy.Basic256]] optional
      • [securityModes= [MessageSecurityMode.NONE,MessageSecurityMode.SIGN,MessageSecurityMode.SIGNANDENCRYPT]] optional
      • [disableDiscovery= false] optional

        true if Discovery Service on unsecure channel shall be disabled

      • [allowAnonymous= true] optional

        tells if the server default endpoints should allow anonymous connection.

      • [userManager= null] optional

        a object that implements user authentication methods

        • [isValidUser] optional
          synchronous function to check the credentials - can be overruled by isValidUserAsync
        • [isValidUserAsync] optional
          asynchronous function to check if the credentials - overrules isValidUser
        • [getUserRole] optional
          synchronous function to return the role of the given user
      • [resourcePath=null] String optional

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

      • [alternateHostname=null] String optional

        alternate hostname to use

      • [maxConnectionsPerEndpoint=null] optional
      • [serverCapabilities] optional

        UserNameIdentityToken is valid.

      • [isAuditing= false] Boolean optional

        true if server shall raise AuditingEvent

    Methods

    _apply_on_SessionObject

    (
    • ResponseClass
    • message
    • channel
    • action_to_perform
    )
    private

    Defined in packages\node-opcua-server\src\opcua_server.js:1312

    ensure that action is performed on a valid session object,

    Parameters:

    • ResponseClass Constructor

      the constructor of the response Class

    • message Object
    • channel Object
    • action_to_perform Function
      • session ServerSession
      • sendResponse Function
        • response ResponseClass
      • sendError Function
        • statusCode StatusCode
        • diagnostics DiagnosticsInfo

    _apply_on_Subscription

    (
    • ResponseClass
    • message
    • channel
    • action_to_perform
    )
    private

    Defined in packages\node-opcua-server\src\opcua_server.js:1392

    Parameters:

    • ResponseClass Object
    • message Object
    • channel Object
    • action_to_perform Object

    _apply_on_SubscriptionIds

    (
    • ResponseClass
    • message
    • channel
    • action_to_perform
    )
    private

    Defined in packages\node-opcua-server\src\opcua_server.js:1416

    Parameters:

    • ResponseClass Object
    • message Object
    • channel Object
    • action_to_perform Object

    _apply_on_Subscriptions

    (
    • ResponseClass
    • message
    • channel
    • action_to_perform
    )
    private

    Defined in packages\node-opcua-server\src\opcua_server.js:1450

    Parameters:

    • ResponseClass Object
    • message Object
    • channel Object
    • action_to_perform Object

    _on_ActivateSessionRequest

    (
    • message
    • channel
    )
    private

    Defined in packages\node-opcua-server\src\opcua_server.js:1097

    Parameters:

    _on_CloseSessionRequest

    (
    • message
    • channel
    )
    private

    Defined in packages\node-opcua-server\src\opcua_server.js:1473

    Parameters:

    • message Object
    • channel Object

    _on_FindServersRequest

    (
    • message
    • channel
    )
    private

    Inherited from OPCUABaseServer: packages\node-opcua-server\src\base_server.js:350

    Parameters:

    • message Object
    • channel Object

    _on_GetEndpointsRequest

    (
    • message
    • channel
    )
    private

    Inherited from OPCUABaseServer: packages\node-opcua-server\src\base_server.js:292

    Parameters:

    • message Object
    • channel Object

    bindMethod

    (
    • nodeId
    • func
    )

    Inherited from ServerEngine: packages\node-opcua-server\src\server_engine.js:1206

    Parameters:

    • nodeId NodeId
      the node id of the method
    • func Object
      • inputArguments Array
      • context Object
      • callback Function

    browse

    (
    • nodesToBrowse
    • [session]
    )
    BrowseResult[]

    Inherited from ServerEngine: packages\node-opcua-server\src\server_engine.js:851

    Parameters:

    Returns:

    BrowseResult[]:

    browsePath

    (
    • browsePath
    )
    BrowsePathResult

    Inherited from ServerEngine: packages\node-opcua-server\src\server_engine.js:1497

    Parameters:

    • browsePath Object

    Returns:

    BrowsePathResult:

    browseSingleNode

    (
    • nodeId
    • browseDescription
    • [session]
    )
    BrowseResult

    Inherited from ServerEngine: packages\node-opcua-server\src\server_engine.js:834

    Parameters:

    Returns:

    BrowseResult:

    closeSession

    (
    • authenticationToken
    • deleteSubscriptions
    • [reason = "CloseSession"]
    )

    Inherited from ServerEngine: packages\node-opcua-server\src\server_engine.js:1326

    Parameters:

    • authenticationToken Object
    • deleteSubscriptions Boolean
      : true if sessions's subscription shall be deleted
    • [reason = "CloseSession"] String optional
      the reason for closing the session (shall be "Timeout", "Terminated" or "CloseSession") what the specs say: ------------------- If a Client invokes the CloseSession Service then all Subscriptions associated with the Session are also deleted if the deleteSubscriptions flag is set to TRUE. If a Server terminates a Session for any other reason, Subscriptions associated with the Session, are not deleted. Each Subscription has its own lifetime to protect against data loss in the case of a Session termination. In these cases, the Subscription can be reassigned to another Client before its lifetime expires.

    createSession

    () ServerSession

    Defined in packages\node-opcua-server\src\opcua_server.js:391

    create and register a new session

    Returns:

    ServerSession:

    getChannels

    () Array

    Inherited from OPCUABaseServer: packages\node-opcua-server\src\base_server.js:392

    returns a array of currently active channels

    Returns:

    Array:

    getSession

    (
    • authenticationToken
    • activeOnly
    )

    Inherited from ServerEngine but overwritten in packages\node-opcua-server\src\opcua_server.js:410

    retrieve a session by authentication token

    Parameters:

    • authenticationToken Object
    • activeOnly Object

      search only within sessions that are not closed

    historyRead

    (
    • context
    • historyReadRequest
    • callback
    )

    Inherited from ServerEngine: packages\node-opcua-server\src\server_engine.js:1143

    Parameters:

    historyReadSingleNode

    (
    • context
    • nodeId
    • attributeId
    • historyReadDetails
    • [timestampsToReturn=TimestampsToReturn.Neither]
    • callback
    )

    Inherited from ServerEngine: packages\node-opcua-server\src\server_engine.js:1067

    Parameters:

    • context SessionContext
    • nodeId NodeId
    • attributeId AttributeId
    • historyReadDetails HistoryReadDetails
    • [timestampsToReturn=TimestampsToReturn.Neither] Object optional
    • callback Function

    initialize

    (
    • done
    )
    async

    Inherited from ServerEngine but overwritten in packages\node-opcua-server\src\opcua_server.js:434

    Initialize the server by installing default node set.

    Parameters:

    • done Function

    iterate_on_signed_message_chunks

    (
    • buffer
    • callback
    )

    Inherited from OPCUABaseServer: packages\node-opcua-secure-channel\test_helpers\fake_message_chunk_factory.js:26

    Parameters:

    • buffer Object
    • callback Function
      • err Error
      • chunks Array

    makeServiceFault

    (
    • statusCode
    • messages
    )

    Inherited from OPCUABaseServer: packages\node-opcua-server\src\base_server.js:188

    construct a service Fault response

    Parameters:

    • statusCode Object
    • messages Object

    read

    (
    • readRequest
    )
    DataValue[]

    Inherited from ServerEngine: packages\node-opcua-server\src\server_engine.js:945

    Parameters:

    • readRequest ReadRequest
      • timestampsToReturn TimestampsToReturn
      • nodesToRead
      • maxAge Number

        maxAge - must be greater or equal than zero. Maximum age of the value to be read in milliseconds. The age of the value is based on the difference between the ServerTimestamp and the time when the Server starts processing the request. For example if the Client specifies a maxAge of 500 milliseconds and it takes 100 milliseconds until the Server starts processing the request, the age of the returned value could be 600 milliseconds prior to the time it was requested. If the Server has one or more values of an Attribute that are within the maximum age, it can return any one of the values or it can read a new value from the data source. The number of values of an Attribute that a Server has depends on the number of MonitoredItems that are defined for the Attribute. In any case, the Client can make no assumption about which copy of the data will be returned. If the Server does not have a value that is within the maximum age, it shall attempt to read a new value from the data source. If the Server cannot meet the requested maxAge, it returns its 'best effort' value rather than rejecting the request. This may occur when the time it takes the Server to process and return the new data value after it has been accessed is greater than the specified maximum age. If maxAge is set to 0, the Server shall attempt to read a new value from the data source. If maxAge is set to the max Int32 value or greater, the Server shall attempt to geta cached value. Negative values are invalid for maxAge.

    Returns:

    DataValue[]:

    readSingleNode

    (
    • context
    • nodeId
    • attributeId
    • [timestampsToReturn=TimestampsToReturn.Neither]
    )
    DataValue

    Inherited from ServerEngine: packages\node-opcua-server\src\server_engine.js:876

    Parameters:

    • context SessionContext
    • nodeId Object
    • attributeId AttributeId
    • [timestampsToReturn=TimestampsToReturn.Neither] Object optional

    Returns:

    DataValue:

    refreshValues

    (
    • nodesToRefresh
    • callback
    )
    async

    Inherited from ServerEngine: packages\node-opcua-server\src\server_engine.js:1507

    performs a call to `asyncRefresh` on all variable nodes that provide an async refresh func.

    Parameters: