Type alias MsgVpnQueue

MsgVpnQueue: {
    accessType?: MsgVpnQueue.accessType;
    consumerAckPropagationEnabled?: boolean;
    deadMsgQueue?: string;
    deliveryCountEnabled?: boolean;
    deliveryDelay?: number;
    egressEnabled?: boolean;
    eventBindCountThreshold?: EventThreshold;
    eventMsgSpoolUsageThreshold?: EventThreshold;
    eventRejectLowPriorityMsgLimitThreshold?: EventThreshold;
    ingressEnabled?: boolean;
    maxBindCount?: number;
    maxDeliveredUnackedMsgsPerFlow?: number;
    maxMsgSize?: number;
    maxMsgSpoolUsage?: number;
    maxRedeliveryCount?: number;
    maxTtl?: number;
    msgVpnName?: string;
    owner?: string;
    permission?: MsgVpnQueue.permission;
    queueName?: string;
    redeliveryEnabled?: boolean;
    rejectLowPriorityMsgEnabled?: boolean;
    rejectLowPriorityMsgLimit?: number;
    rejectMsgToSenderOnDiscardBehavior?: MsgVpnQueue.rejectMsgToSenderOnDiscardBehavior;
    respectMsgPriorityEnabled?: boolean;
    respectTtlEnabled?: boolean;
}

Type declaration

  • Optional accessType?: MsgVpnQueue.accessType

    The access type for delivering messages to consumer flows bound to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "exclusive". The allowed values and their meaning are:

    "exclusive" - Exclusive delivery of messages to the first bound consumer flow.
"non-exclusive" - Non-exclusive delivery of messages to all bound consumer flows in a round-robin fashion.
  • Optional consumerAckPropagationEnabled?: boolean

    Enable or disable the propagation of consumer acknowledgements (ACKs) received on the active replication Message VPN to the standby replication Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true.

  • Optional deadMsgQueue?: string

    The name of the Dead Message Queue (DMQ) used by the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "#DEAD_MSG_QUEUE". Available since 2.2.

  • Optional deliveryCountEnabled?: boolean

    Enable or disable the ability for client applications to query the message delivery count of messages received from the Queue. This is a controlled availability feature. Please contact support to find out if this feature is supported for your use case. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.19.

  • Optional deliveryDelay?: number

    The delay, in seconds, to apply to messages arriving on the Queue before the messages are eligible for delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0. Available since 2.22.

  • Optional egressEnabled?: boolean

    Enable or disable the transmission of messages from the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional eventBindCountThreshold?: EventThreshold
  • Optional eventMsgSpoolUsageThreshold?: EventThreshold
  • Optional eventRejectLowPriorityMsgLimitThreshold?: EventThreshold
  • Optional ingressEnabled?: boolean

    Enable or disable the reception of messages to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional maxBindCount?: number

    The maximum number of consumer flows that can bind to the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 1000.

  • Optional maxDeliveredUnackedMsgsPerFlow?: number

    The maximum number of messages delivered but not acknowledged per flow for the Queue. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 10000.

  • Optional maxMsgSize?: number

    The maximum message size allowed in the Queue, in bytes (B). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 10000000.

  • Optional maxMsgSpoolUsage?: number

    The maximum message spool usage allowed by the Queue, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 5000.

  • Optional maxRedeliveryCount?: number

    The maximum number of times the Queue will attempt redelivery of a message prior to it being discarded or moved to the DMQ. A value of 0 means to retry forever. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

  • Optional maxTtl?: number

    The maximum time in seconds a message can stay in the Queue when respectTtlEnabled is "true". A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the maxTtl configured for the Queue, is exceeded. A value of 0 disables expiry. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

  • Optional msgVpnName?: string

    The name of the Message VPN.

  • Optional owner?: string

    The Client Username that owns the Queue and has permission equivalent to "delete". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

  • Optional permission?: MsgVpnQueue.permission

    The permission level for all consumers of the Queue, excluding the owner. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "no-access". The allowed values and their meaning are:

    "no-access" - Disallows all access.
"read-only" - Read-only access to the messages.
"consume" - Consume (read and remove) messages.
"modify-topic" - Consume messages or modify the topic/selector.
"delete" - Consume messages, modify the topic/selector or delete the Client created endpoint altogether.
  • Optional queueName?: string

    The name of the Queue.

  • Optional redeliveryEnabled?: boolean

    Enable or disable message redelivery. When enabled, the number of redelivery attempts is controlled by maxRedeliveryCount. When disabled, the message will never be delivered from the queue more than once. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is true. Available since 2.18.

  • Optional rejectLowPriorityMsgEnabled?: boolean

    Enable or disable the checking of low priority messages against the rejectLowPriorityMsgLimit. This may only be enabled if rejectMsgToSenderOnDiscardBehavior does not have a value of "never". Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional rejectLowPriorityMsgLimit?: number

    The number of messages of any priority in the Queue above which low priority messages are not admitted but higher priority messages are allowed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 0.

  • Optional rejectMsgToSenderOnDiscardBehavior?: MsgVpnQueue.rejectMsgToSenderOnDiscardBehavior

    Determines when to return negative acknowledgements (NACKs) to sending clients on message discards. Note that NACKs cause the message to not be delivered to any destination and Transacted Session commits to fail. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "when-queue-enabled". The allowed values and their meaning are:

    "always" - Always return a negative acknowledgment (NACK) to the sending client on message discard.
"when-queue-enabled" - Only return a negative acknowledgment (NACK) to the sending client on message discard when the Queue is enabled.
"never" - Never return a negative acknowledgment (NACK) to the sending client on message discard.

    Available since 2.1.

  • Optional respectMsgPriorityEnabled?: boolean

    Enable or disable the respecting of message priority. When enabled, messages contained in the Queue are delivered in priority order, from 9 (highest) to 0 (lowest). MQTT queues do not support enabling message priority. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false. Available since 2.8.

  • Optional respectTtlEnabled?: boolean

    Enable or disable the respecting of the time-to-live (TTL) for messages in the Queue. When enabled, expired messages are discarded or moved to the DMQ. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

Settings

Member Visibility

Theme