Skip to content

Class: TcpClient

Defined in: packages/microservices/src/client/tcp.client.ts:26

Client proxy that communicates over raw TCP with newline-delimited JSON framing.

  • send: writes { id, pattern, data }\n and waits for { id, data }\n.
  • emit: writes { id, pattern, data }\n without waiting for a reply.

Extends

Constructors

Constructor

ts
new TcpClient(options): TcpClient;

Defined in: packages/microservices/src/client/tcp.client.ts:44

Parameters

ParameterType
optionsTcpOptions

Returns

TcpClient

Overrides

ClientProxy.constructor

Methods

close()

ts
close(): void;

Defined in: packages/microservices/src/client/tcp.client.ts:171

Destroys the socket and rejects any in-flight requests.

Returns

void

Overrides

ClientProxy.close


connect()

ts
connect(): Promise<void>;

Defined in: packages/microservices/src/client/tcp.client.ts:49

Opens a TCP connection to the configured host/port.

Returns

Promise<void>

Overrides

ClientProxy.connect


emit()

ts
emit<T>(pattern, data): void;

Defined in: packages/microservices/src/client/tcp.client.ts:163

Writes a fire-and-forget event to the server.

Type Parameters

Type ParameterDefault type
Tunknown

Parameters

ParameterType
patternstring
dataT

Returns

void

Overrides

ClientProxy.emit


send()

ts
send<T, R>(pattern, data): Observable<R>;

Defined in: packages/microservices/src/client/tcp.client.ts:134

Sends a request to pattern and returns an Observable that emits the response then completes. Times out after 5 seconds.

Type Parameters

Type ParameterDefault type
Tunknown
Runknown

Parameters

ParameterType
patternstring
dataT

Returns

Observable<R>

Overrides

ClientProxy.send

Released under the MIT License.