API Docs for: 0.0.57
Show:

ServerTCP_transport Class

Constructor

ServerTCP_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

init

(
  • socket
  • callback
)

Initialize the server transport.

The ServerTCP_transport initialisation process starts by waiting for the client to send a "HEL" message.

The ServerTCP_transport replies with a "ACK" message and then start waiting for further messages of any size.

The callback function received an error:

  • if no message from the client is received within the self.timeout period,
  • or, if the connection has dropped within the same interval.
  • if the protocol version specified within the HEL message is invalid or is greater than self.protocolVersion

Parameters:

  • socket Socket
  • callback Function
    • err Error | | Null

      err = null if init succeeded

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