IMQOptions interface

cleanup

boolean

Turns on/off cleanup of the message queues

{boolean}

cleanupFilter

string

Defines cleanup pattern for the name of the queue which should be removed during cleanup processing

{string}

cluster?

[]

(Optional) Queue cluster instances, if MQ should be clustered

{{host: string, port: number }[]}

host?

string

(Optional) Message queue network host

{string}

logger?

ILogger

(Optional) Logger defined to be used within message queue in runtime

{ILogger}

port?

number

(Optional) Message queue network port

{number}

prefix?

string

(Optional) Message queue global key prefix (namespace)

{string}

safeDelivery?

boolean

(Optional) Enables/disables safe message delivery. When safe message delivery is turned on it will use more complex algorithm for message handling by a worker process, guaranteeing that if worker fails the message will be delivered to another possible worker anyway. In most cases it is not required unless it is required by a system design.

{boolean}

safeDeliveryTtl?

number

(Optional) Time-to-live of worker queues (after this time messages are back to main queue for handling if worker died). Only works if safeDelivery option enabled.

{number}

useGzip?

boolean

(Optional) A way to serialize message using compression. Will increase load to worker process but can decrease network traffic between worker and queue host application

{boolean}

vendor?

string

(Optional) Message queue vendor

{string}

watcherCheckDelay?

number

(Optional) Watcher check delay period. This is used by a queue watcher agent to make sure at least one watcher is available for queue operations.

{number}