Class Producer

Hierarchy

Producer

Implements

QueueProducer

Index

Constructors

constructor

Methods

Constructors

constructor

new Producer(kernel: Kernel, pool: Pool, session: string): Producer

- Defined in lib/producer.ts:96
Parameters
- kernel: Kernel
- pool: Pool
- session: string
Returns Producer

Methods

deleteJob

deleteJob(context: LogContext, key: string): Promise<void>

Implementation of QueueProducer.deleteJob
- Defined in lib/producer.ts:401
summary
Delete a job from the queue using its job key

Parameters
- context: LogContext
  
  execution context
- key: string
  
  job key to delete
Returns Promise<void>

enqueue

enqueue(actor: string, session: string, options: ProducerOptions): Promise<ActionRequestContract>

Implementation of QueueProducer.enqueue
- Defined in lib/producer.ts:273
summary
Enqueue a request

function
Parameters
- actor: string
  
  actor
- session: string
  
  session
- options: ProducerOptions
  
  options
Returns Promise<ActionRequestContract>
action request

getLastExecutionEvent

getLastExecutionEvent(logContext: LogContext, originator: string): Promise<null | ExecuteContract>

Implementation of QueueProducer.getLastExecutionEvent
- Defined in lib/producer.ts:384
summary
Get the last execution event given an originator

function
Parameters
- logContext: LogContext
  
  log context
- originator: string
  
  originator card id
Returns Promise<null | ExecuteContract>
last execution event

initialize

initialize(logContext: LogContext): Promise<void>

Implementation of QueueProducer.initialize
- Defined in lib/producer.ts:109
summary
Initialize the queue producer

function
Parameters
- logContext: LogContext
  
  log context
Returns Promise<void>

makeWorkerUtils

makeWorkerUtils(logContext: LogContext, retries?: number): Promise<WorkerUtils>

- Defined in lib/producer.ts:136
summary
Make and return Graphile worker utils instance

function
example
```
const workerUtils = await this.makeWorkerUtils(context);
```
Parameters
- logContext: LogContext
  
  log context
- retries: number = GRAPHILE_RETRIES
  
  number of times to retry Graphile worker initialization
Returns Promise<WorkerUtils>
Graphile worker utils instance

storeRequest

storeRequest(actor: string, session: string, options: ProducerOptions): Promise<ActionRequestContract>

Implementation of QueueProducer.storeRequest
- Defined in lib/producer.ts:165
Parameters
- actor: string
- session: string
- options: ProducerOptions
Returns Promise<ActionRequestContract>

waitResults

waitResults(logContext: LogContext, actionRequest: ActionRequestContract): Promise<ProducerResults>

Implementation of QueueProducer.waitResults
- Defined in lib/producer.ts:318
summary
Wait for an action request results

function
Parameters
- logContext: LogContext
  
  log context
- actionRequest: ActionRequestContract
  
  action request
Returns Promise<ProducerResults>
results

Generated using TypeDoc