Class Consumer

Used for setting up or ensuring required RabbitMQ internal structure and consuming messages.

Hierarchy

Consumer

Implements

RabbitMqPeer

Index

Constructors

constructor

Methods

Constructors

constructor

new Consumer(): Consumer

- Defined in models/consumer.ts:29
Returns Consumer

Methods

closeChannel

closeChannel(): Promise<void>

Implementation of RabbitMqPeer.closeChannel
- Defined in models/consumer.ts:209
Closes the active channel, this will throw a RabbitMqChannelClosedError in the consumer's stream

Returns Promise<void>

commitMessage

commitMessage(amqpMessage: Message): void

- Defined in models/consumer.ts:245
Commits a message (ack command of amqp)

Parameters
- amqpMessage: Message
  
  amqplib's message object
Returns void

getActiveChannel

getActiveChannel(): Channel

Implementation of RabbitMqPeer.getActiveChannel
- Defined in models/consumer.ts:216
Returns a channel object of amqplib

Returns Channel

getActiveConfigs

getActiveConfigs(): ConsumerConfigs

- Defined in models/consumer.ts:237
Returns current consumer's configs. Returns null if consumer was setup with custom setup function

Returns ConsumerConfigs

getActiveConnection

getActiveConnection(): Connection

Implementation of RabbitMqPeer.getActiveConnection
- Defined in models/consumer.ts:223
Return a connection object of amqplib

Returns Connection

init

init(connection: RabbitMqConnection): Promise<void>

- Defined in models/consumer.ts:143
Initializes the consumer, sets up internal RabbitMQ structure according to configs or runs custom setup function, if provided

Parameters
- connection: RabbitMqConnection
  
  connection
Returns Promise<void>

reconnect

reconnect(): Observable<void>

Implementation of RabbitMqPeer.reconnect
- Defined in models/consumer.ts:184
Constantly attempts to reconnect to RabbitMQ either default or given amount of times with some default or given timeout

Returns Observable<void>

rejectMessage

rejectMessage(message: Message, allUpToCurrent?: boolean, requeue?: boolean): void

- Defined in models/consumer.ts:255
Rejects a message (nack command of amqp)

Parameters
- message: Message
  
  amqplib's message object
- Default value allUpToCurrent: boolean = false
  
  set true if there is a need to reject all messages up to current, default is false
- Default value requeue: boolean = false
  
  set true if there is a need to put this message back in to the queue, default is false
Returns void

setConfigs

setConfigs(configs: ConsumerConfigs): void

- Defined in models/consumer.ts:124
Sets consumer's configs

Parameters
- configs: ConsumerConfigs
  
  consumer's configs
Returns void

setCustomSetupFunction

setCustomSetupFunction(setupFunction: RabbitMqConsumerSetupFunction): void

- Defined in models/consumer.ts:133
Sets custom setup function

Parameters
- setupFunction: RabbitMqConsumerSetupFunction
  
  custom setup function
Returns void

startConsuming

startConsuming(): ReplaySubject<Message>

- Defined in models/consumer.ts:230
Returns an instance of ReplaySubject, to which it is possible to subscribe to listen to messages and any other RabbitMQ activity

Returns ReplaySubject<Message>

Generated using TypeDoc