Type alias MsgVpnMqttSession

MsgVpnMqttSession: {
    enabled?: boolean;
    mqttSessionClientId?: string;
    mqttSessionVirtualRouter?: MsgVpnMqttSession.mqttSessionVirtualRouter;
    msgVpnName?: string;
    owner?: string;
    queueConsumerAckPropagationEnabled?: boolean;
    queueDeadMsgQueue?: string;
    queueEventBindCountThreshold?: EventThreshold;
    queueEventMsgSpoolUsageThreshold?: EventThreshold;
    queueEventRejectLowPriorityMsgLimitThreshold?: EventThreshold;
    queueMaxBindCount?: number;
    queueMaxDeliveredUnackedMsgsPerFlow?: number;
    queueMaxMsgSize?: number;
    queueMaxMsgSpoolUsage?: number;
    queueMaxRedeliveryCount?: number;
    queueMaxTtl?: number;
    queueRejectLowPriorityMsgEnabled?: boolean;
    queueRejectLowPriorityMsgLimit?: number;
    queueRejectMsgToSenderOnDiscardBehavior?: MsgVpnMqttSession.queueRejectMsgToSenderOnDiscardBehavior;
    queueRespectTtlEnabled?: boolean;
}

Type declaration

  • Optional enabled?: boolean

    Enable or disable the MQTT Session. When disabled, the client is disconnected, new messages matching QoS 0 subscriptions are discarded, and new messages matching QoS 1 subscriptions are stored for future delivery. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional mqttSessionClientId?: string

    The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.

  • Optional mqttSessionVirtualRouter?: MsgVpnMqttSession.mqttSessionVirtualRouter

    The virtual router of the MQTT Session. The allowed values and their meaning are:

    "primary" - The MQTT Session belongs to the primary virtual router.
"backup" - The MQTT Session belongs to the backup virtual router.
"auto" - The MQTT Session is automatically assigned a virtual router at creation, depending on the broker's active-standby role.
  • Optional msgVpnName?: string

    The name of the Message VPN.

  • Optional owner?: string

    The owner of the MQTT Session. For externally-created sessions this defaults to the Client Username of the connecting client. For management-created sessions this defaults to empty. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

  • Optional queueConsumerAckPropagationEnabled?: 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. Available since 2.14.

  • Optional queueDeadMsgQueue?: string

    The name of the Dead Message Queue (DMQ) used by the MQTT Session 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.14.

  • Optional queueEventBindCountThreshold?: EventThreshold
  • Optional queueEventMsgSpoolUsageThreshold?: EventThreshold
  • Optional queueEventRejectLowPriorityMsgLimitThreshold?: EventThreshold
  • Optional queueMaxBindCount?: number

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

  • Optional queueMaxDeliveredUnackedMsgsPerFlow?: number

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

  • Optional queueMaxMsgSize?: number

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

  • Optional queueMaxMsgSpoolUsage?: number

    The maximum message spool usage allowed by the MQTT Session 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. Available since 2.14.

  • Optional queueMaxRedeliveryCount?: number

    The maximum number of times the MQTT Session 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. Available since 2.14.

  • Optional queueMaxTtl?: number

    The maximum time in seconds a message can stay in the MQTT Session Queue when queueRespectTtlEnabled is "true". A message expires when the lesser of the sender assigned time-to-live (TTL) in the message and the queueMaxTtl configured for the MQTT Session 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. Available since 2.14.

  • Optional queueRejectLowPriorityMsgEnabled?: boolean

    Enable or disable the checking of low priority messages against the queueRejectLowPriorityMsgLimit. This may only be enabled if queueRejectMsgToSenderOnDiscardBehavior 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. Available since 2.14.

  • Optional queueRejectLowPriorityMsgLimit?: number

    The number of messages of any priority in the MQTT Session 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. Available since 2.14.

  • Optional queueRejectMsgToSenderOnDiscardBehavior?: MsgVpnMqttSession.queueRejectMsgToSenderOnDiscardBehavior

    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.14.

  • Optional queueRespectTtlEnabled?: boolean

    Enable or disable the respecting of the time-to-live (TTL) for messages in the MQTT Session 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. Available since 2.14.

Settings

Member Visibility

Theme