class ClientRMQ extends ClientProxy {
constructor(options: { urls?: string[] | RmqUrl[]; queue?: string; prefetchCount?: number; isGlobalPrefetchCount?: boolean; queueOptions?: any; socketOptions?: any; noAck?: boolean; serializer?: Serializer<any, any>; ... 5 more ...; maxConnectionAttempts?: number; })
protected logger: Logger
protected connection$: ReplaySubject<any>
protected connection: Promise<any>
protected client: AmqpConnectionManager
protected channel: ChannelWrapper
protected urls: string[] | RmqUrl[]
protected queue: string
protected queueOptions: Record<string, any>
protected responseEmitter: EventEmitter
protected replyQueue: string
protected persistent: boolean
protected noAssert: boolean
protected options: RmqOptions['options']
close(): void
connect(): Promise<any>
createChannel(): Promise<void>
createClient(): AmqpConnectionManager
mergeDisconnectEvent<T = any>(instance: any, source$: Observable<T>): Observable<T>
convertConnectionToPromise()
setupChannel(channel: any, resolve: Function)
consumeChannel(channel: any)
handleError(client: any): void
handleDisconnectError(client: any): void
handleMessage(packet: unknown, options: Record<string, unknown> | ((packet: WritePacket<any>) => any), callback?: (packet: WritePacket<any>) => any)
protected publish(message: ReadPacket<any>, callback: (packet: WritePacket<any>) => any): () => void
protected dispatchEvent(packet: ReadPacket<any>): Promise<any>
protected initializeSerializer(options: { urls?: string[] | RmqUrl[]; queue?: string; prefetchCount?: number; isGlobalPrefetchCount?: boolean; queueOptions?: any; socketOptions?: any; noAck?: boolean; serializer?: Serializer<any, any>; ... 5 more ...; maxConnectionAttempts?: number; })
protected mergeHeaders(requestHeaders?: Record<string, string>): Record<string, string> | undefined
protected routingMap: Map<string, Function>
protected serializer: ProducerSerializer
protected deserializer: ProducerDeserializer
abstract connect(): Promise<any>
abstract close(): any
send<TResult = any, TInput = any>(pattern: any, data: TInput): Observable<TResult>
emit<TResult = any, TInput = any>(pattern: any, data: TInput): Observable<TResult>
protected abstract publish(packet: ReadPacket<any>, callback: (packet: WritePacket<any>) => void): () => void
protected abstract dispatchEvent<T = any>(packet: ReadPacket<any>): Promise<T>
protected createObserver<T>(observer: Observer<T>): (packet: WritePacket) => void
protected serializeError(err: any): any
protected serializeResponse(response: any): any
protected assignPacketId(packet: ReadPacket<any>): ReadPacket & PacketId
protected connect$(instance: any, errorEvent: string = ERROR_EVENT, connectEvent: string = CONNECT_EVENT): Observable<any>
protected getOptionsProp<T extends ClientOptions['options'], K extends keyof T>(obj: T, prop: K, defaultValue: T[K] = undefined)
protected normalizePattern(pattern: MsPattern): string
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...)
}
Constructor
constructor(options: { urls?: string[] | RmqUrl[]; queue?: string; prefetchCount?: number; isGlobalPrefetchCount?: boolean; queueOptions?: any; socketOptions?: any; noAck?: boolean; serializer?: Serializer<any, any>; ... 5 more ...; maxConnectionAttempts?: number; })
Parameters
Option |
Type |
Description |
options
|
object |
|
|
Properties
Property |
Description |
protected logger: Logger
|
Read-only.
|
protected connection$: ReplaySubject<any>
|
|
protected connection: Promise<any>
|
|
protected client: AmqpConnectionManager
|
|
protected channel: ChannelWrapper
|
|
protected urls: string[] | RmqUrl[]
|
|
protected queue: string
|
|
protected queueOptions: Record<string, any>
|
|
protected responseEmitter: EventEmitter
|
|
protected replyQueue: string
|
|
protected persistent: boolean
|
|
protected noAssert: boolean
|
|
protected options: RmqOptions['options']
|
Read-only.
Declared in constructor.
|
Methods
close()
|
close(): void
Parameters
There are no parameters.
Returns
void
|
connect()
|
connect(): Promise<any>
Parameters
There are no parameters.
Returns
Promise<any>
|
createChannel()
|
createChannel(): Promise<void>
Parameters
There are no parameters.
Returns
Promise<void>
|
createClient()
|
createClient(): AmqpConnectionManager
Parameters
There are no parameters.
Returns
AmqpConnectionManager
|
mergeDisconnectEvent()
|
mergeDisconnectEvent<T = any>(instance: any, source$: Observable<T>): Observable<T>
Parameters
Option |
Type |
Description |
instance
|
any |
|
source$
|
Observable |
|
Returns
Observable<T>
|
convertConnectionToPromise()
|
convertConnectionToPromise()
Parameters
There are no parameters.
|
setupChannel()
|
setupChannel(channel: any, resolve: Function)
Parameters
Option |
Type |
Description |
channel
|
any |
|
resolve
|
Function |
|
|
consumeChannel()
|
consumeChannel(channel: any)
Parameters
Option |
Type |
Description |
channel
|
any |
|
|
handleError()
|
handleError(client: any): void
Parameters
Option |
Type |
Description |
client
|
any |
|
Returns
void
|
handleDisconnectError()
|
handleDisconnectError(client: any): void
Parameters
Option |
Type |
Description |
client
|
any |
|
Returns
void
|
handleMessage()
|
handleMessage(packet: unknown, callback: (packet: WritePacket<any>) => any)
Parameters
Option |
Type |
Description |
packet
|
unknown |
|
callback
|
(packet: WritePacket) => any |
|
|
handleMessage(packet: unknown, options: Record<string, unknown>, callback: (packet: WritePacket<any>) => any)
Parameters
Option |
Type |
Description |
packet
|
unknown |
|
options
|
Record |
|
callback
|
(packet: WritePacket) => any |
|
|
publish()
|
protected publish(message: ReadPacket<any>, callback: (packet: WritePacket<any>) => any): () => void
Parameters
Returns
() => void
|
dispatchEvent()
|
protected dispatchEvent(packet: ReadPacket<any>): Promise<any>
Parameters
Returns
Promise<any>
|
initializeSerializer()
|
protected initializeSerializer(options: { urls?: string[] | RmqUrl[]; queue?: string; prefetchCount?: number; isGlobalPrefetchCount?: boolean; queueOptions?: any; socketOptions?: any; noAck?: boolean; serializer?: Serializer<any, any>; ... 5 more ...; maxConnectionAttempts?: number; })
Parameters
Option |
Type |
Description |
options
|
object |
|
|
|
protected mergeHeaders(requestHeaders?: Record<string, string>): Record<string, string> | undefined
Parameters
Option |
Type |
Description |
requestHeaders
|
Record |
Optional. Default is undefined .
|
Returns
Record<string, string> | undefined
|