Skip to main content

MemoryQueueParameters

@webda/core

Class: MemoryQueueParameters

Defined in: packages/core/src/queues/memoryqueue.service.ts:10

Parameters for the in-memory FIFO queue, including message expiration and receive timeout

Extends​

Constructors​

Constructor​

new MemoryQueueParameters(): MemoryQueueParameters

Returns​

MemoryQueueParameters

Inherited from​

QueueParameters.constructor

Properties​

expire?​

optional expire?: number

Defined in: packages/core/src/queues/memoryqueue.service.ts:16

Number of seconds before droping message

Default​

30

maxConsumers​

maxConsumers: number = 10

Defined in: packages/core/src/queues/queueservice.ts:45

Max number of queue consumers Queue will auto increase to this max number if queue is loaded and it will decrease to just one consumer if no messages are available

Default​

10

Inherited from​

QueueParameters.maxConsumers

timeout?​

optional timeout?: number

Defined in: packages/core/src/queues/memoryqueue.service.ts:20

Number of seconds to wait for receiving new message

type​

type: string

Defined in: packages/core/src/services/serviceparameters.ts:10

Type of the service

Inherited from​

QueueParameters.type

workerDelayer?​

optional workerDelayer?: WaitDelayerDefinition

Defined in: packages/core/src/queues/queueservice.ts:32

Delayer between two failed attempts to process messages

Inherited from​

QueueParameters.workerDelayer

workerParallelism​

workerParallelism: boolean = true

Defined in: packages/core/src/queues/queueservice.ts:37

Define if worker should process multi message received in //

Default​

true

Inherited from​

QueueParameters.workerParallelism

Accessors​

expireMs​

Get Signature​

get expireMs(): number

Defined in: packages/core/src/queues/memoryqueue.service.ts:37

Get the expiration delay in milliseconds

Returns​

number

the result number

timeoutMs​

Get Signature​

get timeoutMs(): number

Defined in: packages/core/src/queues/memoryqueue.service.ts:45

Get the receive timeout in milliseconds

Returns​

number

the result number

Methods​

load()​

load(params?): this

Defined in: packages/core/src/queues/memoryqueue.service.ts:27

Load parameters with defaults for expiration and timeout

Parameters​

params?​

any = {}

the service parameters

Returns​

this

this for chaining

Overrides​

QueueParameters.load

update()​

update(params?, delta): this

Defined in: packages/core/src/services/serviceparameters.ts:35

Update parameters and call watchers if a parameter was changed

Parameters​

params?​

any = {}

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

QueueParameters.update

with()​

with(callback): this

Defined in: packages/core/src/services/serviceparameters.ts:65

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

QueueParameters.with