The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.1.0-pre

    • APIs

    Show:

    HelloMessage Class

    Extends BaseUAObject
    Defined in: packages\node-opcua-transport\_generated_\_auto_generated_HelloMessage.js:27
    Module: opcua.address_space.types

    Constructor

    HelloMessage

    (
    • options
    )

    Defined in packages\node-opcua-transport\_generated_\_auto_generated_HelloMessage.js:27

    Parameters:

    • options Object
      • [protocolVersion] UInt32 optional

        The latest version of the OPC UA TCP protocol supported by the Client

      • [receiveBufferSize] UInt32 optional

        The largest message that the sender can receive.

      • [sendBufferSize] UInt32 optional

        The largest message that the sender will send.

      • [maxMessageSize] UInt32 optional

        The maximum size for any response message.

      • [maxChunkCount] UInt32 optional

        The maximum number of chunks in any response message

      • [endpointUrl] UAString optional

        The URL of the Endpoint which the Client wished to connect to.

    Methods

    binaryStoreSize

    () Number

    Inherited from BaseUAObject: packages\node-opcua-factory\src\factories_baseobject.js:49

    Calculate the required size to store this object in a binary stream.

    Returns:

    Number:

    decode

    (
    • stream
    • [option]
    )

    Defined in packages\node-opcua-transport\_generated_\_auto_generated_HelloMessage.js:120

    decode the object from a binary stream

    Parameters:

    encode

    (
    • stream
    )

    Defined in packages\node-opcua-transport\_generated_\_auto_generated_HelloMessage.js:104

    encode the object into a binary stream

    Parameters:

    isValid

    () Boolean

    Inherited from BaseUAObject: packages\node-opcua-factory\src\factories_baseobject.js:83

    verify that all object attributes values are valid according to schema

    Returns:

    Boolean:

    toString

    () String

    Inherited from BaseUAObject: packages\node-opcua-factory\src\factories_baseobject.js:61

    Returns:

    String:

    Properties

    endpointUrl

    UAString

    Defined in packages\node-opcua-transport\_generated_\_auto_generated_HelloMessage.js:86

    The URL of the Endpoint which the Client wished to connect to.

    maxChunkCount

    UInt32

    Defined in packages\node-opcua-transport\_generated_\_auto_generated_HelloMessage.js:79

    The maximum number of chunks in any response message

    maxMessageSize

    UInt32

    Defined in packages\node-opcua-transport\_generated_\_auto_generated_HelloMessage.js:72

    The maximum size for any response message.

    protocolVersion

    UInt32

    Defined in packages\node-opcua-transport\_generated_\_auto_generated_HelloMessage.js:51

    The latest version of the OPC UA TCP protocol supported by the Client

    receiveBufferSize

    UInt32

    Defined in packages\node-opcua-transport\_generated_\_auto_generated_HelloMessage.js:58

    The largest message that the sender can receive.

    sendBufferSize

    UInt32

    Defined in packages\node-opcua-transport\_generated_\_auto_generated_HelloMessage.js:65

    The largest message that the sender will send.