RabbitMQClient | @vertx/rabbitmq-client

Hierarchy

RabbitMQClient

Methods

addConfirmListener

addConfirmListener(maxQueueSize: number): PromiseLike<ReadStream<RabbitMQConfirmation>>
addConfirmListener(maxQueueSize: number, resultHandler: ((res: AsyncResult<ReadStream<RabbitMQConfirmation>>) => void) | Handler<AsyncResult<ReadStream<RabbitMQConfirmation>>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:105
Add a Confirm Listener to the channel. Note that this will automatically call confirmSelect, it is not necessary to call that too.

Parameters
- maxQueueSize: number
Returns PromiseLike<ReadStream<RabbitMQConfirmation>>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:111
Add a Confirm Listener to the channel. Note that this will automatically call confirmSelect, it is not necessary to call that too.

Parameters
- maxQueueSize: number
- resultHandler: ((res: AsyncResult<ReadStream<RabbitMQConfirmation>>) => void) | Handler<AsyncResult<ReadStream<RabbitMQConfirmation>>>
Returns void

basicAck

basicAck(deliveryTag: number, multiple: boolean): PromiseLike<void>
basicAck(deliveryTag: number, multiple: boolean, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:43
Acknowledge one or several received messages. Supply the deliveryTag from the AMQP.Basic.GetOk or AMQP.Basic.Deliver method containing the received message being acknowledged.

Parameters
- deliveryTag: number
- multiple: boolean
Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:49
Acknowledge one or several received messages. Supply the deliveryTag from the AMQP.Basic.GetOk or AMQP.Basic.Deliver method containing the received message being acknowledged.

Parameters
- deliveryTag: number
- multiple: boolean
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

basicConsumer

basicConsumer(queue: string): PromiseLike<RabbitMQConsumer>
basicConsumer(queue: string, resultHandler: ((res: AsyncResult<RabbitMQConsumer>) => void) | Handler<AsyncResult<RabbitMQConsumer>>): void
basicConsumer(queue: string, options: QueueOptions): PromiseLike<RabbitMQConsumer>
basicConsumer(queue: string, options: QueueOptions, resultHandler: ((res: AsyncResult<RabbitMQConsumer>) => void) | Handler<AsyncResult<RabbitMQConsumer>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:73
Parameters
- queue: string
Returns PromiseLike<RabbitMQConsumer>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:77
Parameters
- queue: string
- resultHandler: ((res: AsyncResult<RabbitMQConsumer>) => void) | Handler<AsyncResult<RabbitMQConsumer>>
Returns void
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:82
Create a consumer with the given options.

Parameters
- queue: string
- options: QueueOptions
Returns PromiseLike<RabbitMQConsumer>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:87
Create a consumer with the given options.

Parameters
- queue: string
- options: QueueOptions
- resultHandler: ((res: AsyncResult<RabbitMQConsumer>) => void) | Handler<AsyncResult<RabbitMQConsumer>>
Returns void

basicGet

basicGet(queue: string, autoAck: boolean): PromiseLike<RabbitMQMessage>
basicGet(queue: string, autoAck: boolean, resultHandler: ((res: AsyncResult<RabbitMQMessage>) => void) | Handler<AsyncResult<RabbitMQMessage>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:64
Retrieve a message from a queue using AMQP.Basic.Get

Parameters
- queue: string
- autoAck: boolean
Returns PromiseLike<RabbitMQMessage>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:69
Retrieve a message from a queue using AMQP.Basic.Get

Parameters
- queue: string
- autoAck: boolean
- resultHandler: ((res: AsyncResult<RabbitMQMessage>) => void) | Handler<AsyncResult<RabbitMQMessage>>
Returns void

basicNack

basicNack(deliveryTag: number, multiple: boolean, requeue: boolean): PromiseLike<void>
basicNack(deliveryTag: number, multiple: boolean, requeue: boolean, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:54
Reject one or several received messages.

Parameters
- deliveryTag: number
- multiple: boolean
- requeue: boolean
Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:59
Reject one or several received messages.

Parameters
- deliveryTag: number
- multiple: boolean
- requeue: boolean
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

basicPublish

basicPublish(exchange: string, routingKey: string, body: Buffer): PromiseLike<void>
basicPublish(exchange: string, routingKey: string, body: Buffer, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void
basicPublish(exchange: string, routingKey: string, properties: any, body: Buffer): PromiseLike<void>
basicPublish(exchange: string, routingKey: string, properties: any, body: Buffer, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:93
Publish a message. Publishing to a non-existent exchange will result in a channel-level protocol exception, which closes the channel. Invocations of Channel#basicPublish will eventually block if a resource-driven alarm is in effect.

Parameters
- exchange: string
- routingKey: string
- body: Buffer
Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:99
Publish a message. Publishing to a non-existent exchange will result in a channel-level protocol exception, which closes the channel. Invocations of Channel#basicPublish will eventually block if a resource-driven alarm is in effect.

Parameters
- exchange: string
- routingKey: string
- body: Buffer
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:365
Publish a message. Publishing to a non-existent exchange will result in a channel-level protocol exception, which closes the channel. Invocations of Channel#basicPublish will eventually block if a resource-driven alarm is in effect.

Parameters
- exchange: string
- routingKey: string
- properties: any
- body: Buffer
Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:371
Publish a message. Publishing to a non-existent exchange will result in a channel-level protocol exception, which closes the channel. Invocations of Channel#basicPublish will eventually block if a resource-driven alarm is in effect.

Parameters
- exchange: string
- routingKey: string
- properties: any
- body: Buffer
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

basicPublishWithDeliveryTag

basicPublishWithDeliveryTag(exchange: string, routingKey: string, properties: any, body: Buffer, deliveryTagHandler: ((res: number) => void) | Handler<number> | null | undefined): PromiseLike<void>
basicPublishWithDeliveryTag(exchange: string, routingKey: string, properties: any, body: Buffer, deliveryTagHandler: ((res: number) => void) | Handler<number> | null | undefined, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:380
Publish a message. Publishing to a non-existent exchange will result in a channel-level protocol exception, which closes the channel. Invocations of Channel#basicPublish will eventually block if a resource-driven alarm is in effect.

The deliveryTagHandler will be called before the message is sent, which is necessary because the confirmation may arrive asynchronously before the resultHandler is called.

Parameters
- exchange: string
- routingKey: string
- properties: any
- body: Buffer
- deliveryTagHandler: ((res: number) => void) | Handler<number> | null | undefined
Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:389
Publish a message. Publishing to a non-existent exchange will result in a channel-level protocol exception, which closes the channel. Invocations of Channel#basicPublish will eventually block if a resource-driven alarm is in effect.

The deliveryTagHandler will be called before the message is sent, which is necessary because the confirmation may arrive asynchronously before the resultHandler is called.

Parameters
- exchange: string
- routingKey: string
- properties: any
- body: Buffer
- deliveryTagHandler: ((res: number) => void) | Handler<number> | null | undefined
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

basicQos

basicQos(prefetchCount: number): PromiseLike<void>
basicQos(prefetchCount: number, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void
basicQos(prefetchCount: number, global: boolean): PromiseLike<void>
basicQos(prefetchCount: number, global: boolean, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void
basicQos(prefetchSize: number, prefetchCount: number, global: boolean): PromiseLike<void>
basicQos(prefetchSize: number, prefetchCount: number, global: boolean, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:153
Request a specific prefetchCount "quality of service" settings for this channel.

Parameters
- prefetchCount: number
Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:159
Request a specific prefetchCount "quality of service" settings for this channel.

Parameters
- prefetchCount: number
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:165
Request a specific prefetchCount "quality of service" settings for this channel.

Parameters
- prefetchCount: number
- global: boolean
Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:171
Request a specific prefetchCount "quality of service" settings for this channel.

Parameters
- prefetchCount: number
- global: boolean
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:180
Request specific "quality of service" settings.

These settings impose limits on the amount of data the server will deliver to consumers before requiring acknowledgements. Thus they provide a means of consumer-initiated flow control.

Parameters
- prefetchSize: number
- prefetchCount: number
- global: boolean
Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:189
Request specific "quality of service" settings.

These settings impose limits on the amount of data the server will deliver to consumers before requiring acknowledgements. Thus they provide a means of consumer-initiated flow control.

Parameters
- prefetchSize: number
- prefetchCount: number
- global: boolean
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

confirmSelect

confirmSelect(): PromiseLike<void>
confirmSelect(resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:117
Enables publisher acknowledgements on this channel. Can be called once during client initialisation. Calls to basicPublish() will have to be confirmed.

Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:123
Enables publisher acknowledgements on this channel. Can be called once during client initialisation. Calls to basicPublish() will have to be confirmed.

Parameters
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

exchangeBind

exchangeBind(destination: string, source: string, routingKey: string): PromiseLike<void>
exchangeBind(destination: string, source: string, routingKey: string, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void
exchangeBind(destination: string, source: string, routingKey: string, arguments: {}): PromiseLike<void>
exchangeBind(destination: string, source: string, routingKey: string, arguments: {}, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:224
Bind an exchange to an exchange.

Parameters
- destination: string
- source: string
- routingKey: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:229
Bind an exchange to an exchange.

Parameters
- destination: string
- source: string
- routingKey: string
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:234
Bind an exchange to an exchange.

Parameters
- destination: string
- source: string
- routingKey: string
- arguments: {}
  - [key: string]: any
Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:239
Bind an exchange to an exchange.

Parameters
- destination: string
- source: string
- routingKey: string
- arguments: {}
  - [key: string]: any
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

exchangeDeclare

exchangeDeclare(exchange: string, type: string, durable: boolean, autoDelete: boolean): PromiseLike<void>
exchangeDeclare(exchange: string, type: string, durable: boolean, autoDelete: boolean, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void
exchangeDeclare(exchange: string, type: string, durable: boolean, autoDelete: boolean, config: {}): PromiseLike<void>
exchangeDeclare(exchange: string, type: string, durable: boolean, autoDelete: boolean, config: {}, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:194
Declare an exchange.

Parameters
- exchange: string
- type: string
- durable: boolean
- autoDelete: boolean
Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:199
Declare an exchange.

Parameters
- exchange: string
- type: string
- durable: boolean
- autoDelete: boolean
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:204
Declare an exchange with additional parameters such as dead lettering, an alternate exchange or TTL.

Parameters
- exchange: string
- type: string
- durable: boolean
- autoDelete: boolean
- config: {}
  - [key: string]: any
Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:209
Declare an exchange with additional parameters such as dead lettering, an alternate exchange or TTL.

Parameters
- exchange: string
- type: string
- durable: boolean
- autoDelete: boolean
- config: {}
  - [key: string]: any
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

exchangeDelete

exchangeDelete(exchange: string): PromiseLike<void>
exchangeDelete(exchange: string, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:214
Delete an exchange, without regard for whether it is in use or not.

Parameters
- exchange: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:219
Delete an exchange, without regard for whether it is in use or not.

Parameters
- exchange: string
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

exchangeUnbind

exchangeUnbind(destination: string, source: string, routingKey: string): PromiseLike<void>
exchangeUnbind(destination: string, source: string, routingKey: string, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void
exchangeUnbind(destination: string, source: string, routingKey: string, arguments: {}): PromiseLike<void>
exchangeUnbind(destination: string, source: string, routingKey: string, arguments: {}, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:244
Unbind an exchange from an exchange.

Parameters
- destination: string
- source: string
- routingKey: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:249
Unbind an exchange from an exchange.

Parameters
- destination: string
- source: string
- routingKey: string
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:254
Unbind an exchange from an exchange.

Parameters
- destination: string
- source: string
- routingKey: string
- arguments: {}
  - [key: string]: any
Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:259
Unbind an exchange from an exchange.

Parameters
- destination: string
- source: string
- routingKey: string
- arguments: {}
  - [key: string]: any
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

isConnected

isConnected(): boolean

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:344
Check if a connection is open

Returns boolean

isOpenChannel

isOpenChannel(): boolean

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:359
Check if a channel is open

Returns boolean

messageCount

messageCount(queue: string): PromiseLike<number>
messageCount(queue: string, resultHandler: ((res: AsyncResult<number>) => void) | Handler<AsyncResult<number>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:314
Returns the number of messages in a queue ready to be delivered.

Parameters
- queue: string
Returns PromiseLike<number>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:319
Returns the number of messages in a queue ready to be delivered.

Parameters
- queue: string
- resultHandler: ((res: AsyncResult<number>) => void) | Handler<AsyncResult<number>>
Returns void

queueBind

queueBind(queue: string, exchange: string, routingKey: string): PromiseLike<void>
queueBind(queue: string, exchange: string, routingKey: string, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void
queueBind(queue: string, exchange: string, routingKey: string, arguments: {}): PromiseLike<void>
queueBind(queue: string, exchange: string, routingKey: string, arguments: {}, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:274
Bind a queue to an exchange

Parameters
- queue: string
- exchange: string
- routingKey: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:279
Bind a queue to an exchange

Parameters
- queue: string
- exchange: string
- routingKey: string
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:284
Bind a queue to an exchange

Parameters
- queue: string
- exchange: string
- routingKey: string
- arguments: {}
  - [key: string]: any
Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:289
Bind a queue to an exchange

Parameters
- queue: string
- exchange: string
- routingKey: string
- arguments: {}
  - [key: string]: any
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

queueDeclare

queueDeclare(queue: string, durable: boolean, exclusive: boolean, autoDelete: boolean): PromiseLike<any>
queueDeclare(queue: string, durable: boolean, exclusive: boolean, autoDelete: boolean, resultHandler: ((res: AsyncResult<any>) => void) | Handler<AsyncResult<any>>): void
queueDeclare(queue: string, durable: boolean, exclusive: boolean, autoDelete: boolean, config: {}): PromiseLike<any>
queueDeclare(queue: string, durable: boolean, exclusive: boolean, autoDelete: boolean, config: {}, resultHandler: ((res: AsyncResult<any>) => void) | Handler<AsyncResult<any>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:394
Declare a queue

Parameters
- queue: string
- durable: boolean
- exclusive: boolean
- autoDelete: boolean
Returns PromiseLike<any>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:399
Declare a queue

Parameters
- queue: string
- durable: boolean
- exclusive: boolean
- autoDelete: boolean
- resultHandler: ((res: AsyncResult<any>) => void) | Handler<AsyncResult<any>>
Returns void
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:404
Declare a queue with config options

Parameters
- queue: string
- durable: boolean
- exclusive: boolean
- autoDelete: boolean
- config: {}
  - [key: string]: any
Returns PromiseLike<any>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:409
Declare a queue with config options

Parameters
- queue: string
- durable: boolean
- exclusive: boolean
- autoDelete: boolean
- config: {}
  - [key: string]: any
- resultHandler: ((res: AsyncResult<any>) => void) | Handler<AsyncResult<any>>
Returns void

queueDeclareAuto

queueDeclareAuto(): PromiseLike<{}>
queueDeclareAuto(resultHandler: ((res: AsyncResult<{}>) => void) | Handler<AsyncResult<{}>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:264
Actively declare a server-named exclusive, autodelete, non-durable queue.

Returns PromiseLike<{}>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:269
Actively declare a server-named exclusive, autodelete, non-durable queue.

Parameters
- resultHandler: ((res: AsyncResult<{}>) => void) | Handler<AsyncResult<{}>>
Returns void

queueDelete

queueDelete(queue: string): PromiseLike<any>
queueDelete(queue: string, resultHandler: ((res: AsyncResult<any>) => void) | Handler<AsyncResult<any>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:414
Delete a queue, without regard for whether it is in use or has messages on it

Parameters
- queue: string
Returns PromiseLike<any>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:419
Delete a queue, without regard for whether it is in use or has messages on it

Parameters
- queue: string
- resultHandler: ((res: AsyncResult<any>) => void) | Handler<AsyncResult<any>>
Returns void

queueDeleteIf

queueDeleteIf(queue: string, ifUnused: boolean, ifEmpty: boolean): PromiseLike<any>
queueDeleteIf(queue: string, ifUnused: boolean, ifEmpty: boolean, resultHandler: ((res: AsyncResult<any>) => void) | Handler<AsyncResult<any>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:424
Delete a queue

Parameters
- queue: string
- ifUnused: boolean
- ifEmpty: boolean
Returns PromiseLike<any>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:429
Delete a queue

Parameters
- queue: string
- ifUnused: boolean
- ifEmpty: boolean
- resultHandler: ((res: AsyncResult<any>) => void) | Handler<AsyncResult<any>>
Returns void

queueUnbind

queueUnbind(queue: string, exchange: string, routingKey: string): PromiseLike<void>
queueUnbind(queue: string, exchange: string, routingKey: string, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void
queueUnbind(queue: string, exchange: string, routingKey: string, arguments: {}): PromiseLike<void>
queueUnbind(queue: string, exchange: string, routingKey: string, arguments: {}, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:294
Unbind a queue from an exchange

Parameters
- queue: string
- exchange: string
- routingKey: string
Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:299
Unbind a queue from an exchange

Parameters
- queue: string
- exchange: string
- routingKey: string
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:304
Unbind a queue from an exchange

Parameters
- queue: string
- exchange: string
- routingKey: string
- arguments: {}
  - [key: string]: any
Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:309
Unbind a queue from an exchange

Parameters
- queue: string
- exchange: string
- routingKey: string
- arguments: {}
  - [key: string]: any
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

restartConnect

restartConnect(attempts: number): PromiseLike<void>
restartConnect(attempts: number, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:349
restart the rabbitMQ connect.

Parameters
- attempts: number
Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:354
restart the rabbitMQ connect.

Parameters
- attempts: number
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

start

start(): PromiseLike<void>
start(resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:324
Start the rabbitMQ client. Create the connection and the channel.

Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:329
Start the rabbitMQ client. Create the connection and the channel.

Parameters
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

stop

stop(): PromiseLike<void>
stop(resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:334
Stop the rabbitMQ client. Close the connection and its channel.

Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:339
Stop the rabbitMQ client. Close the connection and its channel.

Parameters
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

waitForConfirms

waitForConfirms(): PromiseLike<void>
waitForConfirms(resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void
waitForConfirms(timeout: number): PromiseLike<void>
waitForConfirms(timeout: number, resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:130
Wait until all messages published since the last call have been either ack'd or nack'd by the broker. This will incur slight performance loss at the expense of higher write consistency. If desired, multiple calls to basicPublish() can be batched before confirming.

Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:137
Wait until all messages published since the last call have been either ack'd or nack'd by the broker. This will incur slight performance loss at the expense of higher write consistency. If desired, multiple calls to basicPublish() can be batched before confirming.

Parameters
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:142
Wait until all messages published since the last call have been either ack'd or nack'd by the broker; or until timeout elapses. If the timeout expires a TimeoutException is thrown.

Parameters
- timeout: number
Returns PromiseLike<void>
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:147
Wait until all messages published since the last call have been either ack'd or nack'd by the broker; or until timeout elapses. If the timeout expires a TimeoutException is thrown.

Parameters
- timeout: number
- resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

Static create

create(vertx: Vertx): RabbitMQClient
create(vertx: Vertx, config: RabbitMQOptions): RabbitMQClient

- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:32
Create and return a client configured with the default options.

Parameters
- vertx: Vertx
Returns RabbitMQClient
- Defined in io.vertx/vertx-rabbitmq-client/target/npm/index.d.ts:37
Create and return a client.

Parameters
- vertx: Vertx
- config: RabbitMQOptions
Returns RabbitMQClient

Hierarchy

Index

Methods

Methods

addConfirmListener

Parameters

maxQueueSize: number

Returns PromiseLike<ReadStream<RabbitMQConfirmation>>

Parameters

maxQueueSize: number

resultHandler: ((res: AsyncResult<ReadStream<RabbitMQConfirmation>>) => void) | Handler<AsyncResult<ReadStream<RabbitMQConfirmation>>>

Returns void

basicAck

Parameters

deliveryTag: number

multiple: boolean

Returns PromiseLike<void>

Parameters

deliveryTag: number

multiple: boolean

resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

basicConsumer

Parameters

queue: string

Returns PromiseLike<RabbitMQConsumer>

Parameters

queue: string

resultHandler: ((res: AsyncResult<RabbitMQConsumer>) => void) | Handler<AsyncResult<RabbitMQConsumer>>

Returns void

Parameters

queue: string

options: QueueOptions

Returns PromiseLike<RabbitMQConsumer>

Parameters

queue: string

options: QueueOptions

resultHandler: ((res: AsyncResult<RabbitMQConsumer>) => void) | Handler<AsyncResult<RabbitMQConsumer>>

Returns void

basicGet

Parameters

queue: string

autoAck: boolean

Returns PromiseLike<RabbitMQMessage>

Parameters

queue: string

autoAck: boolean

resultHandler: ((res: AsyncResult<RabbitMQMessage>) => void) | Handler<AsyncResult<RabbitMQMessage>>

Returns void

basicNack

Parameters

deliveryTag: number

multiple: boolean

requeue: boolean

Returns PromiseLike<void>

Parameters

deliveryTag: number

multiple: boolean

requeue: boolean

resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

basicPublish

Parameters

exchange: string

routingKey: string

body: Buffer

Returns PromiseLike<void>

Parameters

exchange: string

routingKey: string

body: Buffer

resultHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

Parameters

exchange: string

routingKey: string

properties: any

body: Buffer

Returns PromiseLike<void>

Parameters