Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClientTCP_transport

  subscribe now with sterfive to access the online-user manual

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

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

Readonly Static captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Readonly Static errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

isDisconnecting

  • get isDisconnecting(): boolean

  • Returns boolean

timeout

  • get timeout(): number
  • set timeout(value: number): any

  • Returns number

  • Parameters

    • value: number

    Returns any

Methods

addListener

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClientTCP_transport

connect

  • Parameters

    Returns void

createChunk

  • createChunk(msgType: string, chunkType: string, length: number): 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.

    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 the TCP layer and close the underlying socket. The "close" event will be emitted to the observers with err=null.

    method

    disconnect

    async

    Parameters

    Returns void

dispose

  • dispose(): void

  • Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

isValid

  • isValid(): boolean

  • Returns boolean

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClientTCP_transport

on

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClientTCP_transport

once

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClientTCP_transport

prematureTerminate

  • prematureTerminate(err: Error): void

  • Parameters

    • err: Error

    Returns void

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): ClientTCP_transport

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClientTCP_transport

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): ClientTCP_transport

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClientTCP_transport

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): ClientTCP_transport

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ClientTCP_transport

setMaxListeners

write

  • write(messageChunk: Buffer): void

  • 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

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string): Promise<any[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string

    Returns Promise<any[]>

Generated using TypeDoc