The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.2.0

    • APIs

    Show:

    MessageBuilderBase Class

    Uses
    Extends EventEmitter
    Defined in: packages\node-opcua-transport\src\message_builder_base.js:32
    Module: opcua.miscellaneous

    Constructor

    MessageBuilderBase

    (
    • options
    )

    Defined in packages\node-opcua-transport\src\message_builder_base.js:32

    Parameters:

    • options Object
      • [signatureLength=0] Number optional

    Methods

    _append

    (
    • message_chunk
    )
    private

    Defined in packages\node-opcua-transport\src\message_builder_base.js:102

    append a message chunk

    Parameters:

    • message_chunk Object

    encode_decode_round_trip_test

    (
    • obj
    • [options]
    • callback_buffer
    )

    Inherited from PacketAssembler: packages\node-opcua-packet-analyzer\test_helpers\encode_decode_round_trip_test.js:55

    Parameters:

    • obj Object

      : object to test ( the object must provide a binaryStoreSize,encode,decode method

    • [options] Object optional
    • callback_buffer Object

    Returns:

    :

    extract_values

    (
    • array
    • [dimensions = null]
    )

    Inherited from PacketAssembler: packages\node-opcua-numeric-range\src\numeric_range.js:480

    Parameters:

    • array Array

      flat array containing values

    • [dimensions = null] Array optional

      dimension of the matrix if data is a matrix

    Returns:

    :

    feed

    (
    • data
    )

    Defined in packages\node-opcua-transport\src\message_builder_base.js:151

    Feed message builder with some data

    Parameters:

    • data Object

    packet_analyzer

    (
    • buffer
    • id
    • padding
    • offset
    • custom_options
    )

    Inherited from PacketAssembler: packages\node-opcua-packet-analyzer\src\packet_analyzer\packet_analyzer.js:160

    Parameters:

    • buffer Buffer
    • id Object
    • padding Integer
    • offset Integer
    • custom_options Object
      • factory Object
        • constructObject Function

    Events

    chunk

    Defined in packages\node-opcua-transport\src\message_builder_base.js:169

    notify the observers that new message chunk has been received

    Event Payload:

    • messageChunk Buffer

      the raw message chunk

    error

    Defined in packages\node-opcua-transport\src\message_builder_base.js:216

    notify the observers that an error has occurred

    Event Payload:

    • error Error

      the error to raise

    full_message_body

    Defined in packages\node-opcua-transport\src\message_builder_base.js:188

    notify the observers that a full message has been received

    Event Payload:

    • full_message_body Buffer

      the full message body made of all concatenated chunks.

    start_chunk

    Defined in packages\node-opcua-transport\src\message_builder_base.js:61

    notify the observers that a new message is being built

    Event Payload:

    • info Object
    • data Object