Documentation
    Preparing search index...

    Interface IMQOptions

    Message queue options

    interface IMQOptions {
        cleanup: boolean;
        cleanupFilter: string;
        cluster?: IMessageQueueConnection[];
        clusterManagers?: ClusterManager[];
        host?: string;
        id?: string;
        logger?: ILogger;
        password?: string;
        port?: number;
        prefix?: string;
        safeDelivery?: boolean;
        safeDeliveryTtl?: number;
        useGzip?: boolean;
        username?: string;
        vendor?: string;
        watcherCheckDelay?: number;
    }

    Hierarchy

    Index

    Properties

    cleanup cleanupFilter cluster? clusterManagers? host? id? logger? password? port? prefix? safeDelivery? safeDeliveryTtl? useGzip? username? vendor? watcherCheckDelay?

    Properties

    cleanup: boolean

    Turns on/off cleanup of the message queues

    cleanupFilter: string

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

    cluster?: IMessageQueueConnection[]

    Queue cluster instances, if MQ should be clustered

    clusterManagers?: ClusterManager[]

    Array of cluster managers used to handle cluster operations. Any manager implements specific cluster server detection.

    host?: string

    Message queue network host

    id?: string

    Message queue network unique identifier, optional property

    logger?: ILogger

    Logger defined to be used within message queue in runtime

    password?: string

    Message queue password

    port?: number

    Message queue network port

    prefix?: string

    Message queue global key prefix (namespace)

    safeDelivery?: boolean

    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.

    safeDeliveryTtl?: number

    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.

    useGzip?: boolean

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

    username?: string

    Message queue username

    vendor?: string

    Message queue vendor

    watcherCheckDelay?: number

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

    Settings

    Member Visibility

    On This Page

    Properties