The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.5.4

    • APIs

    Show:

    ServerEngine Class

    Uses
    Extends EventEmitter
    Defined in: packages\node-opcua-server\src\server_engine.js:1489
    Module: opcua.server

    create a new server session object.

    Constructor

    ServerEngine

    (
    • options
    )
    ServerSession

    Defined in packages\node-opcua-server\src\server_engine.js:1489

    Parameters:

    • options Object
      • buildInfo
      • [isAuditing= false] Boolean optional
      • [serverCapabilities] optional
        • [serverProfileArray] optional
        • [localeIdArray] optional
      • applicationUri String

        the application URI.

      • [historyServerCapabilities] optional
      • [serverDiagnosticsEnabled= true] optional

        set to true to enable serverDiagnostics

    Returns:

    ServerSession:

    Methods

    _createSubscriptionOnSession

    (
    • request
    )
    Subscription

    Defined in packages\node-opcua-server\src\server_engine.js:1439

    create a new subscription

    Parameters:

    • request Object
      • requestedPublishingInterval Duration
      • requestedLifetimeCount Counter
      • requestedMaxKeepAliveCount Counter
      • maxNotificationsPerPublish Counter
      • publishingEnabled Boolean
      • priority Byte

    Returns:

    Subscription:

    add_subscription

    (
    • subscription
    )

    Inherited from ServerSidePublishEngine: packages\node-opcua-server\src\server_publish_engine.js:451

    Parameters:

    bindMethod

    (
    • nodeId
    • func
    )

    Defined in packages\node-opcua-server\src\server_engine.js:1324

    Parameters:

    • nodeId NodeId

      the node id of the method

    • func Object
      • inputArguments Array
      • context Object
      • callback Function

    browse

    (
    • nodesToBrowse
    • [session]
    )
    BrowseResult[]

    Defined in packages\node-opcua-server\src\server_engine.js:960

    Parameters:

    Returns:

    BrowseResult[]:

    browsePath

    (
    • browsePath
    )
    BrowsePathResult

    Defined in packages\node-opcua-server\src\server_engine.js:1789

    Parameters:

    • browsePath Object

    Returns:

    BrowsePathResult:

    browseSingleNode

    (
    • nodeId
    • browseDescription
    • [session]
    )
    BrowseResult

    Defined in packages\node-opcua-server\src\server_engine.js:943

    Parameters:

    Returns:

    BrowseResult:

    closeSession

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

    Defined in packages\node-opcua-server\src\server_engine.js:1600

    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.

    getSession

    (
    • authenticationToken
    • activeOnly
    )
    ServerSession

    Defined in packages\node-opcua-server\src\server_engine.js:1766

    retrieve a session by its authenticationToken.

    Parameters:

    • authenticationToken Object
    • activeOnly Object

    Returns:

    ServerSession:

    getSubscriptionById

    (
    • subscriptionId
    )
    Subscription

    Inherited from ServerSidePublishEngine: packages\node-opcua-server\src\server_publish_engine.js:567

    retrieve a subscription by id.

    Parameters:

    • subscriptionId Integer

    Returns:

    Subscription:

    historyRead

    (
    • context
    • historyReadRequest
    • callback
    )

    Defined in packages\node-opcua-server\src\server_engine.js:1261

    Parameters:

    historyReadSingleNode

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

    Defined in packages\node-opcua-server\src\server_engine.js:1184

    Parameters:

    initialize

    (
    • options
    • callback
    )
    async

    Defined in packages\node-opcua-server\src\server_engine.js:469

    Parameters:

    • options Object
      • nodeset_filename String
        • [option](default : 'mini.Node.Set2.xml' )
    • callback Object

    read

    (
    • readRequest
    )
    DataValue[]

    Defined in packages\node-opcua-server\src\server_engine.js:1059

    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

    Defined in packages\node-opcua-server\src\server_engine.js:985

    Parameters:

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

    Returns:

    DataValue:

    refreshValues

    (
    • nodesToRefresh
    • callback
    )
    async

    Defined in packages\node-opcua-server\src\server_engine.js:1800

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

    Parameters: