The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.4.5

    • APIs

    Show:

    BinaryStream Class

    Defined in: packages\node-opcua-binary-stream\dist\binaryStream.js:13
    Module: opcua.miscellaneous

    a BinaryStream can be use to perform sequential read or write inside a buffer. The BinaryStream maintains a cursor up to date as the caller operates on the stream using the various read/write methods. It uses the Little Endian convention.

    data can either be:

    • a Buffer , in this case the BinaryStream operates on this Buffer
    • null , in this case a BinaryStream with 1024 bytes is created
    • any data , in this case the object is converted into a binary buffer.

    example:

    var stream = new BinaryStream(32)

    Constructor

    BinaryStream

    (
    • data
    )

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:13

    Parameters:

    • data Null | Buffer | Number

    Methods

    BinaryStream.rewind

    ()

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:54

    set the cursor to the begining of the stream

    Returns:

    null

    calculateByteLength calculate the size in bytes of a utf8 string

    (
    • str
    )

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:401

    Parameters:

    • str String

    decodeArray

    (
    • stream
    • decode_element_func
    )
    Array

    Provided by the opcua.server.simulation module.

    Defined in packages\node-opcua-basic-types\src\array.js:23

    Parameters:

    • stream BinaryStream

      the stream.

    • decode_element_func Function

      The function to decode a single array element. This function returns the element decoded from the stream

    Returns:

    Array:

    encodeArray

    (
    • arr
    • stream
    • encode_element_func
    )

    Provided by the opcua.server.simulation module.

    Defined in packages\node-opcua-basic-types\src\array.js:4

    Parameters:

    • arr Array

      the array to encode.

    • stream BinaryStream

      the stream.

    • encode_element_func Function

      The function to encode a single array element.

    getRandomInt

    (
    • min
    • max
    )
    private

    Provided by the opcua.server.simulation module.

    Defined in packages\node-opcua-basic-types\src\utils.js:3

    return a random integer value in the range of min inclusive and max exclusive

    Parameters:

    • min Object
    • max Object

    Returns:

    :

    getRandomInt

    (
    • min
    • max
    )
    private

    Provided by the opcua.server.simulation module.

    Defined in packages\node-opcua-basic-types\src\floats.js:7

    return a random float value in the range of min inclusive and max exclusive

    Parameters:

    • min Object
    • max Object

    Returns:

    :

    readArrayBuffer

    (
    • length
    )
    Uint8Array

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:333

    Parameters:

    • length Object

    Returns:

    Uint8Array:

    readByte

    () Number

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:191

    read a single signed byte (8 bits) from the stream.

    Returns:

    Number:

    readByteStream

    () Buffer

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:350

    read a byte stream to the stream. The method reads the length of the byte array from the stream as a 32 bits integer before reading the byte stream.

    Returns:

    Buffer:

    readDouble

    ()

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:266

    read a single 64-bit floating point number from the stream.

    Returns:

    the value read from the stream

    readFloat

    ()

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:256

    read a single 32-bit floating point number from the stream.

    Returns:

    the value read from the stream

    readInt16

    () Number

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:216

    read a single signed 16-bit integer from the stream.

    Returns:

    Number:

    readInteger

    () Number

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:236

    read a single signed 32-bit integer from the stream.

    Returns:

    Number:

    readUInt16

    () Number

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:226

    read a single unsigned 16-bit integer from the stream.

    Returns:

    Number:

    q

    readUInt32

    () Number

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:246

    read a single unsigned 32-bit integer from the stream.

    Returns:

    Number:

    the value read from the stream

    readUInt8

    () Number

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:204

    read a single unsigned byte (8 bits) from the stream.

    Returns:

    Number:

    writeArrayBuffer

    (
    • arrayBuf
    • offset
    • length
    )

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:165

    Parameters:

    • arrayBuf ArrayBuffer
    • offset Number
    • length Number

    writeByteStream

    (
    • buf
    )

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:276

    write a byte stream to the stream. The method writes the length of the byte array into the stream as a 32 bits integer before the byte stream.

    Parameters:

    • buf Buffer

      the buffer to write. the buffer buf.length the buffer to write

    writeDouble

    (
    • value
    )

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:154

    write a single 64 bit floating number to the stream.

    Parameters:

    • value Object

    writeFloat

    (
    • value
    )

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:143

    write a single 32 bit floating number to the stream.

    Parameters:

    • value Object

    writeInt16

    (
    • value
    )

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:89

    write a single 16 bit signed integer to the stream.

    Parameters:

    • value Object

    writeInt8

    (
    • value
    )

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:62

    write a single signed byte (8 bits) to the stream. value must be in the range of [-127,128]

    Parameters:

    • value Object

    writeInteger

    (
    • value
    )

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:111

    write a single 32 bit signed integer to the stream.

    Parameters:

    • value Object

    writeUInt16

    (
    • value
    )

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:100

    write a single 16 bit unsigned integer to the stream.

    Parameters:

    • value Object

    writeUInt32

    (
    • value
    )

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:122

    write a single 32 bit unsigned integer to the stream.

    Parameters:

    • value Object

    writeUInt8

    (
    • value
    )

    Defined in packages\node-opcua-binary-stream\dist\binaryStream.js:76

    write a single unsigned byte (8 bits) to the stream.

    Parameters:

    • value Object