The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.5.4

    • APIs

    Show:

    MessageBuilder Class

    Extends MessageBuilderBase
    Defined in: packages\node-opcua-secure-channel\src\message_builder.js:40
    Module: opcua.miscellaneous

    Constructor

    MessageBuilder

    (
    • options
    )

    Defined in packages\node-opcua-secure-channel\src\message_builder.js:40

    Parameters:

    • options Object
      • securityMode MessageSecurityMode

        the security Mode

      • [objectFactory=factories] optional

        a object that provides a constructObject(id) method

    Methods

    _append

    (
    • message_chunk
    )
    private

    Inherited from MessageBuilderBase: packages\node-opcua-transport\src\message_builder_base.js:102

    append a message chunk

    Parameters:

    • message_chunk Object

    _read_headers

    (
    • binaryStream
    )
    Boolean private

    Defined in packages\node-opcua-secure-channel\src\message_builder.js:344

    Parameters:

    • binaryStream Object

    Returns:

    Boolean:

    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:64

    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
    )

    Inherited from MessageBuilderBase: 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:159

    Parameters:

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

    Events

    chunk

    Inherited from MessageBuilderBase: 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

    Inherited from MessageBuilderBase: 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

    Inherited from MessageBuilderBase: 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.

    invalid_sequence_number

    Defined in packages\node-opcua-secure-channel\src\message_builder.js:107

    notify the observers that a message with an invalid sequence number has been received.

    Event Payload:

    • expected Number

      sequence Number

    • actual Number

      sequence Number

    message

    Defined in packages\node-opcua-secure-channel\src\message_builder.js:455

    notify the observers that a full message has been received

    Event Payload:

    • objMessage Object

      the decoded message object

    • msgType String

      the message type ( "HEL","ACK","OPN","CLO" or "MSG" )

    • the Number

      request Id

    start_chunk

    Inherited from MessageBuilderBase: 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