AmqpBroker | celery-ts

AmqpBroker implements MessageBroker using the RabbitMQ message broker. Messages are, by default, durable, and will survive a broker restart.

Hierarchy

AmqpBroker

Implements

MessageBroker

Index

Constructors

constructor

Methods

Constructors

constructor

new AmqpBroker(options?: AmqpOptions): AmqpBroker

- Defined in amqp/broker.ts:48
Constructs an AmqpBroker with the given options.

Parameters
- Optional options: AmqpOptions
  
  The configuration of the connection to make. If undefined, will connect to RabbitMQ at localhost:6379.
Returns AmqpBroker

An AmqpBroker connected using the specified configuration.

Methods

disconnect

disconnect(): Promise<void>

Implementation of MessageBroker.disconnect
- Defined in amqp/broker.ts:91
Disconnects from the RabbitMQ node. Only call once. Alias for #end().

see

#end

Returns Promise<void>

A Promise that resolves once the connection is closed.

end

end(): Promise<void>

Implementation of MessageBroker.end
- Defined in amqp/broker.ts:100
Disconnects from the RabbitMQ node. Only call once.

Returns Promise<void>

A Promise that resolves once the connection is closed.

publish

publish(message: TaskMessage): Promise<string>

Implementation of MessageBroker.publish
- Defined in amqp/broker.ts:114
Queues a message onto the requested exchange.

Parameters
- message: TaskMessage
  
  The message to be published. Used to determine the publishing options.
Returns Promise<string>

A Promise that resolves to "flushed to write buffer".

Generated using TypeDoc