콘텐츠로 이동

MessageJobProcessor

Defined in: packages/messaging/src/queue/job.processor.ts:350

Specific processor for message jobs

new MessageJobProcessor(provider, options?, jobQueue?): MessageJobProcessor

Defined in: packages/messaging/src/queue/job.processor.ts:351

Provider

Partial<JobProcessorOptions> = {}

JobQueue<any>

MessageJobProcessor

JobProcessor.constructor

add<T>(jobType, data, options?): Promise<string>

Defined in: packages/messaging/src/queue/job.processor.ts:107

Add a job to the queue

T

string

T

number

number

Record<string, any>

number

Promise<string>

JobProcessor.add


addListener(eventName, listener): this

Defined in: packages/messaging/src/shared/event-emitter.ts:16

string

Listener

this

JobProcessor.addListener


cleanup(): Promise<number>

Defined in: packages/messaging/src/queue/job.processor.ts:191

Remove completed jobs from queue

Promise<number>

JobProcessor.cleanup


emit(eventName, …args): boolean

Defined in: packages/messaging/src/shared/event-emitter.ts:44

string

unknown[]

boolean

JobProcessor.emit


getJob(jobId): Promise<Job<any> | undefined>

Defined in: packages/messaging/src/queue/job.processor.ts:202

Get specific job by ID

string

Promise<Job<any> | undefined>

JobProcessor.getJob


getMetrics(): JobProcessorMetrics

Defined in: packages/messaging/src/queue/job.processor.ts:165

Get current metrics

JobProcessorMetrics

JobProcessor.getMetrics


getQueueStatus(): Promise<{ failed: number; pending: number; processing: number; totalProcessed: number; }>

Defined in: packages/messaging/src/queue/job.processor.ts:172

Get queue status

Promise<{ failed: number; pending: number; processing: number; totalProcessed: number; }>

JobProcessor.getQueueStatus


handle<T>(jobType, handler): void

Defined in: packages/messaging/src/queue/job.processor.ts:100

Register a job handler

T

string

JobHandler<T>

void

JobProcessor.handle


off(eventName, listener): this

Defined in: packages/messaging/src/shared/event-emitter.ts:20

string

Listener

this

JobProcessor.off


on(eventName, listener): this

Defined in: packages/messaging/src/shared/event-emitter.ts:9

string

Listener

this

JobProcessor.on


once(eventName, listener): this

Defined in: packages/messaging/src/shared/event-emitter.ts:35

string

Listener

this

JobProcessor.once


queueBulkMessages(messageRequests, options?): Promise<string>

Defined in: packages/messaging/src/queue/job.processor.ts:589

Add bulk messages to the processing queue

MessageRequest[]

number

Record<string, any>

number

Promise<string>


queueMessage(messageRequest, options?): Promise<string>

Defined in: packages/messaging/src/queue/job.processor.ts:561

Add a message to the processing queue

MessageRequest

number

Record<string, any>

number

Promise<string>


removeAllListeners(eventName?): this

Defined in: packages/messaging/src/shared/event-emitter.ts:57

string

this

JobProcessor.removeAllListeners


removeJob(jobId): Promise<boolean>

Defined in: packages/messaging/src/queue/job.processor.ts:209

Remove job from queue

string

Promise<boolean>

JobProcessor.removeJob


removeListener(eventName, listener): this

Defined in: packages/messaging/src/shared/event-emitter.ts:31

string

Listener

this

JobProcessor.removeListener


scheduleMessage(messageRequest, scheduledAt, options?): Promise<string>

Defined in: packages/messaging/src/queue/job.processor.ts:607

Schedule a message for future delivery

MessageRequest

Date

Record<string, any>

Promise<string>


start(): void

Defined in: packages/messaging/src/queue/job.processor.ts:133

Start processing jobs

void

JobProcessor.start


stop(): Promise<void>

Defined in: packages/messaging/src/queue/job.processor.ts:146

Stop processing jobs

Promise<void>

JobProcessor.stop