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 }\nand waits for{ id, data }\n. - emit: writes
{ id, pattern, data }\nwithout waiting for a reply.
Extends
Constructors
Constructor
new TcpClient(options): TcpClient;Defined in: packages/microservices/src/client/tcp.client.ts:44
Parameters
| Parameter | Type |
|---|---|
options | TcpOptions |
Returns
TcpClient
Overrides
Methods
close()
close(): void;Defined in: packages/microservices/src/client/tcp.client.ts:171
Destroys the socket and rejects any in-flight requests.
Returns
void
Overrides
connect()
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
emit()
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 Parameter | Default type |
|---|---|
T | unknown |
Parameters
| Parameter | Type |
|---|---|
pattern | string |
data | T |
Returns
void
Overrides
send()
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 Parameter | Default type |
|---|---|
T | unknown |
R | unknown |
Parameters
| Parameter | Type |
|---|---|
pattern | string |
data | T |
Returns
Observable<R>