MessageRetryHandler
Defined in: packages/messaging/src/queue/retry.handler.ts:75
Extends
Section titled “Extends”EventEmitter
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new MessageRetryHandler(
options):MessageRetryHandler
Defined in: packages/messaging/src/queue/retry.handler.ts:97
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”MessageRetryHandler
Overrides
Section titled “Overrides”EventEmitter.constructor
Methods
Section titled “Methods”addForRetry()
Section titled “addForRetry()”addForRetry(
deliveryReport):Promise<boolean>
Defined in: packages/messaging/src/queue/retry.handler.ts:146
Add a failed delivery for retry
Parameters
Section titled “Parameters”deliveryReport
Section titled “deliveryReport”Returns
Section titled “Returns”Promise<boolean>
addListener()
Section titled “addListener()”addListener(
eventName,listener):this
Defined in: packages/messaging/src/shared/event-emitter.ts:16
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.addListener
cancelRetry()
Section titled “cancelRetry()”cancelRetry(
messageId):boolean
Defined in: packages/messaging/src/queue/retry.handler.ts:186
Cancel retry for a specific message
Parameters
Section titled “Parameters”messageId
Section titled “messageId”string
Returns
Section titled “Returns”boolean
cleanup()
Section titled “cleanup()”cleanup():
number
Defined in: packages/messaging/src/queue/retry.handler.ts:223
Clean up terminal retry items
Returns
Section titled “Returns”number
emit()
Section titled “emit()”emit(
eventName, …args):boolean
Defined in: packages/messaging/src/shared/event-emitter.ts:44
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
…unknown[]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”EventEmitter.emit
getMetrics()
Section titled “getMetrics()”getMetrics():
RetryHandlerMetrics
Defined in: packages/messaging/src/queue/retry.handler.ts:216
Get metrics
Returns
Section titled “Returns”getRetryQueue()
Section titled “getRetryQueue()”getRetryQueue():
RetryQueueItem[]
Defined in: packages/messaging/src/queue/retry.handler.ts:209
Get all retry queue items
Returns
Section titled “Returns”getRetryStatus()
Section titled “getRetryStatus()”getRetryStatus(
messageId):RetryQueueItem|undefined
Defined in: packages/messaging/src/queue/retry.handler.ts:202
Get retry status for a message
Parameters
Section titled “Parameters”messageId
Section titled “messageId”string
Returns
Section titled “Returns”RetryQueueItem | undefined
off(
eventName,listener):this
Defined in: packages/messaging/src/shared/event-emitter.ts:20
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.off
on(
eventName,listener):this
Defined in: packages/messaging/src/shared/event-emitter.ts:9
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.on
once()
Section titled “once()”once(
eventName,listener):this
Defined in: packages/messaging/src/shared/event-emitter.ts:35
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.once
removeAllListeners()
Section titled “removeAllListeners()”removeAllListeners(
eventName?):this
Defined in: packages/messaging/src/shared/event-emitter.ts:57
Parameters
Section titled “Parameters”eventName?
Section titled “eventName?”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeAllListeners
removeListener()
Section titled “removeListener()”removeListener(
eventName,listener):this
Defined in: packages/messaging/src/shared/event-emitter.ts:31
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeListener
start()
Section titled “start()”start():
void
Defined in: packages/messaging/src/queue/retry.handler.ts:115
Start the retry handler
Returns
Section titled “Returns”void
stop()
Section titled “stop()”stop():
Promise<void>
Defined in: packages/messaging/src/queue/retry.handler.ts:128
Stop the retry handler
Returns
Section titled “Returns”Promise<void>