class ServerTCP extends Server implements CustomTransportStrategy {
constructor(options: { host?: string; port?: number; retryAttempts?: number; retryDelay?: number; serializer?: Serializer<any, any>; tlsOptions?: ConnectionOptions; deserializer?: Deserializer<...>; socketClass?: Type<...>; })
transportId: Transport.TCP
protected server: NetSocket
listen(callback: (err?: unknown, ...optionalParams: unknown[]) => void)
close()
bindHandler(socket: Socket)
handleMessage(socket: TcpSocket, rawMessage: unknown)
handleClose(): undefined | number | NodeJS.Timer
protected messageHandlers: Map<string, MessageHandler>
protected logger: LoggerService
protected serializer: ConsumerSerializer
protected deserializer: ConsumerDeserializer
addHandler(pattern: any, callback: MessageHandler<any, any, any>, isEventHandler: boolean = false, extras: Record<string, any> = {})
getHandlers(): Map<string, MessageHandler>
getHandlerByPattern(pattern: string): MessageHandler | null
send(stream$: Observable<any>, respond: (data: WritePacket<any>) => unknown): Subscription
handleEvent(pattern: string, packet: ReadPacket<any>, context: BaseRpcContext<unknown[]>): Promise<any>
transformToObservable(resultOrDeferred: any)
getOptionsProp<T extends MicroserviceOptions['options'], K extends keyof T>(obj: T, prop: K, defaultValue: T[K] = undefined)
protected handleError(error: string)
protected loadPackage<T = any>(name: string, ctx: string, loader?: Function): T
protected initializeSerializer(options: { url?: string; maxSendMessageLength?: number; maxReceiveMessageLength?: number; maxMetadataSize?: number; keepalive?: { keepaliveTimeMs?: number; keepaliveTimeoutMs?: number; keepalivePermitWithoutCalls?: number; http2MaxPingsWithoutData?: number; http2MinTimeBetweenPingsMs?: number; http2MinPingIntervalWithoutData...)
protected initializeDeserializer(options: { url?: string; maxSendMessageLength?: number; maxReceiveMessageLength?: number; maxMetadataSize?: number; keepalive?: { keepaliveTimeMs?: number; keepaliveTimeoutMs?: number; keepalivePermitWithoutCalls?: number; http2MaxPingsWithoutData?: number; http2MinTimeBetweenPingsMs?: number; http2MinPingIntervalWithoutData...)
protected getRouteFromPattern(pattern: string): string
protected normalizePattern(pattern: MsPattern): string
}
Constructor
constructor(options: { host?: string; port?: number; retryAttempts?: number; retryDelay?: number; serializer?: Serializer<any, any>; tlsOptions?: ConnectionOptions; deserializer?: Deserializer<...>; socketClass?: Type<...>; })
Parameters
Option |
Type |
Description |
options
|
object |
|
|
Properties
Property |
Description |
transportId: Transport.TCP
|
Read-only.
|
protected server: NetSocket
|
|
Methods
listen()
|
listen(callback: (err?: unknown, ...optionalParams: unknown[]) => void)
Parameters
Option |
Type |
Description |
callback
|
(err?: unknown, ...optionalParams: unknown[]) => void |
|
|
close()
|
close()
Parameters
There are no parameters.
|
bindHandler()
|
bindHandler(socket: Socket)
Parameters
Option |
Type |
Description |
socket
|
Socket |
|
|
handleMessage()
|
handleMessage(socket: TcpSocket, rawMessage: unknown)
Parameters
Option |
Type |
Description |
socket
|
TcpSocket |
|
rawMessage
|
unknown |
|
|
handleClose()
|
handleClose(): undefined | number | NodeJS.Timer
Parameters
There are no parameters.
Returns
undefined | number | NodeJS.Timer
|