TcpTransportOptions
Defined in: src/transports/tcpTransport.ts:20
Properties
Section titled “Properties”connectTimeoutMs?
Section titled “connectTimeoutMs?”optional connectTimeoutMs?: number;Defined in: src/transports/tcpTransport.ts:26
Reject connect() if no ‘connect’ arrives within this many ms. Default 10000.
createSocket?
Section titled “createSocket?”optional createSocket?: (host, port) => SocketLike;Defined in: src/transports/tcpTransport.ts:33
Test seam: build the socket. Defaults to net.createConnection, which both
creates the socket and starts dialing — so connect() just waits for events.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
host | string |
port | number |
Returns
Section titled “Returns”host: string;Defined in: src/transports/tcpTransport.ts:22
Host to dial.
maxFrameBytes?
Section titled “maxFrameBytes?”optional maxFrameBytes?: number;Defined in: src/transports/tcpTransport.ts:28
Max companion-frame payload size for the de-framer. Default 256.
port: number;Defined in: src/transports/tcpTransport.ts:24
TCP port to dial.