File Explorer

1"use strict";2/*3 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.4 * SPDX-License-Identifier: Apache-2.0.5 */6Object.defineProperty(exports, "__esModule", { value: true });7exports.ClientOperationQueueBehavior = exports.InboundTopicAliasBehaviorType = exports.OutboundTopicAliasBehaviorType = exports.RetryJitterType = exports.ClientSessionBehavior = void 0;8/**9 * Controls how the MQTT5 client should behave with respect to MQTT sessions.10 */11var ClientSessionBehavior;12(function (ClientSessionBehavior) {13    /** Maps to Clean */14    ClientSessionBehavior[ClientSessionBehavior["Default"] = 0] = "Default";15    /**16     * Always ask for a clean session when connecting17     */18    ClientSessionBehavior[ClientSessionBehavior["Clean"] = 1] = "Clean";19    /**20     * Always attempt to rejoin an existing session after an initial connection success.21     *22     * Session rejoin requires an appropriate non-zero session expiry interval in the client's CONNECT options.23     */24    ClientSessionBehavior[ClientSessionBehavior["RejoinPostSuccess"] = 2] = "RejoinPostSuccess";25    /**26     * Always attempt to rejoin an existing session.  Since the client does not yet support durable session persistence,27     * this option is not guaranteed to be spec compliant because any unacknowledged qos1 publishes (which are28     * part of the client session state) will not be present on the initial connection.  Until we support29     * durable session resumption, this option is technically spec-breaking, but useful.30     */31    ClientSessionBehavior[ClientSessionBehavior["RejoinAlways"] = 3] = "RejoinAlways";32})(ClientSessionBehavior = exports.ClientSessionBehavior || (exports.ClientSessionBehavior = {}));33/**34 * Controls how the reconnect delay is modified in order to smooth out the distribution of reconnection attempt35 * timepoints for a large set of reconnecting clients.36 *37 * See [Exponential Backoff and Jitter](https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/)38 */39var RetryJitterType;40(function (RetryJitterType) {41    /**42     * Maps to Full43     */44    RetryJitterType[RetryJitterType["Default"] = 0] = "Default";45    /**46     * Do not perform any randomization on the reconnect delay:47     * ```NextReconnectDelay = CurrentExponentialBackoffValue```48     */49    RetryJitterType[RetryJitterType["None"] = 1] = "None";50    /**51     * Fully random between no delay and the current exponential backoff value.52     * ```NextReconnectDelay = Random(0, CurrentExponentialBackoffValue)```53     */54    RetryJitterType[RetryJitterType["Full"] = 2] = "Full";55    /**56     * ```NextReconnectDelay = Min(MaxReconnectDelay, Random(MinReconnectDelay, 3 * CurrentReconnectDelay)```57     */58    RetryJitterType[RetryJitterType["Decorrelated"] = 3] = "Decorrelated";59})(RetryJitterType = exports.RetryJitterType || (exports.RetryJitterType = {}));60/**61 * An enumeration that controls how the client applies topic aliasing to outbound publish packets.62 *63 * Topic alias behavior is described in https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc390111364 */65var OutboundTopicAliasBehaviorType;66(function (OutboundTopicAliasBehaviorType) {67    /**68     * Maps to Disabled.  This keeps the client from being broken (by default) if the broker69     * topic aliasing implementation has a problem.70     */71    OutboundTopicAliasBehaviorType[OutboundTopicAliasBehaviorType["Default"] = 0] = "Default";72    /**73     * Outbound aliasing is the user's responsibility.  Client will cache and use74     * previously-established aliases if they fall within the negotiated limits of the connection.75     *76     * The user must still always submit a full topic in their publishes because disconnections disrupt77     * topic alias mappings unpredictably.  The client will properly use a requested alias when the most-recently-seen78     * binding for a topic alias value matches the alias and topic in the publish packet.79     */80    OutboundTopicAliasBehaviorType[OutboundTopicAliasBehaviorType["Manual"] = 1] = "Manual";81    /**82     * (Recommended) The client will use an LRU cache to drive alias usage.83     *84     * Manually setting a topic alias will be ignored (the LRU cache is authoritative)85     */86    OutboundTopicAliasBehaviorType[OutboundTopicAliasBehaviorType["LRU"] = 2] = "LRU";87    /**88     * Completely disable outbound topic aliasing.89     */90    OutboundTopicAliasBehaviorType[OutboundTopicAliasBehaviorType["Disabled"] = 3] = "Disabled";91})(OutboundTopicAliasBehaviorType = exports.OutboundTopicAliasBehaviorType || (exports.OutboundTopicAliasBehaviorType = {}));92/**93 * An enumeration that controls whether or not the client allows the broker to send publishes that use topic94 * aliasing.95 *96 * Topic alias behavior is described in https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc390111397 */98var InboundTopicAliasBehaviorType;99(function (InboundTopicAliasBehaviorType) {100    /**101     * Maps to Disabled.  This keeps the client from being broken (by default) if the broker102     * topic aliasing implementation has a problem.103     */104    InboundTopicAliasBehaviorType[InboundTopicAliasBehaviorType["Default"] = 0] = "Default";105    /**106     * Allow the server to send PUBLISH packets to the client that use topic aliasing107     */108    InboundTopicAliasBehaviorType[InboundTopicAliasBehaviorType["Enabled"] = 1] = "Enabled";109    /**110     * Forbid the server from sending PUBLISH packets to the client that use topic aliasing111     */112    InboundTopicAliasBehaviorType[InboundTopicAliasBehaviorType["Disabled"] = 2] = "Disabled";113})(InboundTopicAliasBehaviorType = exports.InboundTopicAliasBehaviorType || (exports.InboundTopicAliasBehaviorType = {}));114/**115 * Controls how disconnects affect the queued and in-progress operations tracked by the client.  Also controls116 * how operations are handled while the client is not connected.  In particular, if the client is not connected,117 * then any operation that would be failed on disconnect (according to these rules) will be rejected.118 */119var ClientOperationQueueBehavior;120(function (ClientOperationQueueBehavior) {121    /** Same as FailQos0PublishOnDisconnect */122    ClientOperationQueueBehavior[ClientOperationQueueBehavior["Default"] = 0] = "Default";123    /**124     * Re-queues QoS 1+ publishes on disconnect; un-acked publishes go to the front while unprocessed publishes stay125     * in place.  All other operations (QoS 0 publishes, subscribe, unsubscribe) are failed.126     */127    ClientOperationQueueBehavior[ClientOperationQueueBehavior["FailNonQos1PublishOnDisconnect"] = 1] = "FailNonQos1PublishOnDisconnect";128    /**129     * QoS 0 publishes that are not complete at the time of disconnection are failed.  Un-acked QoS 1+ publishes are130     * re-queued at the head of the line for immediate retransmission on a session resumption.  All other operations131     * are requeued in original order behind any retransmissions.132     */133    ClientOperationQueueBehavior[ClientOperationQueueBehavior["FailQos0PublishOnDisconnect"] = 2] = "FailQos0PublishOnDisconnect";134    /**135     * All operations that are not complete at the time of disconnection are failed, except operations that136     * the MQTT5 spec requires to be retransmitted (un-acked QoS1+ publishes).137     */138    ClientOperationQueueBehavior[ClientOperationQueueBehavior["FailAllOnDisconnect"] = 3] = "FailAllOnDisconnect";139})(ClientOperationQueueBehavior = exports.ClientOperationQueueBehavior || (exports.ClientOperationQueueBehavior = {}));140//# sourceMappingURL=mqtt5.js.map