RpcBackend | celery-ts

RabbitMQ result backend using RPC and one queue per client.

Hierarchy

RpcBackend

Implements

ResultBackend

Index

Constructors

constructor

Methods

Constructors

constructor

new RpcBackend(routingKey: string, options?: AmqpOptions): RpcBackend

- Defined in amqp/backend.ts:55
Constructs an RpcBackend with the given routing key and options. Queues up connection, creation, queue assertion, and consumer handling.

Parameters
- routingKey: string
  
  The name of the queue to consume from.
- Optional options: AmqpOptions
  
  Connection options for the RabbitMQ connections. If undefined, will connect to localhost:6379.
Returns RpcBackend

Methods

delete

delete(taskId: string): Promise<string>

Implementation of ResultBackend.delete
- Defined in amqp/backend.ts:134
Parameters
- taskId: string
  
  The UUID of the task whose result is to be deleted.
Returns Promise<string>

"deleted" | "no result found".

disconnect

disconnect(): Promise<void>

Implementation of ResultBackend.disconnect
- Defined in amqp/backend.ts:150
Gently closes all channels and the connection with RabbitMQ. Alias for #end.

see

#end

Returns Promise<void>

A Promise that resolves when the disconnection is complete.

end

end(): Promise<void>

Implementation of ResultBackend.end
- Defined in amqp/backend.ts:159
Gently closes all channels and the connection with RabbitMQ.

Returns Promise<void>

A Promise that resolves when the disconnection is complete.

get

get<T>(__namedParameters: object): Promise<ResultMessage<T>>

- Defined in amqp/backend.ts:120
Uses Utility.createTimeoutPromise.

Type parameters
- T
Parameters
- __namedParameters: object
Returns Promise<ResultMessage<T>>

The result as fetched from RabbitMQ.

put

put<T>(message: ResultMessage<T>): Promise<string>

Implementation of ResultBackend.put
- Defined in amqp/backend.ts:101
Type parameters
- T
Parameters
- message: ResultMessage<T>
  
  The message to queue.
Returns Promise<string>

The response from RabbitMQ.

uri

uri(): never

Implementation of ResultBackend.uri
- Defined in amqp/backend.ts:180
TODO: Actually return the connected RabbitMQ node's URI.

throws

UnimplementedError Always.

Returns never

Nothing.

Generated using TypeDoc