API Docs for: 0.0.57
Show:

TCP_transport Class

Extends EventEmitter
Module: opcua.transport

TCP_transport

Constructor

TCP_transport

()

Methods

_install_socket

(
  • socket
)
protected

Parameters:

  • socket Socket

createChunk

(
  • msg_type
  • chunk_type
  • length
)
Buffer

createChunk is used to construct a pre-allocated chunk to store up to length bytes of data. The created chunk includes a prepended header for chunk_type of size self.headerSize.

Parameters:

  • msg_type Object
  • chunk_type String

    chunk type. should be 'F' 'C' or 'A'

  • length Object

Returns:

Buffer:

a buffer object with the required length representing the chunk.

Note:

  • only one chunk can be created at a time.
  • a created chunk should be committed using the write method before an other one is created.

disconnect

(
  • callback
)
async

disconnect the TCP layer and close the underlying socket. The "close" event will be emitted to the observers with err=null.

Parameters:

  • callback Object

write

(
  • message_chunk
)

write the message_chunk on the socket.

Parameters:

  • message_chunk Buffer

    Notes:

    • the message chunk must have been created by createChunk.
    • once a message chunk has been written, it is possible to call createChunk again.

Properties

[timeout=30000]

Number

timeout

chunkSize

Number

headerSize the size of the header in bytes

Number

Default: 8

protocolVersion indicates the version number of the OPCUA protocol used

Number

Default: 0

Events

close

notify the observers that the transport layer has been disconnected.

Event Payload:

  • err Object

    the Error object or null

message

notify the observers that a message chunk has been received

Event Payload:

  • message_chunk Buffer

    the message chunk