The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.5.4

    • APIs

    Show:

    ServerSidePublishEngine Class

    Defined in: packages\node-opcua-server\src\server_publish_engine.js:35
    Module: opcua.server

    a Publish Engine for a given session

    Constructor

    ServerSidePublishEngine

    (
    • options
    )

    Defined in packages\node-opcua-server\src\server_publish_engine.js:35

    Parameters:

    • options Object
      • [maxPublishRequestInQueue= 100] Integer optional

    Methods

    add_subscription

    (
    • subscription
    )

    Defined in packages\node-opcua-server\src\server_publish_engine.js:451

    Parameters:

    getSubscriptionById

    (
    • subscriptionId
    )
    Subscription

    Defined in packages\node-opcua-server\src\server_publish_engine.js:567

    retrieve a subscription by id.

    Parameters:

    • subscriptionId Integer

    Returns:

    Subscription:

    send_keep_alive_response

    (
    • subscriptionId
    • future_sequence_number
    )
    Boolean

    Defined in packages\node-opcua-server\src\server_publish_engine.js:295

    call by a subscription when no notification message is available after the keep alive delay has expired.

    Parameters:

    • subscriptionId Object
    • future_sequence_number Object

    Returns:

    Boolean:

    true if a publish response has been sent

    send_notification_message

    (
    • param
    • force
    )
    private

    Defined in packages\node-opcua-server\src\server_publish_engine.js:375

    Parameters:

    • param Object
      • subscriptionId Number
      • sequenceNumber Number
      • notificationData Object
      • availableSequenceNumbers Array
      • moreNotifications Boolean
    • force Boolean

      push response in queue until next publish Request is received

    transferSubscription

    (
    • subscription
    • destPublishEngine
    • sendInitialValues
    )
    Void private

    Defined in packages\node-opcua-server\src\server_publish_engine.js:639

    Parameters:

    • subscription Object
    • destPublishEngine Object
    • sendInitialValues Boolean

      true if initial values should be sent

    Returns:

    Void:

    transferSubscriptionsToOrphan

    (
    • srcPublishEngine
    • destPublishEngine
    )
    private static

    Defined in packages\node-opcua-server\src\server_publish_engine.js:671

    Parameters:

    Returns:

    void

    Properties

    pendingPublishRequestCount

    Integer

    Defined in packages\node-opcua-server\src\server_publish_engine.js:509

    number of pending PublishRequest available in queue

    subscription

    Subscription[]

    Defined in packages\node-opcua-server\src\server_publish_engine.js:116

    get a array of subscription handled by the publish engine.

    subscriptionCount

    Integer

    Defined in packages\node-opcua-server\src\server_publish_engine.js:518

    number of subscriptions