File Explorer

1/**2 *3 * A module containing support for mqtt connection establishment and operations.4 *5 * @packageDocumentation6 * @module mqtt7 */8import { ICrtError } from './error';9/**10 * Quality of service control for mqtt publish operations11 *12 * @category MQTT13 */14export declare enum QoS {15    /**16     * QoS 0 - At most once delivery17     * The message is delivered according to the capabilities of the underlying network.18     * No response is sent by the receiver and no retry is performed by the sender.19     * The message arrives at the receiver either once or not at all.20     */21    AtMostOnce = 0,22    /**23     * QoS 1 - At least once delivery24     * This quality of service ensures that the message arrives at the receiver at least once.25     */26    AtLeastOnce = 1,27    /**28     * QoS 2 - Exactly once delivery29 30     * This is the highest quality of service, for use when neither loss nor31     * duplication of messages are acceptable. There is an increased overhead32     * associated with this quality of service.33 34     * Note that, while this client supports QoS 2, the AWS IoT Core service35     * does not support QoS 2 at time of writing (May 2020).36     */37    ExactlyOnce = 238}39/**40 * Possible types of data to send via publish.41 *42 * An ArrayBuffer will send its bytes without transformation.43 * An ArrayBufferView (DataView, Uint8Array, etc) will send its bytes without transformation.44 * A String will be sent with utf-8 encoding.45 * An Object will be sent as a JSON string with utf-8 encoding.46 *47 * @category MQTT48 */49export type Payload = string | Record<string, unknown> | ArrayBuffer | ArrayBufferView;50/**51 * Function called upon receipt of a Publish message on a subscribed topic.52 *53 * @param topic The topic to which the message was published.54 * @param payload The payload data.55 * @param dup DUP flag. If true, this might be re-delivery of an earlier56 *            attempt to send the message.57 * @param qos Quality of Service used to deliver the message.58 * @param retain Retain flag. If true, the message was sent as a result of59 *               a new subscription being made by the client. *60 *61 * @category MQTT62 */63export type OnMessageCallback = (topic: string, payload: ArrayBuffer, dup: boolean, qos: QoS, retain: boolean) => void;64/**65 * Every request sent returns an MqttRequest66 *67 * @category MQTT68 */69export interface MqttRequest {70    /** Packet ID being acknowledged when the request completes */71    packet_id?: number;72}73/**74 * The data returned from an on_connection_success callback75 *76 * @category MQTT77 */78export interface OnConnectionSuccessResult {79    /**80     * A boolean indicating if the connection resumed a session.81     */82    session_present: boolean;83    /**84     * An optional connect return code received from the server, if a connect return code was returned.85     */86    reason_code?: number;87}88/**89 * The data returned from an on_connection_failed callback90 *91 * @category MQTT92 */93export interface OnConnectionFailedResult {94    /**95     * Error description of the error that occurred96     */97    error: ICrtError;98}99/**100 * The data returned from the on_connection_closed callback101 *102 * @category MQTT103 */104export interface OnConnectionClosedResult {105}106/**107 * Subscription SUBACK result108 *109 * @category MQTT110 */111export interface MqttSubscribeRequest extends MqttRequest {112    /** Topic filter of the SUBSCRIBE packet being acknowledged */113    topic: string;114    /** Maximum QoS granted by the server. This may be lower than the requested QoS. */115    qos: QoS;116    /** If an error occurred, the error code */117    error_code?: number;118}119/**120 * A Will message is published by the server if a client is lost unexpectedly.121 *122 * The Will message is stored on the server when a client connects.123 * It is published if the client connection is lost without the server124 * receiving a DISCONNECT packet.125 *126 * [MQTT - 3.1.2 - 8]127 *128 * @category MQTT129 */130export declare class MqttWill {131    /** Topic to publish Will message on. */132    readonly topic: string;133    /** QoS used when publishing the Will message. */134    readonly qos: QoS;135    /** Content of Will message. */136    readonly payload: Payload;137    /** Whether the Will message is to be retained when it is published. */138    readonly retain: boolean;139    constructor(140    /** Topic to publish Will message on. */141    topic: string, 142    /** QoS used when publishing the Will message. */143    qos: QoS, 144    /** Content of Will message. */145    payload: Payload, 146    /** Whether the Will message is to be retained when it is published. */147    retain?: boolean);148}149/**150 * Listener signature for event emitted from an {@link MqttClientConnection} when the connection reaches an initial151 * connected state152 *153 * @param session_present true if the reconnection went to an existing session, false if this is a clean session154 *155 * @category MQTT156 */157export type MqttConnectionConnected = (session_present: boolean) => void;158/**159 * Listener signature for event emitted from an {@link MqttClientConnection} when the connection has fully disconnected160 * by user request161 *162 * @category MQTT163 */164export type MqttConnectionDisconnected = () => void;165/**166 * Listener signature for event emitted from an {@link MqttClientConnection} when the connection successfully167 * reestablishes itself after an interruption168 *169 * @param return_code MQTT connect return code (should be 0 for a successful reconnection)170 * @param session_present true if the reconnection went to an existing session, false if this is a clean session171 *172 * @category MQTT173 */174export type MqttConnectionResumed = (return_code: number, session_present: boolean) => void;175/**176 * Const value for max reconnection back off time177 *178 * @category MQTT179 */180export declare const DEFAULT_RECONNECT_MAX_SEC = 128;181/**182 * Const value for min reconnection back off time183 *184 * @category MQTT185 */186export declare const DEFAULT_RECONNECT_MIN_SEC = 1;187