ClientTCP_transport | NodeOPCUA reference documentation

a ClientTCP_transport connects to a remote server socket and initiates a communication with a HEL/ACK transaction. It negotiates the communication parameters with the other end.

example

const transport = ClientTCP_transport(url);

transport.timeout = 10000;

transport.connect(function(err)) {
     if (err) {
        // cannot connect
     } else {
        // connected

     }
});
....

transport.write(message_chunk,'F');

....

transport.on("message",function(message_chunk) {
    // do something with message from server...
});

Hierarchy

TCP_transport
- ClientTCP_transport

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ClientTCP_transport(): ClientTCP_transport

Inherited from TCP_transport.constructor
- Defined in node-opcua-transport/dist/source/client_tcp_transport.d.ts:60
Returns ClientTCP_transport

Properties

_socket

_socket: Socket

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

chunkReadCount

chunkReadCount: number

chunkWrittenCount

chunkWrittenCount: number

endpointUrl

endpointUrl: string

name

name: string

numberOfRetry

numberOfRetry: number

Optional parameters

parameters: AcknowledgeMessage

protocolVersion

protocolVersion: number

indicates the version number of the OPCUA protocol used

default: 0

serverUri

serverUri: string

Accessors

isDisconnecting

get isDisconnecting(): boolean

- Defined in node-opcua-transport/dist/source/tcp_transport.d.ts:81
Returns boolean

timeout

get timeout(): number
set timeout(value: number): void

- Defined in node-opcua-transport/dist/source/tcp_transport.d.ts:52
Returns number
- Defined in node-opcua-transport/dist/source/tcp_transport.d.ts:53
Parameters
- value: number
Returns void

Methods

connect

connect(endpointUrl: string, callback: ErrorCallback): void

- Defined in node-opcua-transport/dist/source/client_tcp_transport.d.ts:62
Parameters
- endpointUrl: string
- callback: ErrorCallback
Returns void

createChunk

createChunk(msgType: string, chunkType: string, length: number): Buffer

Inherited from TCP_transport.createChunk
- Defined in node-opcua-transport/dist/source/tcp_transport.d.ts:69
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.

method

createChunk

Parameters
- msgType: string
- chunkType: string
  
  chunk type. should be 'F' 'C' or 'A'
- length: number
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

disconnect(callback: ErrorCallback): void

Inherited from TCP_transport.disconnect
- Defined in node-opcua-transport/dist/source/tcp_transport.d.ts:90
disconnect the TCP layer and close the underlying socket. The "close" event will be emitted to the observers with err=null.

method

disconnect

async

Parameters
- callback: ErrorCallback
Returns void

dispose

dispose(): void

Inherited from TCP_transport.dispose
- Defined in node-opcua-transport/dist/source/client_tcp_transport.d.ts:61
Returns void

isValid

isValid(): boolean

Inherited from TCP_transport.isValid
- Defined in node-opcua-transport/dist/source/tcp_transport.d.ts:91
Returns boolean

on

on(eventName: "message", eventHandler: (message: Buffer) => void): ClientTCP_transport
on(eventName: "socket_closed", eventHandler: (err: Error) => void): ClientTCP_transport
on(eventName: "close", eventHandler: (err: Error) => void): ClientTCP_transport
on(eventName: "connection_break", eventHandler: () => void): ClientTCP_transport

Inherited from TCP_transport.on
- Defined in node-opcua-transport/dist/source/client_tcp_transport.d.ts:6
Parameters
- eventName: "message"
- eventHandler: (message: Buffer) => void
  - - (message: Buffer): void
    - Parameters
      - message: Buffer
      Returns void
Returns ClientTCP_transport
Inherited from TCP_transport.on
- Defined in node-opcua-transport/dist/source/client_tcp_transport.d.ts:7
Parameters
- eventName: "socket_closed"
- eventHandler: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns ClientTCP_transport
Inherited from TCP_transport.on
- Defined in node-opcua-transport/dist/source/client_tcp_transport.d.ts:8
Parameters
- eventName: "close"
- eventHandler: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns ClientTCP_transport
- Defined in node-opcua-transport/dist/source/client_tcp_transport.d.ts:9
Parameters
- eventName: "connection_break"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns ClientTCP_transport

once

once(eventName: "message", eventHandler: (message: Buffer) => void): ClientTCP_transport
once(eventName: "socket_closed", eventHandler: (err: Error) => void): ClientTCP_transport
once(eventName: "close", eventHandler: (err: Error) => void): ClientTCP_transport
once(eventName: "connection_break", eventHandler: () => void): ClientTCP_transport

Inherited from TCP_transport.once
- Defined in node-opcua-transport/dist/source/client_tcp_transport.d.ts:10
Parameters
- eventName: "message"
- eventHandler: (message: Buffer) => void
  - - (message: Buffer): void
    - Parameters
      - message: Buffer
      Returns void
Returns ClientTCP_transport
Inherited from TCP_transport.once
- Defined in node-opcua-transport/dist/source/client_tcp_transport.d.ts:11
Parameters
- eventName: "socket_closed"
- eventHandler: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns ClientTCP_transport
Inherited from TCP_transport.once
- Defined in node-opcua-transport/dist/source/client_tcp_transport.d.ts:12
Parameters
- eventName: "close"
- eventHandler: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns ClientTCP_transport
- Defined in node-opcua-transport/dist/source/client_tcp_transport.d.ts:13
Parameters
- eventName: "connection_break"
- eventHandler: () => void
  - - (): void
    - Returns void
Returns ClientTCP_transport

prematureTerminate

prematureTerminate(err: Error): void

Inherited from TCP_transport.prematureTerminate
- Defined in node-opcua-transport/dist/source/tcp_transport.d.ts:100
Parameters
- err: Error
Returns void

write

write(messageChunk: Buffer): void

Inherited from TCP_transport.write
- Defined in node-opcua-transport/dist/source/tcp_transport.d.ts:80
write the message_chunk on the socket.

method

write

Parameters
- messageChunk: 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.
Returns void

subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ClientTCP_transport

Properties

_socket

bytesRead

bytesWritten

chunkReadCount

chunkWrittenCount

endpointUrl

name

numberOfRetry

Optional parameters

protocolVersion

serverUri

Accessors

isDisconnecting

Returns boolean

timeout

Returns number

Parameters

value: number

Returns void

Methods

connect

Parameters

endpointUrl: string

callback: ErrorCallback

Returns void

createChunk

Parameters

msgType: string

chunkType: string

length: number

Returns Buffer

disconnect

Parameters

callback: ErrorCallback

Returns void

dispose

Returns void

isValid

Returns boolean

on

Parameters

eventName: "message"

eventHandler: (message: Buffer) => void

Parameters

message: Buffer

Returns void

Returns ClientTCP_transport

Parameters

eventName: "socket_closed"

eventHandler: (err: Error) => void

Parameters

err: Error

Returns void

Returns ClientTCP_transport

Parameters

eventName: "close"

eventHandler: (err: Error) => void

Parameters

err: Error

Returns void

Returns ClientTCP_transport

Parameters

eventName: "connection_break"

eventHandler: () => void

Returns void

Returns ClientTCP_transport

once

Parameters

eventName: "message"