From 57c66b1c61303720f6f82738c4a5bf038e9f4697 Mon Sep 17 00:00:00 2001 From: Dave Hibberd Date: Fri, 29 Nov 2024 19:19:19 +0000 Subject: [PATCH] New upstream version 6.0.24.51.1+repack --- MQTTAsync.h | 2383 -------------------------------------- MQTTClient.h | 1980 ------------------------------- MQTTClientPersistence.h | 277 ----- MQTTExportDeclarations.h | 36 - MQTTProperties.h | 222 ---- MQTTReasonCodes.h | 79 -- MQTTSubscribeOpts.h | 46 - XAprs | Bin 174928 -> 0 bytes igd_desc_parse.h | 49 - mailapi.c | 17 +- miniupnpc.h | 153 --- miniupnpctypes.h | 19 - pcap.h | 257 ---- upnpcommands.h | 348 ------ upnpdev.h | 44 - upnperrors.h | 26 - zconf.h | 333 ------ zlib.h | 1358 ---------------------- 18 files changed, 15 insertions(+), 7612 deletions(-) delete mode 100644 MQTTAsync.h delete mode 100644 MQTTClient.h delete mode 100644 MQTTClientPersistence.h delete mode 100644 MQTTExportDeclarations.h delete mode 100644 MQTTProperties.h delete mode 100644 MQTTReasonCodes.h delete mode 100644 MQTTSubscribeOpts.h delete mode 100644 XAprs delete mode 100644 igd_desc_parse.h delete mode 100644 miniupnpc.h delete mode 100644 miniupnpctypes.h delete mode 100644 pcap.h delete mode 100644 upnpcommands.h delete mode 100644 upnpdev.h delete mode 100644 upnperrors.h delete mode 100644 zconf.h delete mode 100644 zlib.h diff --git a/MQTTAsync.h b/MQTTAsync.h deleted file mode 100644 index e11af04..0000000 --- a/MQTTAsync.h +++ /dev/null @@ -1,2383 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2009, 2023 IBM Corp., Ian Craggs and others - * - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v2.0 - * and Eclipse Distribution License v1.0 which accompany this distribution. - * - * The Eclipse Public License is available at - * https://www.eclipse.org/legal/epl-2.0/ - * and the Eclipse Distribution License is available at - * http://www.eclipse.org/org/documents/edl-v10.php. - * - * Contributors: - * Ian Craggs - initial API and implementation - * Ian Craggs, Allan Stockdill-Mander - SSL connections - * Ian Craggs - multiple server connection support - * Ian Craggs - MQTT 3.1.1 support - * Ian Craggs - fix for bug 444103 - success/failure callbacks not invoked - * Ian Craggs - automatic reconnect and offline buffering (send while disconnected) - * Ian Craggs - binary will message - * Ian Craggs - binary password - * Ian Craggs - remove const on eyecatchers #168 - * Ian Craggs - MQTT 5.0 - *******************************************************************************/ - -/********************************************************************/ - -/** - * @cond MQTTAsync_main - * @mainpage Asynchronous MQTT client library for C (MQTTAsync) - * - * © Copyright 2009, 2023 IBM Corp., Ian Craggs and others - * - * @brief An Asynchronous MQTT client library for C. - * - * An MQTT client application connects to MQTT-capable servers. - * A typical client is responsible for collecting information from a telemetry - * device and publishing the information to the server. It can also subscribe - * to topics, receive messages, and use this information to control the - * telemetry device. - * - * MQTT clients implement the published MQTT v3 protocol. You can write your own - * API to the MQTT protocol using the programming language and platform of your - * choice. This can be time-consuming and error-prone. - * - * To simplify writing MQTT client applications, this library encapsulates - * the MQTT v3 protocol for you. Using this library enables a fully functional - * MQTT client application to be written in a few lines of code. - * The information presented here documents the API provided - * by the Asynchronous MQTT Client library for C. - * - * Using the client
- * Applications that use the client library typically use a similar structure: - * - * Some simple examples are shown here: - * - * Additional information about important concepts is provided here: - * - * @endcond - */ - -/* -/// @cond EXCLUDE -*/ -#if !defined(MQTTASYNC_H) -#define MQTTASYNC_H - -#if defined(__cplusplus) - extern "C" { -#endif - -#include -/* -/// @endcond -*/ - -#include "MQTTExportDeclarations.h" - -#include "MQTTProperties.h" -#include "MQTTReasonCodes.h" -#include "MQTTSubscribeOpts.h" -#if !defined(NO_PERSISTENCE) -#include "MQTTClientPersistence.h" -#endif - -/** - * Return code: No error. Indicates successful completion of an MQTT client - * operation. - */ -#define MQTTASYNC_SUCCESS 0 -/** - * Return code: A generic error code indicating the failure of an MQTT client - * operation. - */ -#define MQTTASYNC_FAILURE -1 - -/* error code -2 is MQTTAsync_PERSISTENCE_ERROR */ - -#define MQTTASYNC_PERSISTENCE_ERROR -2 - -/** - * Return code: The client is disconnected. - */ -#define MQTTASYNC_DISCONNECTED -3 -/** - * Return code: The maximum number of messages allowed to be simultaneously - * in-flight has been reached. - */ -#define MQTTASYNC_MAX_MESSAGES_INFLIGHT -4 -/** - * Return code: An invalid UTF-8 string has been detected. - */ -#define MQTTASYNC_BAD_UTF8_STRING -5 -/** - * Return code: A NULL parameter has been supplied when this is invalid. - */ -#define MQTTASYNC_NULL_PARAMETER -6 -/** - * Return code: The topic has been truncated (the topic string includes - * embedded NULL characters). String functions will not access the full topic. - * Use the topic length value to access the full topic. - */ -#define MQTTASYNC_TOPICNAME_TRUNCATED -7 -/** - * Return code: A structure parameter does not have the correct eyecatcher - * and version number. - */ -#define MQTTASYNC_BAD_STRUCTURE -8 -/** - * Return code: A qos parameter is not 0, 1 or 2 - */ -#define MQTTASYNC_BAD_QOS -9 -/** - * Return code: All 65535 MQTT msgids are being used - */ -#define MQTTASYNC_NO_MORE_MSGIDS -10 -/** - * Return code: the request is being discarded when not complete - */ -#define MQTTASYNC_OPERATION_INCOMPLETE -11 -/** - * Return code: no more messages can be buffered - */ -#define MQTTASYNC_MAX_BUFFERED_MESSAGES -12 -/** - * Return code: Attempting SSL connection using non-SSL version of library - */ -#define MQTTASYNC_SSL_NOT_SUPPORTED -13 -/** - * Return code: protocol prefix in serverURI should be: - * @li @em tcp:// or @em mqtt:// - Insecure TCP - * @li @em ssl:// or @em mqtts:// - Encrypted SSL/TLS - * @li @em ws:// - Insecure websockets - * @li @em wss:// - Secure web sockets - * - * The TLS enabled prefixes (ssl, mqtts, wss) are only valid if the TLS - * version of the library is linked with. - */ -#define MQTTASYNC_BAD_PROTOCOL -14 -/** - * Return code: don't use options for another version of MQTT - */ -#define MQTTASYNC_BAD_MQTT_OPTION -15 -/** - * Return code: call not applicable to the client's version of MQTT - */ -#define MQTTASYNC_WRONG_MQTT_VERSION -16 -/** - * Return code: 0 length will topic - */ -#define MQTTASYNC_0_LEN_WILL_TOPIC -17 -/* - * Return code: connect or disconnect command ignored because there is already a connect or disconnect - * command at the head of the list waiting to be processed. Use the onSuccess/onFailure callbacks to wait - * for the previous connect or disconnect command to be complete. - */ -#define MQTTASYNC_COMMAND_IGNORED -18 - /* - * Return code: maxBufferedMessages in the connect options must be >= 0 - */ - #define MQTTASYNC_MAX_BUFFERED -19 - -/** - * Default MQTT version to connect with. Use 3.1.1 then fall back to 3.1 - */ -#define MQTTVERSION_DEFAULT 0 -/** - * MQTT version to connect with: 3.1 - */ -#define MQTTVERSION_3_1 3 -/** - * MQTT version to connect with: 3.1.1 - */ -#define MQTTVERSION_3_1_1 4 -/** - * MQTT version to connect with: 5 - */ -#define MQTTVERSION_5 5 -/** - * Bad return code from subscribe, as defined in the 3.1.1 specification - */ -#define MQTT_BAD_SUBSCRIBE 0x80 - - -/** - * Initialization options - */ -typedef struct -{ - /** The eyecatcher for this structure. Must be MQTG. */ - char struct_id[4]; - /** The version number of this structure. Must be 0 */ - int struct_version; - /** 1 = we do openssl init, 0 = leave it to the application */ - int do_openssl_init; -} MQTTAsync_init_options; - -#define MQTTAsync_init_options_initializer { {'M', 'Q', 'T', 'G'}, 0, 0 } - -/** - * Global init of mqtt library. Call once on program start to set global behaviour. - * handle_openssl_init - if mqtt library should handle openssl init (1) or rely on the caller to init it before using mqtt (0) - */ -LIBMQTT_API void MQTTAsync_global_init(MQTTAsync_init_options* inits); - -/** - * A handle representing an MQTT client. A valid client handle is available - * following a successful call to MQTTAsync_create(). - */ -typedef void* MQTTAsync; -/** - * A value representing an MQTT message. A token is returned to the - * client application when a message is published. The token can then be used to - * check that the message was successfully delivered to its destination (see - * MQTTAsync_publish(), - * MQTTAsync_publishMessage(), - * MQTTAsync_deliveryComplete(), and - * MQTTAsync_getPendingTokens()). - */ -typedef int MQTTAsync_token; - -/** - * A structure representing the payload and attributes of an MQTT message. The - * message topic is not part of this structure (see MQTTAsync_publishMessage(), - * MQTTAsync_publish(), MQTTAsync_receive(), MQTTAsync_freeMessage() - * and MQTTAsync_messageArrived()). - */ -typedef struct -{ - /** The eyecatcher for this structure. must be MQTM. */ - char struct_id[4]; - /** The version number of this structure. Must be 0 or 1. - * 0 indicates no message properties */ - int struct_version; - /** The length of the MQTT message payload in bytes. */ - int payloadlen; - /** A pointer to the payload of the MQTT message. */ - void* payload; - /** - * The quality of service (QoS) assigned to the message. - * There are three levels of QoS: - *
- *
QoS0
- *
Fire and forget - the message may not be delivered
- *
QoS1
- *
At least once - the message will be delivered, but may be - * delivered more than once in some circumstances.
- *
QoS2
- *
Once and one only - the message will be delivered exactly once.
- *
- */ - int qos; - /** - * The retained flag serves two purposes depending on whether the message - * it is associated with is being published or received. - * - * retained = true
- * For messages being published, a true setting indicates that the MQTT - * server should retain a copy of the message. The message will then be - * transmitted to new subscribers to a topic that matches the message topic. - * For subscribers registering a new subscription, the flag being true - * indicates that the received message is not a new one, but one that has - * been retained by the MQTT server. - * - * retained = false
- * For publishers, this indicates that this message should not be retained - * by the MQTT server. For subscribers, a false setting indicates this is - * a normal message, received as a result of it being published to the - * server. - */ - int retained; - /** - * The dup flag indicates whether or not this message is a duplicate. - * It is only meaningful when receiving QoS1 messages. When true, the - * client application should take appropriate action to deal with the - * duplicate message. This is an output parameter only. - */ - int dup; - /** The message identifier is reserved for internal use by the - * MQTT client and server. It is an output parameter only - writing - * to it will serve no purpose. It contains the MQTT message id of - * an incoming publish message. - */ - int msgid; - /** - * The MQTT V5 properties associated with the message. - */ - MQTTProperties properties; -} MQTTAsync_message; - -#define MQTTAsync_message_initializer { {'M', 'Q', 'T', 'M'}, 1, 0, NULL, 0, 0, 0, 0, MQTTProperties_initializer } - -/** - * This is a callback function. The client application - * must provide an implementation of this function to enable asynchronous - * receipt of messages. The function is registered with the client library by - * passing it as an argument to MQTTAsync_setCallbacks(). It is - * called by the client library when a new message that matches a client - * subscription has been received from the server. This function is executed on - * a separate thread to the one on which the client application is running. - * - * Note: Neither MQTTAsync_create() nor MQTTAsync_destroy() should be - * called within this callback. - * @param context A pointer to the context value originally passed to - * MQTTAsync_setCallbacks(), which contains any application-specific context. - * @param topicName The topic associated with the received message. - * @param topicLen The length of the topic if there are one - * more NULL characters embedded in topicName, otherwise topicLen - * is 0. If topicLen is 0, the value returned by strlen(topicName) - * can be trusted. If topicLen is greater than 0, the full topic name - * can be retrieved by accessing topicName as a byte array of length - * topicLen. - * @param message The MQTTAsync_message structure for the received message. - * This structure contains the message payload and attributes. - * @return This function must return 0 or 1 indicating whether or not - * the message has been safely received by the client application.
- * Returning 1 indicates that the message has been successfully handled. - * To free the message storage, ::MQTTAsync_freeMessage must be called. - * To free the topic name storage, ::MQTTAsync_free must be called.
- * Returning 0 indicates that there was a problem. In this - * case, the client library will reinvoke MQTTAsync_messageArrived() to - * attempt to deliver the message to the application again. - * Do not free the message and topic storage when returning 0, otherwise - * the redelivery will fail. - */ -typedef int MQTTAsync_messageArrived(void* context, char* topicName, int topicLen, MQTTAsync_message* message); - -/** - * This is a callback function. The client application - * must provide an implementation of this function to enable asynchronous - * notification of delivery of messages to the server. The function is - * registered with the client library by passing it as an argument to MQTTAsync_setCallbacks(). - * It is called by the client library after the client application has - * published a message to the server. It indicates that the necessary - * handshaking and acknowledgements for the requested quality of service (see - * MQTTAsync_message.qos) have been completed. This function is executed on a - * separate thread to the one on which the client application is running. - * - * Note: Neither MQTTAsync_create() nor MQTTAsync_destroy() should be - * called within this callback. - * @param context A pointer to the context value originally passed to - * MQTTAsync_setCallbacks(), which contains any application-specific context. - * @param token The ::MQTTAsync_token associated with - * the published message. Applications can check that all messages have been - * correctly published by matching the tokens returned from calls to - * MQTTAsync_send() and MQTTAsync_sendMessage() with the tokens passed - * to this callback. - */ -typedef void MQTTAsync_deliveryComplete(void* context, MQTTAsync_token token); - -/** - * This is a callback function. The client application - * must provide an implementation of this function to enable asynchronous - * notification of the loss of connection to the server. The function is - * registered with the client library by passing it as an argument to - * MQTTAsync_setCallbacks(). It is called by the client library if the client - * loses its connection to the server. The client application must take - * appropriate action, such as trying to reconnect or reporting the problem. - * This function is executed on a separate thread to the one on which the - * client application is running. - * - * Note: Neither MQTTAsync_create() nor MQTTAsync_destroy() should be - * called within this callback. - * @param context A pointer to the context value originally passed to - * MQTTAsync_setCallbacks(), which contains any application-specific context. - * @param cause The reason for the disconnection. - * Currently, cause is always set to NULL. - */ -typedef void MQTTAsync_connectionLost(void* context, char* cause); - - -/** - * This is a callback function, which will be called when the client - * library successfully connects. This is superfluous when the connection - * is made in response to a MQTTAsync_connect call, because the onSuccess - * callback can be used. It is intended for use when automatic reconnect - * is enabled, so that when a reconnection attempt succeeds in the background, - * the application is notified and can take any required actions. - * - * Note: Neither MQTTAsync_create() nor MQTTAsync_destroy() should be - * called within this callback. - * @param context A pointer to the context value originally passed to - * MQTTAsync_setCallbacks(), which contains any application-specific context. - * @param cause The reason for the disconnection. - * Currently, cause is always set to NULL. - */ -typedef void MQTTAsync_connected(void* context, char* cause); - -/** - * This is a callback function, which will be called when the client - * library receives a disconnect packet from the server. This applies to MQTT V5 and above only. - * - * Note: Neither MQTTAsync_create() nor MQTTAsync_destroy() should be - * called within this callback. - * @param context A pointer to the context value originally passed to - * MQTTAsync_setCallbacks(), which contains any application-specific context. - * @param properties the properties in the disconnect packet. - * @param properties the reason code from the disconnect packet - * Currently, cause is always set to NULL. - */ -typedef void MQTTAsync_disconnected(void* context, MQTTProperties* properties, - enum MQTTReasonCodes reasonCode); - -/** - * Sets the MQTTAsync_disconnected() callback function for a client. - * @param handle A valid client handle from a successful call to - * MQTTAsync_create(). - * - * Note: Neither MQTTAsync_create() nor MQTTAsync_destroy() should be - * called within this callback. - * @param context A pointer to any application-specific context. The - * the context pointer is passed to each of the callback functions to - * provide access to the context information in the callback. - * @param co A pointer to an MQTTAsync_connected() callback - * function. NULL removes the callback setting. - * @return ::MQTTASYNC_SUCCESS if the callbacks were correctly set, - * ::MQTTASYNC_FAILURE if an error occurred. - */ -LIBMQTT_API int MQTTAsync_setDisconnected(MQTTAsync handle, void* context, MQTTAsync_disconnected* co); - -/** The connect options that can be updated before an automatic reconnect. */ -typedef struct -{ - /** The eyecatcher for this structure. Will be MQCD. */ - char struct_id[4]; - /** The version number of this structure. Will be 0 */ - int struct_version; - /** - * MQTT servers that support the MQTT v3.1 protocol provide authentication - * and authorisation by user name and password. This is the user name parameter. - * Set data to NULL to remove. To change, allocate new - * storage with ::MQTTAsync_allocate - this will then be free later by the library. - */ - const char* username; - /** - * The password parameter of the MQTT authentication. - * Set data to NULL to remove. To change, allocate new - * storage with ::MQTTAsync_allocate - this will then be free later by the library. - */ - struct { - int len; /**< binary password length */ - const void* data; /**< binary password data */ - } binarypwd; -} MQTTAsync_connectData; - -#define MQTTAsync_connectData_initializer {{'M', 'Q', 'C', 'D'}, 0, NULL, {0, NULL}} - -/** - * This is a callback function which will allow the client application to update the - * connection data. - * @param data The connection data which can be modified by the application. - * @return Return a non-zero value to update the connect data, zero to keep the same data. - */ -typedef int MQTTAsync_updateConnectOptions(void* context, MQTTAsync_connectData* data); - -/** - * Sets the MQTTAsync_updateConnectOptions() callback function for a client. - * @param handle A valid client handle from a successful call to MQTTAsync_create(). - * @param context A pointer to any application-specific context. The - * the context pointer is passed to each of the callback functions to - * provide access to the context information in the callback. - * @param co A pointer to an MQTTAsync_updateConnectOptions() callback - * function. NULL removes the callback setting. - */ -LIBMQTT_API int MQTTAsync_setUpdateConnectOptions(MQTTAsync handle, void* context, MQTTAsync_updateConnectOptions* co); - -/** - * Sets the MQTTPersistence_beforeWrite() callback function for a client. - * @param handle A valid client handle from a successful call to MQTTAsync_create(). - * @param context A pointer to any application-specific context. The - * the context pointer is passed to the callback function to - * provide access to the context information in the callback. - * @param co A pointer to an MQTTPersistence_beforeWrite() callback - * function. NULL removes the callback setting. - */ -LIBMQTT_API int MQTTAsync_setBeforePersistenceWrite(MQTTAsync handle, void* context, MQTTPersistence_beforeWrite* co); - - -/** - * Sets the MQTTPersistence_afterRead() callback function for a client. - * @param handle A valid client handle from a successful call to MQTTAsync_create(). - * @param context A pointer to any application-specific context. The - * the context pointer is passed to the callback function to - * provide access to the context information in the callback. - * @param co A pointer to an MQTTPersistence_beforeWrite() callback - * function. NULL removes the callback setting. - */ -LIBMQTT_API int MQTTAsync_setAfterPersistenceRead(MQTTAsync handle, void* context, MQTTPersistence_afterRead* co); - - -/** The data returned on completion of an unsuccessful API call in the response callback onFailure. */ -typedef struct -{ - /** A token identifying the failed request. */ - MQTTAsync_token token; - /** A numeric code identifying the error. */ - int code; - /** Optional text explaining the error. Can be NULL. */ - const char *message; -} MQTTAsync_failureData; - - -/** The data returned on completion of an unsuccessful API call in the response callback onFailure. */ -typedef struct -{ - /** The eyecatcher for this structure. Will be MQFD. */ - char struct_id[4]; - /** The version number of this structure. Will be 0 */ - int struct_version; - /** A token identifying the failed request. */ - MQTTAsync_token token; - /** The MQTT reason code returned. */ - enum MQTTReasonCodes reasonCode; - /** The MQTT properties on the ack, if any. */ - MQTTProperties properties; - /** A numeric code identifying the MQTT client library error. */ - int code; - /** Optional further text explaining the error. Can be NULL. */ - const char *message; - /** Packet type on which the failure occurred - used for publish QoS 1/2 exchanges*/ - int packet_type; -} MQTTAsync_failureData5; - -#define MQTTAsync_failureData5_initializer {{'M', 'Q', 'F', 'D'}, 0, 0, MQTTREASONCODE_SUCCESS, MQTTProperties_initializer, 0, NULL, 0} - -/** The data returned on completion of a successful API call in the response callback onSuccess. */ -typedef struct -{ - /** A token identifying the successful request. Can be used to refer to the request later. */ - MQTTAsync_token token; - /** A union of the different values that can be returned for subscribe, unsubscribe and publish. */ - union - { - /** For subscribe, the granted QoS of the subscription returned by the server. - * Also for subscribeMany, if only 1 subscription was requested. */ - int qos; - /** For subscribeMany, if more than one subscription was requested, - * the list of granted QoSs of the subscriptions returned by the server. */ - int* qosList; - /** For publish, the message being sent to the server. */ - struct - { - MQTTAsync_message message; /**< the message being sent to the server */ - char* destinationName; /**< the topic destination for the message */ - } pub; - /* For connect, the server connected to, MQTT version used, and sessionPresent flag */ - struct - { - char* serverURI; /**< the connection string of the server */ - int MQTTVersion; /**< the version of MQTT being used */ - int sessionPresent; /**< the session present flag returned from the server */ - } connect; - } alt; -} MQTTAsync_successData; - - -/** The data returned on completion of a successful API call in the response callback onSuccess. */ -typedef struct -{ - char struct_id[4]; /**< The eyecatcher for this structure. Will be MQSD. */ - int struct_version; /**< The version number of this structure. Will be 0 */ - /** A token identifying the successful request. Can be used to refer to the request later. */ - MQTTAsync_token token; - enum MQTTReasonCodes reasonCode; /**< MQTT V5 reason code returned */ - MQTTProperties properties; /**< MQTT V5 properties returned, if any */ - /** A union of the different values that can be returned for subscribe, unsubscribe and publish. */ - union - { - /** For subscribeMany, the list of reasonCodes returned by the server. */ - struct - { - int reasonCodeCount; /**< the number of reason codes in the reasonCodes array */ - enum MQTTReasonCodes* reasonCodes; /**< an array of reasonCodes */ - } sub; - /** For publish, the message being sent to the server. */ - struct - { - MQTTAsync_message message; /**< the message being sent to the server */ - char* destinationName; /**< the topic destination for the message */ - } pub; - /* For connect, the server connected to, MQTT version used, and sessionPresent flag */ - struct - { - char* serverURI; /**< the connection string of the server */ - int MQTTVersion; /**< the version of MQTT being used */ - int sessionPresent; /**< the session present flag returned from the server */ - } connect; - /** For unsubscribeMany, the list of reasonCodes returned by the server. */ - struct - { - int reasonCodeCount; /**< the number of reason codes in the reasonCodes array */ - enum MQTTReasonCodes* reasonCodes; /**< an array of reasonCodes */ - } unsub; - } alt; -} MQTTAsync_successData5; - -#define MQTTAsync_successData5_initializer {{'M', 'Q', 'S', 'D'}, 0, 0, MQTTREASONCODE_SUCCESS, MQTTProperties_initializer, {.sub={0,0}}} - -/** - * This is a callback function. The client application - * must provide an implementation of this function to enable asynchronous - * notification of the successful completion of an API call. The function is - * registered with the client library by passing it as an argument in - * ::MQTTAsync_responseOptions. - * - * Note: Neither MQTTAsync_create() nor MQTTAsync_destroy() should be - * called within this callback. - * @param context A pointer to the context value originally passed to - * ::MQTTAsync_responseOptions, which contains any application-specific context. - * @param response Any success data associated with the API completion. - */ -typedef void MQTTAsync_onSuccess(void* context, MQTTAsync_successData* response); - -/** - * This is a callback function, the MQTT V5 version of ::MQTTAsync_onSuccess. - * The client application - * must provide an implementation of this function to enable asynchronous - * notification of the successful completion of an API call. The function is - * registered with the client library by passing it as an argument in - * ::MQTTAsync_responseOptions. - * - * Note: Neither MQTTAsync_create() nor MQTTAsync_destroy() should be - * called within this callback. - * @param context A pointer to the context value originally passed to - * ::MQTTAsync_responseOptions, which contains any application-specific context. - * @param response Any success data associated with the API completion. - */ -typedef void MQTTAsync_onSuccess5(void* context, MQTTAsync_successData5* response); - -/** - * This is a callback function. The client application - * must provide an implementation of this function to enable asynchronous - * notification of the unsuccessful completion of an API call. The function is - * registered with the client library by passing it as an argument in - * ::MQTTAsync_responseOptions. - * - * Note: Neither MQTTAsync_create() nor MQTTAsync_destroy() should be - * called within this callback. - * @param context A pointer to the context value originally passed to - * ::MQTTAsync_responseOptions, which contains any application-specific context. - * @param response Failure data associated with the API completion. - */ -typedef void MQTTAsync_onFailure(void* context, MQTTAsync_failureData* response); - -/** - * This is a callback function, the MQTT V5 version of ::MQTTAsync_onFailure. - * The application must provide an implementation of this function to enable asynchronous - * notification of the unsuccessful completion of an API call. The function is - * registered with the client library by passing it as an argument in - * ::MQTTAsync_responseOptions. - * - * Note: Neither MQTTAsync_create() nor MQTTAsync_destroy() should be - * called within this callback. - * @param context A pointer to the context value originally passed to - * ::MQTTAsync_responseOptions, which contains any application-specific context. - * @param response Failure data associated with the API completion. - */ -typedef void MQTTAsync_onFailure5(void* context, MQTTAsync_failureData5* response); - -/** Structure to define call options. For MQTT 5.0 there is input data as well as that - * describing the response method. So there is now also a synonym ::MQTTAsync_callOptions - * to better reflect the use. This responseOptions name is kept for backward - * compatibility. - */ -typedef struct MQTTAsync_responseOptions -{ - /** The eyecatcher for this structure. Must be MQTR */ - char struct_id[4]; - /** The version number of this structure. Must be 0 or 1 - * if 0, no MQTTV5 options */ - int struct_version; - /** - * A pointer to a callback function to be called if the API call successfully - * completes. Can be set to NULL, in which case no indication of successful - * completion will be received. - */ - MQTTAsync_onSuccess* onSuccess; - /** - * A pointer to a callback function to be called if the API call fails. - * Can be set to NULL, in which case no indication of unsuccessful - * completion will be received. - */ - MQTTAsync_onFailure* onFailure; - /** - * A pointer to any application-specific context. The - * the context pointer is passed to success or failure callback functions to - * provide access to the context information in the callback. - */ - void* context; - /** - * A token is returned from the call. It can be used to track - * the state of this request, both in the callbacks and in future calls - * such as ::MQTTAsync_waitForCompletion. This is output only - any - * change by the application will be ignored. - */ - MQTTAsync_token token; - /** - * A pointer to a callback function to be called if the API call successfully - * completes. Can be set to NULL, in which case no indication of successful - * completion will be received. - */ - MQTTAsync_onSuccess5* onSuccess5; - /** - * A pointer to a callback function to be called if the API call successfully - * completes. Can be set to NULL, in which case no indication of successful - * completion will be received. - */ - MQTTAsync_onFailure5* onFailure5; - /** - * MQTT V5 input properties - */ - MQTTProperties properties; - /* - * MQTT V5 subscribe options, when used with subscribe only. - */ - MQTTSubscribe_options subscribeOptions; - /* - * MQTT V5 subscribe option count, when used with subscribeMany only. - * The number of entries in the subscribe_options_list array. - */ - int subscribeOptionsCount; - /* - * MQTT V5 subscribe option array, when used with subscribeMany only. - */ - MQTTSubscribe_options* subscribeOptionsList; -} MQTTAsync_responseOptions; - -#define MQTTAsync_responseOptions_initializer { {'M', 'Q', 'T', 'R'}, 1, NULL, NULL, 0, 0, NULL, NULL, MQTTProperties_initializer, MQTTSubscribe_options_initializer, 0, NULL} - -/** A synonym for responseOptions to better reflect its usage since MQTT 5.0 */ -typedef struct MQTTAsync_responseOptions MQTTAsync_callOptions; -#define MQTTAsync_callOptions_initializer MQTTAsync_responseOptions_initializer - -/** - * This function sets the global callback functions for a specific client. - * If your client application doesn't use a particular callback, set the - * relevant parameter to NULL. Any necessary message acknowledgements and - * status communications are handled in the background without any intervention - * from the client application. If you do not set a messageArrived callback - * function, you will not be notified of the receipt of any messages as a - * result of a subscription. - * - * Note: The MQTT client must be disconnected when this function is - * called. - * @param handle A valid client handle from a successful call to - * MQTTAsync_create(). - * @param context A pointer to any application-specific context. The - * the context pointer is passed to each of the callback functions to - * provide access to the context information in the callback. - * @param cl A pointer to an MQTTAsync_connectionLost() callback - * function. You can set this to NULL if your application doesn't handle - * disconnections. - * @param ma A pointer to an MQTTAsync_messageArrived() callback - * function. If this callback is not set, an error will be returned. - * You must set this callback because otherwise there would be - * no way to deliver any incoming messages. - * @param dc A pointer to an MQTTAsync_deliveryComplete() callback - * function. You can set this to NULL if you do not want to check - * for successful delivery. - * @return ::MQTTASYNC_SUCCESS if the callbacks were correctly set, - * ::MQTTASYNC_FAILURE if an error occurred. - */ -LIBMQTT_API int MQTTAsync_setCallbacks(MQTTAsync handle, void* context, MQTTAsync_connectionLost* cl, - MQTTAsync_messageArrived* ma, MQTTAsync_deliveryComplete* dc); - -/** - * This function sets the callback function for a connection lost event for - * a specific client. Any necessary message acknowledgements and status - * communications are handled in the background without any intervention - * from the client application. - * - * Note: The MQTT client must be disconnected when this function is - * called. - * @param handle A valid client handle from a successful call to - * MQTTAsync_create(). - * @param context A pointer to any application-specific context. The - * the context pointer is passed the callback functions to provide - * access to the context information in the callback. - * @param cl A pointer to an MQTTAsync_connectionLost() callback - * function. You can set this to NULL if your application doesn't handle - * disconnections. - * @return ::MQTTASYNC_SUCCESS if the callbacks were correctly set, - * ::MQTTASYNC_FAILURE if an error occurred. - */ - -LIBMQTT_API int MQTTAsync_setConnectionLostCallback(MQTTAsync handle, void* context, - MQTTAsync_connectionLost* cl); - -/** - * This function sets the callback function for a message arrived event for - * a specific client. Any necessary message acknowledgements and status - * communications are handled in the background without any intervention - * from the client application. If you do not set a messageArrived callback - * function, you will not be notified of the receipt of any messages as a - * result of a subscription. - * - * Note: The MQTT client must be disconnected when this function is - * called. - * @param handle A valid client handle from a successful call to - * MQTTAsync_create(). - * @param context A pointer to any application-specific context. The - * the context pointer is passed to the callback functions to provide - * access to the context information in the callback. - * @param ma A pointer to an MQTTAsync_messageArrived() callback - * function. You can set this to NULL if your application doesn't handle - * receipt of messages. - * @return ::MQTTASYNC_SUCCESS if the callbacks were correctly set, - * ::MQTTASYNC_FAILURE if an error occurred. - */ -LIBMQTT_API int MQTTAsync_setMessageArrivedCallback(MQTTAsync handle, void* context, - MQTTAsync_messageArrived* ma); - -/** - * This function sets the callback function for a delivery complete event - * for a specific client. Any necessary message acknowledgements and status - * communications are handled in the background without any intervention - * from the client application. - * - * Note: The MQTT client must be disconnected when this function is - * called. - * @param handle A valid client handle from a successful call to - * MQTTAsync_create(). - * @param context A pointer to any application-specific context. The - * the context pointer is passed to the callback functions to provide - * access to the context information in the callback. - * @param dc A pointer to an MQTTAsync_deliveryComplete() callback - * function. You can set this to NULL if you do not want to check - * for successful delivery. - * @return ::MQTTASYNC_SUCCESS if the callbacks were correctly set, - * ::MQTTASYNC_FAILURE if an error occurred. - */ -LIBMQTT_API int MQTTAsync_setDeliveryCompleteCallback(MQTTAsync handle, void* context, - MQTTAsync_deliveryComplete* dc); - -/** - * Sets the MQTTAsync_connected() callback function for a client. - * @param handle A valid client handle from a successful call to - * MQTTAsync_create(). - * @param context A pointer to any application-specific context. The - * the context pointer is passed to each of the callback functions to - * provide access to the context information in the callback. - * @param co A pointer to an MQTTAsync_connected() callback - * function. NULL removes the callback setting. - * @return ::MQTTASYNC_SUCCESS if the callbacks were correctly set, - * ::MQTTASYNC_FAILURE if an error occurred. - */ -LIBMQTT_API int MQTTAsync_setConnected(MQTTAsync handle, void* context, MQTTAsync_connected* co); - - -/** - * Reconnects a client with the previously used connect options. Connect - * must have previously been called for this to work. - * @param handle A valid client handle from a successful call to - * MQTTAsync_create(). - * @return ::MQTTASYNC_SUCCESS if the callbacks were correctly set, - * ::MQTTASYNC_FAILURE if an error occurred. - */ -LIBMQTT_API int MQTTAsync_reconnect(MQTTAsync handle); - - -/** - * This function creates an MQTT client ready for connection to the - * specified server and using the specified persistent storage (see - * MQTTAsync_persistence). See also MQTTAsync_destroy(). - * @param handle A pointer to an ::MQTTAsync handle. The handle is - * populated with a valid client reference following a successful return from - * this function. - * @param serverURI A null-terminated string specifying the server to - * which the client will connect. It takes the form - * protocol://host:port where protocol must be: - *
- * @em tcp:// or @em mqtt:// - Insecure TCP - *
- * @em ssl:// or @em mqtts:// - Encrypted SSL/TLS - *
- * @em ws:// - Insecure websockets - *
- * @em wss:// - Secure web sockets - *
- * The TLS enabled prefixes (ssl, mqtts, wss) are only valid if a TLS - * version of the library is linked with. - * For host, you can specify either an IP address or a host name. For - * instance, to connect to a server running on the local machines with the - * default MQTT port, specify tcp://localhost:1883. - * @param clientId The client identifier passed to the server when the - * client connects to it. It is a null-terminated UTF-8 encoded string. - * @param persistence_type The type of persistence to be used by the client: - *
- * ::MQTTCLIENT_PERSISTENCE_NONE: Use in-memory persistence. If the device or - * system on which the client is running fails or is switched off, the current - * state of any in-flight messages is lost and some messages may not be - * delivered even at QoS1 and QoS2. - *
- * ::MQTTCLIENT_PERSISTENCE_DEFAULT: Use the default (file system-based) - * persistence mechanism. Status about in-flight messages is held in persistent - * storage and provides some protection against message loss in the case of - * unexpected failure. - *
- * ::MQTTCLIENT_PERSISTENCE_USER: Use an application-specific persistence - * implementation. Using this type of persistence gives control of the - * persistence mechanism to the application. The application has to implement - * the MQTTClient_persistence interface. - * @param persistence_context If the application uses - * ::MQTTCLIENT_PERSISTENCE_NONE persistence, this argument is unused and should - * be set to NULL. For ::MQTTCLIENT_PERSISTENCE_DEFAULT persistence, it - * should be set to the location of the persistence directory (if set - * to NULL, the persistence directory used is the working directory). - * Applications that use ::MQTTCLIENT_PERSISTENCE_USER persistence set this - * argument to point to a valid MQTTClient_persistence structure. - * @return ::MQTTASYNC_SUCCESS if the client is successfully created, otherwise - * an error code is returned. - */ -LIBMQTT_API int MQTTAsync_create(MQTTAsync* handle, const char* serverURI, const char* clientId, - int persistence_type, void* persistence_context); - -/** Options for the ::MQTTAsync_createWithOptions call */ -typedef struct -{ - /** The eyecatcher for this structure. must be MQCO. */ - char struct_id[4]; - /** The version number of this structure. Must be 0, 1, 2 or 3 - * 0 means no MQTTVersion - * 1 means no allowDisconnectedSendAtAnyTime, deleteOldestMessages, restoreMessages - * 2 means no persistQoS0 - */ - int struct_version; - /** Whether to allow messages to be sent when the client library is not connected. */ - int sendWhileDisconnected; - /** The maximum number of messages allowed to be buffered. This is intended to be used to - * limit the number of messages queued while the client is not connected. It also applies - * when the client is connected, however, so has to be greater than 0. */ - int maxBufferedMessages; - /** Whether the MQTT version is 3.1, 3.1.1, or 5. To use V5, this must be set. - * MQTT V5 has to be chosen here, because during the create call the message persistence - * is initialized, and we want to know whether the format of any persisted messages - * is appropriate for the MQTT version we are going to connect with. Selecting 3.1 or - * 3.1.1 and attempting to read 5.0 persisted messages will result in an error on create. */ - int MQTTVersion; - /** - * Allow sending of messages while disconnected before a first successful connect. - */ - int allowDisconnectedSendAtAnyTime; - /* - * When the maximum number of buffered messages is reached, delete the oldest rather than the newest. - */ - int deleteOldestMessages; - /* - * Restore messages from persistence on create - or clear it. - */ - int restoreMessages; - /* - * Persist QoS0 publish commands - an option to not persist them. - */ - int persistQoS0; -} MQTTAsync_createOptions; - -#define MQTTAsync_createOptions_initializer { {'M', 'Q', 'C', 'O'}, 2, 0, 100, MQTTVERSION_DEFAULT, 0, 0, 1, 1} - -#define MQTTAsync_createOptions_initializer5 { {'M', 'Q', 'C', 'O'}, 2, 0, 100, MQTTVERSION_5, 0, 0, 1, 1} - - -LIBMQTT_API int MQTTAsync_createWithOptions(MQTTAsync* handle, const char* serverURI, const char* clientId, - int persistence_type, void* persistence_context, MQTTAsync_createOptions* options); - -/** - * MQTTAsync_willOptions defines the MQTT "Last Will and Testament" (LWT) settings for - * the client. In the event that a client unexpectedly loses its connection to - * the server, the server publishes the LWT message to the LWT topic on - * behalf of the client. This allows other clients (subscribed to the LWT topic) - * to be made aware that the client has disconnected. To enable the LWT - * function for a specific client, a valid pointer to an MQTTAsync_willOptions - * structure is passed in the MQTTAsync_connectOptions structure used in the - * MQTTAsync_connect() call that connects the client to the server. The pointer - * to MQTTAsync_willOptions can be set to NULL if the LWT function is not - * required. - */ -typedef struct -{ - /** The eyecatcher for this structure. must be MQTW. */ - char struct_id[4]; - /** The version number of this structure. Must be 0 or 1 - 0 indicates no binary will message support - */ - int struct_version; - /** The LWT topic to which the LWT message will be published. */ - const char* topicName; - /** The LWT payload. */ - const char* message; - /** - * The retained flag for the LWT message (see MQTTAsync_message.retained). - */ - int retained; - /** - * The quality of service setting for the LWT message (see - * MQTTAsync_message.qos and @ref qos). - */ - int qos; - /** The LWT payload in binary form. This is only checked and used if the message option is NULL */ - struct - { - int len; /**< binary payload length */ - const void* data; /**< binary payload data */ - } payload; -} MQTTAsync_willOptions; - -#define MQTTAsync_willOptions_initializer { {'M', 'Q', 'T', 'W'}, 1, NULL, NULL, 0, 0, { 0, NULL } } - -#define MQTT_SSL_VERSION_DEFAULT 0 -#define MQTT_SSL_VERSION_TLS_1_0 1 -#define MQTT_SSL_VERSION_TLS_1_1 2 -#define MQTT_SSL_VERSION_TLS_1_2 3 - -/** -* MQTTAsync_sslProperties defines the settings to establish an SSL/TLS connection using the -* OpenSSL library. It covers the following scenarios: -* - Server authentication: The client needs the digital certificate of the server. It is included -* in a store containting trusted material (also known as "trust store"). -* - Mutual authentication: Both client and server are authenticated during the SSL handshake. In -* addition to the digital certificate of the server in a trust store, the client will need its own -* digital certificate and the private key used to sign its digital certificate stored in a "key store". -* - Anonymous connection: Both client and server do not get authenticated and no credentials are needed -* to establish an SSL connection. Note that this scenario is not fully secure since it is subject to -* man-in-the-middle attacks. -*/ -typedef struct -{ - /** The eyecatcher for this structure. Must be MQTS */ - char struct_id[4]; - - /** The version number of this structure. Must be 0, 1, 2, 3, 4 or 5. - * 0 means no sslVersion - * 1 means no verify, CApath - * 2 means no ssl_error_context, ssl_error_cb - * 3 means no ssl_psk_cb, ssl_psk_context, disableDefaultTrustStore - * 4 means no protos, protos_len - */ - int struct_version; - - /** The file in PEM format containing the public digital certificates trusted by the client. */ - const char* trustStore; - - /** The file in PEM format containing the public certificate chain of the client. It may also include - * the client's private key. - */ - const char* keyStore; - - /** If not included in the sslKeyStore, this setting points to the file in PEM format containing - * the client's private key. - */ - const char* privateKey; - - /** The password to load the client's privateKey if encrypted. */ - const char* privateKeyPassword; - - /** - * The list of cipher suites that the client will present to the server during the SSL handshake. For a - * full explanation of the cipher list format, please see the OpenSSL on-line documentation: - * http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT - * If this setting is ommitted, its default value will be "ALL", that is, all the cipher suites -excluding - * those offering no encryption- will be considered. - * This setting can be used to set an SSL anonymous connection ("aNULL" string value, for instance). - */ - const char* enabledCipherSuites; - - /** True/False option to enable verification of the server certificate **/ - int enableServerCertAuth; - - /** The SSL/TLS version to use. Specify one of MQTT_SSL_VERSION_DEFAULT (0), - * MQTT_SSL_VERSION_TLS_1_0 (1), MQTT_SSL_VERSION_TLS_1_1 (2) or MQTT_SSL_VERSION_TLS_1_2 (3). - * Only used if struct_version is >= 1. - */ - int sslVersion; - - /** - * Whether to carry out post-connect checks, including that a certificate - * matches the given host name. - * Exists only if struct_version >= 2 - */ - int verify; - - /** - * From the OpenSSL documentation: - * If CApath is not NULL, it points to a directory containing CA certificates in PEM format. - * Exists only if struct_version >= 2 - */ - const char* CApath; - - /** - * Callback function for OpenSSL error handler ERR_print_errors_cb - * Exists only if struct_version >= 3 - */ - int (*ssl_error_cb) (const char *str, size_t len, void *u); - - /** - * Application-specific contex for OpenSSL error handler ERR_print_errors_cb - * Exists only if struct_version >= 3 - */ - void* ssl_error_context; - - /** - * Callback function for setting TLS-PSK options. Parameters correspond to that of - * SSL_CTX_set_psk_client_callback, except for u which is the pointer ssl_psk_context. - * Exists only if struct_version >= 4 - */ - unsigned int (*ssl_psk_cb) (const char *hint, char *identity, unsigned int max_identity_len, unsigned char *psk, unsigned int max_psk_len, void *u); - - /** - * Application-specific contex for ssl_psk_cb - * Exists only if struct_version >= 4 - */ - void* ssl_psk_context; - - /** - * Don't load default SSL CA. Should be used together with PSK to make sure - * regular servers with certificate in place is not accepted. - * Exists only if struct_version >= 4 - */ - int disableDefaultTrustStore; - - /** - * The protocol-lists must be in wire-format, which is defined as a vector of non-empty, 8-bit length-prefixed, byte strings. - * The length-prefix byte is not included in the length. Each string is limited to 255 bytes. A byte-string length of 0 is invalid. - * A truncated byte-string is invalid. - * Check documentation for SSL_CTX_set_alpn_protos - * Exists only if struct_version >= 5 - */ - const unsigned char *protos; - - /** - * The length of the vector protos vector - * Exists only if struct_version >= 5 - */ - unsigned int protos_len; -} MQTTAsync_SSLOptions; - -#define MQTTAsync_SSLOptions_initializer { {'M', 'Q', 'T', 'S'}, 5, NULL, NULL, NULL, NULL, NULL, 1, MQTT_SSL_VERSION_DEFAULT, 0, NULL, NULL, NULL, NULL, NULL, 0, NULL, 0 } - -/** Utility structure where name/value pairs are needed */ -typedef struct -{ - const char* name; /**< name string */ - const char* value; /**< value string */ -} MQTTAsync_nameValue; - -/** - * MQTTAsync_connectOptions defines several settings that control the way the - * client connects to an MQTT server. - * - * Suitable default values are set in the following initializers: - * - MQTTAsync_connectOptions_initializer: for MQTT 3.1.1 non-WebSockets - * - MQTTAsync_connectOptions_initializer5: for MQTT 5.0 non-WebSockets - * - MQTTAsync_connectOptions_initializer_ws: for MQTT 3.1.1 WebSockets - * - MQTTAsync_connectOptions_initializer5_ws: for MQTT 5.0 WebSockets - */ -typedef struct -{ - /** The eyecatcher for this structure. must be MQTC. */ - char struct_id[4]; - /** The version number of this structure. Must be 0, 1, 2, 3 4 5 6, 7 or 8. - * 0 signifies no SSL options and no serverURIs - * 1 signifies no serverURIs - * 2 signifies no MQTTVersion - * 3 signifies no automatic reconnect options - * 4 signifies no binary password option (just string) - * 5 signifies no MQTTV5 properties - * 6 signifies no HTTP headers option - * 7 signifies no HTTP proxy and HTTPS proxy options - */ - int struct_version; - /** The "keep alive" interval, measured in seconds, defines the maximum time - * that should pass without communication between the client and the server - * The client will ensure that at least one message travels across the - * network within each keep alive period. In the absence of a data-related - * message during the time period, the client sends a very small MQTT - * "ping" message, which the server will acknowledge. The keep alive - * interval enables the client to detect when the server is no longer - * available without having to wait for the long TCP/IP timeout. - * Set to 0 if you do not want any keep alive processing. - */ - int keepAliveInterval; - /** - * This is a boolean value. The cleansession setting controls the behaviour - * of both the client and the server at connection and disconnection time. - * The client and server both maintain session state information. This - * information is used to ensure "at least once" and "exactly once" - * delivery, and "exactly once" receipt of messages. Session state also - * includes subscriptions created by an MQTT client. You can choose to - * maintain or discard state information between sessions. - * - * When cleansession is true, the state information is discarded at - * connect and disconnect. Setting cleansession to false keeps the state - * information. When you connect an MQTT client application with - * MQTTAsync_connect(), the client identifies the connection using the - * client identifier and the address of the server. The server checks - * whether session information for this client - * has been saved from a previous connection to the server. If a previous - * session still exists, and cleansession=true, then the previous session - * information at the client and server is cleared. If cleansession=false, - * the previous session is resumed. If no previous session exists, a new - * session is started. - */ - int cleansession; - /** - * This controls how many messages can be in-flight simultaneously. - */ - int maxInflight; - /** - * This is a pointer to an MQTTAsync_willOptions structure. If your - * application does not make use of the Last Will and Testament feature, - * set this pointer to NULL. - */ - MQTTAsync_willOptions* will; - /** - * MQTT servers that support the MQTT v3.1 protocol provide authentication - * and authorisation by user name and password. This is the user name - * parameter. - */ - const char* username; - /** - * MQTT servers that support the MQTT v3.1 protocol provide authentication - * and authorisation by user name and password. This is the password - * parameter. - */ - const char* password; - /** - * The time interval in seconds to allow a connect to complete. - */ - int connectTimeout; - /** - * The time interval in seconds after which unacknowledged publish requests are - * retried during a TCP session. With MQTT 3.1.1 and later, retries are - * not required except on reconnect. 0 turns off in-session retries, and is the - * recommended setting. Adding retries to an already overloaded network only - * exacerbates the problem. - */ - int retryInterval; - /** - * This is a pointer to an MQTTAsync_SSLOptions structure. If your - * application does not make use of SSL, set this pointer to NULL. - */ - MQTTAsync_SSLOptions* ssl; - /** - * A pointer to a callback function to be called if the connect successfully - * completes. Can be set to NULL, in which case no indication of successful - * completion will be received. - */ - MQTTAsync_onSuccess* onSuccess; - /** - * A pointer to a callback function to be called if the connect fails. - * Can be set to NULL, in which case no indication of unsuccessful - * completion will be received. - */ - MQTTAsync_onFailure* onFailure; - /** - * A pointer to any application-specific context. The - * the context pointer is passed to success or failure callback functions to - * provide access to the context information in the callback. - */ - void* context; - /** - * The number of entries in the serverURIs array. - */ - int serverURIcount; - /** - * An array of null-terminated strings specifying the servers to - * which the client will connect. Each string takes the form protocol://host:port. - * protocol must be tcp, ssl, ws or wss. - * The TLS enabled prefixes (ssl, wss) are only valid if a TLS version of the library - * is linked with. - * For host, you can - * specify either an IP address or a domain name. For instance, to connect to - * a server running on the local machines with the default MQTT port, specify - * tcp://localhost:1883. - */ - char* const* serverURIs; - /** - * Sets the version of MQTT to be used on the connect. - * MQTTVERSION_DEFAULT (0) = default: start with 3.1.1, and if that fails, fall back to 3.1 - * MQTTVERSION_3_1 (3) = only try version 3.1 - * MQTTVERSION_3_1_1 (4) = only try version 3.1.1 - */ - int MQTTVersion; - /** - * Reconnect automatically in the case of a connection being lost. 0=false, 1=true - */ - int automaticReconnect; - /** - * The minimum automatic reconnect retry interval in seconds. Doubled on each failed retry. - */ - int minRetryInterval; - /** - * The maximum automatic reconnect retry interval in seconds. The doubling stops here on failed retries. - */ - int maxRetryInterval; - /** - * Optional binary password. Only checked and used if the password option is NULL - */ - struct { - int len; /**< binary password length */ - const void* data; /**< binary password data */ - } binarypwd; - /* - * MQTT V5 clean start flag. Only clears state at the beginning of the session. - */ - int cleanstart; - /** - * MQTT V5 properties for connect - */ - MQTTProperties *connectProperties; - /** - * MQTT V5 properties for the will message in the connect - */ - MQTTProperties *willProperties; - /** - * A pointer to a callback function to be called if the connect successfully - * completes. Can be set to NULL, in which case no indication of successful - * completion will be received. - */ - MQTTAsync_onSuccess5* onSuccess5; - /** - * A pointer to a callback function to be called if the connect fails. - * Can be set to NULL, in which case no indication of unsuccessful - * completion will be received. - */ - MQTTAsync_onFailure5* onFailure5; - /** - * HTTP headers for websockets - */ - const MQTTAsync_nameValue* httpHeaders; - /** - * HTTP proxy - */ - const char* httpProxy; - /** - * HTTPS proxy - */ - const char* httpsProxy; -} MQTTAsync_connectOptions; - -/** Initializer for connect options for MQTT 3.1.1 non-WebSocket connections */ -#define MQTTAsync_connectOptions_initializer { {'M', 'Q', 'T', 'C'}, 8, 60, 1, 65535, NULL, NULL, NULL, 30, 0,\ -NULL, NULL, NULL, NULL, 0, NULL, MQTTVERSION_DEFAULT, 0, 1, 60, {0, NULL}, 0, NULL, NULL, NULL, NULL, NULL, NULL, NULL} - -/** Initializer for connect options for MQTT 5.0 non-WebSocket connections */ -#define MQTTAsync_connectOptions_initializer5 { {'M', 'Q', 'T', 'C'}, 8, 60, 0, 65535, NULL, NULL, NULL, 30, 0,\ -NULL, NULL, NULL, NULL, 0, NULL, MQTTVERSION_5, 0, 1, 60, {0, NULL}, 1, NULL, NULL, NULL, NULL, NULL, NULL, NULL} - -/** Initializer for connect options for MQTT 3.1.1 WebSockets connections. - * The keepalive interval is set to 45 seconds to avoid webserver 60 second inactivity timeouts. - */ -#define MQTTAsync_connectOptions_initializer_ws { {'M', 'Q', 'T', 'C'}, 8, 45, 1, 65535, NULL, NULL, NULL, 30, 0,\ -NULL, NULL, NULL, NULL, 0, NULL, MQTTVERSION_DEFAULT, 0, 1, 60, {0, NULL}, 0, NULL, NULL, NULL, NULL, NULL, NULL, NULL} - -/** Initializer for connect options for MQTT 5.0 WebSockets connections. - * The keepalive interval is set to 45 seconds to avoid webserver 60 second inactivity timeouts. - */ -#define MQTTAsync_connectOptions_initializer5_ws { {'M', 'Q', 'T', 'C'}, 8, 45, 0, 65535, NULL, NULL, NULL, 30, 0,\ -NULL, NULL, NULL, NULL, 0, NULL, MQTTVERSION_5, 0, 1, 60, {0, NULL}, 1, NULL, NULL, NULL, NULL, NULL, NULL, NULL} - - -/** - * This function attempts to connect a previously-created client (see - * MQTTAsync_create()) to an MQTT server using the specified options. If you - * want to enable asynchronous message and status notifications, you must call - * MQTTAsync_setCallbacks() prior to MQTTAsync_connect(). - * @param handle A valid client handle from a successful call to - * MQTTAsync_create(). - * @param options A pointer to a valid MQTTAsync_connectOptions - * structure. - * @return ::MQTTASYNC_SUCCESS if the client connect request was accepted. - * If the client was unable to connect to the server, an error code is - * returned via the onFailure callback, if set. - * Error codes greater than 0 are returned by the MQTT protocol:

- * 1: Connection refused: Unacceptable protocol version
- * 2: Connection refused: Identifier rejected
- * 3: Connection refused: Server unavailable
- * 4: Connection refused: Bad user name or password
- * 5: Connection refused: Not authorized
- * 6-255: Reserved for future use
- */ -LIBMQTT_API int MQTTAsync_connect(MQTTAsync handle, const MQTTAsync_connectOptions* options); - -/** Options for the ::MQTTAsync_disconnect call */ -typedef struct -{ - /** The eyecatcher for this structure. Must be MQTD. */ - char struct_id[4]; - /** The version number of this structure. Must be 0 or 1. 0 signifies no V5 properties */ - int struct_version; - /** - * The client delays disconnection for up to this time (in - * milliseconds) in order to allow in-flight message transfers to complete. - */ - int timeout; - /** - * A pointer to a callback function to be called if the disconnect successfully - * completes. Can be set to NULL, in which case no indication of successful - * completion will be received. - */ - MQTTAsync_onSuccess* onSuccess; - /** - * A pointer to a callback function to be called if the disconnect fails. - * Can be set to NULL, in which case no indication of unsuccessful - * completion will be received. - */ - MQTTAsync_onFailure* onFailure; - /** - * A pointer to any application-specific context. The - * the context pointer is passed to success or failure callback functions to - * provide access to the context information in the callback. - */ - void* context; - /** - * MQTT V5 input properties - */ - MQTTProperties properties; - /** - * Reason code for MQTTV5 disconnect - */ - enum MQTTReasonCodes reasonCode; - /** - * A pointer to a callback function to be called if the disconnect successfully - * completes. Can be set to NULL, in which case no indication of successful - * completion will be received. - */ - MQTTAsync_onSuccess5* onSuccess5; - /** - * A pointer to a callback function to be called if the disconnect fails. - * Can be set to NULL, in which case no indication of unsuccessful - * completion will be received. - */ - MQTTAsync_onFailure5* onFailure5; -} MQTTAsync_disconnectOptions; - -#define MQTTAsync_disconnectOptions_initializer { {'M', 'Q', 'T', 'D'}, 0, 0, NULL, NULL, NULL,\ - MQTTProperties_initializer, MQTTREASONCODE_SUCCESS, NULL, NULL } - -#define MQTTAsync_disconnectOptions_initializer5 { {'M', 'Q', 'T', 'D'}, 1, 0, NULL, NULL, NULL,\ - MQTTProperties_initializer, MQTTREASONCODE_SUCCESS, NULL, NULL } - -/** - * This function attempts to disconnect the client from the MQTT - * server. In order to allow the client time to complete handling of messages - * that are in-flight when this function is called, a timeout period is - * specified. When the timeout period has expired, the client disconnects even - * if there are still outstanding message acknowledgements. - * The next time the client connects to the same server, any QoS 1 or 2 - * messages which have not completed will be retried depending on the - * cleansession settings for both the previous and the new connection (see - * MQTTAsync_connectOptions.cleansession and MQTTAsync_connect()). - * @param handle A valid client handle from a successful call to - * MQTTAsync_create(). - * @param options The client delays disconnection for up to this time (in - * milliseconds) in order to allow in-flight message transfers to complete. - * @return ::MQTTASYNC_SUCCESS if the client successfully disconnects from - * the server. An error code is returned if the client was unable to disconnect - * from the server - */ -LIBMQTT_API int MQTTAsync_disconnect(MQTTAsync handle, const MQTTAsync_disconnectOptions* options); - - -/** - * This function allows the client application to test whether or not a - * client is currently connected to the MQTT server. - * @param handle A valid client handle from a successful call to - * MQTTAsync_create(). - * @return Boolean true if the client is connected, otherwise false. - */ -LIBMQTT_API int MQTTAsync_isConnected(MQTTAsync handle); - - -/** - * This function attempts to subscribe a client to a single topic, which may - * contain wildcards (see @ref wildcard). This call also specifies the - * @ref qos requested for the subscription - * (see also MQTTAsync_subscribeMany()). - * @param handle A valid client handle from a successful call to - * MQTTAsync_create(). - * @param topic The subscription topic, which may include wildcards. - * @param qos The requested quality of service for the subscription. - * @param response A pointer to a response options structure. Used to set callback functions. - * @return ::MQTTASYNC_SUCCESS if the subscription request is successful. - * An error code is returned if there was a problem registering the - * subscription. - */ -LIBMQTT_API int MQTTAsync_subscribe(MQTTAsync handle, const char* topic, int qos, MQTTAsync_responseOptions* response); - - -/** - * This function attempts to subscribe a client to a list of topics, which may - * contain wildcards (see @ref wildcard). This call also specifies the - * @ref qos requested for each topic (see also MQTTAsync_subscribe()). - * @param handle A valid client handle from a successful call to - * MQTTAsync_create(). - * @param count The number of topics for which the client is requesting - * subscriptions. - * @param topic An array (of length count) of pointers to - * topics, each of which may include wildcards. - * @param qos An array (of length count) of @ref qos - * values. qos[n] is the requested QoS for topic[n]. - * @param response A pointer to a response options structure. Used to set callback functions. - * @return ::MQTTASYNC_SUCCESS if the subscription request is successful. - * An error code is returned if there was a problem registering the - * subscriptions. - */ -LIBMQTT_API int MQTTAsync_subscribeMany(MQTTAsync handle, int count, char* const* topic, const int* qos, MQTTAsync_responseOptions* response); - -/** - * This function attempts to remove an existing subscription made by the - * specified client. - * @param handle A valid client handle from a successful call to - * MQTTAsync_create(). - * @param topic The topic for the subscription to be removed, which may - * include wildcards (see @ref wildcard). - * @param response A pointer to a response options structure. Used to set callback functions. - * @return ::MQTTASYNC_SUCCESS if the subscription is removed. - * An error code is returned if there was a problem removing the - * subscription. - */ -LIBMQTT_API int MQTTAsync_unsubscribe(MQTTAsync handle, const char* topic, MQTTAsync_responseOptions* response); - -/** - * This function attempts to remove existing subscriptions to a list of topics - * made by the specified client. - * @param handle A valid client handle from a successful call to - * MQTTAsync_create(). - * @param count The number subscriptions to be removed. - * @param topic An array (of length count) of pointers to the topics of - * the subscriptions to be removed, each of which may include wildcards. - * @param response A pointer to a response options structure. Used to set callback functions. - * @return ::MQTTASYNC_SUCCESS if the subscriptions are removed. - * An error code is returned if there was a problem removing the subscriptions. - */ -LIBMQTT_API int MQTTAsync_unsubscribeMany(MQTTAsync handle, int count, char* const* topic, MQTTAsync_responseOptions* response); - - -/** - * This function attempts to publish a message to a given topic (see also - * ::MQTTAsync_sendMessage()). An ::MQTTAsync_token is issued when - * this function returns successfully if the QoS is greater than 0. - * If the client application needs to - * test for successful delivery of messages, a callback should be set - * (see ::MQTTAsync_onSuccess() and ::MQTTAsync_deliveryComplete()). - * @param handle A valid client handle from a successful call to - * MQTTAsync_create(). - * @param destinationName The topic associated with this message. - * @param payloadlen The length of the payload in bytes. - * @param payload A pointer to the byte array payload of the message. - * @param qos The @ref qos of the message. - * @param retained The retained flag for the message. - * @param response A pointer to an ::MQTTAsync_responseOptions structure. Used to set callback functions. - * This is optional and can be set to NULL. - * @return ::MQTTASYNC_SUCCESS if the message is accepted for publication. - * An error code is returned if there was a problem accepting the message. - */ -LIBMQTT_API int MQTTAsync_send(MQTTAsync handle, const char* destinationName, int payloadlen, const void* payload, int qos, - int retained, MQTTAsync_responseOptions* response); - -/** - * This function attempts to publish a message to a given topic (see also - * MQTTAsync_publish()). An ::MQTTAsync_token is issued when - * this function returns successfully if the QoS is greater than 0. - * If the client application needs to - * test for successful delivery of messages, a callback should be set - * (see ::MQTTAsync_onSuccess() and ::MQTTAsync_deliveryComplete()). - * @param handle A valid client handle from a successful call to - * MQTTAsync_create(). - * @param destinationName The topic associated with this message. - * @param msg A pointer to a valid MQTTAsync_message structure containing - * the payload and attributes of the message to be published. - * @param response A pointer to an ::MQTTAsync_responseOptions structure. Used to set callback functions. - * @return ::MQTTASYNC_SUCCESS if the message is accepted for publication. - * An error code is returned if there was a problem accepting the message. - */ -LIBMQTT_API int MQTTAsync_sendMessage(MQTTAsync handle, const char* destinationName, const MQTTAsync_message* msg, MQTTAsync_responseOptions* response); - - -/** - * This function sets a pointer to an array of tokens for - * messages that are currently in-flight (pending completion). - * - * Important note: The memory used to hold the array of tokens is - * malloc()'d in this function. The client application is responsible for - * freeing this memory when it is no longer required. - * @param handle A valid client handle from a successful call to - * MQTTAsync_create(). - * @param tokens The address of a pointer to an ::MQTTAsync_token. - * When the function returns successfully, the pointer is set to point to an - * array of tokens representing messages pending completion. The last member of - * the array is set to -1 to indicate there are no more tokens. If no tokens - * are pending, the pointer is set to NULL. - * @return ::MQTTASYNC_SUCCESS if the function returns successfully. - * An error code is returned if there was a problem obtaining the list of - * pending tokens. - */ -LIBMQTT_API int MQTTAsync_getPendingTokens(MQTTAsync handle, MQTTAsync_token **tokens); - -/** - * Tests whether a request corresponding to a token is complete. - * - * @param handle A valid client handle from a successful call to - * MQTTAsync_create(). - * @param token An ::MQTTAsync_token associated with a request. - * @return 1 if the request has been completed, 0 if not. - */ -#define MQTTASYNC_TRUE 1 -LIBMQTT_API int MQTTAsync_isComplete(MQTTAsync handle, MQTTAsync_token token); - - -/** - * Waits for a request corresponding to a token to complete. This only works for - * messages with QoS greater than 0. A QoS 0 message has no MQTT token. - * This function will always return ::MQTTASYNC_SUCCESS for a QoS 0 message. - * - * @param handle A valid client handle from a successful call to - * MQTTAsync_create(). - * @param token An ::MQTTAsync_token associated with a request. - * @param timeout the maximum time to wait for completion, in milliseconds - * @return ::MQTTASYNC_SUCCESS if the request has been completed in the time allocated, - * ::MQTTASYNC_FAILURE or ::MQTTASYNC_DISCONNECTED if not. - */ -LIBMQTT_API int MQTTAsync_waitForCompletion(MQTTAsync handle, MQTTAsync_token token, unsigned long timeout); - - -/** - * This function frees memory allocated to an MQTT message, including the - * additional memory allocated to the message payload. The client application - * calls this function when the message has been fully processed. Important - * note: This function does not free the memory allocated to a message - * topic string. It is the responsibility of the client application to free - * this memory using the MQTTAsync_free() library function. - * @param msg The address of a pointer to the ::MQTTAsync_message structure - * to be freed. - */ -LIBMQTT_API void MQTTAsync_freeMessage(MQTTAsync_message** msg); - -/** - * This function frees memory allocated by the MQTT C client library, especially the - * topic name. This is needed on Windows when the client library and application - * program have been compiled with different versions of the C compiler. It is - * thus good policy to always use this function when freeing any MQTT C client- - * allocated memory. - * @param ptr The pointer to the client library storage to be freed. - */ -LIBMQTT_API void MQTTAsync_free(void* ptr); - -/** - * This function is used to allocate memory to be used or freed by the MQTT C client library, - * especially the data in the ::MQTTPersistence_afterRead and ::MQTTPersistence_beforeWrite - * callbacks. This is needed on Windows when the client library and application - * program have been compiled with different versions of the C compiler. - * @param size The size of the memory to be allocated. - */ -LIBMQTT_API void* MQTTAsync_malloc(size_t size); - -/** - * This function frees the memory allocated to an MQTT client (see - * MQTTAsync_create()). It should be called when the client is no longer - * required. - * @param handle A pointer to the handle referring to the ::MQTTAsync - * structure to be freed. - */ -LIBMQTT_API void MQTTAsync_destroy(MQTTAsync* handle); - - - -enum MQTTASYNC_TRACE_LEVELS -{ - MQTTASYNC_TRACE_MAXIMUM = 1, - MQTTASYNC_TRACE_MEDIUM, - MQTTASYNC_TRACE_MINIMUM, - MQTTASYNC_TRACE_PROTOCOL, - MQTTASYNC_TRACE_ERROR, - MQTTASYNC_TRACE_SEVERE, - MQTTASYNC_TRACE_FATAL, -}; - - -/** - * This function sets the level of trace information which will be - * returned in the trace callback. - * @param level the trace level required - */ -LIBMQTT_API void MQTTAsync_setTraceLevel(enum MQTTASYNC_TRACE_LEVELS level); - - -/** - * This is a callback function prototype which must be implemented if you want - * to receive trace information. Do not invoke any other Paho API calls in this - * callback function - unpredictable behavior may result. - * @param level the trace level of the message returned - * @param message the trace message. This is a pointer to a static buffer which - * will be overwritten on each call. You must copy the data if you want to keep - * it for later. - */ -typedef void MQTTAsync_traceCallback(enum MQTTASYNC_TRACE_LEVELS level, char* message); - -/** - * This function sets the trace callback if needed. If set to NULL, - * no trace information will be returned. The default trace level is - * MQTTASYNC_TRACE_MINIMUM. - * @param callback a pointer to the function which will handle the trace information - */ -LIBMQTT_API void MQTTAsync_setTraceCallback(MQTTAsync_traceCallback* callback); - -/** - * This function returns version information about the library. - * no trace information will be returned. The default trace level is - * MQTTASYNC_TRACE_MINIMUM - * @return an array of strings describing the library. The last entry is a NULL pointer. - */ -LIBMQTT_API MQTTAsync_nameValue* MQTTAsync_getVersionInfo(void); - -/** - * Returns a pointer to a string representation of the error code, or NULL. - * Do not free after use. Returns NULL if the error code is unknown. - * @param code the MQTTASYNC_ return code. - * @return a static string representation of the error code. - */ -LIBMQTT_API const char* MQTTAsync_strerror(int code); - - -/*! - * @cond MQTTAsync_main - * @page async Threading - * The client application runs on several threads. - * Processing of handshaking and maintaining - * the network connection is performed in the background. - * This API is thread safe: functions may be called by multiple application - * threads. - * Notifications of status and message reception are provided to the client - * application using callbacks registered with the library by the call to - * MQTTAsync_setCallbacks() (see MQTTAsync_messageArrived(), - * MQTTAsync_connectionLost() and MQTTAsync_deliveryComplete()). - * In addition, some functions allow success and failure callbacks to be set - * for individual requests, in the ::MQTTAsync_responseOptions structure. Applications - * can be written as a chain of callback functions. - * - * @page callbacks Callbacks - * Any function from this API may be used within a callback. It is not advisable to - * use ::MQTTAsync_waitForCompletion within a callback, however, as it is the only - * API call that may take some time to complete, which may cause unpredictable - * behaviour. All the other API calls are intended to complete quickly, starting - * a request in the background, with success or failure notified by other callbacks. - * - * If no callbacks are assigned, this will include the message arrived callback. - * This could be done if the application is a pure publisher, and does - * not subscribe to any topics. If however messages are received, and no message - * arrived callback is set, then those messages will accumulate - * and take up memory, as there is no place for them to be delivered. - * A log message will be written to highlight the issue, but it is up - * to the application to protect against this situation. - * - * @page auto_reconnect Automatic Reconnect - * The ability for the client library to reconnect automatically in the event - * of a connection failure was added in 1.1. The connection lost callback - * allows a flexible response to the loss of a connection, so almost any - * behaviour can be implemented in that way. Automatic reconnect does have the - * advantage of being a little simpler to use. - * - * To switch on automatic reconnect, the connect options field - * automaticReconnect should be set to non-zero. The minimum and maximum times - * before the next connection attempt can also be set, the defaults being 1 and - * 60 seconds. At each failure to reconnect, the retry interval is doubled until - * the maximum value is reached, and there it stays until the connection is - * successfully re-established whereupon it is reset. - * - * When a reconnection attempt is successful, the ::MQTTAsync_connected callback - * function is invoked, if set by calling ::MQTTAsync_setConnected. This allows - * the application to take any actions needed, such as amending subscriptions. - * - * @page offline_publish Publish While Disconnected - * This feature was not originally available because with persistence enabled, - * messages could be stored locally without ever knowing if they could be sent. - * The client application could have created the client with an erroneous broker - * address or port for instance. - * - * To enable messages to be published when the application is disconnected - * ::MQTTAsync_createWithOptions must be used instead of ::MQTTAsync_create to - * create the client object. The ::MQTTAsync_createOptions field sendWhileDisconnected - * must be set to non-zero, and the maxBufferedMessages field set as required - - * the default being 100. - * - * ::MQTTAsync_getPendingTokens can be called to return the ids of the messages - * waiting to be sent, or for which the sending process has not completed. - * - * @page wildcard Subscription wildcards - * Every MQTT message includes a topic that classifies it. MQTT servers use - * topics to determine which subscribers should receive messages published to - * the server. - * - * Consider the server receiving messages from several environmental sensors. - * Each sensor publishes its measurement data as a message with an associated - * topic. Subscribing applications need to know which sensor originally - * published each received message. A unique topic is thus used to identify - * each sensor and measurement type. Topics such as SENSOR1TEMP, - * SENSOR1HUMIDITY, SENSOR2TEMP and so on achieve this but are not very - * flexible. If additional sensors are added to the system at a later date, - * subscribing applications must be modified to receive them. - * - * To provide more flexibility, MQTT supports a hierarchical topic namespace. - * This allows application designers to organize topics to simplify their - * management. Levels in the hierarchy are delimited by the '/' character, - * such as SENSOR/1/HUMIDITY. Publishers and subscribers use these - * hierarchical topics as already described. - * - * For subscriptions, two wildcard characters are supported: - * - * Publishers are not allowed to use the wildcard characters in their topic - * names. - * - * Deciding on your topic hierarchy is an important step in your system design. - * - * @page qos Quality of service - * The MQTT protocol provides three qualities of service for delivering - * messages between clients and servers: "at most once", "at least once" and - * "exactly once". - * - * Quality of service (QoS) is an attribute of an individual message being - * published. An application sets the QoS for a specific message by setting the - * MQTTAsync_message.qos field to the required value. - * - * A subscribing client can set the maximum quality of service a server uses - * to send messages that match the client subscriptions. The - * MQTTAsync_subscribe() and MQTTAsync_subscribeMany() functions set this - * maximum. The QoS of a message forwarded to a subscriber thus might be - * different to the QoS given to the message by the original publisher. - * The lower of the two values is used to forward a message. - * - * The three levels are: - * - * QoS0, At most once: The message is delivered at most once, or it - * may not be delivered at all. Its delivery across the network is not - * acknowledged. The message is not stored. The message could be lost if the - * client is disconnected, or if the server fails. QoS0 is the fastest mode of - * transfer. It is sometimes called "fire and forget". - * - * The MQTT protocol does not require servers to forward publications at QoS0 - * to a client. If the client is disconnected at the time the server receives - * the publication, the publication might be discarded, depending on the - * server implementation. - * - * QoS1, At least once: The message is always delivered at least once. - * It might be delivered multiple times if there is a failure before an - * acknowledgment is received by the sender. The message must be stored - * locally at the sender, until the sender receives confirmation that the - * message has been published by the receiver. The message is stored in case - * the message must be sent again. - * - * QoS2, Exactly once: The message is always delivered exactly once. - * The message must be stored locally at the sender, until the sender receives - * confirmation that the message has been published by the receiver. The - * message is stored in case the message must be sent again. QoS2 is the - * safest, but slowest mode of transfer. A more sophisticated handshaking - * and acknowledgement sequence is used than for QoS1 to ensure no duplication - * of messages occurs. - * @page publish Publication example -@code -#include -#include -#include -#include "MQTTAsync.h" - -#if !defined(_WIN32) -#include -#else -#include -#endif - -#if defined(_WRS_KERNEL) -#include -#endif - -#define ADDRESS "tcp://mqtt.eclipseprojects.io:1883" -#define CLIENTID "ExampleClientPub" -#define TOPIC "MQTT Examples" -#define PAYLOAD "Hello World!" -#define QOS 1 -#define TIMEOUT 10000L - -int finished = 0; - -void connlost(void *context, char *cause) -{ - MQTTAsync client = (MQTTAsync)context; - MQTTAsync_connectOptions conn_opts = MQTTAsync_connectOptions_initializer; - int rc; - - printf("\nConnection lost\n"); - printf(" cause: %s\n", cause); - - printf("Reconnecting\n"); - conn_opts.keepAliveInterval = 20; - conn_opts.cleansession = 1; - if ((rc = MQTTAsync_connect(client, &conn_opts)) != MQTTASYNC_SUCCESS) - { - printf("Failed to start connect, return code %d\n", rc); - finished = 1; - } -} - -void onDisconnectFailure(void* context, MQTTAsync_failureData* response) -{ - printf("Disconnect failed\n"); - finished = 1; -} - -void onDisconnect(void* context, MQTTAsync_successData* response) -{ - printf("Successful disconnection\n"); - finished = 1; -} - -void onSendFailure(void* context, MQTTAsync_failureData* response) -{ - MQTTAsync client = (MQTTAsync)context; - MQTTAsync_disconnectOptions opts = MQTTAsync_disconnectOptions_initializer; - int rc; - - printf("Message send failed token %d error code %d\n", response->token, response->code); - opts.onSuccess = onDisconnect; - opts.onFailure = onDisconnectFailure; - opts.context = client; - if ((rc = MQTTAsync_disconnect(client, &opts)) != MQTTASYNC_SUCCESS) - { - printf("Failed to start disconnect, return code %d\n", rc); - exit(EXIT_FAILURE); - } -} - -void onSend(void* context, MQTTAsync_successData* response) -{ - MQTTAsync client = (MQTTAsync)context; - MQTTAsync_disconnectOptions opts = MQTTAsync_disconnectOptions_initializer; - int rc; - - printf("Message with token value %d delivery confirmed\n", response->token); - opts.onSuccess = onDisconnect; - opts.onFailure = onDisconnectFailure; - opts.context = client; - if ((rc = MQTTAsync_disconnect(client, &opts)) != MQTTASYNC_SUCCESS) - { - printf("Failed to start disconnect, return code %d\n", rc); - exit(EXIT_FAILURE); - } -} - - -void onConnectFailure(void* context, MQTTAsync_failureData* response) -{ - printf("Connect failed, rc %d\n", response ? response->code : 0); - finished = 1; -} - - -void onConnect(void* context, MQTTAsync_successData* response) -{ - MQTTAsync client = (MQTTAsync)context; - MQTTAsync_responseOptions opts = MQTTAsync_responseOptions_initializer; - MQTTAsync_message pubmsg = MQTTAsync_message_initializer; - int rc; - - printf("Successful connection\n"); - opts.onSuccess = onSend; - opts.onFailure = onSendFailure; - opts.context = client; - pubmsg.payload = PAYLOAD; - pubmsg.payloadlen = (int)strlen(PAYLOAD); - pubmsg.qos = QOS; - pubmsg.retained = 0; - if ((rc = MQTTAsync_sendMessage(client, TOPIC, &pubmsg, &opts)) != MQTTASYNC_SUCCESS) - { - printf("Failed to start sendMessage, return code %d\n", rc); - exit(EXIT_FAILURE); - } -} - -int messageArrived(void* context, char* topicName, int topicLen, MQTTAsync_message* m) -{ - // not expecting any messages - return 1; -} - -int main(int argc, char* argv[]) -{ - MQTTAsync client; - MQTTAsync_connectOptions conn_opts = MQTTAsync_connectOptions_initializer; - int rc; - - if ((rc = MQTTAsync_create(&client, ADDRESS, CLIENTID, MQTTCLIENT_PERSISTENCE_NONE, NULL)) != MQTTASYNC_SUCCESS) - { - printf("Failed to create client object, return code %d\n", rc); - exit(EXIT_FAILURE); - } - - if ((rc = MQTTAsync_setCallbacks(client, NULL, connlost, messageArrived, NULL)) != MQTTASYNC_SUCCESS) - { - printf("Failed to set callback, return code %d\n", rc); - exit(EXIT_FAILURE); - } - - conn_opts.keepAliveInterval = 20; - conn_opts.cleansession = 1; - conn_opts.onSuccess = onConnect; - conn_opts.onFailure = onConnectFailure; - conn_opts.context = client; - if ((rc = MQTTAsync_connect(client, &conn_opts)) != MQTTASYNC_SUCCESS) - { - printf("Failed to start connect, return code %d\n", rc); - exit(EXIT_FAILURE); - } - - printf("Waiting for publication of %s\n" - "on topic %s for client with ClientID: %s\n", - PAYLOAD, TOPIC, CLIENTID); - while (!finished) - #if defined(_WIN32) - Sleep(100); - #else - usleep(10000L); - #endif - - MQTTAsync_destroy(&client); - return rc; -} - - * @endcode - * @page subscribe Subscription example -@code -#include -#include -#include -#include "MQTTAsync.h" - -#if !defined(_WIN32) -#include -#else -#include -#endif - -#if defined(_WRS_KERNEL) -#include -#endif - -#define ADDRESS "tcp://mqtt.eclipseprojects.io:1883" -#define CLIENTID "ExampleClientSub" -#define TOPIC "MQTT Examples" -#define PAYLOAD "Hello World!" -#define QOS 1 -#define TIMEOUT 10000L - -int disc_finished = 0; -int subscribed = 0; -int finished = 0; - -void connlost(void *context, char *cause) -{ - MQTTAsync client = (MQTTAsync)context; - MQTTAsync_connectOptions conn_opts = MQTTAsync_connectOptions_initializer; - int rc; - - printf("\nConnection lost\n"); - if (cause) - printf(" cause: %s\n", cause); - - printf("Reconnecting\n"); - conn_opts.keepAliveInterval = 20; - conn_opts.cleansession = 1; - if ((rc = MQTTAsync_connect(client, &conn_opts)) != MQTTASYNC_SUCCESS) - { - printf("Failed to start connect, return code %d\n", rc); - finished = 1; - } -} - - -int msgarrvd(void *context, char *topicName, int topicLen, MQTTAsync_message *message) -{ - printf("Message arrived\n"); - printf(" topic: %s\n", topicName); - printf(" message: %.*s\n", message->payloadlen, (char*)message->payload); - MQTTAsync_freeMessage(&message); - MQTTAsync_free(topicName); - return 1; -} - -void onDisconnectFailure(void* context, MQTTAsync_failureData* response) -{ - printf("Disconnect failed, rc %d\n", response->code); - disc_finished = 1; -} - -void onDisconnect(void* context, MQTTAsync_successData* response) -{ - printf("Successful disconnection\n"); - disc_finished = 1; -} - -void onSubscribe(void* context, MQTTAsync_successData* response) -{ - printf("Subscribe succeeded\n"); - subscribed = 1; -} - -void onSubscribeFailure(void* context, MQTTAsync_failureData* response) -{ - printf("Subscribe failed, rc %d\n", response->code); - finished = 1; -} - - -void onConnectFailure(void* context, MQTTAsync_failureData* response) -{ - printf("Connect failed, rc %d\n", response->code); - finished = 1; -} - - -void onConnect(void* context, MQTTAsync_successData* response) -{ - MQTTAsync client = (MQTTAsync)context; - MQTTAsync_responseOptions opts = MQTTAsync_responseOptions_initializer; - int rc; - - printf("Successful connection\n"); - - printf("Subscribing to topic %s\nfor client %s using QoS%d\n\n" - "Press Q to quit\n\n", TOPIC, CLIENTID, QOS); - opts.onSuccess = onSubscribe; - opts.onFailure = onSubscribeFailure; - opts.context = client; - if ((rc = MQTTAsync_subscribe(client, TOPIC, QOS, &opts)) != MQTTASYNC_SUCCESS) - { - printf("Failed to start subscribe, return code %d\n", rc); - finished = 1; - } -} - - -int main(int argc, char* argv[]) -{ - MQTTAsync client; - MQTTAsync_connectOptions conn_opts = MQTTAsync_connectOptions_initializer; - MQTTAsync_disconnectOptions disc_opts = MQTTAsync_disconnectOptions_initializer; - int rc; - int ch; - - if ((rc = MQTTAsync_create(&client, ADDRESS, CLIENTID, MQTTCLIENT_PERSISTENCE_NONE, NULL)) - != MQTTASYNC_SUCCESS) - { - printf("Failed to create client, return code %d\n", rc); - rc = EXIT_FAILURE; - goto exit; - } - - if ((rc = MQTTAsync_setCallbacks(client, client, connlost, msgarrvd, NULL)) != MQTTASYNC_SUCCESS) - { - printf("Failed to set callbacks, return code %d\n", rc); - rc = EXIT_FAILURE; - goto destroy_exit; - } - - conn_opts.keepAliveInterval = 20; - conn_opts.cleansession = 1; - conn_opts.onSuccess = onConnect; - conn_opts.onFailure = onConnectFailure; - conn_opts.context = client; - if ((rc = MQTTAsync_connect(client, &conn_opts)) != MQTTASYNC_SUCCESS) - { - printf("Failed to start connect, return code %d\n", rc); - rc = EXIT_FAILURE; - goto destroy_exit; - } - - while (!subscribed && !finished) - #if defined(_WIN32) - Sleep(100); - #else - usleep(10000L); - #endif - - if (finished) - goto exit; - - do - { - ch = getchar(); - } while (ch!='Q' && ch != 'q'); - - disc_opts.onSuccess = onDisconnect; - disc_opts.onFailure = onDisconnectFailure; - if ((rc = MQTTAsync_disconnect(client, &disc_opts)) != MQTTASYNC_SUCCESS) - { - printf("Failed to start disconnect, return code %d\n", rc); - rc = EXIT_FAILURE; - goto destroy_exit; - } - while (!disc_finished) - { - #if defined(_WIN32) - Sleep(100); - #else - usleep(10000L); - #endif - } - -destroy_exit: - MQTTAsync_destroy(&client); -exit: - return rc; -} - - * @endcode -* @page tracing Tracing - * - * Runtime tracing can be controlled by environment variables or API calls. - * - * #### Environment variables - * - * Tracing is switched on by setting the MQTT_C_CLIENT_TRACE environment variable. - * A value of ON, or stdout, prints to stdout, any other value is interpreted as a file name to use. - * - * The amount of trace detail is controlled with the MQTT_C_CLIENT_TRACE_LEVEL environment - * variable - valid values are ERROR, PROTOCOL, MINIMUM, MEDIUM and MAXIMUM - * (from least to most verbose). - * - * The variable MQTT_C_CLIENT_TRACE_MAX_LINES limits the number of lines of trace that are output - * to a file. Two files are used at most, when they are full, the last one is overwritten with the - * new trace entries. The default size is 1000 lines. - * - * #### Trace API calls - * - * MQTTAsync_traceCallback() is used to set a callback function which is called whenever trace - * information is available. This will be the same information as that printed if the - * environment variables were used to control the trace. - * - * The MQTTAsync_setTraceLevel() calls is used to set the maximum level of trace entries that will be - * passed to the callback function. The levels are: - * 1. ::MQTTASYNC_TRACE_MAXIMUM - * 2. ::MQTTASYNC_TRACE_MEDIUM - * 3. ::MQTTASYNC_TRACE_MINIMUM - * 4. ::MQTTASYNC_TRACE_PROTOCOL - * 5. ::MQTTASYNC_TRACE_ERROR - * 6. ::MQTTASYNC_TRACE_SEVERE - * 7. ::MQTTASYNC_TRACE_FATAL - * - * Selecting ::MQTTASYNC_TRACE_MAXIMUM will cause all trace entries at all levels to be returned. - * Choosing ::MQTTASYNC_TRACE_ERROR will cause ERROR, SEVERE and FATAL trace entries to be returned - * to the callback function. - * - * ### MQTT Packet Tracing - * - * A feature that can be very useful is printing the MQTT packets that are sent and received. To - * achieve this, use the following environment variable settings: - * @code - MQTT_C_CLIENT_TRACE=ON - MQTT_C_CLIENT_TRACE_LEVEL=PROTOCOL - * @endcode - * The output you should see looks like this: - * @code - 20130528 155936.813 3 stdout-subscriber -> CONNECT cleansession: 1 (0) - 20130528 155936.813 3 stdout-subscriber <- CONNACK rc: 0 - 20130528 155936.813 3 stdout-subscriber -> SUBSCRIBE msgid: 1 (0) - 20130528 155936.813 3 stdout-subscriber <- SUBACK msgid: 1 - 20130528 155941.818 3 stdout-subscriber -> DISCONNECT (0) - * @endcode - * where the fields are: - * 1. date - * 2. time - * 3. socket number - * 4. client id - * 5. direction (-> from client to server, <- from server to client) - * 6. packet details - * - * ### Default Level Tracing - * - * This is an extract of a default level trace of a call to connect: - * @code - 19700101 010000.000 (1152206656) (0)> MQTTClient_connect:893 - 19700101 010000.000 (1152206656) (1)> MQTTClient_connectURI:716 - 20130528 160447.479 Connecting to serverURI localhost:1883 - 20130528 160447.479 (1152206656) (2)> MQTTProtocol_connect:98 - 20130528 160447.479 (1152206656) (3)> MQTTProtocol_addressPort:48 - 20130528 160447.479 (1152206656) (3)< MQTTProtocol_addressPort:73 - 20130528 160447.479 (1152206656) (3)> Socket_new:599 - 20130528 160447.479 New socket 4 for localhost, port 1883 - 20130528 160447.479 (1152206656) (4)> Socket_addSocket:163 - 20130528 160447.479 (1152206656) (5)> Socket_setnonblocking:73 - 20130528 160447.479 (1152206656) (5)< Socket_setnonblocking:78 (0) - 20130528 160447.479 (1152206656) (4)< Socket_addSocket:176 (0) - 20130528 160447.479 (1152206656) (4)> Socket_error:95 - 20130528 160447.479 (1152206656) (4)< Socket_error:104 (115) - 20130528 160447.479 Connect pending - 20130528 160447.479 (1152206656) (3)< Socket_new:683 (115) - 20130528 160447.479 (1152206656) (2)< MQTTProtocol_connect:131 (115) - * @endcode - * where the fields are: - * 1. date - * 2. time - * 3. thread id - * 4. function nesting level - * 5. function entry (>) or exit (<) - * 6. function name : line of source code file - * 7. return value (if there is one) - * - * ### Memory Allocation Tracing - * - * Setting the trace level to maximum causes memory allocations and frees to be traced along with - * the default trace entries, with messages like the following: - * @code - 20130528 161819.657 Allocating 16 bytes in heap at file /home/icraggs/workspaces/mqrtc/mqttv3c/src/MQTTPacket.c line 177 ptr 0x179f930 - - 20130528 161819.657 Freeing 16 bytes in heap at file /home/icraggs/workspaces/mqrtc/mqttv3c/src/MQTTPacket.c line 201, heap use now 896 bytes - * @endcode - * When the last MQTT client object is destroyed, if the trace is being recorded - * and all memory allocated by the client library has not been freed, an error message will be - * written to the trace. This can help with fixing memory leaks. The message will look like this: - * @code - 20130528 163909.208 Some memory not freed at shutdown, possible memory leak - 20130528 163909.208 Heap scan start, total 880 bytes - 20130528 163909.208 Heap element size 32, line 354, file /home/icraggs/workspaces/mqrtc/mqttv3c/src/MQTTPacket.c, ptr 0x260cb00 - 20130528 163909.208 Content - 20130528 163909.209 Heap scan end - * @endcode - * @endcond - */ - -#if defined(__cplusplus) - } -#endif - -#endif diff --git a/MQTTClient.h b/MQTTClient.h deleted file mode 100644 index a5dc7f2..0000000 --- a/MQTTClient.h +++ /dev/null @@ -1,1980 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2009, 2023 IBM Corp., Ian Craggs and others - * - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v2.0 - * and Eclipse Distribution License v1.0 which accompany this distribution. - * - * The Eclipse Public License is available at - * https://www.eclipse.org/legal/epl-2.0/ - * and the Eclipse Distribution License is available at - * http://www.eclipse.org/org/documents/edl-v10.php. - * - * Contributors: - * Ian Craggs - initial API and implementation and/or initial documentation - * Ian Craggs, Allan Stockdill-Mander - SSL updates - * Ian Craggs - multiple server connection support - * Ian Craggs - MQTT 3.1.1 support - * Ian Craggs - remove const from eyecatchers #168 - *******************************************************************************/ - -/** - * @cond MQTTClient_internal - * @mainpage MQTT Client Library Internals - * In the beginning there was one MQTT C client library, MQTTClient, as implemented in MQTTClient.c - * This library was designed to be easy to use for applications which didn't mind if some of the calls - * blocked for a while. For instance, the MQTTClient_connect call will block until a successful - * connection has completed, or a connection has failed, which could be as long as the "connection - * timeout" interval, whose default is 30 seconds. - * - * However in mobile devices and other windowing environments, blocking on the GUI thread is a bad - * thing as it causes the user interface to freeze. Hence a new API, MQTTAsync, implemented - * in MQTTAsync.c, was devised. There are no blocking calls in this library, so it is well suited - * to GUI and mobile environments, at the expense of some extra complexity. - * - * Both libraries are designed to be sparing in the use of threads. So multiple client objects are - * handled by one or two threads, with a select call in Socket_getReadySocket(), used to determine - * when a socket has incoming data. This API is thread safe: functions may be called by multiple application - * threads, with the exception of ::MQTTClient_yield and ::MQTTClient_receive, which are intended - * for single threaded environments only. - * - * @endcond - * @cond MQTTClient_main - * @mainpage MQTT Client library for C (MQTTClient) - * © Copyright 2009, 2023 IBM Corp., Ian Craggs and others - * - * @brief An MQTT client library in C. - * - * These pages describe the original more synchronous API which might be - * considered easier to use. Some of the calls will block. For the new - * totally asynchronous API where no calls block, which is especially suitable - * for use in windowed environments, see the - * MQTT C Client Asynchronous API Documentation. - * The MQTTClient API is not thread safe, whereas the MQTTAsync API is. - * - * An MQTT client application connects to MQTT-capable servers. - * A typical client is responsible for collecting information from a telemetry - * device and publishing the information to the server. It can also subscribe - * to topics, receive messages, and use this information to control the - * telemetry device. - * - * MQTT clients implement the published MQTT v3 protocol. You can write your own - * API to the MQTT protocol using the programming language and platform of your - * choice. This can be time-consuming and error-prone. - * - * To simplify writing MQTT client applications, this library encapsulates - * the MQTT v3 protocol for you. Using this library enables a fully functional - * MQTT client application to be written in a few lines of code. - * The information presented here documents the API provided - * by the MQTT Client library for C. - * - * Using the client
- * Applications that use the client library typically use a similar structure: - *
    - *
  • Create a client object
    • - *
  • Set the options to connect to an MQTT server
    • - *
  • Set up callback functions if multi-threaded (asynchronous mode) - * operation is being used (see @ref async).
    • - *
  • Subscribe to any topics the client needs to receive
    • - *
  • Repeat until finished:
    • - *
      - *
    • Publish any messages the client needs to
      • - *
    • Handle any incoming messages
      • - *
    - *
  • Disconnect the client
    • - *
  • Free any memory being used by the client
    • - *
- * Some simple examples are shown here: - *
    - *
  • @ref pubsync
    • - *
  • @ref pubasync
    • - *
  • @ref subasync
    • - *
- * Additional information about important concepts is provided here: - *
    - *
  • @ref async
    • - *
  • @ref callbacks
    • - *
  • @ref wildcard
    • - *
  • @ref qos
    • - *
  • @ref tracing
    • - *
- * @endcond - */ - -/* -/// @cond EXCLUDE -*/ -#if !defined(MQTTCLIENT_H) -#define MQTTCLIENT_H - -#if defined(__cplusplus) - extern "C" { -#endif - -#include -/* -/// @endcond -*/ - -#include "MQTTExportDeclarations.h" - -#include "MQTTProperties.h" -#include "MQTTReasonCodes.h" -#include "MQTTSubscribeOpts.h" -#if !defined(NO_PERSISTENCE) -#include "MQTTClientPersistence.h" -#endif - -/** - * Return code: No error. Indicates successful completion of an MQTT client - * operation. - */ -#define MQTTCLIENT_SUCCESS 0 -/** - * Return code: A generic error code indicating the failure of an MQTT client - * operation. - */ -#define MQTTCLIENT_FAILURE -1 - -/* error code -2 is MQTTCLIENT_PERSISTENCE_ERROR */ - -/** - * Return code: The client is disconnected. - */ -#define MQTTCLIENT_DISCONNECTED -3 -/** - * Return code: The maximum number of messages allowed to be simultaneously - * in-flight has been reached. - */ -#define MQTTCLIENT_MAX_MESSAGES_INFLIGHT -4 -/** - * Return code: An invalid UTF-8 string has been detected. - */ -#define MQTTCLIENT_BAD_UTF8_STRING -5 -/** - * Return code: A NULL parameter has been supplied when this is invalid. - */ -#define MQTTCLIENT_NULL_PARAMETER -6 -/** - * Return code: The topic has been truncated (the topic string includes - * embedded NULL characters). String functions will not access the full topic. - * Use the topic length value to access the full topic. - */ -#define MQTTCLIENT_TOPICNAME_TRUNCATED -7 -/** - * Return code: A structure parameter does not have the correct eyecatcher - * and version number. - */ -#define MQTTCLIENT_BAD_STRUCTURE -8 -/** - * Return code: A QoS value that falls outside of the acceptable range (0,1,2) - */ -#define MQTTCLIENT_BAD_QOS -9 -/** - * Return code: Attempting SSL connection using non-SSL version of library - */ -#define MQTTCLIENT_SSL_NOT_SUPPORTED -10 - /** - * Return code: unrecognized MQTT version - */ - #define MQTTCLIENT_BAD_MQTT_VERSION -11 -/** - * Return code: protocol prefix in serverURI should be: - * @li @em tcp:// or @em mqtt:// - Insecure TCP - * @li @em ssl:// or @em mqtts:// - Encrypted SSL/TLS - * @li @em ws:// - Insecure websockets - * @li @em wss:// - Secure web sockets - * The TLS enabled prefixes (ssl, mqtts, wss) are only valid if a TLS - * version of the library is linked with. - */ -#define MQTTCLIENT_BAD_PROTOCOL -14 - /** - * Return code: option not applicable to the requested version of MQTT - */ - #define MQTTCLIENT_BAD_MQTT_OPTION -15 - /** - * Return code: call not applicable to the requested version of MQTT - */ - #define MQTTCLIENT_WRONG_MQTT_VERSION -16 - /** - * Return code: 0 length will topic on connect - */ - #define MQTTCLIENT_0_LEN_WILL_TOPIC -17 - - -/** - * Default MQTT version to connect with. Use 3.1.1 then fall back to 3.1 - */ -#define MQTTVERSION_DEFAULT 0 -/** - * MQTT version to connect with: 3.1 - */ -#define MQTTVERSION_3_1 3 -/** - * MQTT version to connect with: 3.1.1 - */ -#define MQTTVERSION_3_1_1 4 - /** - * MQTT version to connect with: 5 - */ - #define MQTTVERSION_5 5 -/** - * Bad return code from subscribe, as defined in the 3.1.1 specification - */ -#define MQTT_BAD_SUBSCRIBE 0x80 - -/** - * Initialization options - */ -typedef struct -{ - /** The eyecatcher for this structure. Must be MQTG. */ - char struct_id[4]; - /** The version number of this structure. Must be 0 */ - int struct_version; - /** 1 = we do openssl init, 0 = leave it to the application */ - int do_openssl_init; -} MQTTClient_init_options; - -#define MQTTClient_init_options_initializer { {'M', 'Q', 'T', 'G'}, 0, 0 } - -/** - * Global init of mqtt library. Call once on program start to set global behaviour. - * do_openssl_init - if mqtt library should initialize OpenSSL (1) or rely on the caller to do it before using the library (0) - */ -LIBMQTT_API void MQTTClient_global_init(MQTTClient_init_options* inits); - -/** - * A handle representing an MQTT client. A valid client handle is available - * following a successful call to MQTTClient_create(). - */ -typedef void* MQTTClient; -/** - * A value representing an MQTT message. A delivery token is returned to the - * client application when a message is published. The token can then be used to - * check that the message was successfully delivered to its destination (see - * MQTTClient_publish(), - * MQTTClient_publishMessage(), - * MQTTClient_deliveryComplete(), - * MQTTClient_waitForCompletion() and - * MQTTClient_getPendingDeliveryTokens()). - */ -typedef int MQTTClient_deliveryToken; -typedef int MQTTClient_token; - -/** - * A structure representing the payload and attributes of an MQTT message. The - * message topic is not part of this structure (see MQTTClient_publishMessage(), - * MQTTClient_publish(), MQTTClient_receive(), MQTTClient_freeMessage() - * and MQTTClient_messageArrived()). - */ -typedef struct -{ - /** The eyecatcher for this structure. must be MQTM. */ - char struct_id[4]; - /** The version number of this structure. Must be 0 or 1 - * 0 indicates no message properties */ - int struct_version; - /** The length of the MQTT message payload in bytes. */ - int payloadlen; - /** A pointer to the payload of the MQTT message. */ - void* payload; - /** - * The quality of service (QoS) assigned to the message. - * There are three levels of QoS: - *
- *
QoS0
- *
Fire and forget - the message may not be delivered
- *
QoS1
- *
At least once - the message will be delivered, but may be - * delivered more than once in some circumstances.
- *
QoS2
- *
Once and one only - the message will be delivered exactly once.
- *
- */ - int qos; - /** - * The retained flag serves two purposes depending on whether the message - * it is associated with is being published or received. - * - * retained = true
- * For messages being published, a true setting indicates that the MQTT - * server should retain a copy of the message. The message will then be - * transmitted to new subscribers to a topic that matches the message topic. - * For subscribers registering a new subscription, the flag being true - * indicates that the received message is not a new one, but one that has - * been retained by the MQTT server. - * - * retained = false
- * For publishers, this indicates that this message should not be retained - * by the MQTT server. For subscribers, a false setting indicates this is - * a normal message, received as a result of it being published to the - * server. - */ - int retained; - /** - * The dup flag indicates whether or not this message is a duplicate. - * It is only meaningful when receiving QoS1 messages. When true, the - * client application should take appropriate action to deal with the - * duplicate message. - */ - int dup; - /** The message identifier is normally reserved for internal use by the - * MQTT client and server. - */ - int msgid; - /** - * The MQTT V5 properties associated with the message. - */ - MQTTProperties properties; -} MQTTClient_message; - -#define MQTTClient_message_initializer { {'M', 'Q', 'T', 'M'}, 1, 0, NULL, 0, 0, 0, 0, MQTTProperties_initializer } - -/** - * This is a callback function. The client application - * must provide an implementation of this function to enable asynchronous - * receipt of messages. The function is registered with the client library by - * passing it as an argument to MQTTClient_setCallbacks(). It is - * called by the client library when a new message that matches a client - * subscription has been received from the server. This function is executed on - * a separate thread to the one on which the client application is running. - * @param context A pointer to the context value originally passed to - * MQTTClient_setCallbacks(), which contains any application-specific context. - * @param topicName The topic associated with the received message. - * @param topicLen The length of the topic if there are one - * more NULL characters embedded in topicName, otherwise topicLen - * is 0. If topicLen is 0, the value returned by strlen(topicName) - * can be trusted. If topicLen is greater than 0, the full topic name - * can be retrieved by accessing topicName as a byte array of length - * topicLen. - * @param message The MQTTClient_message structure for the received message. - * This structure contains the message payload and attributes. - * @return This function must return 0 or 1 indicating whether or not - * the message has been safely received by the client application.
- * Returning 1 indicates that the message has been successfully handled. - * To free the message storage, ::MQTTClient_freeMessage must be called. - * To free the topic name storage, ::MQTTClient_free must be called.
- * Returning 0 indicates that there was a problem. In this - * case, the client library will reinvoke MQTTClient_messageArrived() to - * attempt to deliver the message to the application again. - * Do not free the message and topic storage when returning 0, otherwise - * the redelivery will fail. - */ -typedef int MQTTClient_messageArrived(void* context, char* topicName, int topicLen, MQTTClient_message* message); - -/** - * This is a callback function. The client application - * must provide an implementation of this function to enable asynchronous - * notification of delivery of messages. The function is registered with the - * client library by passing it as an argument to MQTTClient_setCallbacks(). - * It is called by the client library after the client application has - * published a message to the server. It indicates that the necessary - * handshaking and acknowledgements for the requested quality of service (see - * MQTTClient_message.qos) have been completed. This function is executed on a - * separate thread to the one on which the client application is running. - * Note:MQTTClient_deliveryComplete() is not called when messages are - * published at QoS0. - * @param context A pointer to the context value originally passed to - * MQTTClient_setCallbacks(), which contains any application-specific context. - * @param dt The ::MQTTClient_deliveryToken associated with - * the published message. Applications can check that all messages have been - * correctly published by matching the delivery tokens returned from calls to - * MQTTClient_publish() and MQTTClient_publishMessage() with the tokens passed - * to this callback. - */ -typedef void MQTTClient_deliveryComplete(void* context, MQTTClient_deliveryToken dt); - -/** - * This is a callback function. The client application - * must provide an implementation of this function to enable asynchronous - * notification of the loss of connection to the server. The function is - * registered with the client library by passing it as an argument to - * MQTTClient_setCallbacks(). It is called by the client library if the client - * loses its connection to the server. The client application must take - * appropriate action, such as trying to reconnect or reporting the problem. - * This function is executed on a separate thread to the one on which the - * client application is running. - * @param context A pointer to the context value originally passed to - * MQTTClient_setCallbacks(), which contains any application-specific context. - * @param cause The reason for the disconnection. - * Currently, cause is always set to NULL. - */ -typedef void MQTTClient_connectionLost(void* context, char* cause); - -/** - * This function sets the callback functions for a specific client. - * If your client application doesn't use a particular callback, set the - * relevant parameter to NULL. Calling MQTTClient_setCallbacks() puts the - * client into multi-threaded mode. Any necessary message acknowledgements and - * status communications are handled in the background without any intervention - * from the client application. See @ref async for more information. - * - * Note: The MQTT client must be disconnected when this function is - * called. - * @param handle A valid client handle from a successful call to - * MQTTClient_create(). - * @param context A pointer to any application-specific context. The - * the context pointer is passed to each of the callback functions to - * provide access to the context information in the callback. - * @param cl A pointer to an MQTTClient_connectionLost() callback - * function. You can set this to NULL if your application doesn't handle - * disconnections. - * @param ma A pointer to an MQTTClient_messageArrived() callback - * function. This callback function must be set when you call - * MQTTClient_setCallbacks(), as otherwise there would be nowhere to deliver - * any incoming messages. - * @param dc A pointer to an MQTTClient_deliveryComplete() callback - * function. You can set this to NULL if your application publishes - * synchronously or if you do not want to check for successful delivery. - * @return ::MQTTCLIENT_SUCCESS if the callbacks were correctly set, - * ::MQTTCLIENT_FAILURE if an error occurred. - */ -LIBMQTT_API int MQTTClient_setCallbacks(MQTTClient handle, void* context, MQTTClient_connectionLost* cl, - MQTTClient_messageArrived* ma, MQTTClient_deliveryComplete* dc); - - -/** - * This is a callback function, which will be called when the a disconnect - * packet is received from the server. This applies to MQTT V5 and above only. - * @param context A pointer to the context value originally passed to - * ::MQTTClient_setDisconnected(), which contains any application-specific context. - * @param properties The MQTT V5 properties received with the disconnect, if any. - * @param reasonCode The MQTT V5 reason code received with the disconnect. - * Currently, cause is always set to NULL. - */ -typedef void MQTTClient_disconnected(void* context, MQTTProperties* properties, - enum MQTTReasonCodes reasonCode); - -/** - * Sets the MQTTClient_disconnected() callback function for a client. This will be called - * if a disconnect packet is received from the server. Only valid for MQTT V5 and above. - * @param handle A valid client handle from a successful call to - * MQTTClient_create(). - * @param context A pointer to any application-specific context. The - * the context pointer is passed to each of the callback functions to - * provide access to the context information in the callback. - * @param co A pointer to an MQTTClient_disconnected() callback - * function. NULL removes the callback setting. - * @return ::MQTTCLIENT_SUCCESS if the callbacks were correctly set, - * ::MQTTCLIENT_FAILURE if an error occurred. - */ -LIBMQTT_API int MQTTClient_setDisconnected(MQTTClient handle, void* context, MQTTClient_disconnected* co); - -/** - * This is a callback function, the MQTT V5 version of MQTTClient_deliveryComplete(). - * The client application - * must provide an implementation of this function to enable asynchronous - * notification of the completed delivery of messages. - * It is called by the client library after the client application has - * published a message to the server. It indicates that the necessary - * handshaking and acknowledgements for the requested quality of service (see - * MQTTClient_message.qos) have been completed. This function is executed on a - * separate thread to the one on which the client application is running. - * Note: It is not called when messages are published at QoS0. - * @param context A pointer to the context value originally passed to - * MQTTClient_setCallbacks(), which contains any application-specific context. - * @param dt The ::MQTTClient_deliveryToken associated with - * the published message. Applications can check that all messages have been - * correctly published by matching the delivery tokens returned from calls to - * MQTTClient_publish() and MQTTClient_publishMessage() with the tokens passed - * to this callback. - * @param packet_type the last received packet type for this completion. For QoS 1 - * always PUBACK. For QoS 2 could be PUBREC or PUBCOMP. - * @param properties the MQTT V5 properties returned with the last packet from the server - * @param reasonCode the reason code returned from the server - */ -typedef void MQTTClient_published(void* context, int dt, int packet_type, MQTTProperties* properties, - enum MQTTReasonCodes reasonCode); - -LIBMQTT_API int MQTTClient_setPublished(MQTTClient handle, void* context, MQTTClient_published* co); - -/** - * This function creates an MQTT client ready for connection to the - * specified server and using the specified persistent storage (see - * MQTTClient_persistence). See also MQTTClient_destroy(). - * @param handle A pointer to an ::MQTTClient handle. The handle is - * populated with a valid client reference following a successful return from - * this function. - * @param serverURI A null-terminated string specifying the server to - * which the client will connect. It takes the form protocol://host:port. - * Currently, protocol must be: - *
- * @em tcp:// or @em mqtt:// - Insecure TCP - *
- * @em ssl:// or @em mqtts:// - Encrypted SSL/TLS - *
- * @em ws:// - Insecure websockets - *
- * @em wss:// - Secure web sockets - *
- * The TLS enabled prefixes (ssl, mqtts, wss) are only valid if a TLS - * version of the library is linked with. - * For host, you can specify either an IP address or a host name. For - * instance, to connect to a server running on the local machines with the - * default MQTT port, specify tcp://localhost:1883. - * @param clientId The client identifier passed to the server when the - * client connects to it. It is a null-terminated UTF-8 encoded string. - * @param persistence_type The type of persistence to be used by the client: - *
- * ::MQTTCLIENT_PERSISTENCE_NONE: Use in-memory persistence. If the device or - * system on which the client is running fails or is switched off, the current - * state of any in-flight messages is lost and some messages may not be - * delivered even at QoS1 and QoS2. - *
- * ::MQTTCLIENT_PERSISTENCE_DEFAULT: Use the default (file system-based) - * persistence mechanism. Status about in-flight messages is held in persistent - * storage and provides some protection against message loss in the case of - * unexpected failure. - *
- * ::MQTTCLIENT_PERSISTENCE_USER: Use an application-specific persistence - * implementation. Using this type of persistence gives control of the - * persistence mechanism to the application. The application has to implement - * the MQTTClient_persistence interface. - * @param persistence_context If the application uses - * ::MQTTCLIENT_PERSISTENCE_NONE persistence, this argument is unused and should - * be set to NULL. For ::MQTTCLIENT_PERSISTENCE_DEFAULT persistence, it - * should be set to the location of the persistence directory (if set - * to NULL, the persistence directory used is the working directory). - * Applications that use ::MQTTCLIENT_PERSISTENCE_USER persistence set this - * argument to point to a valid MQTTClient_persistence structure. - * @return ::MQTTCLIENT_SUCCESS if the client is successfully created, otherwise - * an error code is returned. - */ -LIBMQTT_API int MQTTClient_create(MQTTClient* handle, const char* serverURI, const char* clientId, - int persistence_type, void* persistence_context); - -/** Options for the ::MQTTClient_createWithOptions call */ -typedef struct -{ - /** The eyecatcher for this structure. must be MQCO. */ - char struct_id[4]; - /** The version number of this structure. Must be 0 */ - int struct_version; - /** Whether the MQTT version is 3.1, 3.1.1, or 5. To use V5, this must be set. - * MQTT V5 has to be chosen here, because during the create call the message persistence - * is initialized, and we want to know whether the format of any persisted messages - * is appropriate for the MQTT version we are going to connect with. Selecting 3.1 or - * 3.1.1 and attempting to read 5.0 persisted messages will result in an error on create. */ - int MQTTVersion; -} MQTTClient_createOptions; - -#define MQTTClient_createOptions_initializer { {'M', 'Q', 'C', 'O'}, 0, MQTTVERSION_DEFAULT } - -/** - * A version of :MQTTClient_create() with additional options. - * This function creates an MQTT client ready for connection to the - * specified server and using the specified persistent storage (see - * MQTTClient_persistence). See also MQTTClient_destroy(). - * @param handle A pointer to an ::MQTTClient handle. The handle is - * populated with a valid client reference following a successful return from - * this function. - * @param serverURI A null-terminated string specifying the server to - * which the client will connect. It takes the form protocol://host:port. - * Currently, protocol must be tcp or ssl. - * For host, you can - * specify either an IP address or a host name. For instance, to connect to - * a server running on the local machines with the default MQTT port, specify - * tcp://localhost:1883. - * @param clientId The client identifier passed to the server when the - * client connects to it. It is a null-terminated UTF-8 encoded string. - * @param persistence_type The type of persistence to be used by the client: - *
- * ::MQTTCLIENT_PERSISTENCE_NONE: Use in-memory persistence. If the device or - * system on which the client is running fails or is switched off, the current - * state of any in-flight messages is lost and some messages may not be - * delivered even at QoS1 and QoS2. - *
- * ::MQTTCLIENT_PERSISTENCE_DEFAULT: Use the default (file system-based) - * persistence mechanism. Status about in-flight messages is held in persistent - * storage and provides some protection against message loss in the case of - * unexpected failure. - *
- * ::MQTTCLIENT_PERSISTENCE_USER: Use an application-specific persistence - * implementation. Using this type of persistence gives control of the - * persistence mechanism to the application. The application has to implement - * the MQTTClient_persistence interface. - * @param persistence_context If the application uses - * ::MQTTCLIENT_PERSISTENCE_NONE persistence, this argument is unused and should - * be set to NULL. For ::MQTTCLIENT_PERSISTENCE_DEFAULT persistence, it - * should be set to the location of the persistence directory (if set - * to NULL, the persistence directory used is the working directory). - * Applications that use ::MQTTCLIENT_PERSISTENCE_USER persistence set this - * argument to point to a valid MQTTClient_persistence structure. - * @param options additional options for the create. - * @return ::MQTTCLIENT_SUCCESS if the client is successfully created, otherwise - * an error code is returned. - */ -LIBMQTT_API int MQTTClient_createWithOptions(MQTTClient* handle, const char* serverURI, const char* clientId, - int persistence_type, void* persistence_context, MQTTClient_createOptions* options); - -/** - * MQTTClient_willOptions defines the MQTT "Last Will and Testament" (LWT) settings for - * the client. In the event that a client unexpectedly loses its connection to - * the server, the server publishes the LWT message to the LWT topic on - * behalf of the client. This allows other clients (subscribed to the LWT topic) - * to be made aware that the client has disconnected. To enable the LWT - * function for a specific client, a valid pointer to an MQTTClient_willOptions - * structure is passed in the MQTTClient_connectOptions structure used in the - * MQTTClient_connect() call that connects the client to the server. The pointer - * to MQTTClient_willOptions can be set to NULL if the LWT function is not - * required. - */ -typedef struct -{ - /** The eyecatcher for this structure. must be MQTW. */ - char struct_id[4]; - /** The version number of this structure. Must be 0 or 1 - 0 means there is no binary payload option - */ - int struct_version; - /** The LWT topic to which the LWT message will be published. */ - const char* topicName; - /** The LWT payload in string form. */ - const char* message; - /** - * The retained flag for the LWT message (see MQTTClient_message.retained). - */ - int retained; - /** - * The quality of service setting for the LWT message (see - * MQTTClient_message.qos and @ref qos). - */ - int qos; - /** The LWT payload in binary form. This is only checked and used if the message option is NULL */ - struct - { - int len; /**< binary payload length */ - const void* data; /**< binary payload data */ - } payload; -} MQTTClient_willOptions; - -#define MQTTClient_willOptions_initializer { {'M', 'Q', 'T', 'W'}, 1, NULL, NULL, 0, 0, {0, NULL} } - -#define MQTT_SSL_VERSION_DEFAULT 0 -#define MQTT_SSL_VERSION_TLS_1_0 1 -#define MQTT_SSL_VERSION_TLS_1_1 2 -#define MQTT_SSL_VERSION_TLS_1_2 3 - -/** -* MQTTClient_sslProperties defines the settings to establish an SSL/TLS connection using the -* OpenSSL library. It covers the following scenarios: -* - Server authentication: The client needs the digital certificate of the server. It is included -* in a store containting trusted material (also known as "trust store"). -* - Mutual authentication: Both client and server are authenticated during the SSL handshake. In -* addition to the digital certificate of the server in a trust store, the client will need its own -* digital certificate and the private key used to sign its digital certificate stored in a "key store". -* - Anonymous connection: Both client and server do not get authenticated and no credentials are needed -* to establish an SSL connection. Note that this scenario is not fully secure since it is subject to -* man-in-the-middle attacks. -*/ -typedef struct -{ - /** The eyecatcher for this structure. Must be MQTS */ - char struct_id[4]; - - /** The version number of this structure. Must be 0, 1, 2, 3, 4 or 5. - * 0 means no sslVersion - * 1 means no verify, CApath - * 2 means no ssl_error_context, ssl_error_cb - * 3 means no ssl_psk_cb, ssl_psk_context, disableDefaultTrustStore - * 4 means no protos, protos_len - */ - int struct_version; - - /** The file in PEM format containing the public digital certificates trusted by the client. */ - const char* trustStore; - - /** The file in PEM format containing the public certificate chain of the client. It may also include - * the client's private key. - */ - const char* keyStore; - - /** If not included in the sslKeyStore, this setting points to the file in PEM format containing - * the client's private key. - */ - const char* privateKey; - - /** The password to load the client's privateKey if encrypted. */ - const char* privateKeyPassword; - - /** - * The list of cipher suites that the client will present to the server during the SSL handshake. For a - * full explanation of the cipher list format, please see the OpenSSL on-line documentation: - * http://www.openssl.org/docs/apps/ciphers.html#CIPHER_LIST_FORMAT - * If this setting is ommitted, its default value will be "ALL", that is, all the cipher suites -excluding - * those offering no encryption- will be considered. - * This setting can be used to set an SSL anonymous connection ("aNULL" string value, for instance). - */ - const char* enabledCipherSuites; - - /** True/False option to enable verification of the server certificate **/ - int enableServerCertAuth; - - /** The SSL/TLS version to use. Specify one of MQTT_SSL_VERSION_DEFAULT (0), - * MQTT_SSL_VERSION_TLS_1_0 (1), MQTT_SSL_VERSION_TLS_1_1 (2) or MQTT_SSL_VERSION_TLS_1_2 (3). - * Only used if struct_version is >= 1. - */ - int sslVersion; - - /** - * Whether to carry out post-connect checks, including that a certificate - * matches the given host name. - * Exists only if struct_version >= 2 - */ - int verify; - - /** - * From the OpenSSL documentation: - * If CApath is not NULL, it points to a directory containing CA certificates in PEM format. - * Exists only if struct_version >= 2 - */ - const char* CApath; - - /** - * Callback function for OpenSSL error handler ERR_print_errors_cb - * Exists only if struct_version >= 3 - */ - int (*ssl_error_cb) (const char *str, size_t len, void *u); - - /** - * Application-specific contex for OpenSSL error handler ERR_print_errors_cb - * Exists only if struct_version >= 3 - */ - void* ssl_error_context; - - /** - * Callback function for setting TLS-PSK options. Parameters correspond to that of - * SSL_CTX_set_psk_client_callback, except for u which is the pointer ssl_psk_context. - * Exists only if struct_version >= 4 - */ - unsigned int (*ssl_psk_cb) (const char *hint, char *identity, unsigned int max_identity_len, unsigned char *psk, unsigned int max_psk_len, void *u); - - /** - * Application-specific contex for ssl_psk_cb - * Exists only if struct_version >= 4 - */ - void* ssl_psk_context; - - /** - * Don't load default SSL CA. Should be used together with PSK to make sure - * regular servers with certificate in place is not accepted. - * Exists only if struct_version >= 4 - */ - int disableDefaultTrustStore; - - /** - * The protocol-lists must be in wire-format, which is defined as a vector of non-empty, 8-bit length-prefixed, byte strings. - * The length-prefix byte is not included in the length. Each string is limited to 255 bytes. A byte-string length of 0 is invalid. - * A truncated byte-string is invalid. - * Check documentation for SSL_CTX_set_alpn_protos - * Exists only if struct_version >= 5 - */ - const unsigned char *protos; - - /** - * The length of the vector protos vector - * Exists only if struct_version >= 5 - */ - unsigned int protos_len; -} MQTTClient_SSLOptions; - -#define MQTTClient_SSLOptions_initializer { {'M', 'Q', 'T', 'S'}, 5, NULL, NULL, NULL, NULL, NULL, 1, MQTT_SSL_VERSION_DEFAULT, 0, NULL, NULL, NULL, NULL, NULL, 0, NULL, 0 } - -/** - * MQTTClient_libraryInfo is used to store details relating to the currently used - * library such as the version in use, the time it was built and relevant openSSL - * options. - * There is one static instance of this struct in MQTTClient.c - */ - -typedef struct -{ - const char* name; - const char* value; -} MQTTClient_nameValue; - -/** - * This function returns version information about the library. - * no trace information will be returned. - * @return an array of strings describing the library. The last entry is a NULL pointer. - */ -LIBMQTT_API MQTTClient_nameValue* MQTTClient_getVersionInfo(void); - -/** - * MQTTClient_connectOptions defines several settings that control the way the - * client connects to an MQTT server. - * - * Note: Default values are not defined for members of - * MQTTClient_connectOptions so it is good practice to specify all settings. - * If the MQTTClient_connectOptions structure is defined as an automatic - * variable, all members are set to random values and thus must be set by the - * client application. If the MQTTClient_connectOptions structure is defined - * as a static variable, initialization (in compliant compilers) sets all - * values to 0 (NULL for pointers). A #keepAliveInterval setting of 0 prevents - * correct operation of the client and so you must at least set a value - * for #keepAliveInterval. - * - * Suitable default values are set in the following initializers: - * - MQTTClient_connectOptions_initializer: for MQTT 3.1.1 non-WebSockets - * - MQTTClient_connectOptions_initializer5: for MQTT 5.0 non-WebSockets - * - MQTTClient_connectOptions_initializer_ws: for MQTT 3.1.1 WebSockets - * - MQTTClient_connectOptions_initializer5_ws: for MQTT 5.0 WebSockets - */ -typedef struct -{ - /** The eyecatcher for this structure. must be MQTC. */ - char struct_id[4]; - /** The version number of this structure. Must be 0, 1, 2, 3, 4, 5, 6, 7 or 8. - * 0 signifies no SSL options and no serverURIs - * 1 signifies no serverURIs - * 2 signifies no MQTTVersion - * 3 signifies no returned values - * 4 signifies no binary password option - * 5 signifies no maxInflightMessages and cleanstart - * 6 signifies no HTTP headers option - * 7 signifies no HTTP proxy and HTTPS proxy options - */ - int struct_version; - /** The "keep alive" interval, measured in seconds, defines the maximum time - * that should pass without communication between the client and the server - * The client will ensure that at least one message travels across the - * network within each keep alive period. In the absence of a data-related - * message during the time period, the client sends a very small MQTT - * "ping" message, which the server will acknowledge. The keep alive - * interval enables the client to detect when the server is no longer - * available without having to wait for the long TCP/IP timeout. - */ - int keepAliveInterval; - /** - * This is a boolean value. The cleansession setting controls the behaviour - * of both the client and the server at connection and disconnection time. - * The client and server both maintain session state information. This - * information is used to ensure "at least once" and "exactly once" - * delivery, and "exactly once" receipt of messages. Session state also - * includes subscriptions created by an MQTT client. You can choose to - * maintain or discard state information between sessions. - * - * When cleansession is true, the state information is discarded at - * connect and disconnect. Setting cleansession to false keeps the state - * information. When you connect an MQTT client application with - * MQTTClient_connect(), the client identifies the connection using the - * client identifier and the address of the server. The server checks - * whether session information for this client - * has been saved from a previous connection to the server. If a previous - * session still exists, and cleansession=true, then the previous session - * information at the client and server is cleared. If cleansession=false, - * the previous session is resumed. If no previous session exists, a new - * session is started. - */ - int cleansession; - /** - * This is a boolean value that controls how many messages can be in-flight - * simultaneously. Setting reliable to true means that a published - * message must be completed (acknowledgements received) before another - * can be sent. Attempts to publish additional messages receive an - * ::MQTTCLIENT_MAX_MESSAGES_INFLIGHT return code. Setting this flag to - * false allows up to 10 messages to be in-flight. This can increase - * overall throughput in some circumstances. - */ - int reliable; - /** - * This is a pointer to an MQTTClient_willOptions structure. If your - * application does not make use of the Last Will and Testament feature, - * set this pointer to NULL. - */ - MQTTClient_willOptions* will; - /** - * MQTT servers that support the MQTT v3.1.1 protocol provide authentication - * and authorisation by user name and password. This is the user name - * parameter. - */ - const char* username; - /** - * MQTT servers that support the MQTT v3.1.1 protocol provide authentication - * and authorisation by user name and password. This is the password - * parameter. - */ - const char* password; - /** - * The time interval in seconds to allow a connect to complete. - */ - int connectTimeout; - /** - * The time interval in seconds after which unacknowledged publish requests are - * retried during a TCP session. With MQTT 3.1.1 and later, retries are - * not required except on reconnect. 0 turns off in-session retries, and is the - * recommended setting. Adding retries to an already overloaded network only - * exacerbates the problem. - */ - int retryInterval; - /** - * This is a pointer to an MQTTClient_SSLOptions structure. If your - * application does not make use of SSL, set this pointer to NULL. - */ - MQTTClient_SSLOptions* ssl; - /** - * The number of entries in the optional serverURIs array. Defaults to 0. - */ - int serverURIcount; - /** - * An optional array of null-terminated strings specifying the servers to - * which the client will connect. Each string takes the form protocol://host:port. - * protocol must be tcp, ssl, ws or wss. - * The TLS enabled prefixes (ssl, wss) are only valid if a TLS version of the library - * is linked with. - * For host, you can - * specify either an IP address or a host name. For instance, to connect to - * a server running on the local machines with the default MQTT port, specify - * tcp://localhost:1883. - * If this list is empty (the default), the server URI specified on MQTTClient_create() - * is used. - */ - char* const* serverURIs; - /** - * Sets the version of MQTT to be used on the connect. - * MQTTVERSION_DEFAULT (0) = default: start with 3.1.1, and if that fails, fall back to 3.1 - * MQTTVERSION_3_1 (3) = only try version 3.1 - * MQTTVERSION_3_1_1 (4) = only try version 3.1.1 - * MQTTVERSION_5 (5) = only try version 5.0 - */ - int MQTTVersion; - /** - * Returned from the connect when the MQTT version used to connect is 3.1.1 - */ - struct - { - const char* serverURI; /**< the serverURI connected to */ - int MQTTVersion; /**< the MQTT version used to connect with */ - int sessionPresent; /**< if the MQTT version is 3.1.1, the value of sessionPresent returned in the connack */ - } returned; - /** - * Optional binary password. Only checked and used if the password option is NULL - */ - struct - { - int len; /**< binary password length */ - const void* data; /**< binary password data */ - } binarypwd; - /** - * The maximum number of messages in flight - */ - int maxInflightMessages; - /* - * MQTT V5 clean start flag. Only clears state at the beginning of the session. - */ - int cleanstart; - /** - * HTTP headers for websockets - */ - const MQTTClient_nameValue* httpHeaders; - /** - * HTTP proxy - */ - const char* httpProxy; - /** - * HTTPS proxy - */ - const char* httpsProxy; -} MQTTClient_connectOptions; - -/** Initializer for connect options for MQTT 3.1.1 non-WebSocket connections */ -#define MQTTClient_connectOptions_initializer { {'M', 'Q', 'T', 'C'}, 8, 60, 1, 1, NULL, NULL, NULL, 30, 0, NULL,\ -0, NULL, MQTTVERSION_DEFAULT, {NULL, 0, 0}, {0, NULL}, -1, 0, NULL, NULL, NULL} - -/** Initializer for connect options for MQTT 5.0 non-WebSocket connections */ -#define MQTTClient_connectOptions_initializer5 { {'M', 'Q', 'T', 'C'}, 8, 60, 0, 1, NULL, NULL, NULL, 30, 0, NULL,\ -0, NULL, MQTTVERSION_5, {NULL, 0, 0}, {0, NULL}, -1, 1, NULL, NULL, NULL} - -/** Initializer for connect options for MQTT 3.1.1 WebSockets connections. - * The keepalive interval is set to 45 seconds to avoid webserver 60 second inactivity timeouts. - */ -#define MQTTClient_connectOptions_initializer_ws { {'M', 'Q', 'T', 'C'}, 8, 45, 1, 1, NULL, NULL, NULL, 30, 0, NULL,\ -0, NULL, MQTTVERSION_DEFAULT, {NULL, 0, 0}, {0, NULL}, -1, 0, NULL, NULL, NULL} - -/** Initializer for connect options for MQTT 5.0 WebSockets connections. - * The keepalive interval is set to 45 seconds to avoid webserver 60 second inactivity timeouts. - */ -#define MQTTClient_connectOptions_initializer5_ws { {'M', 'Q', 'T', 'C'}, 8, 45, 0, 1, NULL, NULL, NULL, 30, 0, NULL,\ -0, NULL, MQTTVERSION_5, {NULL, 0, 0}, {0, NULL}, -1, 1, NULL, NULL, NULL} - -/** - * This function attempts to connect a previously-created client (see - * MQTTClient_create()) to an MQTT server using the specified options. If you - * want to enable asynchronous message and status notifications, you must call - * MQTTClient_setCallbacks() prior to MQTTClient_connect(). - * @param handle A valid client handle from a successful call to - * MQTTClient_create(). - * @param options A pointer to a valid MQTTClient_connectOptions - * structure. - * @return ::MQTTCLIENT_SUCCESS if the client successfully connects to the - * server. An error code is returned if the client was unable to connect to - * the server. - * Error codes greater than 0 are returned by the MQTT protocol:

- * 1: Connection refused: Unacceptable protocol version
- * 2: Connection refused: Identifier rejected
- * 3: Connection refused: Server unavailable
- * 4: Connection refused: Bad user name or password
- * 5: Connection refused: Not authorized
- * 6-255: Reserved for future use
- */ -LIBMQTT_API int MQTTClient_connect(MQTTClient handle, MQTTClient_connectOptions* options); - -/** MQTT version 5.0 response information */ -typedef struct MQTTResponse -{ - int version; /* the version number of this structure */ - enum MQTTReasonCodes reasonCode; /* the MQTT 5.0 reason code returned */ - int reasonCodeCount; /* the number of reason codes. Used for subscribeMany5 and unsubscribeMany5 */ - enum MQTTReasonCodes* reasonCodes; /* a list of reason codes. Used for subscribeMany5 and unsubscribeMany5 */ - MQTTProperties* properties; /* optionally, the MQTT 5.0 properties returned */ -} MQTTResponse; - -#define MQTTResponse_initializer {1, MQTTREASONCODE_SUCCESS, 0, NULL, NULL} - -/** - * Frees the storage associated with the MQTT response. - * @param response the response structure to be freed - */ -LIBMQTT_API void MQTTResponse_free(MQTTResponse response); - -/** - * Attempts to connect a previously-created client (see - * MQTTClient_create()) to an MQTT server using MQTT version 5.0 and the specified options. If you - * want to enable asynchronous message and status notifications, you must call - * MQTTClient_setCallbacks() prior to MQTTClient_connect(). - * @param handle A valid client handle from a successful call to - * MQTTClient_create(). - * @param options A pointer to a valid MQTTClient_connectOptions - * structure. - * @param connectProperties the MQTT 5.0 connect properties to use - * @param willProperties the MQTT 5.0 properties to set on the will message - * @return the MQTT 5.0 response information: error codes and properties. - */ -LIBMQTT_API MQTTResponse MQTTClient_connect5(MQTTClient handle, MQTTClient_connectOptions* options, - MQTTProperties* connectProperties, MQTTProperties* willProperties); - -/** - * This function attempts to disconnect the client from the MQTT - * server. In order to allow the client time to complete handling of messages - * that are in-flight when this function is called, a timeout period is - * specified. When the timeout period has expired, the client disconnects even - * if there are still outstanding message acknowledgements. - * The next time the client connects to the same server, any QoS 1 or 2 - * messages which have not completed will be retried depending on the - * cleansession settings for both the previous and the new connection (see - * MQTTClient_connectOptions.cleansession and MQTTClient_connect()). - * @param handle A valid client handle from a successful call to - * MQTTClient_create(). - * @param timeout The client delays disconnection for up to this time (in - * milliseconds) in order to allow in-flight message transfers to complete. - * @return ::MQTTCLIENT_SUCCESS if the client successfully disconnects from - * the server. An error code is returned if the client was unable to disconnect - * from the server - */ -LIBMQTT_API int MQTTClient_disconnect(MQTTClient handle, int timeout); - -LIBMQTT_API int MQTTClient_disconnect5(MQTTClient handle, int timeout, enum MQTTReasonCodes reason, MQTTProperties* props); - -/** - * This function allows the client application to test whether or not a - * client is currently connected to the MQTT server. - * @param handle A valid client handle from a successful call to - * MQTTClient_create(). - * @return Boolean true if the client is connected, otherwise false. - */ -LIBMQTT_API int MQTTClient_isConnected(MQTTClient handle); - - -/* Subscribe is synchronous. QoS list parameter is changed on return to granted QoSs. - Returns return code, MQTTCLIENT_SUCCESS == success, non-zero some sort of error (TBD) */ - -/** - * This function attempts to subscribe a client to a single topic, which may - * contain wildcards (see @ref wildcard). This call also specifies the - * @ref qos requested for the subscription - * (see also MQTTClient_subscribeMany()). - * @param handle A valid client handle from a successful call to - * MQTTClient_create(). - * @param topic The subscription topic, which may include wildcards. - * @param qos The requested quality of service for the subscription. - * @return ::MQTTCLIENT_SUCCESS if the subscription request is successful. - * An error code is returned if there was a problem registering the - * subscription. - */ -LIBMQTT_API int MQTTClient_subscribe(MQTTClient handle, const char* topic, int qos); - -/** - * This function attempts to subscribe an MQTT version 5.0 client to a single topic, which may - * contain wildcards (see @ref wildcard). This call also specifies the - * @ref qos requested for the subscription - * (see also MQTTClient_subscribeMany()). - * @param handle A valid client handle from a successful call to - * MQTTClient_create(). - * @param topic The subscription topic, which may include wildcards. - * @param qos The requested quality of service for the subscription. - * @param opts the MQTT 5.0 subscribe options to be used - * @param props the MQTT 5.0 properties to be used - * @return the MQTT 5.0 response information: error codes and properties. - */ -LIBMQTT_API MQTTResponse MQTTClient_subscribe5(MQTTClient handle, const char* topic, int qos, - MQTTSubscribe_options* opts, MQTTProperties* props); - -/** - * This function attempts to subscribe a client to a list of topics, which may - * contain wildcards (see @ref wildcard). This call also specifies the - * @ref qos requested for each topic (see also MQTTClient_subscribe()). - * @param handle A valid client handle from a successful call to - * MQTTClient_create(). - * @param count The number of topics for which the client is requesting - * subscriptions. - * @param topic An array (of length count) of pointers to - * topics, each of which may include wildcards. - * @param qos An array (of length count) of @ref qos - * values. qos[n] is the requested QoS for topic[n]. - * @return ::MQTTCLIENT_SUCCESS if the subscription request is successful. - * An error code is returned if there was a problem registering the - * subscriptions. - */ -LIBMQTT_API int MQTTClient_subscribeMany(MQTTClient handle, int count, char* const* topic, int* qos); - -/** - * This function attempts to subscribe an MQTT version 5.0 client to a list of topics, which may - * contain wildcards (see @ref wildcard). This call also specifies the - * @ref qos requested for each topic (see also MQTTClient_subscribe()). - * @param handle A valid client handle from a successful call to - * MQTTClient_create(). - * @param count The number of topics for which the client is requesting - * subscriptions. - * @param topic An array (of length count) of pointers to - * topics, each of which may include wildcards. - * @param qos An array (of length count) of @ref qos - * values. qos[n] is the requested QoS for topic[n]. - * @param opts the MQTT 5.0 subscribe options to be used - * @param props the MQTT 5.0 properties to be used - * @return the MQTT 5.0 response information: error codes and properties. - */ -LIBMQTT_API MQTTResponse MQTTClient_subscribeMany5(MQTTClient handle, int count, char* const* topic, - int* qos, MQTTSubscribe_options* opts, MQTTProperties* props); - -/** - * This function attempts to remove an existing subscription made by the - * specified client. - * @param handle A valid client handle from a successful call to - * MQTTClient_create(). - * @param topic The topic for the subscription to be removed, which may - * include wildcards (see @ref wildcard). - * @return ::MQTTCLIENT_SUCCESS if the subscription is removed. - * An error code is returned if there was a problem removing the - * subscription. - */ -LIBMQTT_API int MQTTClient_unsubscribe(MQTTClient handle, const char* topic); - -/** - * This function attempts to remove an existing subscription made by the - * specified client using MQTT 5.0. - * @param handle A valid client handle from a successful call to - * MQTTClient_create(). - * @param topic The topic for the subscription to be removed, which may - * include wildcards (see @ref wildcard). - * @param props the MQTT 5.0 properties to be used - * @return the MQTT 5.0 response information: error codes and properties. - */ -LIBMQTT_API MQTTResponse MQTTClient_unsubscribe5(MQTTClient handle, const char* topic, MQTTProperties* props); - -/** - * This function attempts to remove existing subscriptions to a list of topics - * made by the specified client. - * @param handle A valid client handle from a successful call to - * MQTTClient_create(). - * @param count The number subscriptions to be removed. - * @param topic An array (of length count) of pointers to the topics of - * the subscriptions to be removed, each of which may include wildcards. - * @return ::MQTTCLIENT_SUCCESS if the subscriptions are removed. - * An error code is returned if there was a problem removing the subscriptions. - */ -LIBMQTT_API int MQTTClient_unsubscribeMany(MQTTClient handle, int count, char* const* topic); - -/** - * This function attempts to remove existing subscriptions to a list of topics - * made by the specified client using MQTT version 5.0. - * @param handle A valid client handle from a successful call to - * MQTTClient_create(). - * @param count The number subscriptions to be removed. - * @param topic An array (of length count) of pointers to the topics of - * the subscriptions to be removed, each of which may include wildcards. - * @param props the MQTT 5.0 properties to be used - * @return the MQTT 5.0 response information: error codes and properties. - */ -LIBMQTT_API MQTTResponse MQTTClient_unsubscribeMany5(MQTTClient handle, int count, char* const* topic, MQTTProperties* props); - -/** - * This function attempts to publish a message to a given topic (see also - * MQTTClient_publishMessage()). An ::MQTTClient_deliveryToken is issued when - * this function returns successfully. If the client application needs to - * test for succesful delivery of QoS1 and QoS2 messages, this can be done - * either asynchronously or synchronously (see @ref async, - * ::MQTTClient_waitForCompletion and MQTTClient_deliveryComplete()). - * @param handle A valid client handle from a successful call to - * MQTTClient_create(). - * @param topicName The topic associated with this message. - * @param payloadlen The length of the payload in bytes. - * @param payload A pointer to the byte array payload of the message. - * @param qos The @ref qos of the message. - * @param retained The retained flag for the message. - * @param dt A pointer to an ::MQTTClient_deliveryToken. This is populated - * with a token representing the message when the function returns - * successfully. If your application does not use delivery tokens, set this - * argument to NULL. - * @return ::MQTTCLIENT_SUCCESS if the message is accepted for publication. - * An error code is returned if there was a problem accepting the message. - */ -LIBMQTT_API int MQTTClient_publish(MQTTClient handle, const char* topicName, int payloadlen, const void* payload, int qos, int retained, - MQTTClient_deliveryToken* dt); - -/** - * Attempts to publish a message to a given topic using MQTT version 5.0 (see also - * MQTTClient_publishMessage5()). An ::MQTTClient_deliveryToken is issued when - * this function returns successfully. If the client application needs to - * test for succesful delivery of QoS1 and QoS2 messages, this can be done - * either asynchronously or synchronously (see @ref async, - * ::MQTTClient_waitForCompletion and MQTTClient_deliveryComplete()). - * @param handle A valid client handle from a successful call to - * MQTTClient_create(). - * @param topicName The topic associated with this message. - * @param payloadlen The length of the payload in bytes. - * @param payload A pointer to the byte array payload of the message. - * @param qos The @ref qos of the message. - * @param retained The retained flag for the message. - * @param properties the MQTT 5.0 properties to be used - * @param dt A pointer to an ::MQTTClient_deliveryToken. This is populated - * with a token representing the message when the function returns - * successfully. If your application does not use delivery tokens, set this - * argument to NULL. - * @return the MQTT 5.0 response information: error codes and properties. - */ -LIBMQTT_API MQTTResponse MQTTClient_publish5(MQTTClient handle, const char* topicName, int payloadlen, const void* payload, - int qos, int retained, MQTTProperties* properties, MQTTClient_deliveryToken* dt); -/** - * This function attempts to publish a message to a given topic (see also - * MQTTClient_publish()). An ::MQTTClient_deliveryToken is issued when - * this function returns successfully. If the client application needs to - * test for succesful delivery of QoS1 and QoS2 messages, this can be done - * either asynchronously or synchronously (see @ref async, - * ::MQTTClient_waitForCompletion and MQTTClient_deliveryComplete()). - * @param handle A valid client handle from a successful call to - * MQTTClient_create(). - * @param topicName The topic associated with this message. - * @param msg A pointer to a valid MQTTClient_message structure containing - * the payload and attributes of the message to be published. - * @param dt A pointer to an ::MQTTClient_deliveryToken. This is populated - * with a token representing the message when the function returns - * successfully. If your application does not use delivery tokens, set this - * argument to NULL. - * @return ::MQTTCLIENT_SUCCESS if the message is accepted for publication. - * An error code is returned if there was a problem accepting the message. - */ -LIBMQTT_API int MQTTClient_publishMessage(MQTTClient handle, const char* topicName, MQTTClient_message* msg, MQTTClient_deliveryToken* dt); - - -/** - * Attempts to publish a message to the given topic using MQTT version 5.0 - * (see also - * MQTTClient_publish5()). An ::MQTTClient_deliveryToken is issued when - * this function returns successfully. If the client application needs to - * test for succesful delivery of QoS1 and QoS2 messages, this can be done - * either asynchronously or synchronously (see @ref async, - * ::MQTTClient_waitForCompletion and MQTTClient_deliveryComplete()). - * @param handle A valid client handle from a successful call to - * MQTTClient_create(). - * @param topicName The topic associated with this message. - * @param msg A pointer to a valid MQTTClient_message structure containing - * the payload and attributes of the message to be published. - * @param dt A pointer to an ::MQTTClient_deliveryToken. This is populated - * with a token representing the message when the function returns - * successfully. If your application does not use delivery tokens, set this - * argument to NULL. - * @return the MQTT 5.0 response information: error codes and properties. - */ -LIBMQTT_API MQTTResponse MQTTClient_publishMessage5(MQTTClient handle, const char* topicName, MQTTClient_message* msg, - MQTTClient_deliveryToken* dt); - -/** - * This function is called by the client application to synchronize execution - * of the main thread with completed publication of a message. When called, - * MQTTClient_waitForCompletion() blocks execution until the message has been - * successful delivered or the specified timeout has expired. See @ref async. - * @param handle A valid client handle from a successful call to - * MQTTClient_create(). - * @param dt The ::MQTTClient_deliveryToken that represents the message being - * tested for successful delivery. Delivery tokens are issued by the - * publishing functions MQTTClient_publish() and MQTTClient_publishMessage(). - * @param timeout The maximum time to wait in milliseconds. - * @return ::MQTTCLIENT_SUCCESS if the message was successfully delivered. - * An error code is returned if the timeout expires or there was a problem - * checking the token. - */ -LIBMQTT_API int MQTTClient_waitForCompletion(MQTTClient handle, MQTTClient_deliveryToken dt, unsigned long timeout); - - -/** - * This function sets a pointer to an array of delivery tokens for - * messages that are currently in-flight (pending completion). - * - * Important note: The memory used to hold the array of tokens is - * malloc()'d in this function. The client application is responsible for - * freeing this memory when it is no longer required. - * @param handle A valid client handle from a successful call to - * MQTTClient_create(). - * @param tokens The address of a pointer to an ::MQTTClient_deliveryToken. - * When the function returns successfully, the pointer is set to point to an - * array of tokens representing messages pending completion. The last member of - * the array is set to -1 to indicate there are no more tokens. If no tokens - * are pending, the pointer is set to NULL. - * @return ::MQTTCLIENT_SUCCESS if the function returns successfully. - * An error code is returned if there was a problem obtaining the list of - * pending tokens. - */ -LIBMQTT_API int MQTTClient_getPendingDeliveryTokens(MQTTClient handle, MQTTClient_deliveryToken **tokens); - -/** - * When implementing a single-threaded client, call this function periodically - * to allow processing of message retries and to send MQTT keepalive pings. - * If the application is calling MQTTClient_receive() regularly, then it is - * not necessary to call this function. - */ -LIBMQTT_API void MQTTClient_yield(void); - -/** - * This function performs a synchronous receive of incoming messages. It should - * be used only when the client application has not set callback methods to - * support asynchronous receipt of messages (see @ref async and - * MQTTClient_setCallbacks()). Using this function allows a single-threaded - * client subscriber application to be written. When called, this function - * blocks until the next message arrives or the specified timeout expires - *(see also MQTTClient_yield()). - * - * Important note: The application must free() the memory allocated - * to the topic and the message when processing is complete (see - * MQTTClient_freeMessage()). - * @param handle A valid client handle from a successful call to - * MQTTClient_create(). - * @param topicName The address of a pointer to a topic. This function - * allocates the memory for the topic and returns it to the application - * by setting topicName to point to the topic. - * @param topicLen The length of the topic. If the return code from this - * function is ::MQTTCLIENT_TOPICNAME_TRUNCATED, the topic contains embedded - * NULL characters and the full topic should be retrieved by using - * topicLen. - * @param message The address of a pointer to the received message. This - * function allocates the memory for the message and returns it to the - * application by setting message to point to the received message. - * The pointer is set to NULL if the timeout expires. - * @param timeout The length of time to wait for a message in milliseconds. - * @return ::MQTTCLIENT_SUCCESS or ::MQTTCLIENT_TOPICNAME_TRUNCATED if a - * message is received. ::MQTTCLIENT_SUCCESS can also indicate that the - * timeout expired, in which case message is NULL. An error code is - * returned if there was a problem trying to receive a message. - */ -LIBMQTT_API int MQTTClient_receive(MQTTClient handle, char** topicName, int* topicLen, MQTTClient_message** message, - unsigned long timeout); - -/** - * This function frees memory allocated to an MQTT message, including the - * additional memory allocated to the message payload. The client application - * calls this function when the message has been fully processed. Important - * note: This function does not free the memory allocated to a message - * topic string. It is the responsibility of the client application to free - * this memory using the MQTTClient_free() library function. - * @param msg The address of a pointer to the ::MQTTClient_message structure - * to be freed. - */ -LIBMQTT_API void MQTTClient_freeMessage(MQTTClient_message** msg); - -/** - * This function frees memory allocated by the MQTT C client library, especially the - * topic name. This is needed on Windows when the client libary and application - * program have been compiled with different versions of the C compiler. It is - * thus good policy to always use this function when freeing any MQTT C client- - * allocated memory. - * @param ptr The pointer to the client library storage to be freed. - */ -LIBMQTT_API void MQTTClient_free(void* ptr); - -/** - * This function is used to allocate memory to be used or freed by the MQTT C client library, - * especially the data in user persistence. This is needed on Windows when the client library - * and application program have been compiled with different versions of the C compiler. - * @param size The size of the memory to be allocated. - */ -LIBMQTT_API void* MQTTClient_malloc(size_t size); - -/** - * This function frees the memory allocated to an MQTT client (see - * MQTTClient_create()). It should be called when the client is no longer - * required. - * @param handle A pointer to the handle referring to the ::MQTTClient - * structure to be freed. - */ -LIBMQTT_API void MQTTClient_destroy(MQTTClient* handle); - - -enum MQTTCLIENT_TRACE_LEVELS -{ - MQTTCLIENT_TRACE_MAXIMUM = 1, - MQTTCLIENT_TRACE_MEDIUM, - MQTTCLIENT_TRACE_MINIMUM, - MQTTCLIENT_TRACE_PROTOCOL, - MQTTCLIENT_TRACE_ERROR, - MQTTCLIENT_TRACE_SEVERE, - MQTTCLIENT_TRACE_FATAL, -}; - - -/** - * This function sets the level of trace information which will be - * returned in the trace callback. - * @param level the trace level required - */ -LIBMQTT_API void MQTTClient_setTraceLevel(enum MQTTCLIENT_TRACE_LEVELS level); - - -/** - * This is a callback function prototype which must be implemented if you want - * to receive trace information. Do not invoke any other Paho API calls in this - * callback function - unpredictable behavior may result. - * @param level the trace level of the message returned - * @param message the trace message. This is a pointer to a static buffer which - * will be overwritten on each call. You must copy the data if you want to keep - * it for later. - */ -typedef void MQTTClient_traceCallback(enum MQTTCLIENT_TRACE_LEVELS level, char* message); - -/** - * This function sets the trace callback if needed. If set to NULL, - * no trace information will be returned. The default trace level is - * MQTTASYNC_TRACE_MINIMUM. - * @param callback a pointer to the function which will handle the trace information - */ -LIBMQTT_API void MQTTClient_setTraceCallback(MQTTClient_traceCallback* callback); - -/** - * Sets the timeout value for un/subscribe commands when waiting for the un/suback response from - * the server. Values less than 5000 are not allowed. - * @param handle A valid client handle from a successful call to MQTTClient_create(). - * @param milliSeconds the maximum number of milliseconds to wait - * @return MQTTCLIENT_SUCCESS or MQTTCLIENT_FAILURE - */ -LIBMQTT_API int MQTTClient_setCommandTimeout(MQTTClient handle, unsigned long milliSeconds); - -/** - * Returns a pointer to the string representation of the error or NULL. - * - * Do not free after use. Returns NULL if the error code is unknown. - */ -LIBMQTT_API const char* MQTTClient_strerror(int code); - -#if defined(__cplusplus) - } -#endif - -#endif - -/*! - * @cond MQTTClient_main - * @page async Asynchronous vs synchronous client applications - * This client library supports two modes of operation. These are referred to - * as synchronous and asynchronous modes. If your application - * calls MQTTClient_setCallbacks(), this puts the client into asynchronous - * mode, otherwise it operates in synchronous mode. - * - * In synchronous mode, the client application runs on a single thread. - * Messages are published using the MQTTClient_publish() and - * MQTTClient_publishMessage() functions. To determine that a QoS1 or QoS2 - * (see @ref qos) message has been successfully delivered, the application - * must call the MQTTClient_waitForCompletion() function. An example showing - * synchronous publication is shown in @ref pubsync. Receiving messages in - * synchronous mode uses the MQTTClient_receive() function. Client applications - * must call either MQTTClient_receive() or MQTTClient_yield() relatively - * frequently in order to allow processing of acknowledgements and the MQTT - * "pings" that keep the network connection to the server alive. - * - * In asynchronous mode, the client application runs on several threads. The - * main program calls functions in the client library to publish and subscribe, - * just as for the synchronous mode. Processing of handshaking and maintaining - * the network connection is performed in the background, however. - * Notifications of status and message reception are provided to the client - * application using callbacks registered with the library by the call to - * MQTTClient_setCallbacks() (see MQTTClient_messageArrived(), - * MQTTClient_connectionLost() and MQTTClient_deliveryComplete()). - * This API is not thread safe however - it is not possible to call it from multiple - * threads without synchronization. You can use the MQTTAsync API for that. - * - * @page callbacks Callbacks - * You must not call a function from this API from within a callback otherwise - * a deadlock might result. The only exception to this is the ability to call - * connect within the connection lost callback, to allow a reconnect. - * - * When using MQTT 5.0, you can also call connect from within the disconnected - * callback, which is invoked when the MQTT server sends a disconnect packet. - * This server behaviour is allowed in MQTT 5.0, but not in MQTT 3.1.1, so the - * disconnected callback will never be invoked if you use MQTT 3.1.1. - * - * In particular, you must make a publish call within the message arrived callback. - * These restrictions are all lifted in the - * MQTTAsync API. - * - * If no callbacks are assigned, this will include the message arrived callback. - * This could be done if the application is a pure publisher, and does - * not subscribe to any topics. If however messages are received, and no message - * arrived callback is set, or receive not called, then those messages will accumulate - * and take up memory, as there is no place for them to be delivered. - * It is up to the application to protect against this situation. - * - * @page wildcard Subscription wildcards - * Every MQTT message includes a topic that classifies it. MQTT servers use - * topics to determine which subscribers should receive messages published to - * the server. - * - * Consider the server receiving messages from several environmental sensors. - * Each sensor publishes its measurement data as a message with an associated - * topic. Subscribing applications need to know which sensor originally - * published each received message. A unique topic is thus used to identify - * each sensor and measurement type. Topics such as SENSOR1TEMP, - * SENSOR1HUMIDITY, SENSOR2TEMP and so on achieve this but are not very - * flexible. If additional sensors are added to the system at a later date, - * subscribing applications must be modified to receive them. - * - * To provide more flexibility, MQTT supports a hierarchical topic namespace. - * This allows application designers to organize topics to simplify their - * management. Levels in the hierarchy are delimited by the '/' character, - * such as SENSOR/1/HUMIDITY. Publishers and subscribers use these - * hierarchical topics as already described. - * - * For subscriptions, two wildcard characters are supported: - *
    - *
  • A '#' character represents a complete sub-tree of the hierarchy and - * thus must be the last character in a subscription topic string, such as - * SENSOR/#. This will match any topic starting with SENSOR/, such as - * SENSOR/1/TEMP and SENSOR/2/HUMIDITY.
    • - *
  • A '+' character represents a single level of the hierarchy and is - * used between delimiters. For example, SENSOR/+/TEMP will match - * SENSOR/1/TEMP and SENSOR/2/TEMP.
    • - *
- * Publishers are not allowed to use the wildcard characters in their topic - * names. - * - * Deciding on your topic hierarchy is an important step in your system design. - * - * @page qos Quality of service - * The MQTT protocol provides three qualities of service for delivering - * messages between clients and servers: "at most once", "at least once" and - * "exactly once". - * - * Quality of service (QoS) is an attribute of an individual message being - * published. An application sets the QoS for a specific message by setting the - * MQTTClient_message.qos field to the required value. - * - * A subscribing client can set the maximum quality of service a server uses - * to send messages that match the client subscriptions. The - * MQTTClient_subscribe() and MQTTClient_subscribeMany() functions set this - * maximum. The QoS of a message forwarded to a subscriber thus might be - * different to the QoS given to the message by the original publisher. - * The lower of the two values is used to forward a message. - * - * The three levels are: - * - * QoS0, At most once: The message is delivered at most once, or it - * may not be delivered at all. Its delivery across the network is not - * acknowledged. The message is not stored. The message could be lost if the - * client is disconnected, or if the server fails. QoS0 is the fastest mode of - * transfer. It is sometimes called "fire and forget". - * - * The MQTT protocol does not require servers to forward publications at QoS0 - * to a client. If the client is disconnected at the time the server receives - * the publication, the publication might be discarded, depending on the - * server implementation. - * - * QoS1, At least once: The message is always delivered at least once. - * It might be delivered multiple times if there is a failure before an - * acknowledgment is received by the sender. The message must be stored - * locally at the sender, until the sender receives confirmation that the - * message has been published by the receiver. The message is stored in case - * the message must be sent again. - * - * QoS2, Exactly once: The message is always delivered exactly once. - * The message must be stored locally at the sender, until the sender receives - * confirmation that the message has been published by the receiver. The - * message is stored in case the message must be sent again. QoS2 is the - * safest, but slowest mode of transfer. A more sophisticated handshaking - * and acknowledgement sequence is used than for QoS1 to ensure no duplication - * of messages occurs. - * @page pubsync Synchronous publication example -@code -#include -#include -#include -#include "MQTTClient.h" - -#define ADDRESS "tcp://mqtt.eclipseprojects.io:1883" -#define CLIENTID "ExampleClientPub" -#define TOPIC "MQTT Examples" -#define PAYLOAD "Hello World!" -#define QOS 1 -#define TIMEOUT 10000L - -int main(int argc, char* argv[]) -{ - MQTTClient client; - MQTTClient_connectOptions conn_opts = MQTTClient_connectOptions_initializer; - MQTTClient_message pubmsg = MQTTClient_message_initializer; - MQTTClient_deliveryToken token; - int rc; - - if ((rc = MQTTClient_create(&client, ADDRESS, CLIENTID, - MQTTCLIENT_PERSISTENCE_NONE, NULL)) != MQTTCLIENT_SUCCESS) - { - printf("Failed to create client, return code %d\n", rc); - exit(EXIT_FAILURE); - } - - conn_opts.keepAliveInterval = 20; - conn_opts.cleansession = 1; - if ((rc = MQTTClient_connect(client, &conn_opts)) != MQTTCLIENT_SUCCESS) - { - printf("Failed to connect, return code %d\n", rc); - exit(EXIT_FAILURE); - } - - pubmsg.payload = PAYLOAD; - pubmsg.payloadlen = (int)strlen(PAYLOAD); - pubmsg.qos = QOS; - pubmsg.retained = 0; - if ((rc = MQTTClient_publishMessage(client, TOPIC, &pubmsg, &token)) != MQTTCLIENT_SUCCESS) - { - printf("Failed to publish message, return code %d\n", rc); - exit(EXIT_FAILURE); - } - - printf("Waiting for up to %d seconds for publication of %s\n" - "on topic %s for client with ClientID: %s\n", - (int)(TIMEOUT/1000), PAYLOAD, TOPIC, CLIENTID); - rc = MQTTClient_waitForCompletion(client, token, TIMEOUT); - printf("Message with delivery token %d delivered\n", token); - - if ((rc = MQTTClient_disconnect(client, 10000)) != MQTTCLIENT_SUCCESS) - printf("Failed to disconnect, return code %d\n", rc); - MQTTClient_destroy(&client); - return rc; -} - - * @endcode - * - * @page pubasync Asynchronous publication example -@code{.c} -#include -#include -#include -#include "MQTTClient.h" - -#if !defined(_WIN32) -#include -#else -#include -#endif - -#define ADDRESS "tcp://mqtt.eclipseprojects.io:1883" -#define CLIENTID "ExampleClientPub" -#define TOPIC "MQTT Examples" -#define PAYLOAD "Hello World!" -#define QOS 1 -#define TIMEOUT 10000L - -MQTTClient_deliveryToken deliveredtoken; - -void delivered(void *context, MQTTClient_deliveryToken dt) -{ - printf("Message with token value %d delivery confirmed\n", dt); - deliveredtoken = dt; -} - -int msgarrvd(void *context, char *topicName, int topicLen, MQTTClient_message *message) -{ - printf("Message arrived\n"); - printf(" topic: %s\n", topicName); - printf(" message: %.*s\n", message->payloadlen, (char*)message->payload); - MQTTClient_freeMessage(&message); - MQTTClient_free(topicName); - return 1; -} - -void connlost(void *context, char *cause) -{ - printf("\nConnection lost\n"); - printf(" cause: %s\n", cause); -} - -int main(int argc, char* argv[]) -{ - MQTTClient client; - MQTTClient_connectOptions conn_opts = MQTTClient_connectOptions_initializer; - MQTTClient_message pubmsg = MQTTClient_message_initializer; - MQTTClient_deliveryToken token; - int rc; - - if ((rc = MQTTClient_create(&client, ADDRESS, CLIENTID, - MQTTCLIENT_PERSISTENCE_NONE, NULL)) != MQTTCLIENT_SUCCESS) - { - printf("Failed to create client, return code %d\n", rc); - rc = EXIT_FAILURE; - goto exit; - } - - if ((rc = MQTTClient_setCallbacks(client, NULL, connlost, msgarrvd, delivered)) != MQTTCLIENT_SUCCESS) - { - printf("Failed to set callbacks, return code %d\n", rc); - rc = EXIT_FAILURE; - goto destroy_exit; - } - - conn_opts.keepAliveInterval = 20; - conn_opts.cleansession = 1; - if ((rc = MQTTClient_connect(client, &conn_opts)) != MQTTCLIENT_SUCCESS) - { - printf("Failed to connect, return code %d\n", rc); - rc = EXIT_FAILURE; - goto destroy_exit; - } - - pubmsg.payload = PAYLOAD; - pubmsg.payloadlen = (int)strlen(PAYLOAD); - pubmsg.qos = QOS; - pubmsg.retained = 0; - deliveredtoken = 0; - if ((rc = MQTTClient_publishMessage(client, TOPIC, &pubmsg, &token)) != MQTTCLIENT_SUCCESS) - { - printf("Failed to publish message, return code %d\n", rc); - rc = EXIT_FAILURE; - } - else - { - printf("Waiting for publication of %s\n" - "on topic %s for client with ClientID: %s\n", - PAYLOAD, TOPIC, CLIENTID); - while (deliveredtoken != token) - { - #if defined(_WIN32) - Sleep(100); - #else - usleep(10000L); - #endif - } - } - - if ((rc = MQTTClient_disconnect(client, 10000)) != MQTTCLIENT_SUCCESS) - { - printf("Failed to disconnect, return code %d\n", rc); - rc = EXIT_FAILURE; - } - -destroy_exit: - MQTTClient_destroy(&client); - -exit: - return rc; -} - - * @endcode - * @page subasync Asynchronous subscription example -@code -#include -#include -#include -#include "MQTTClient.h" - -#define ADDRESS "tcp://mqtt.eclipseprojects.io:1883" -#define CLIENTID "ExampleClientSub" -#define TOPIC "MQTT Examples" -#define PAYLOAD "Hello World!" -#define QOS 1 -#define TIMEOUT 10000L - -volatile MQTTClient_deliveryToken deliveredtoken; - -void delivered(void *context, MQTTClient_deliveryToken dt) -{ - printf("Message with token value %d delivery confirmed\n", dt); - deliveredtoken = dt; -} - -int msgarrvd(void *context, char *topicName, int topicLen, MQTTClient_message *message) -{ - printf("Message arrived\n"); - printf(" topic: %s\n", topicName); - printf(" message: %.*s\n", message->payloadlen, (char*)message->payload); - MQTTClient_freeMessage(&message); - MQTTClient_free(topicName); - return 1; -} - -void connlost(void *context, char *cause) -{ - printf("\nConnection lost\n"); - printf(" cause: %s\n", cause); -} - -int main(int argc, char* argv[]) -{ - MQTTClient client; - MQTTClient_connectOptions conn_opts = MQTTClient_connectOptions_initializer; - int rc; - - if ((rc = MQTTClient_create(&client, ADDRESS, CLIENTID, - MQTTCLIENT_PERSISTENCE_NONE, NULL)) != MQTTCLIENT_SUCCESS) - { - printf("Failed to create client, return code %d\n", rc); - rc = EXIT_FAILURE; - goto exit; - } - - if ((rc = MQTTClient_setCallbacks(client, NULL, connlost, msgarrvd, delivered)) != MQTTCLIENT_SUCCESS) - { - printf("Failed to set callbacks, return code %d\n", rc); - rc = EXIT_FAILURE; - goto destroy_exit; - } - - conn_opts.keepAliveInterval = 20; - conn_opts.cleansession = 1; - if ((rc = MQTTClient_connect(client, &conn_opts)) != MQTTCLIENT_SUCCESS) - { - printf("Failed to connect, return code %d\n", rc); - rc = EXIT_FAILURE; - goto destroy_exit; - } - - printf("Subscribing to topic %s\nfor client %s using QoS%d\n\n" - "Press Q to quit\n\n", TOPIC, CLIENTID, QOS); - if ((rc = MQTTClient_subscribe(client, TOPIC, QOS)) != MQTTCLIENT_SUCCESS) - { - printf("Failed to subscribe, return code %d\n", rc); - rc = EXIT_FAILURE; - } - else - { - int ch; - do - { - ch = getchar(); - } while (ch!='Q' && ch != 'q'); - - if ((rc = MQTTClient_unsubscribe(client, TOPIC)) != MQTTCLIENT_SUCCESS) - { - printf("Failed to unsubscribe, return code %d\n", rc); - rc = EXIT_FAILURE; - } - } - - if ((rc = MQTTClient_disconnect(client, 10000)) != MQTTCLIENT_SUCCESS) - { - printf("Failed to disconnect, return code %d\n", rc); - rc = EXIT_FAILURE; - } -destroy_exit: - MQTTClient_destroy(&client); -exit: - return rc; -} - - * @endcode - * @page tracing Tracing - * - * Runtime tracing is controlled by environment variables. - * - * Tracing is switched on by setting MQTT_C_CLIENT_TRACE. A value of ON, or stdout, prints to - * stdout, any other value is interpreted as a file name to use. - * - * The amount of trace detail is controlled with the MQTT_C_CLIENT_TRACE_LEVEL environment - * variable - valid values are ERROR, PROTOCOL, MINIMUM, MEDIUM and MAXIMUM - * (from least to most verbose). - * - * The variable MQTT_C_CLIENT_TRACE_MAX_LINES limits the number of lines of trace that are output - * to a file. Two files are used at most, when they are full, the last one is overwritten with the - * new trace entries. The default size is 1000 lines. - * - * ### MQTT Packet Tracing - * - * A feature that can be very useful is printing the MQTT packets that are sent and received. To - * achieve this, use the following environment variable settings: - * @code - MQTT_C_CLIENT_TRACE=ON - MQTT_C_CLIENT_TRACE_LEVEL=PROTOCOL - * @endcode - * The output you should see looks like this: - * @code - 20130528 155936.813 3 stdout-subscriber -> CONNECT cleansession: 1 (0) - 20130528 155936.813 3 stdout-subscriber <- CONNACK rc: 0 - 20130528 155936.813 3 stdout-subscriber -> SUBSCRIBE msgid: 1 (0) - 20130528 155936.813 3 stdout-subscriber <- SUBACK msgid: 1 - 20130528 155941.818 3 stdout-subscriber -> DISCONNECT (0) - * @endcode - * where the fields are: - * 1. date - * 2. time - * 3. socket number - * 4. client id - * 5. direction (-> from client to server, <- from server to client) - * 6. packet details - * - * ### Default Level Tracing - * - * This is an extract of a default level trace of a call to connect: - * @code - 19700101 010000.000 (1152206656) (0)> MQTTClient_connect:893 - 19700101 010000.000 (1152206656) (1)> MQTTClient_connectURI:716 - 20130528 160447.479 Connecting to serverURI localhost:1883 - 20130528 160447.479 (1152206656) (2)> MQTTProtocol_connect:98 - 20130528 160447.479 (1152206656) (3)> MQTTProtocol_addressPort:48 - 20130528 160447.479 (1152206656) (3)< MQTTProtocol_addressPort:73 - 20130528 160447.479 (1152206656) (3)> Socket_new:599 - 20130528 160447.479 New socket 4 for localhost, port 1883 - 20130528 160447.479 (1152206656) (4)> Socket_addSocket:163 - 20130528 160447.479 (1152206656) (5)> Socket_setnonblocking:73 - 20130528 160447.479 (1152206656) (5)< Socket_setnonblocking:78 (0) - 20130528 160447.479 (1152206656) (4)< Socket_addSocket:176 (0) - 20130528 160447.479 (1152206656) (4)> Socket_error:95 - 20130528 160447.479 (1152206656) (4)< Socket_error:104 (115) - 20130528 160447.479 Connect pending - 20130528 160447.479 (1152206656) (3)< Socket_new:683 (115) - 20130528 160447.479 (1152206656) (2)< MQTTProtocol_connect:131 (115) - * @endcode - * where the fields are: - * 1. date - * 2. time - * 3. thread id - * 4. function nesting level - * 5. function entry (>) or exit (<) - * 6. function name : line of source code file - * 7. return value (if there is one) - * - * ### Memory Allocation Tracing - * - * Setting the trace level to maximum causes memory allocations and frees to be traced along with - * the default trace entries, with messages like the following: - * @code - 20130528 161819.657 Allocating 16 bytes in heap at file /home/icraggs/workspaces/mqrtc/mqttv3c/src/MQTTPacket.c line 177 ptr 0x179f930 - - 20130528 161819.657 Freeing 16 bytes in heap at file /home/icraggs/workspaces/mqrtc/mqttv3c/src/MQTTPacket.c line 201, heap use now 896 bytes - * @endcode - * When the last MQTT client object is destroyed, if the trace is being recorded - * and all memory allocated by the client library has not been freed, an error message will be - * written to the trace. This can help with fixing memory leaks. The message will look like this: - * @code - 20130528 163909.208 Some memory not freed at shutdown, possible memory leak - 20130528 163909.208 Heap scan start, total 880 bytes - 20130528 163909.208 Heap element size 32, line 354, file /home/icraggs/workspaces/mqrtc/mqttv3c/src/MQTTPacket.c, ptr 0x260cb00 - 20130528 163909.208 Content - 20130528 163909.209 Heap scan end - * @endcode - * @endcond - */ diff --git a/MQTTClientPersistence.h b/MQTTClientPersistence.h deleted file mode 100644 index d3caae4..0000000 --- a/MQTTClientPersistence.h +++ /dev/null @@ -1,277 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2009, 2020 IBM Corp. - * - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v2.0 - * and Eclipse Distribution License v1.0 which accompany this distribution. - * - * The Eclipse Public License is available at - * https://www.eclipse.org/legal/epl-2.0/ - * and the Eclipse Distribution License is available at - * http://www.eclipse.org/org/documents/edl-v10.php. - * - * Contributors: - * Ian Craggs - initial API and implementation and/or initial documentation - *******************************************************************************/ - -/** - * @file - * \brief This structure represents a persistent data store, used to store - * outbound and inbound messages, in order to achieve reliable messaging. - * - * The MQTT Client persists QoS1 and QoS2 messages in order to meet the - * assurances of delivery associated with these @ref qos levels. The messages - * are saved in persistent storage - * The type and context of the persistence implementation are specified when - * the MQTT client is created (see MQTTClient_create()). The default - * persistence type (::MQTTCLIENT_PERSISTENCE_DEFAULT) uses a file system-based - * persistence mechanism. The persistence_context argument passed to - * MQTTClient_create() when using the default peristence is a string - * representing the location of the persistence directory. If the context - * argument is NULL, the working directory will be used. - * - * To use memory-based persistence, an application passes - * ::MQTTCLIENT_PERSISTENCE_NONE as the persistence_type to - * MQTTClient_create(). This can lead to message loss in certain situations, - * but can be appropriate in some cases (see @ref qos). - * - * Client applications can provide their own persistence mechanism by passing - * ::MQTTCLIENT_PERSISTENCE_USER as the persistence_type. To implement a - * custom persistence mechanism, the application must pass an initialized - * ::MQTTClient_persistence structure as the persistence_context - * argument to MQTTClient_create(). - * - * If the functions defined return an ::MQTTCLIENT_PERSISTENCE_ERROR then the - * state of the persisted data should remain as it was prior to the function - * being called. For example, if Persistence_put() returns - * ::MQTTCLIENT_PERSISTENCE_ERROR, then it is assumed tha tthe persistent store - * does not contain the data that was passed to the function. Similarly, if - * Persistence_remove() returns ::MQTTCLIENT_PERSISTENCE_ERROR then it is - * assumed that the data to be removed is still held in the persistent store. - * - * It is up to the persistence implementation to log any error information that - * may be required to diagnose a persistence mechanism failure. - */ - -/* -/// @cond EXCLUDE -*/ -#if !defined(MQTTCLIENTPERSISTENCE_H) -#define MQTTCLIENTPERSISTENCE_H -/* -/// @endcond -*/ - -/** - * This persistence_type value specifies the default file system-based - * persistence mechanism (see MQTTClient_create()). - */ -#define MQTTCLIENT_PERSISTENCE_DEFAULT 0 -/** - * This persistence_type value specifies a memory-based - * persistence mechanism (see MQTTClient_create()). - */ -#define MQTTCLIENT_PERSISTENCE_NONE 1 -/** - * This persistence_type value specifies an application-specific - * persistence mechanism (see MQTTClient_create()). - */ -#define MQTTCLIENT_PERSISTENCE_USER 2 - -/** - * Application-specific persistence functions must return this error code if - * there is a problem executing the function. - */ -#define MQTTCLIENT_PERSISTENCE_ERROR -2 - -/** - * @brief Initialize the persistent store. - * - * Either open the existing persistent store for this client ID or create a new - * one if one doesn't exist. If the persistent store is already open, return - * without taking any action. - * - * An application can use the same client identifier to connect to many - * different servers. The clientid in conjunction with the - * serverURI uniquely identifies the persistence store required. - * - * @param handle The address of a pointer to a handle for this persistence - * implementation. This function must set handle to a valid reference to the - * persistence following a successful return. - * The handle pointer is passed as an argument to all the other - * persistence functions. It may include the context parameter and/or any other - * data for use by the persistence functions. - * @param clientID The client identifier for which the persistent store should - * be opened. - * @param serverURI The connection string specified when the MQTT client was - * created (see MQTTClient_create()). - * @param context A pointer to any data required to initialize the persistent - * store (see ::MQTTClient_persistence). - * @return Return 0 if the function completes successfully, otherwise return - * ::MQTTCLIENT_PERSISTENCE_ERROR. - */ -typedef int (*Persistence_open)(void** handle, const char* clientID, const char* serverURI, void* context); - -/** - * @brief Close the persistent store referred to by the handle. - * - * @param handle The handle pointer from a successful call to - * Persistence_open(). - * @return Return 0 if the function completes successfully, otherwise return - * ::MQTTCLIENT_PERSISTENCE_ERROR. - */ -typedef int (*Persistence_close)(void* handle); - -/** - * @brief Put the specified data into the persistent store. - * - * @param handle The handle pointer from a successful call to - * Persistence_open(). - * @param key A string used as the key for the data to be put in the store. The - * key is later used to retrieve data from the store with Persistence_get(). - * @param bufcount The number of buffers to write to the persistence store. - * @param buffers An array of pointers to the data buffers associated with - * this key. - * @param buflens An array of lengths of the data buffers. buflen[n] - * gives the length of buffer[n]. - * @return Return 0 if the function completes successfully, otherwise return - * ::MQTTCLIENT_PERSISTENCE_ERROR. - */ -typedef int (*Persistence_put)(void* handle, char* key, int bufcount, char* buffers[], int buflens[]); - -/** - * @brief Retrieve the specified data from the persistent store. - * - * @param handle The handle pointer from a successful call to - * Persistence_open(). - * @param key A string that is the key for the data to be retrieved. This is - * the same key used to save the data to the store with Persistence_put(). - * @param buffer The address of a pointer to a buffer. This function sets the - * pointer to point at the retrieved data, if successful. - * @param buflen The address of an int that is set to the length of - * buffer by this function if successful. - * @return Return 0 if the function completes successfully, otherwise return - * ::MQTTCLIENT_PERSISTENCE_ERROR. - */ -typedef int (*Persistence_get)(void* handle, char* key, char** buffer, int* buflen); - -/** - * @brief Remove the data for the specified key from the store. - * - * @param handle The handle pointer from a successful call to - * Persistence_open(). - * @param key A string that is the key for the data to be removed from the - * store. This is the same key used to save the data to the store with - * Persistence_put(). - * @return Return 0 if the function completes successfully, otherwise return - * ::MQTTCLIENT_PERSISTENCE_ERROR. - */ -typedef int (*Persistence_remove)(void* handle, char* key); - -/** - * @brief Returns the keys in this persistent data store. - * - * @param handle The handle pointer from a successful call to - * Persistence_open(). - * @param keys The address of a pointer to pointers to strings. Assuming - * successful execution, this function allocates memory to hold the returned - * keys (strings used to store the data with Persistence_put()). It also - * allocates memory to hold an array of pointers to these strings. keys - * is set to point to the array of pointers to strings. - * @param nkeys A pointer to the number of keys in this persistent data store. - * This function sets the number of keys, if successful. - * @return Return 0 if the function completes successfully, otherwise return - * ::MQTTCLIENT_PERSISTENCE_ERROR. - */ -typedef int (*Persistence_keys)(void* handle, char*** keys, int* nkeys); - -/** - * @brief Clears the persistence store, so that it no longer contains any - * persisted data. - * - * @param handle The handle pointer from a successful call to - * Persistence_open(). - * @return Return 0 if the function completes successfully, otherwise return - * ::MQTTCLIENT_PERSISTENCE_ERROR. - */ -typedef int (*Persistence_clear)(void* handle); - -/** - * @brief Returns whether any data has been persisted using the specified key. - * - * @param handle The handle pointer from a successful call to - * Persistence_open(). - * @param key The string to be tested for existence in the store. - * @return Return 0 if the key was found in the store, otherwise return - * ::MQTTCLIENT_PERSISTENCE_ERROR. - */ -typedef int (*Persistence_containskey)(void* handle, char* key); - -/** - * @brief A structure containing the function pointers to a persistence - * implementation and the context or state that will be shared across all - * the persistence functions. - */ -typedef struct { - /** - * A pointer to any data required to initialize the persistent store. - */ - void* context; - /** - * A function pointer to an implementation of Persistence_open(). - */ - Persistence_open popen; - /** - * A function pointer to an implementation of Persistence_close(). - */ - Persistence_close pclose; - /** - * A function pointer to an implementation of Persistence_put(). - */ - Persistence_put pput; - /** - * A function pointer to an implementation of Persistence_get(). - */ - Persistence_get pget; - /** - * A function pointer to an implementation of Persistence_remove(). - */ - Persistence_remove premove; - /** - * A function pointer to an implementation of Persistence_keys(). - */ - Persistence_keys pkeys; - /** - * A function pointer to an implementation of Persistence_clear(). - */ - Persistence_clear pclear; - /** - * A function pointer to an implementation of Persistence_containskey(). - */ - Persistence_containskey pcontainskey; -} MQTTClient_persistence; - - -/** - * A callback which is invoked just before a write to persistence. This can be - * used to transform the data, for instance to encrypt it. - * @param context The context as set in ::MQTTAsync_setBeforePersistenceWrite - * @param bufcount The number of buffers to write to the persistence store. - * @param buffers An array of pointers to the data buffers. - * @param buflens An array of lengths of the data buffers. - * @return Return 0 if the function completes successfully, otherwise non 0. - */ -typedef int MQTTPersistence_beforeWrite(void* context, int bufcount, char* buffers[], int buflens[]); - - -/** - * A callback which is invoked just after a read from persistence. This can be - * used to transform the data, for instance to decrypt it. - * @param context The context as set in ::MQTTAsync_setAfterPersistenceRead - * @param buffer The address of a pointer to a buffer. - * @param buflen The address of an int that is the length of the buffer. - * @return Return 0 if the function completes successfully, otherwise non 0. - */ -typedef int MQTTPersistence_afterRead(void* context, char** buffer, int* buflen); - -#endif diff --git a/MQTTExportDeclarations.h b/MQTTExportDeclarations.h deleted file mode 100644 index d492ef1..0000000 --- a/MQTTExportDeclarations.h +++ /dev/null @@ -1,36 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2020, 2020 Andreas Walter - * - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v2.0 - * and Eclipse Distribution License v1.0 which accompany this distribution. - * - * The Eclipse Public License is available at - * https://www.eclipse.org/legal/epl-2.0/ - * and the Eclipse Distribution License is available at - * http://www.eclipse.org/org/documents/edl-v10.php. - * - * Contributors: - * Andreas Walter - initially moved export declarations into separate fle - *******************************************************************************/ - -#if !defined(EXPORTDECLARATIONS_H) -#define EXPORTDECLARATIONS_H - -#if defined(_WIN32) || defined(_WIN64) -# if defined(PAHO_MQTT_EXPORTS) -# define LIBMQTT_API __declspec(dllexport) -# elif defined(PAHO_MQTT_IMPORTS) -# define LIBMQTT_API __declspec(dllimport) -# else -# define LIBMQTT_API -# endif -#else -# if defined(PAHO_MQTT_EXPORTS) -# define LIBMQTT_API __attribute__ ((visibility ("default"))) -# else -# define LIBMQTT_API extern -# endif -#endif - -#endif diff --git a/MQTTProperties.h b/MQTTProperties.h deleted file mode 100644 index bbfd732..0000000 --- a/MQTTProperties.h +++ /dev/null @@ -1,222 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2017, 2023 IBM Corp. and others - * - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v2.0 - * and Eclipse Distribution License v1.0 which accompany this distribution. - * - * The Eclipse Public License is available at - * https://www.eclipse.org/legal/epl-2.0/ - * and the Eclipse Distribution License is available at - * http://www.eclipse.org/org/documents/edl-v10.php. - * - * Contributors: - * Ian Craggs - initial API and implementation and/or initial documentation - *******************************************************************************/ - -#if !defined(MQTTPROPERTIES_H) -#define MQTTPROPERTIES_H - -#include "MQTTExportDeclarations.h" - -#define MQTT_INVALID_PROPERTY_ID -2 - -/** The one byte MQTT V5 property indicator */ -enum MQTTPropertyCodes { - MQTTPROPERTY_CODE_PAYLOAD_FORMAT_INDICATOR = 1, /**< The value is 1 */ - MQTTPROPERTY_CODE_MESSAGE_EXPIRY_INTERVAL = 2, /**< The value is 2 */ - MQTTPROPERTY_CODE_CONTENT_TYPE = 3, /**< The value is 3 */ - MQTTPROPERTY_CODE_RESPONSE_TOPIC = 8, /**< The value is 8 */ - MQTTPROPERTY_CODE_CORRELATION_DATA = 9, /**< The value is 9 */ - MQTTPROPERTY_CODE_SUBSCRIPTION_IDENTIFIER = 11, /**< The value is 11 */ - MQTTPROPERTY_CODE_SESSION_EXPIRY_INTERVAL = 17, /**< The value is 17 */ - MQTTPROPERTY_CODE_ASSIGNED_CLIENT_IDENTIFER = 18,/**< The value is 18 */ - MQTTPROPERTY_CODE_SERVER_KEEP_ALIVE = 19, /**< The value is 19 */ - MQTTPROPERTY_CODE_AUTHENTICATION_METHOD = 21, /**< The value is 21 */ - MQTTPROPERTY_CODE_AUTHENTICATION_DATA = 22, /**< The value is 22 */ - MQTTPROPERTY_CODE_REQUEST_PROBLEM_INFORMATION = 23,/**< The value is 23 */ - MQTTPROPERTY_CODE_WILL_DELAY_INTERVAL = 24, /**< The value is 24 */ - MQTTPROPERTY_CODE_REQUEST_RESPONSE_INFORMATION = 25,/**< The value is 25 */ - MQTTPROPERTY_CODE_RESPONSE_INFORMATION = 26, /**< The value is 26 */ - MQTTPROPERTY_CODE_SERVER_REFERENCE = 28, /**< The value is 28 */ - MQTTPROPERTY_CODE_REASON_STRING = 31, /**< The value is 31 */ - MQTTPROPERTY_CODE_RECEIVE_MAXIMUM = 33, /**< The value is 33*/ - MQTTPROPERTY_CODE_TOPIC_ALIAS_MAXIMUM = 34, /**< The value is 34 */ - MQTTPROPERTY_CODE_TOPIC_ALIAS = 35, /**< The value is 35 */ - MQTTPROPERTY_CODE_MAXIMUM_QOS = 36, /**< The value is 36 */ - MQTTPROPERTY_CODE_RETAIN_AVAILABLE = 37, /**< The value is 37 */ - MQTTPROPERTY_CODE_USER_PROPERTY = 38, /**< The value is 38 */ - MQTTPROPERTY_CODE_MAXIMUM_PACKET_SIZE = 39, /**< The value is 39 */ - MQTTPROPERTY_CODE_WILDCARD_SUBSCRIPTION_AVAILABLE = 40,/**< The value is 40 */ - MQTTPROPERTY_CODE_SUBSCRIPTION_IDENTIFIERS_AVAILABLE = 41,/**< The value is 41 */ - MQTTPROPERTY_CODE_SHARED_SUBSCRIPTION_AVAILABLE = 42/**< The value is 241 */ -}; - -/** - * Returns a printable string description of an MQTT V5 property code. - * @param value an MQTT V5 property code. - * @return the printable string description of the input property code. - * NULL if the code was not found. - */ -LIBMQTT_API const char* MQTTPropertyName(enum MQTTPropertyCodes value); - -/** The one byte MQTT V5 property type */ -enum MQTTPropertyTypes { - MQTTPROPERTY_TYPE_BYTE, - MQTTPROPERTY_TYPE_TWO_BYTE_INTEGER, - MQTTPROPERTY_TYPE_FOUR_BYTE_INTEGER, - MQTTPROPERTY_TYPE_VARIABLE_BYTE_INTEGER, - MQTTPROPERTY_TYPE_BINARY_DATA, - MQTTPROPERTY_TYPE_UTF_8_ENCODED_STRING, - MQTTPROPERTY_TYPE_UTF_8_STRING_PAIR -}; - -/** - * Returns the MQTT V5 type code of an MQTT V5 property. - * @param value an MQTT V5 property code. - * @return the MQTT V5 type code of the input property. -1 if the code was not found. - */ -LIBMQTT_API int MQTTProperty_getType(enum MQTTPropertyCodes value); - -/** - * The data for a length delimited string - */ -typedef struct -{ - int len; /**< the length of the string */ - char* data; /**< pointer to the string data */ -} MQTTLenString; - - -/** - * Structure to hold an MQTT version 5 property of any type - */ -typedef struct -{ - enum MQTTPropertyCodes identifier; /**< The MQTT V5 property id. A multi-byte integer. */ - /** The value of the property, as a union of the different possible types. */ - union { - unsigned char byte; /**< holds the value of a byte property type */ - unsigned short integer2; /**< holds the value of a 2 byte integer property type */ - unsigned int integer4; /**< holds the value of a 4 byte integer property type */ - struct { - MQTTLenString data; /**< The value of a string property, or the name of a user property. */ - MQTTLenString value; /**< The value of a user property. */ - }; - } value; -} MQTTProperty; - -/** - * MQTT version 5 property list - */ -typedef struct MQTTProperties -{ - int count; /**< number of property entries in the array */ - int max_count; /**< max number of properties that the currently allocated array can store */ - int length; /**< mbi: byte length of all properties */ - MQTTProperty *array; /**< array of properties */ -} MQTTProperties; - -#define MQTTProperties_initializer {0, 0, 0, NULL} - -/** - * Returns the length of the properties structure when serialized ready for network transmission. - * @param props an MQTT V5 property structure. - * @return the length in bytes of the properties when serialized. - */ -int MQTTProperties_len(MQTTProperties* props); - -/** - * Add a property pointer to the property array. Memory is allocated in this function, - * so MQTTClient_create or MQTTAsync_create must be called first to initialize the - * internal heap tracking. Alternatively MQTTAsync_global_init() can be called first - * or build with the HIGH_PERFORMANCE option which disables the heap tracking. - * @param props The property list to add the property to. - * @param prop The property to add to the list. - * @return 0 on success, -1 on failure. - */ -LIBMQTT_API int MQTTProperties_add(MQTTProperties* props, const MQTTProperty* prop); - -/** - * Serialize the given property list to a character buffer, e.g. for writing to the network. - * @param pptr pointer to the buffer - move the pointer as we add data - * @param properties pointer to the property list, can be NULL - * @return whether the write succeeded or not: number of bytes written, or < 0 on failure. - */ -int MQTTProperties_write(char** pptr, const MQTTProperties* properties); - -/** - * Reads a property list from a character buffer into an array. - * @param properties pointer to the property list to be filled. Should be initalized but empty. - * @param pptr pointer to the character buffer. - * @param enddata pointer to the end of the character buffer so we don't read beyond. - * @return 1 if the properties were read successfully. - */ -int MQTTProperties_read(MQTTProperties* properties, char** pptr, char* enddata); - -/** - * Free all memory allocated to the property list, including any to individual properties. - * @param properties pointer to the property list. - */ -LIBMQTT_API void MQTTProperties_free(MQTTProperties* properties); - -/** - * Copy the contents of a property list, allocating additional memory if needed. - * @param props pointer to the property list. - * @return the duplicated property list. - */ -LIBMQTT_API MQTTProperties MQTTProperties_copy(const MQTTProperties* props); - -/** - * Checks if property list contains a specific property. - * @param props pointer to the property list. - * @param propid the property id to check for. - * @return 1 if found, 0 if not. - */ -LIBMQTT_API int MQTTProperties_hasProperty(MQTTProperties *props, enum MQTTPropertyCodes propid); - -/** - * Returns the number of instances of a property id. Most properties can exist only once. - * User properties and subscription ids can exist more than once. - * @param props pointer to the property list. - * @param propid the property id to check for. - * @return the number of times found. Can be 0. - */ -LIBMQTT_API int MQTTProperties_propertyCount(MQTTProperties *props, enum MQTTPropertyCodes propid); - -/** - * Returns the integer value of a specific property. The property given must be a numeric type. - * @param props pointer to the property list. - * @param propid the property id to check for. - * @return the integer value of the property. -9999999 on failure. - */ -LIBMQTT_API int MQTTProperties_getNumericValue(MQTTProperties *props, enum MQTTPropertyCodes propid); - -/** - * Returns the integer value of a specific property when it's not the only instance. - * The property given must be a numeric type. - * @param props pointer to the property list. - * @param propid the property id to check for. - * @param index the instance number, starting at 0. - * @return the integer value of the property. -9999999 on failure. - */ -LIBMQTT_API int MQTTProperties_getNumericValueAt(MQTTProperties *props, enum MQTTPropertyCodes propid, int index); - -/** - * Returns a pointer to the property structure for a specific property. - * @param props pointer to the property list. - * @param propid the property id to check for. - * @return the pointer to the property structure if found. NULL if not found. - */ -LIBMQTT_API MQTTProperty* MQTTProperties_getProperty(MQTTProperties *props, enum MQTTPropertyCodes propid); - -/** - * Returns a pointer to the property structure for a specific property when it's not the only instance. - * @param props pointer to the property list. - * @param propid the property id to check for. - * @param index the instance number, starting at 0. - * @return the pointer to the property structure if found. NULL if not found. - */ -LIBMQTT_API MQTTProperty* MQTTProperties_getPropertyAt(MQTTProperties *props, enum MQTTPropertyCodes propid, int index); - -#endif /* MQTTPROPERTIES_H */ diff --git a/MQTTReasonCodes.h b/MQTTReasonCodes.h deleted file mode 100644 index 2dc08ea..0000000 --- a/MQTTReasonCodes.h +++ /dev/null @@ -1,79 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2017, 2020 IBM Corp. and others - * - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v2.0 - * and Eclipse Distribution License v1.0 which accompany this distribution. - * - * The Eclipse Public License is available at - * https://www.eclipse.org/legal/epl-2.0/ - * and the Eclipse Distribution License is available at - * http://www.eclipse.org/org/documents/edl-v10.php. - * - * Contributors: - * Ian Craggs - initial API and implementation and/or initial documentation - *******************************************************************************/ - -#if !defined(MQTTREASONCODES_H) -#define MQTTREASONCODES_H - -#include "MQTTExportDeclarations.h" - -/** The MQTT V5 one byte reason code */ -enum MQTTReasonCodes { - MQTTREASONCODE_SUCCESS = 0, - MQTTREASONCODE_NORMAL_DISCONNECTION = 0, - MQTTREASONCODE_GRANTED_QOS_0 = 0, - MQTTREASONCODE_GRANTED_QOS_1 = 1, - MQTTREASONCODE_GRANTED_QOS_2 = 2, - MQTTREASONCODE_DISCONNECT_WITH_WILL_MESSAGE = 4, - MQTTREASONCODE_NO_MATCHING_SUBSCRIBERS = 16, - MQTTREASONCODE_NO_SUBSCRIPTION_FOUND = 17, - MQTTREASONCODE_CONTINUE_AUTHENTICATION = 24, - MQTTREASONCODE_RE_AUTHENTICATE = 25, - MQTTREASONCODE_UNSPECIFIED_ERROR = 128, - MQTTREASONCODE_MALFORMED_PACKET = 129, - MQTTREASONCODE_PROTOCOL_ERROR = 130, - MQTTREASONCODE_IMPLEMENTATION_SPECIFIC_ERROR = 131, - MQTTREASONCODE_UNSUPPORTED_PROTOCOL_VERSION = 132, - MQTTREASONCODE_CLIENT_IDENTIFIER_NOT_VALID = 133, - MQTTREASONCODE_BAD_USER_NAME_OR_PASSWORD = 134, - MQTTREASONCODE_NOT_AUTHORIZED = 135, - MQTTREASONCODE_SERVER_UNAVAILABLE = 136, - MQTTREASONCODE_SERVER_BUSY = 137, - MQTTREASONCODE_BANNED = 138, - MQTTREASONCODE_SERVER_SHUTTING_DOWN = 139, - MQTTREASONCODE_BAD_AUTHENTICATION_METHOD = 140, - MQTTREASONCODE_KEEP_ALIVE_TIMEOUT = 141, - MQTTREASONCODE_SESSION_TAKEN_OVER = 142, - MQTTREASONCODE_TOPIC_FILTER_INVALID = 143, - MQTTREASONCODE_TOPIC_NAME_INVALID = 144, - MQTTREASONCODE_PACKET_IDENTIFIER_IN_USE = 145, - MQTTREASONCODE_PACKET_IDENTIFIER_NOT_FOUND = 146, - MQTTREASONCODE_RECEIVE_MAXIMUM_EXCEEDED = 147, - MQTTREASONCODE_TOPIC_ALIAS_INVALID = 148, - MQTTREASONCODE_PACKET_TOO_LARGE = 149, - MQTTREASONCODE_MESSAGE_RATE_TOO_HIGH = 150, - MQTTREASONCODE_QUOTA_EXCEEDED = 151, - MQTTREASONCODE_ADMINISTRATIVE_ACTION = 152, - MQTTREASONCODE_PAYLOAD_FORMAT_INVALID = 153, - MQTTREASONCODE_RETAIN_NOT_SUPPORTED = 154, - MQTTREASONCODE_QOS_NOT_SUPPORTED = 155, - MQTTREASONCODE_USE_ANOTHER_SERVER = 156, - MQTTREASONCODE_SERVER_MOVED = 157, - MQTTREASONCODE_SHARED_SUBSCRIPTIONS_NOT_SUPPORTED = 158, - MQTTREASONCODE_CONNECTION_RATE_EXCEEDED = 159, - MQTTREASONCODE_MAXIMUM_CONNECT_TIME = 160, - MQTTREASONCODE_SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED = 161, - MQTTREASONCODE_WILDCARD_SUBSCRIPTIONS_NOT_SUPPORTED = 162 -}; - -/** - * Returns a printable string description of an MQTT V5 reason code. - * @param value an MQTT V5 reason code. - * @return the printable string description of the input reason code. - * NULL if the code was not found. - */ -LIBMQTT_API const char* MQTTReasonCode_toString(enum MQTTReasonCodes value); - -#endif diff --git a/MQTTSubscribeOpts.h b/MQTTSubscribeOpts.h deleted file mode 100644 index 264e4d0..0000000 --- a/MQTTSubscribeOpts.h +++ /dev/null @@ -1,46 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2018 IBM Corp. - * - * All rights reserved. This program and the accompanying materials - * are made available under the terms of the Eclipse Public License v2.0 - * and Eclipse Distribution License v1.0 which accompany this distribution. - * - * The Eclipse Public License is available at - * https://www.eclipse.org/legal/epl-2.0/ - * and the Eclipse Distribution License is available at - * http://www.eclipse.org/org/documents/edl-v10.php. - * - * Contributors: - * Ian Craggs - initial API and implementation and/or initial documentation - *******************************************************************************/ - -#if !defined(SUBOPTS_H) -#define SUBOPTS_H - -/** The MQTT V5 subscribe options, apart from QoS which existed before V5. */ -typedef struct MQTTSubscribe_options -{ - /** The eyecatcher for this structure. Must be MQSO. */ - char struct_id[4]; - /** The version number of this structure. Must be 0. - */ - int struct_version; - /** To not receive our own publications, set to 1. - * 0 is the original MQTT behaviour - all messages matching the subscription are received. - */ - unsigned char noLocal; - /** To keep the retain flag as on the original publish message, set to 1. - * If 0, defaults to the original MQTT behaviour where the retain flag is only set on - * publications sent by a broker if in response to a subscribe request. - */ - unsigned char retainAsPublished; - /** 0 - send retained messages at the time of the subscribe (original MQTT behaviour) - * 1 - send retained messages on subscribe only if the subscription is new - * 2 - do not send retained messages at all - */ - unsigned char retainHandling; -} MQTTSubscribe_options; - -#define MQTTSubscribe_options_initializer { {'M', 'Q', 'S', 'O'}, 0, 0, 0, 0 } - -#endif diff --git a/XAprs b/XAprs deleted file mode 100644 index 7dc9a42840480f210012502e66e010d074b95c1a..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 174928 zcmd444SZD9wLW|%1PBuKL35gn17l_ z{vMfR82dkKNV!a>L_wqnk-kUp}amVo& zDm1PPyg2a0tM_i&{e@RsO16G`)4teWPdj$&imClC{N*$xr~H|mk${u&xK#|G;)nwj z%K1b5jfol=2Jx-lRQysBJ_kvUCt=cm&BgCmuJV7HBq8a)=c2#FgZ$l{cV@Lg%eWKA8_%1 z*2S;IMZdzuFMMh$zoG;b`#t2UUx`bfTV3+9jp#qD|9`mjG0ByGmrK3{uJqlS8A9@V z$i;u7i~ln&e1%It%`V*P($^AK`WP3#5?6YwOP{Z}?0b<*-Wy!}-gEi)MwdKOT;=U> z>7&a<|9uzz3oiU)7xuX9e;zvx=MVM$HJAMDuKE_b0_S@PjTrt>cYES?R}w(fA{!=0jU2@SNmS%%Ktf6 z{$iIrBd-3p#>KDBMSrHN{E$n(UvcSYx~sn#aOw9&m%X1!R8RctAFlGfuKd4rmH$;& zeUG^0S>^JN7FYe}yVC#a%Kx@Yo)=v9oA0X6Z(a2tA zUG`b-k|*NgzuT3*%*Fo&mwquNjsNlEX`xFWe{%7g;_}D;cJX`Bh4;A1f7+FQg{yu) zbK$SM@{e<+-{!JMz|}u~+U5T}uKGRf%D>iS&kHKjEU^@3Pmo zT=m)RD(|SvU!HZfhjf=dZ*bKQ)A9Hp_Am2X^kG-|Z@T2a(`EmDm;5if@Lyf}_@zt! zsv1QzUiv}Z7zA6{DxfqoW$Pn!yf`J{!?B2Pj~5KMG^!0Q=yCg zRu{j&x%Bh23!mfSKj_lmc2{{huJU3@=~&VlUvky=e3$-bfJXoEw0g2Mc&H3enZSb#vne`95FIOLAJ3Y6i{e77hl zv@o=`pt>}iB3!D#D(_XUN)$qns>(G2rNjY~so!UbjPVDuFW%ZkG{6j7~J#)@U3@bbmM%JOjen(|WMg=KJ( zvMa*n>m5O^0HGoiiLNYIbIZEQ^6IieW5uHK@>{AamW3;e%hnkyg4JQC0>MyOp+qeU zm7>^%Wfj#BA0;h<1+NH$esy&ird%;!Da*-5!IMRnXw7|DxV$oSUBPhhigmA;Xws!%Bze5)YK>~UuT4BDvYY)GNS^T1Z8EIq%)1GqV@UZV8XaH z)0P`Rm|0FeYo_N&!WFF-+n_qYcELb!L*JW_CP7XA-wwTMUD^ zn6udRq4lfbW=;xf20d$}ODHHTbVo63l3c2lNExVUMcKNUmxux`G4RZ4=2sQ3%U^vP zZJ}eJvI5waP$aCbC`6+I*R|ym$-3qjt7l!uiu{=gma7vELMCg#1^I;+^ijPgENm!g zW%}SH$I7SFnD4fgs(&+$^1vC@D3sOHz!r_~g6#3)jp~@U1Mk zEk9hIU%75|T(C7o1!ZL+v<6WMRJ3M&MLcl>`mZGYz}4eP3m42^DnRvS(D}OXEf>|y zoO#i#Pv=ncImSBG)8((N426t!g}3B~*tVs*;bJ&9%u>9rte_PA2Siwdt_#kL*f@Pf zan0)LwfSYCjfg8>k8Ttmv@XAVbqT4f%PK=_4OnnpdH&jRFov?$R2El+i_y&sz2lP* zEWZ>30yKqo1@o*&<1-j5&di6^t^!sw-8^r8;s`qkx9HAW>$5mKRWS16^#FwB;}p%}6;x=OmY)T-(Fr&7j6 zb}CDmFj^MhF2gXZAoT0Y3qz%;bx4gD36pq)i^DWORZtXysXkbF33*Z^tSEqrm2;)& zk)4aM4V9Kc(lSmUDn*TP3uA;!RwWfuuqIr*A(YVe2AWKlCx(opggi>&Y=di1n3TFf zd5_NNICqLAHWn8u6TsPBeS;UZz^_I5gEMR{rQn%g8fsk!PFq(p#!%uJF9aF)PSJ(HXA zi6mN8L{guS)TSKPzcM`F^A2?`aNkY#;AO@3*pY@Oo=Nse2L-c*Q- zl3Q=0i>3Wmmsg@kfSn4R{4W23O)3-Ot8R^P`DN&C))W<&CJ8UysbhG|L95r7Df<^B zCW>(%s3@<%M2OH;Z>QFAzfM(Zq5&m2MZDMGI9+(sI9-8>UzjsQIQ+WuH3h|$_&5P;hSqE__z&kBk~Lf|T2MvhFT5Tz3ak(EtE=F{Rpo1L z355+zOV(7}h6y_ywFu*Xl~E-ISZl16nRMOUpOX1=q{03R6cc1j3bYcmq>wcrX$EH&$cT!YI!0!sXTI-7B$jC|g$o%o#F6 zCZn*mYf8(jLMSIpnae9s7P|5BH6nXK7>Za!h32oODh#ycP}v5gp`AdEP`IePD!lr( zGOl2%t4c#5xN#`FW@DkTR;K9&3{p^trAv7+1Xxp0DuP4AHAR)iT1OWsqNac=XUst{ zsxXyuVkWnGjhd$A%bX}bzXmP{kwP+k%+Ft4Rpm_Mu35D3%B%8c!4>sWj)ACagMn-E zFG-4>8BhOA{AuQ=KVt;1yJqGk`8l%NkS6cs$KWmg80SgHs4WwRTBSYNn`M@-oi=bMZyRCVM*%GILM$j z!^p!hGLVwk9HV^P3Q{pA*GY3p)J$=uER-@0|0)_ysWm{E8OOimtEHzrEKkw1R+>WP zRCJ`8C?$Xx`$go%lC*6UZ%s>@iAeRF^xsFp99vDYhc>ym7`yhT7@uSW{*e05V4>4} zl0M#;mXyvNFP;9%$ZxRgH_n(9Pfs&uW8aG~2Y)9?{tV-CL@-YA8=J&0-PqyK2jlb; zm?VB4;|xf|viPTB(Wjv3G~>%o1kd1b8+m~f_Iee5 z@N^aSoTb8EC$yb#zzGMPaL5UVo$!Pc@(2t0r#oSW6J|PL56T+{quLDbGK>L+`we4| z;WLIY#IVyah8ezO7$+FwMM9>}V~mI5eGFlrEQYY-6o#npREDUjpCOznn;`_5#t<62 zkRkT(a~NXZdNxDs7tdh`517XgcF1Ljt;YEbp|b@HvAMg5AvR@$3~~7B28KA`vx4Cn zhH*2)j~K=(h9AY=G{Y%4lf>{$Y+W+^80^9DINdOIGyIfc zG&97W>t2Qz8pb|`7va1U!%rJV3&V@C@5(U8Fb*@EX&6Ts&N7S+hMzHvqYQCitdrqq z4WoG-;kB?o!!N-83>U%v3>U-x z46lRz8D0a{tOFXe}=1Je}-#de};vyKf@60&u}g5&u|^= z&#(ygXIKpTGc1Aq8Quc>Gc1Mu8Lo%@8J5BR49j7Eh83_s!&_m0hLx~C!z$RHVHoyj zSPlC#+yMJC+z9(KtbzR*-Uj!83?r~V!>_>p48IEdGi-qU8Af4$hF^pI8CtME!x-$(@NU?j;n!h* zhK;a4!+T(VhWEn$47b7l47bDn40pi(48H;UGyEp(&u}N~&+uEYKf`as{tW*U_Gfq> z?9cFi*q`BdV1I_+h5Z>e!Tt=t2m3SpKJ3r%0ob46gRnotAHe<$e+c_C{1NQWa2M>) z@W-$}!-rshhChM*8SaMt89ogAGyEy+&+rl0pJ6lX&+xxse}+GU{Tc3o{Tc3s{TV(A z`!jqD_GkDw?9Xr??9cG$us_3J!2S%Mfc+W%682~KB<#=dSFk_B7T6!-(D+u^pWy-6 zpJ5y9&+s7Z&+yl^T!F4&)8H|)>w53oPO z9@wAZA7OunufYBcUxob{_QL)QUxWP_{t5PH__|>%GY2y4t*04AUE5h8v&`Xkynp%*ehL!BdF&PhYd( zslXwmw1(6k`^r>4ho)493;*a%&bK#h;szb zBVI-97o1C6MC=nhpSXh95KPuZHN=DOBjSNY#I?jdf>~5i196Ao8;Bc;TLiP{qMgLe zf^Q~nB5o4Aig*`squ@f~X5w1G6s>3(5O)YZO58}?BABW#+DY6j zxQn=nxJhsi@h;*-(&qViH$Vi9>G514B`&KS;Ri#7Qs`9rw}&_ z=BbP#KXH>_Kk+o;M#0&{ImESsrxDK~t`K}7aW3&H!8ybWh=YP>69F=;2?1Wafe`j)lk$(+#+}d@lN7q z!8a2(5jP25MZAl+QE(w~GjXlpBI13-6@p8NTZmT)t{^^4926WT?jX(;TtnPRoFjM> zaSyRya4oS->=Rs1JViKh@Z3%-xo zPuwK9iFg`uqu>XLbBJpN?;@T=$gn zv_&?tPjEW%Ah97hgLs&D@NH@T#6~)Bk6<5h262brEMgyVi{L55Q;3@dPbKyfHwpF= zPa|#=oK2iVTq}4Q@f_j`!50$e60Z`RL%e`ED0nt;kT_TH9O4zkIfCaAuOjvf&Lu7) z_6eR(TtRFIUO-$!JouKhf8tu=9>GE42I3CEJhfQVNZcZL1@TVeX2CZTHxV}pUPZi% zxKVH+aWiqP;3DFE#1(=|iCc(Q39cYMOdJ#(Chj246JmlBd!oUK-@ySO7I}@Vd9|RA>t0=T*1S{oy0kUPZ0MI`vn_l+C?_8PjEW%Ah97h zgLs&D@J(s|#Kt(_9>G514B`&KS;Ri#7Qs`9rw}&_o=WT|ZW8P#o<`g#IGZ?!xK{8q z;yJ_>f-fY_C0->shj;;TQ1EQxAaSnXIm9c7a|F*LUPbH|oJ(9p>=QhnxPsUaynwid zc<^u1{)uaedjtoG8;Cmu^DCdCM&cI1D~NXzHw(U*xQVz)@G9b6#EpUriJOUQ1s4(T zBd!o!O58%cN^k}7Vd9|RFmVTQuHYKtPU0NFn}~ae{eo+WZDOC`dg4K1LvRD}F!A7D zS^pmVv$k>M0S*pp8)yFc%h5lYy@SCUmfGiFW?9$PfmLnHY-|}B3C7GE21{-n+0zSZ z`+5whL)O&nwzZA=zf`og(f%lgr@8|cnS9OX!@qZ)j(?{gHiyS;_^5T~AoyUJdTL(u zHFF?q$w-HJ(D&4vZPB-4`!7K8hK)5e@_zyO^E3mpiN3aM`r+2$G;<(5+Sb~CmZ$T% z;c%99FQ>SX=fe}R91boSc^=%Xl_#D`@IyJv?ByV;YkM0rdt|SD!Vi8%^#ztmRX~_Y z=0N7io(G{PyBkX;@UTCNltU&7J*oWc&xw3L0k7Ddi$HBt35o zpAY|8)i5YBJ=K?uSSu^LO=2@_YdcRz{$f}Q9c^RA#8DC99rnLS}$(EtBWi&p;60kXtZck$oX)Gcy!wO+Gkb%FM9*N6ALEgsDEy@4nw6UC&#G$fT)$J%(+@=l`^QSXW1-=jzPysoaU;CLXU`V_d$Gf1ZqA_5 z=v4hTgS!}wk~IY0hAaXpQA6M@?_+_tMc5zeViEI}#B5KL7!3@Xn+J{R%-YRw8{u)a zo8L03e`Ey)6Cyx@Ec*afXLW6>Apr^%=YbrjDCfDz3=E+m3{eqJD*cRciadbm2DAsJ z)wfjt4w>UNCEJ?8)aV-!b%Q^Y$U_+z(8aou&0NL}oM%0b;VSd6w**Y;;@ zbc)iQ8YC$qg-O0*0>S_A*KSkvrmNVOq?l~`E$FMR?HihHk0_?MJJ8c@W+=t1?EIiY z-c=Rv+T7_>@sHgr2T}i#>YE%N={QPr`wz& zDJk+^E%N>e`@WW0Isu~#n!Q;e4}+F@GajsM4IFjydS43Qe;C+LF7N!I6yYs!!oBj5&w!j>osHFza-Dg=mX(l zRv@c;N@~CVNjN}V+mqNQS8~S8npt>GmK0Iv>8O82)>d8Uzoxs-=xoqkvaIv%O88M- z+hoeh{-i^E@Te8Qz;qZ@iw2G;6VZSp)kj9E58H>)p4qgL{p}9SP}mMPAM!pPIJ7r& zZ8UK3*!qJntsFSE{*YzTyjI@8^aD{C%QiRLM$I_ACtis3ezjbfmh&-mlA{ z`;Juij#T&9r+-j6T~ZFc&&umk<#d{xJEfe?@mrkXwfv>P0NW)Si*zjFpHC?y^0tsq zUW*m5TYEA*=r*TBeJ=&N&?uRyM;fQjM3kDT)5$b7>XV@%rTL6U%d2bq(KC*!llwuZ zlU1DsI@z8NYW8DPx7M{dxk)$|4QlzNE@~*D!?9rt7 zz~1=JeU8OZ;}7e#^VDdgdgEjX2b6@P_r@Ps*^j8cD7CVa{*}sZhq~(8X5$T(c(>ET zig#lU2=DGn_PVZ->Q4JQ)fkDz#Bu}t*$P=s`@^*7RcxNH2yNzYp55NQK+OERe3z>Ef;jLcK zz77*ibWSo`!c=>jeHr}O!tjLwGaaL4%oMtqd8^D)Kd(HjA6@&9mFu(6b4ShnVrk4| zGrVN^p6Z7ZERSOWlfqKyG|PcMiv+1GkAP)zXPjlf20=0Z#aaT=m-y_+pW=dZ61@N! zg7%+4}y`!s060xL}6bW2G;NGZ-xQnm}H71&|J=78|@ zMvluuQuxy9!gqt_8~%*_3sgY!bef9d*?L@Rk>J_)U9f8G_cXSrxSJI?S^`rCM9p#20kO~e(v^?91$ zqGW<^D+0{7%*{s(Z~ev8CP0f90>j=)E0~lC@5_?2=DV`;Rfrill5XW4QN^R%4-8K4 zxHNFs8~HsGDc+Teh4R!B10o(KZRX~KMtFr4I6P8)Fi3wnV*g6{l{A%u_C4A&;q8t? z2gu6KP?H211Eo1Rt>7c)qr`*0zF(kZyA3Lb*@x4@bL_{}Gu=va$`ejcqAztUWtK?H zBE`FJgGi4CtlF#78Y@&)3g4inmniQ>9gF?}YBWiSe)kWK0m3<~zAo?%VZS)3z`G^p zB^A>*c2sr!Mw@;#bu}t;IOoNK$t^?=GnCw5db zQ%Ty`zf!2h-D2hsg}Pc(qe(cr`V|v&2X&sZ>`5}LQ8M&T#Mab^H}ZGRWY}$X*khC- zEa`^PK}5cQr7_wjl1n^xNGZ9$Cq9@!Ci}%&Oer2|fj@I^VOaJSPIL!`yK9{Zr`lt9 zM>gS@;X!8DGFk?iCqLz6R2i@MBD#rqK59XQ+->OrDjLH}9J3y|6sAb%YnQUxT%JcN!PO{v?Q zrZyDJ92Ks_qBAUAb@()y)6dcIKuPO`LVF1;Uf1?l95NHtw#WkUpiH6n$rO5jLX%3h zgNX>GS}0C7B?e>_3e^sxa~Y{_v0u^=EsoZn))C0Ef24Y!{c{}wCA4&f24xAhuPbEB z&PLC%H(u`R?!5gJF2v+9{E_ZJrxQCl{#ZT!*c*L2(UiLbc2|gM)*8D?wSexG&4_fQ z`nnncx)wL4wP znbK$xE3}BpyTp@TkhKMt;2qt8j$_!z$%XljJw;_~I9ICefK$571xV_{nMtGD4Dzv& zkJOh#l9Nn7p8R_H%a6UmSj7-LxQW#j>gZp7?2Z0qOzUyd<|k*Kq&D(Es08bumdxg) z)QO6`Kke8XNgkJFzYOoLYukzwOVC0|{z!GEedJ|vV`r@O)?dhO8RM<=N<;QyHIQ>H zh3W1Tq;P@@ud_dsk}?%3V=zvu9d_BBeG?E5^FCcYxj#Lze>(5e;lK62=rDOhHLGY~ z!24w2P16pV!`a@i{sek#?Mbuhr*xoC^>mK(pmc0F_>ocpq;$k6#U7N_Whu zl|MY8FB82Jr%x$5z61VN*Y3S#PL>U=&!GDV>%;5wCkTQPI^Ggvx6 zQNCF4m6%z9MQ{`oUB+5QtdVDU)Pj8Ofh}3;Db{!kx=fu@Z-R>~EH-&Th*-&iv{f=U~YcCWix?w6uSkz8UYmPnT3>tdu_}s8mw)_4Z>hgc4->qH_aMXHq zzNk|vb)G!4(2+-H%fDo(3p4METlWRgc@C}nztzL8qY0hzonI}FRMcZl`Wsn5rI*aZ z`_IS%$Pu(pbW1%^!?C1-{Fvjaq#vr6QdXo8lxhuoATDmUh>M+}|Gl{HypRw#QWP)i zXuPa_V%L95S+V4@R>jMDEne25e_vT=Czn+kFKaknR*%@}-%_tfpHJv8P^((dOVWJCs%bzVbhtRDNVrysl@)%Ni18{9Ee!)N}E=HpW6jH+?x@-ZRTf z-XB%rG)L>^J!snZu)V{t(V<}P?w)CaGKmIbbsW&JJ()KcePMdrFMjgSL!XLvzJ2_; zccY!H!)K|NAQ(#rtok}*l639ox7Rgckm8?2JQ@WyK`~nj+TT_EMSQLxBkg^lwy#AC zt7|*{GY+x6l0QD=_o&@xjCb5$ro0pnQ=C_wEN15f~9UYVzgTrA&%SlB)RJK*yF%&IkrNj?FZNn_J<;tZHAxz5N%okVdyMdey3M_R zLZ`FkUUPG=;f>_Utb%g^*6rJn*D~2lMT zsCS3a9qhMINsjR!GS;KRCi{^`$$0t5qvSRsd`2E62O0nWF4M6bHB*6LkWAa)Rqi+a zUy*aMmQy=x-+U3zQEFtaAV>7b42}nzdp*^ku*5pz&mCBs2kqbfosG=bHvuH^so~L- zsbNRb)DT>5w++YZt>flS%RGXuHD)P9W2_(I$K)#`2P&nEJTt zwsose&gXFWXQqzIol1ggDs?kDUrZd^1D*7mz8~NpXt^Y_#2*XP2JOvi7{wgTs#hk^ z^M9-xp?@ySQj*d!CuGL@-$=UF5T<(QB&40hRr{f{r;<}*)wP&B(e-8WRCPoI<($t9 zbmA~f=cR#O?_Jj;y?;EGPh1G4_O{vfXUnkNgzMEb>Wwc~7FpMKmgIo-a-SQJHTkP6*<3f1yhGjv#dC0S+ z&XJ?v`C-pBGfW7qb?cGk9zj6|PqeI?EFbS(2@7>hhldmo$ZeeC&Y zo^9pX=VC#OV{hmg!;41|Wi;^&RVgYXG+GuaqyGz|r2H>6o9?~)eE7+8p@9!q@Hp?? zKf)UE|Cr4i&4bxD#gD25?QdZUSl2ceyA)XVlo$D5AUSJJ1mZ}S|M zqaGPn?E(yg7@2+M=1fDc{C|TD1&r@9nuX7mB?NmcZn51yS#7jcXR1RSyjZuJM=LQ` zuK}xh`I<=snT)dfz&t$`Xhv7CS04`23zwBLq4#qHy-+gmHHS~xa-kJyW|$o_rF9yy zAYSb4oqJ%@WW4iXdsQ*ba}R8GUb>&Eiw+eSE=uZ=gt=bByyEnqyh9Rm| zJ0B5PAh!qT?P%FYRKSxeM&Ck*DzCHdz}<-Gp5Ku!Dv2}4hq!U(q~iH~Ykp%oU&7q| zcVuB9O!%9VUE?^rr$jrupq<@r?R>sVdO2$6A!NtvKEqqTU6}5k5$L$=$JjOX-eo2t zmZS8o8?3;t8G$2`x~bR!l7a(_yCW@I@(_pMx`cM$Ljv|Y<|VX?m|ckZl;|i79a(po zJrfb+?E)=a4NF+rC-1P2=0h~RXAJC?b49!OZVP=fPURFDlM+XBKh1nw2MO*-5_b8Nw|u7~%L!=UmU zMwDf$PP>(pQTPrFy#hRo5C7ofWR+nx-VBJwfp($(LAJ)XFul_`4`AM>yZ6N^vb86j z&1yG$`aq8d`?TqNMc8Hk01F2Ue~ui!I13NYolubCmL>2L4`!08bN6m}7($@^tb!B` zf%e+X?Xc`2`VMLoJdvo;0jS43J_aY0oEkx{A^nCvFhB)j^s$sOoDEOU;X}sAsByx> z9OmdVN){PdFv6Le2gYIaiMPFX;$?eS_8<%G`!<`#C`?9;`=852FDq=>3bFgz9t-xw zEE#i@d16`Ea2mk=r<@6n23o8@%eetN8rW}c-p?`TWKl*F&oM7m5E?BDRe&+)WM=#zmf5CA-vksy<>`n93R8*b+a12sM!DCo#fqQCxLV8Ex$7lO54D}4s2?#?}c+= ziZEFgTkHqCkIna`&+~_|xhTsonTdN^q5-^gLQ8l@*U|fkw1fi_+%2Jpwd>o9e=Mg< zz%eUsRj1m}+NL^$ynUVywvT_6I_|-<{U|BTWgz7s>q3Cno zM;2$rR~+&xe@gVZ)<0s@RNng>Rv}j2REg8MypKGcoUE57AK@_JEPB$s5uSFi77wZA zRqWa{_<^h=T8@vAr3CySp6E#=rXjKQm9Z1>#ez-}*wA;Osz8?a5qw60^VHm-hz76%OE2|mp8 z%s$Tnevr}t6{jR&9|Z39A*px;6Hhe*CqR7S(m>{>ud9!z_)4x8GaCEsr`VoaaT$+e zYP^e6A4eg-df>#?yo?SEr?+blJN~P@+?lr@gMVN)8H?1M;0AyHenk|S3Z+Oq4|T~` zL_zy~@n)P?2hmC$>loRb51t4$RQnh zp~?rrOFTNR=z!v%C~?D+5@YSS3j*+*gwNX1D33loMkIE}PDEhP!v3ul;Z-D7F4h5q zC7z|=yn~W2m9M7o7PRkcFetZKa0+Wcms;7P%7|;N!5(x)zilRM|fqJv4Ieqv`cw6aw4wdp1&==MG=GZU4 z0eyKNk1*iTe9`=|hpGRUR`woynDOuxZd1j6&UHq>C(jS#nG11m!vpfPf*2v2gZ+l1r-f9hJ*Gjp~0)rj96qhibiIY@Z+1P2|4s> zir*y{lb2k~U&PWMUd%Jf8=xbok6!31?NVJ@c&cpI!b@2v`)~3F#@ENs+qqXq^M*ew zb*2}`A`dE=>56gDH@_$KZjYp+icpc!cPp}kZ_J#GE(vr@KyaVR)uaL%QuDwD$;=z5 z0KcAz1+wrh2L@FuFhw4^EU`THM=rI5Uu%zgq1>}i96Kt>@g!_{N(7`>T9O;IzoZ(2 zij)`cYL1R>yo|VZEs7d&ljv>K+vuA`dS?QN zVO8Ef>|jN83HbV^1xs5@u3BsikC;#&wN4`NI0P78TUvX@PB@t+i9>78DI{>F)dLtt zqImnEbC#&iqR^S)2Or_&p%7+5ORuT;#7Ox zW?K!pt?&$GB5MaN()tQtyeUJ%1o5G{7S0SprAD-(QhB|V#CzVbH&TBhPv3>Ni1J>e9%%MFvP>hz&(~sP^$*{+%#$+N%^{R6Ny_=qq z8Mkz(m~?O2gFHCyxlhf;o!3Tu<0tR7@RCox*xDm6wyKX_$wE7T}ytv@LpnA!?xqlhNiM(auJGPIJ#xJ`jrxAYIKwkX-q=Bx5cz4@yE;%)Z7F zdF($qLnLP;{8Sqg3@2sYlafo#OU6mTiFt`)q0687gpkU>j`@isqTH|jQb%)!qGJ#K z+=^~zkwN=YhoK*KlzAi1b z2S=N*Qj!Tb`%v~Zx(`JMotmt=q82;egSse^a!db-^Ct>Pi8R+p~v%25js?|hs1@ca*e636Vy%uIHQhc0kHh^3_p(Rj*T&|sck36OM}7yz zxR`kuZ_2w7_GB|W=}6Qc+m-uEw;MI@;%riS-l*A#=XP^D{)HE$e43SRUn^xFzb8?) zXUpwQ+58UapDH`_;brSud8$9sE{7)|1%#8%Q@#%zUAQd!VQ8$bZ83zCZh=!nJNjQz zPp4B0bFRV_&}7xR`*94`7oX+w27qGWF+q5wm!zo)rhTq6xlvmXyz@iN)Q0To%98P; zA~KWD7A6N9lLawS1)1&$a_py$e1pOhGjgB(n(8vttqSS}h7=ipjSjS~EhOyIOU61f zZdLxHYnmkEi>i#cjP|ubj1k$$-_X}I znhQNFUK$)N=ls-+k_0`Q{iB~Tt3OVH>3?quNta!(NNC$yz7N7Mbgu2)gM3n}UVDtH z6(BeU?Y+vp_5kxaBt1$PA?XU*_b3vvTCaV&8axDL+AlhCw{xKq#?D=)RWYr9EWQ?6vRGJkyuo$ola=tXGt@$)mZbc#++OLhIT#;awPcqM@gIBfOE0D0do`z23;r z0rABikHr`kKk<{7%y{F-w%gZ)f9Iz8qlcneGuo?etSPERM&Phi0y)1XkS$mIN9GgbrI5m|c-ZUgQ+M44v4#$h#9IqRN#x$*zT+9k?h z6tW%%3E)Z794!!PPdfM`r3Fl?#Ni|!+etzDYbph<4rrI^X^!;f_Aj*q;v-ue<^uDN zBZg%WYUb-S3%M0(g34oGfmY?Fyi8MK&dVE=E>c~Iea0xXlQgYxeN#1eNBSIl8yv;W z{pBA@C841kgZ5I@1tla!XHW*sz!!8}$}BC*_QS2}+FH=XI6Guu#0wJGoa$GJJ4Hwwq^rE*MZdhy2W zj1Tr+sy|uA7ocvpjMt}fOlf-Y#(cZj#BZ;5bF3SM<3FIOq{cjY)1&`m(6D`Oju(%@ z@h7PqQ<~mbt;gS~Hs)@6e-Tgjv)a94Iu-I`m}FB;Q$;w5a29xCy7DJ-#Q1CHDPJe2 z?aB%Ez?U`DHXnIFYR^n*LHm2k+hxAzrhHLTI_>P&$|voI*<(6|Xs$ojw9?Kj)q0&8 z#2invLG|!12t-P3L;JA@YybRvqIFC(u0}~Z_H@POve&WavGF6WEQgvTOG0)` zTG7?M42Kl{BJW=voBWs^m7{}Cd|xQosxe7EokB0QYgD%QY#tMdY`Y3BS=V-Yy=yKh zucE@GqLK{zS*=Fs2va0XiS- z^6ZN?9@fuU(Z>Dyc}ldg1<&eroioo4!;$OSvcM)WmByww-cR?yq=Ov(_;>%gEfTNxfs*4uYADCF=6w%XE5(8tYDe$b+<2^#FiQZ94Y zVn#A0d+=f+W-UszwMeIP79L2q_nU%PRfzg@hxyG=KAq>lG>bb8vk7;cc~Qop&fV&7)TCb}iGsl#(_^rxh~o za-_+!L9g`F?XRFyu4_9V3G|2yxeBO7uNbs{3HMVyijJ9azr-lWk?1ho9rHFlU)t?> zKX=+6QM59Lh~dHxTGnK^KDGY$2N<6Y{tm4P?C*|*iGH0Hl~P#7!#~36z!Ndq>9!yzMN3>n&N6j z@y9GqWGews5yzELQ#B9 zQ*1hkqDE1ip($!lqNrCCZw@%M<*VdWN$*h<&uI$2SWcz5PfO6swfs}3i?bc#Z!vn0!^V@CE5DVDT=Y0LiOg!6u(y#ul8$wpi@dM zrAJY;Y6{i6C-bls#dkFYKP^t>@i#@WSyS*fid2ddisB|sQF9W-h@zOQD3Wr=wyi>e z@OAHDX&26QO4hao8SYZ1D2l%ycWS%nB#Ltt#S4lewGruUg#Hg9n#fm0*B9m@EggISZ+qHMF zZ$k;U3%9X~vfb=}qwr5^o(+=cBgkVPdl&D^;$&cf+4OkK*kX&a({a!B$gL-^;=-h1 zN!@@w9`u(=)|YNaAM;!1Y`n_!v;P!5s*8%aI<;HWz#v-rLp>^vtEzS<#XTf(UVCRe z4%tq%qZ*<%^-`P9sTriyZ?D9hmlV?@F{dZR_@1JcJxMV)OUz%?#6tLNmzZu9V~xjD zV9RH%YtnH@RqmIbuAeFWwx>XhPWFu-NflvD=S`vad`IibVt@IDawXw*jpl&C{8Ifa z+>R)2O>u5h+s$0KIHoPihMgkY6jfVK$Gz0OEMRbI0MT$nuPCUTqMrOGV&*3&?K%=h9u5F zl&(o!Lsb#)MTu>5hMGUT<|xQD7&%nVaI;TSxdtREz!`6LXcE_mL=tDfsnjH{A&Df; zh;zLrag9l|mowyCs7YLd5@$Hhm@`3>sI^9ldpU#7pL(5oyM`qeXABG>L2AactlWEweS1Yw&?1rwlMV6kSq#a1V4YoquMW8(v_kh+`P!Q8Zq;4EDOx=LLq2h zsCf5Zpd#9hi?0kWY0pi+BDi!}dv3!PWwJ+k z99=#sfuA2c`O*}DPPS^NVB!egdJ6#VeuVb^l&XtbxvNBLVl>0LHa)r^-TU}bEdGPM z?uHV{;@*BsPuwy}F4A$YsJOT#;)cwXLh@80DTe&nC#W2~{`J7y`K}RHdD^eXl&7I? zVMk#MsiIxUSo{Tz2g)yyV%}Hnr0*ciLUv{7(@aBF!h3Wz3D>q`GD3n|aPKF^Iw+0N zv0QAMe(YW;Jds_j5RPXDOwOJTtui~JCHqTC?IM)0w!ftfD0NVB#kR3LOu0&()&_m4 zo})-A@>x|8`x6kxe&U{Z%15R&EQJ^WypD6wQ|k%!n8w8 z-_(2L*;A=~MQ5qcKLUH>5qw*TO}D-A?*-Fw?lCtziZ7IOp3zCBMFYD(oFsUm`kEsl zrhI9#>%(*9;^UGB{|6F$uhJAJ`Jca631VK@q*~nOW*-L>o{Qpu@?l36&6YxF9TsqW z)H%24+{vjfqqNsrViEMxpR*tOy1W4zo)n(J9#daesqW`|SasLpE$V*GOO-M8>BbE_ z`K9wjXvUbF^9tHm-tG9Qz7CY9%kVwH*AhivoLaQX7&BGTvra0y#fed0X`Q~I9!?ii zcLv8IHRK*MW8z6){=M=zQ@#w9H29iw;O_}Vq2i@9%!aExjeBDJk2`dROd#c-l369Q z&={_lOgZe+cxf0tgkd5(1+pGR0sPeGY*kauT3QHZc1T6yQO7)yqIY=7NGcmlV`7Xa zml=0SRoo=tRZ&gB z;voo|TCycGmniXXgpSrWP)FG9z0dj53zk<7BeFVT2JN3p-;9qMxU+|vV`a}BJU&?# z7gW|Zb?l9MgD@ctJpTnp|4v`W+p~A7fy6TA26k>a#Q}LcIre76u1OC@hoKKW4zP<2 zpe4zBMYYk13FZ@ARakqt0PGBu!ZdEm(-oz9i69EXJa_<#2*%72T4||WAtZjg0S(2S{peSvLR9a>puIsg zCHrnTvYYau1SMX`cPT~Kg`-f`DoW?&)cD_s5KlOD7&D3x*C$wGqVw0N775cz)!Up& z9=1Il#+2K}FO!Z^#jfp9COKqx!cuOjhrXhjLHo-Uu&;;kZo+3&TCyHv<}bF29?w%% zm?mQS9app`sQ!SAY^RrEXyw>vp$2aLw7J#Vo1Yg(`-*b_p{{n=NTMi76i6 zRyj+UYa}fzk;ZpVPTEpQ8&;hPdGcMBleS*cx)N!8o8_e4E@>^=rO?h3X{Mw-m`K|$ zJgseNDXZV3v8x+Vnz6R2C9Hmt#-v`Iv@4tAtA3NlB&UDHH3O2QU!^hWrz%(CZCyr5 z5T7}38< zN@l;xto?k6nqbh4_KL}si^9(zhcoDCDFmi6RT*$!)fu7LtK#!}8<|PwNf>s~FWMOi?kcx#|<*ihmMb;8w`QWM-Rn z>9iP1KNaFLgLF{zC0OcMouiP1r5=-7#(TI6RHd1*Svmq0g5PD10LlEKnjcMg0@X!d zofr!-Ri2{yINPXI!tl)>=XMOivkw;4MQLyPY%Agq3Z7RuJad1icrK04=_I+4~O*0h&7)#Yg% z8dsmnNk>HrF&|eM?5R%IQLA$OCJAcc=4#6qJx2 z!ru2)l`4}H_E0yXnzzevA;-}1Yp19H=Af#wv>ys~Yx+BiNwVJV(AlKIIre{!l5O3| z+2-qPR3Az!93@-M$=OcT*;F0vhhciRkne0xa@!q`?7oA}A3zMNAGLk{Tw!p}8)WWjsT&2zX(;P=tN6L0<``fhY_ zV>ItB3$y>=S$Ng6;6Ur}SbUVUcLymE9c^uW=d9MgkK@b1p0lPO{uSR>MO$BZJvuyL zFj_BEYD0>bah=RTr~MOb+9UH(B-rDt>s&msBy{q01+eDj?=gwTCuz`w)C3cnmOI2l zv8zy_%Sw{N+ADNA~M)J_#%GO0?tbLB8WUioJJD$L7IRAbtZHWU(FB zVJ(TCYQFdlR%8u*KNRXl5zhNqu7@`j-YwlDYE7hg^|oL6dkh-1jR$#UUE00I3z} zWrj#to^5%qk>>$<-Xzb1@?0y=L-JfN&%^TEAkR{8SK} zO0dyy4qxQ0_rvVw@MYfmPs+m#Z~Yl~=;Jjemn{Rex1M`}@>sd(vKu634`TX;@DF}# zgDY)2BPtIcwqGF|6f0HV)W>~u%jD*Udvo&4$j)I~>(TwU%5z zY;DUyjOXd;_^m;jN!?IuS#m+~w&rY|MsuFL3CKy?LgfYjXDmKJy5^j|)8wRr{Msts zck&q%;B-&Y#a=!#tSsbhA*Ew z@rYiQCnS&dpK9OqYw`OI1dV<7GrM!kwYUClHeu;hX9T(~n}P1a`_)$whkGT_*K>TK zB={Y_bdKB;&>vmLZpkj$pjspDM(e&#{4WkZ{tU!lczQDWDB>ptS;Aa32)sJN| z#un^G3lDuLufhqt~jocs8DnL1@gpfeh% z*IJ(uI2sMqnw#r!O{uxL7M<_;!k5;Z5vbQcT}fllz&-L}b^gdCcRl5|F4guY$;Wa$ z*BKb0f4@>_`Bia(_Je-EQZbIS+;&O3P{XbmGRcg8STHwTrC`~86?vS3DWh^rU9ixy z-~{al{Su~PjDoY;g_^}Bz8p?`Eu5JC;hKs@OU`*=el!)UAMs+CJ!tPz{(+fKhh#yIV!{v!R<`3LiKE7YfsiaX7ZbEMUvEQnxi%5jT{)lo5tPPD|f~vG&iVjWu;UxD!&;Z@AYG$!7uVk|5(8Zeyb#(uaCzR z1Hb>f4E4qp)AG(%7IP(KG0VWb5$_rBjv)j4XSb7`9~Xu==Oku7%LaUnMEeqF`056Z z@+{sX5VEfAdhm@!rlF~~8_NPqZ^Xfc^uW?Xx#Kw71Y4D6wqPH7i)x>2?2(8V2i7<>y)VcmmFAjLKl-ePIw6T0T6OXTJv#>e~Ku zDOKuLqeY9IkXO}x#VwWxF@VDxiq;+Wg_1G zXYpS?~{jl1WPT*54mTQcXt36C<^f$U|tzz9AOa2XAb_ z-^2LZ5wtH;8(-Z4{)QfYOOQYD_6(;9>e@2*4H-@}1jAep@?9?O9oZ+gezT0q%aN9^ zVyZY#lAl#AvN6@NAB2|x_k98M>dbK6z*HtYdm2XDUDsi>ZIAx47Y5fqB!V9#R+p-v zD~-NqH?CLq!EMpB7h=BbIB;Z`Zjy94`E*EVZuZ45D?d|kRvb?N#sU?&tlIf_hI&3B zqLUGB&oc7*A`EX&Hx8e57UH`*q^XGt}z{a@|jOHQO$Wb$9! zgU}(rfQ1Yh%j5?X6lHWcR=ZqjQ+|>bReL}x>&J2F=&)7GDFc3km5-bkm{@`ZTG|6g zVP6Ah)pjr!e)m@9f4G_p@0;;!fH-7!(9Zd;$jR%pL4ZrfH$5kHk)w3hqpT=yR{6m# zsy2~%FivzZR(r-p2<5z8oO*0M3gbOMyTsH!=xm-OGLP2T&8pv(J9~Mg9VhG@ZB{CU z$spJl#Z(xMR>V8>c*CM%AzDM-+Z8GL4Jt-{j~3$;63W!nQ(rLPoU)!L%+T@lYDT(R z*Qrh(w_ZdeD3fJwpvxY?@Oo;ew;TN8KOay7=uIlb`kJA>%-o{;7=v5Lvr032`A&br_fZ$Ynu2xZ+3daNF;S!I91h0YvU^?HMCi zChu>x$6}{PJ`}_ADH7j|uMmY#7mhvfwxKxMn}YV?#-X`MsVH`7S_%bYJnopu4L*!s z_)$gYcQ}0BJ7;n1!a4^!rRsv(lBy++bB0gRnI#tFRYLc|a!DSj-DiqgfGF>S*9<%J z4^B#yec!Y9DvolNEA?kTeD>woa2q@2TFgM4`)zTZ`lWdp-n+Q56Kj+M8j~e1(|ebP z7H{C?YnnRxg7=Y?nY?TE1%1Em3!bOtw?GDAGoz1|)7SXnR-O25x9QcF#P5y8FN(DG z`I2s;l?Yrxn@rI#QGW4a5iV|PJw68a+19;S<4-7|f;|+@Br}SA-ToMx)iU#oEV;1Jn zTedm^;;sQD7=K`Lz|%5=zcqP+XM7-AhTZ!Qc8h&{w12F0Ui#7tEF@>!Phvh)*Y;(W#@mtj?f&Krqk4vO z-v%S`lW=$^i&bV7=NtA3HJqtYITx~GU`x7!`5$VikD4vn;3@xN#WX6vi16E;%x@6G zlFAe;;c$uX-|deVNR8RodKb8#7sUj59Go)(FBr@fd zI?VP9GyV%^SFn~+HVK1v{u-fjRZ^_+gcMPhT*S{XJ+Zba#jAq27x{!L$r7;)kf%A@EWwkiHe{_hACZ!Bnp@2*y= z7BNJ;DVXV?6KGXjqJ<>N-`$+W1R(f`um6_ePwlNRe zTJ{CdeO+7o=cTi-O0)g3Jqs{(wZD23w+rXvar&Xw_tPS8h0mKg5_`-MVI-V=A^+x$ zY=43@X1fPc&V9f7RScc-tDvzB#+xW3`M+iMFVMQ`+P_Ip^g3e!b^*Uo&sKU5@ zP1v}ue1kDRv?jH@4?y{dACLdCw&K6+Pi_6wN!^!#uevG zHL@};&&bNaKN&_a$1pPZ$5^$>F#NuZ^t8*DEDT(3T)8#ZxUyi$!mH1|BJhQoQ?e#+ z^<5AM1m@1WcHzPt&#e>2j=5yv!iATNTexugCyh%k0s9;APevBX$l@Oql$DX@Su$bV ztcAB-aru@>ll~ujZyp~-wfqhDmdtcBBm-&41d^dAOhO2gWymBX5MV-vBm)5=gb?&#J#C=Du;#KeUA}a2PxZ{SPsJMXF1>t%X!EN4eo$e$p_xgLD_x(Ko zJnx5S&8a%4PF0;cb?Th%=^h5G>82hN^78WHy8*F8=5@=m%umP*2G8w=72RB3cOIwt z^Ct4$B&*wxziz=MbazWudpGr+Ks~}IvdZR;nyUJgC6(+3I_Y56)as)oA+;^7HO*X~ ze#&~cUQ3nx`pYj9v|OLIFDPvQbAnwnOT1*uD0>$t8!DD=+% z0k{e>vd)lG4En+|>dw^FWVA0qnFp8yD6VYp(28m*+p5QE38|y2$M$|`EzMd)!MX@ zBE6{x-M2fBbOX{%{(XHZqjN?b^JSmL_dH>bbTh+?jEh(4Nr#hf121d>U1wHVqmo>nPnWrvPJN zHW3Q~Ml^Gku&onO!%b_iV`;axWkqv!s=_t5Xl*Skwf34um|sIRAQ$(rS942Nbab>d zr?is&DK(vlPp-A4bwz7RQ%&;Lz=6WUi}9$Ho`X{<@9YHX-l1~-%TDnx!|0|wvDY*)BR#nU-@hn6F6KwQV9%J!P_ z9%L>ztE#P~u@M!loXh5lm%X0)RXd8(hX*0kxs{^Nv z4peJN^&K6pW7E4j*@6~Q}Lx&EkWxW(G zrITw~(b&<@+E@b-+{_itG$Jy*ry97CUz%E~YZO}3DOiUJ7YNQODbAbQQ_`sE+|ypu z0fwr|<`Eql{G+XG=%{a5(V><1_8?B;Vk=qU8Y!~sTiQFudO4TNrOnBkIXyVNP$Rq? zjO}bD+iPl?*y3MOqjkVatm|s6rL(3@!?ewsRn)_%u&HQmYpH9iY=ZK}MrK9RimH08 z78w;C8fvvwEi0G_#u&&Hnv^0~LF~*2;Aw*avk<`uae4usqJmz1r}y5Qkg#UAldtp| zq^YJBc%M9jy%GM`L-Wj5V}n#^n*SSzzJEf*pE2Y$lEaYFw8{>wmljx1SzS$O3}*ot z)3TzmT7#3)yL=hx><FNQ+1P8Vl_d=wSSO2H(Us8+w6wG(t*troN=N{|=y2+_R%Q8OABFE|?0K7z&RO&y(@{U1EO|ES62${N~N;GhlJV>QZD$nH&S zF_ZW3x3<==mz{daaehZip!64)Y?LuZ{o#qHo~s&i=-y(3ZZ*p3{+*XC-El+1_Y>Pn zo-h9JnbWx3#9u|3-oDl-5BKo9{Wsl6f4rX`Dvo%8yWX zp}ZY8Ic`CD66Lcfx8i2e7bxGr9Rn+Fjh>6!cOH~Ss&OL`yJmFA;(vPwp<<0mG>I#(o@#W#eD3{|q$9GX?;9Jg9 zC?n5DKirJJ6=gBX^VeZ~C}&e-rLKpiI0Ce#AGEccIKiIq~*Th`soWlHRA@i}D_nBkl-= z_M&V=`7O%TC~e5C51>p(8G#tDKpA!qo^nK)hVo&QuVI}XLP`Bp?nVIT9m2Zz#k}|J^_EAd>-W?lzUO0K$-NfP$(B)_-CUmL8(%#v^yT(Cvtwk9dp2g zlK!YqDZn;26k0+Rc@fr&g-QLxghekxG?Uwb>gi}NHn#^Z6otTxFZA$iL0czyO3vgd z>f_mkw!6SH`%Io`eLRQJ_6~SPpTVfzJS)(XDw!ACix*Eclw8GSZy0#5>NyZyl) z;wkOpq5F6X!Sno?a-QhpIRu_x!1F)p;*hgak((YqQ_i+NId1Sg0iGntGutd`JY&*O zT?C$|7b3>blygs?oJQ~zAipg;Q%+T%oQ>eQa&aiM{!BS*`s6$cp5x#-b|%k}KAr>M z*;x?^{p(C!U-jww6+9OsZ?YGPdg7G)yrWN!hMYVMIrXwLb*<~;34rHf@JvHK?DY@g zN1PPSm}pJZgXgcvwO+HFCblHln%RK%Xa1yJL!WJE--q`3XO3r9-*{dFk7ZdX)P`~O z+JW(iO9f^J$vFX@+4$zE`b;?s`sAqCPp)tN^Vsr04n570fj#4pdCb8}#P!mJVd87y z6!I^z#Q|Q@TMzzEuy??;+_VV<|+$a4(rW-7~z<2uGQ0Tog z$NQS_LXYkw@X`Lb75h^X_Jv-#Y;B5ha?j#K6Y<)yC*HL_6dGdokIoy(n|MioE_gRy zf_=-(Oa8tboch$Vxvd7@uNy+4+tH_2zi>0-Ae|SX{k%&d*_dA zq_aT@_UxmGpI(`|jR(XtY%B$@ay`xgVD0548$0@J>;lgc@X(`yf8e>kkLMQfdc9ED?2mpY{yV@=zYO=&f8+o9kNjjKowb^7 z426=-Hq`1i(mb9(`%1LmYMw_uzOOxV9%HR|@bQ*VsL3pg=CMW}5Xtj{$9roi^ou!m zb$KVwjNL}?ayXAoHjjnY%lN+Bvk^S5J42zH&(wKc-&{Qko-N=Rb_P$GvFgYV2f%Y3 zc=F9W-MSxG{G)vb+V3&j-4p*eFw1-6pX5>QNXD6w@ZNYW*X2=N5!w^~hxU53$D^H{ zw|Ziyq%U?hpnWjf51H32`Q}}H&1%rG9XxN~oazJKYXf*1jrgLo%s%jZ44zSE@c2Q~ zx%e2`0wX{KY&=(J4--~!1(D*4)^NK;Sh3n3F0AOXi+D&+95v!OaOBa_h9mNO&Si9# zKKADSeC8?zk8>YhU^ClLh`705HoRHVuYuaHx#LR`TO2ssZ#sbc{bpG-AK9=?pEj1; z{os4>;2CQ~XkZ)^7Zqs#8SOL8a>VI8F;M$jw0k}bg~tD(J*T(*4zvex&G2VA=UKGp zp#9I*s0JNhfM*?eHX`Sn<3`*N#+*m8=^Ey{PjM{>oc^dT7Ihz+>WWa8j=FuQTS!bS zj`JdHmxy^0_VrR;gnD7v^a!mX!X1c63PgDFBGRWtXoV4K-U|`-ygd=Nyq6-Zc`rsl z3CUj#SzkaFEkXKA0?@V6Vbl$$3dp}um>!`9A{>E;*hvvu5xT!X-Ov7=^}tyVob|w2 z51jSDSr44`z*!HR^}tyVob|w251jSDSr7al@Ic8p2qC~9-J0lu`+yLB3>WQGM&mvr zm7|Q3-Z>%qQrv5x(u?mdshnn%)kb->QQm5lj~eA}qdaJo-xy`cDCxUMk~iEaeMWgb zO58f&4vfNg)hKuGQVXHKqttL? zBZQK4;VapeNiN(ULP_^S{@?t`*Z(AQ6xSC;*fJY5|>q^?=QQt$-bXJ%Igyqkxlu@Kp2%Bm%Mk1%NU@ zEua&y9;dct90i;N zgr}oFAQ6xSC;*fJY5|>q^?=QQt$-bXJ%IgyqkxluaC})e7?23a0u%ts0JVTlz~1#|+|12zM;0(JoQ0QLip0!{+L@&3VJKq7!%NGJf% zI|;RbPQZG=X24d!4!|D3e!x+{NkI4*^amsYvH%5uGC(b$6R;kz8L$X39ACL&h0u%ts0JVTlz24CVPRY0AhgX+@>eijf6o&SDR@vnPB1Zy)mi(tgU7cH$zx0M?=)s5YQC z$AbQ|zaIbL9WC|_z@PE`|Fxc6M|%wcj?w@9j~s3I*AG+!kl*P%t^b7#=ReDF_@8?g zG^<+6t@Wd6?OMGWmCyQtuMJT%0RN#qgu0ObSuV5|m1qCXdf==F{;%;sJA3ITwJsa) zbEG!oMHKw$b>2Tz>UE?4P)EFYji9=vrLCRt|1W=eRaJN!WvrH*mfT;Vx03K0N_&3= z@7U0*ws^B`tX9?7(q6-=%rDn!csF-8tV+qN!<%JeHEaYKqm$TcZ6n!xxB7lddu}xh z>jBD_=D&=$IBpDJ9AF|KA5aLG3YY;un&QnK zRb8_rXN7m9UV&HcykpWcy;!84+yvUZsZagTJv}WFziujSx_ELq?kZd@ zni+-FWw@+3KvyrKWO=a^1#kTe?z>31EaODMlH^Bw=_25+**ep+j4Av9Fo{CgG4v0U z!W!^KCw`p-Ro1ZIP>NQ|li(B9;_iSrrV|Z98?Ic$?DGjdZ#vM`R}=bfIneV-zi{6a zplcX<+Z>?Xq)@o1KhO(U?bL}t*D>@c9zhW={1ObJ6ei$0N*ELk{Gy9kjim$Q6$Z{k z&E>=+)KSkX2@RKooi-3RvicJffZoQ?iMZ(`K18TRnuv)M`S8Dy9|#w|nTCp|nC4Fx zpfbG@wbqY-ZVLO?$Cw2(khP7!XEfAj)BO}I@~?7)8} z+%7N0Es(HZ2v_C$QNVvC+#!Dw5BxX6W91JZIP7=AHKmhyIGzZ%@;2@tgz=0>QZ9oF z!vscnlwaYwFo_=wzo#n;10ceA`iVrJ(v9JSS$VQHTe)Bs2pc1Em0S%(1b+xEe&ves zAO`aJAOcEM5r`-r!{G{)Q+^OC9}j7T$_PwWn1de;qDb*;AYA-+U@KN4B0!Af>DTK^ zl|e)#GooCHC1MmK7ASO!FwDb<3MH9{R6YR$s+F34Akvs^^~z(Y3-j{X(9_8E+X(B! zHd`knplxBd&>-dd8dTj%C?~I20{k`_t|YI(gooWlqqSmkk6^ki5>23u=9bLve;RF6 zOH;{ei+XBDa1j!^M_x4@GRE;#A9?d2;JG^9at`qE47W%HkS8q%i+vuJg>*lux8Iu& z^Z|zc6YEIY&QK5R3m-x@*;azL<`` z1%>rtnM!9j>wr3ZSh`A}N4^towwz1Voct|3YB?{JhQ$r)Xu^ZF7at~`?e(a?gskV} zeu=<05H87Y;?!rklzCcy2+P-U85^Pe0hX)fa>DKM2g$&%AY7F%M(sxT9|HmE^?gZI`VK5XQTK(0c+Uo@m%D-LNpHH$-qeZ*Ig|` zS>Qze9dluc);d)Xo+N6F{aBGPIcy1W(A7|r( zv)ge$##%@Zi(8~A_;j30ZNwB!7;4v|h_Pp(ul1U1fm@`d_#AQtKA5lvfJ7&NRqtRQ zfT^->Vy}BiHxTEJ9?lPllZiI5w_&=iH++L8i}V~mhaABN6D%V-bipR}>oHL4%|p;+ zkxmf13UsJFO-1$XURFH}pF>9BLnuRx%5GTB#jaI`mZ3^cQ*f(2j!;A^CFNS6%PP-E|!fUmt&Lsob8vVA9i_yRK&=$SjW-+8han|cI@n&5_>Je1Q%S-T* zRQgS%O{NSLF*+ZpRsIkuIU@5(5-&#vfsfq-+%6wNa|CVS2-u}5!2S0EcgU||^N7fM z7ajiCodv<=8rtYQ-|TBn4u?#E+N$U?hvftbYLqT=VBSF*J3^L>hL(q z8}x#ns3syYN$S-V$aty~3npBBw+fLl>>d|-A)`c{#=Tg|EC&mb&0?8X=eVI@;QjYQ zqI?3Yci?ss&dDpWISqV}ss(+vo&d_`ygw)GKp;h>(+Na4j!=*Ck|^O*gh^BeStxvk zo3^Tx{%Hei8IqZ#4hsR7SHW1-^&wF39K!UdD_;bm+12-ac%<5OAy&5fK0|+@)`J16 z-82#C2c%#ujXM%}4}(TFQjS=~d6ob?Vk&91(4KB{EPV8}V70EI=wWDj8W z)g#nsUrMTv5^5cfsk5uc-vcgxgoUsEOLxi5$-uv-fe7+!j7t6YQQ(s7gbUP@#BSwm zo4TFT}0A59$eF8NW=_EcKJf827qL|e!M*gJn~y4fI%rd)khv9JeA?r zQtSrm;OdpAm*2qD53Z%K;pB710@eeE z8o@P)vFPC&APqk}hPMEKFf+n9$KAkLN&_#|3wPJR?gloo-_8a4$rcPm@Gk&*gzT}d zK@PCT^g9k*uEE5`^e2>y$4`fFF%dHnN;W-+La1hH`fF~gR^5{HyfT-m|JXg8rH7DP)k z7vmzrEx9+vgDsv2kK}%55s2YL_$2qSks#beb1Atqfz&ML+)mXT5~5hXVFA_c@~3g1$jn~n=H z8PuoT=6(+AI>txD0-JmIP!O5q#0r}`Zyty&YN@ul3yBy*M7_;jMr_$cG}_#2t3l)t z(Q0$Qkqlz&Ula_%=AMYv5i^dYb=ll|vDRX8pTiJV+1#BD5aX%OTAO=M6o?5F9T#B; zWX?pgdV|f~7z4sjY**M2t`uL1b>tWOD?r1pJ#-kCcon=CGl^^n6Ax$doHZ?x) z4c2B%1uYhNxB91&I2X#`6(#atK>c zOtZeG{kgzfD1}IJH-yEsl6b40EtZqXHu)_V>f5N^A-_oris7;H#9$Au$_`V>Nlj-LqoJZ*2(UIi)!hnB8 zqOI~e;`xR~X_Fs7!0EVMPQmijaaEpE1^ip$cgSNP&3TOQSm?|ICESB)c78V-Xspfo z?_W{M|3v0;{yWzt9x62BGWuqqm4I>Xq-kxlu4{H_yrrT82W;jBefMku|6L%EjNEUYC~ zxsC`cp9s;K;-fw?YjG=2(sU_2S(>EWjF@uvo(H8zYi*C$%%eqpZ`=(!nM$U15u1g)y~kHFO$NyO-Ej^0ZEKQ))TqrThkX&Cd;% zFfG8y3C3biX&^QA8K#zxe@ZkWy-^krJ4vt%{8req@AAc_|jeNk-U}a+>R( z7@;b2GeDeT6Yo&S3(nI#CD~ZTNyN{L(3BBG{K5#gl1{|0OhA${lCtY>d?F0+=#j$- zG`MsXDvlaD`jpABZ`$t z)M6EA)FsOBq+X&_xzZ0pW^Cokd`!4g5oW`j1qyz=6e)%g6-o;Au?ZAl)yfzm`ZJ9f>J5s8bAgKsrU_h5Lo45uF#UNHIS;IgK5-1GUDxYH0 zat>zJT%;Vs<&-m;5gU~6h;Rt&VBryxpDoG`TE4N2 zxJ79owm4?m9ZEY9PDb3LoKM6s#XoQX?E}BUiR}a^C;BhLY*F<3v>#-M8F)G)YBBbCta)`rywR9@4|56{z@xk zoKTGcVrUZuD=ugBq4^o3F|<7M&?d1KV`%y2p#{uCn`|Chfq7_!eM2i^ve?jc)EHWj z)f+?831etejG?7Xf#p-pLn~%|vbnf894(#Ggo&6Y4C)-=quxQyWGu#@W|;?7%36#; z%{C9J%si+$=0TO42Q{~EQ1h59HYgo61~s468-vmbV^9l>LG>$w+XwHSk{H4m!JJg9o}pc>4BTG}_LWlR2+^aGoSTJA z9F+7y-C)+S#jN8-vyPk0I&Ri=P=>gLF{zXxbkw1rjc#T2vHICaCp6`8EOzH@ti{d6 zjiStRyYL{{lMAOFd03$qH+^XTAwhMVM5@GRIp%fQWx(6R(EQYlY zo2`9>wHVg^&1~)8b!&Bnk1{q@SNIP`AS`B-K;aJII4N{EcM3au6+UiO_=H*ElV*jx z%v1K15f&^-Kdmd|;<{;Dct)szXiUL#LM=8{eNfMvb-ZBKvD>WUMMKB0*#Dh-3>|E< zd5IA!&BtEW!$C2kqp^C7yv*t~Jw|lGtsEE&Nw2V$BxR5S;#Edq3gT%(UK4hcwGQVS z!YjSjzR6gODcEPW_AS<8Ou^fRwPCbRzGJrbUENwPZf^ma-V@p&8q@r~Fb?~)?vVp# z9S6-iJ}~R}(5&N-S;t4Z4rRw8sQ8%m!8E_H0MsYKeqG_G!uDQ;pP3bYZdUk(S>X}0 z!lPz|Um6OT7ysF#kiO1vekBw_54`w|V0ZP5@LRLOV`hclnH3&4&-n?n!hh)sxwx^B z(DA*nlXN6Ge-P+v3*C!9nsuBs>-fp6af*H{xi0}`t5!qP^KNAMRh#pC# zXDJrz;f!FhZecxGtm~)|>sD58#JWxxu`aWgBqfF-PhpZgy6OE`OF9?#@_`-u^6V?&881vEr#g>&8A10O;`I&AH;ev({(hKi>sy!`@!NeD8zDbh*OXS z^@)rzYaU|OJk+c?*3iuS6lZAG;8drRv8np%*9k0#uzEBN6OWL>Y^O^ch*{GW#+wxm zH!F0T6($%8S$rg#hdQEfs7b5`8>)^Pvow;`8?&Sn#w;bX7Gsu1F-abMANR19bR`P= zm@|dh<>TURpyO?-SO$N=ap~fPz2opQeq+i;o5zvCT8t_4nWrq%JdP}V9Lm^ys2Icg zz;PRJ$?eP*ozMe?W5pkO6^=72%rz?KFh4V)X?6aE>vclwU_DIxwwmQ7uGpPTtfXb+!i9#yPnSW^B17TZw6Yf){$<)Ln0AM9$uzW7G9p%aoT6z7BQ)JBRm?7= zwKwT%zFIs^cDbFkVmK~A^l7Lw+f{G2tHEs7Qo}B0$}+Pf8VyG?X zg_)vZ@5CPFY!xqoXAlu>;zhltw3|)oFq^W%Y)YqjPF5PGIFWRnT_WA7R8yL3R&vhO ztd9{9YZ!ruSVftmTO0_bsjBl*aVL;8+(EcZq^A|q+BxUtdR-&uyh7ZIR?dd(#u3Ku zrpuh|OV9^;Xo=257l>1EsjoY9op}@&nn!Vwc@!6$N3q@*#Z0=0y2NlOyDhlE7zMj6 zc%`@zYB7po1>n0%BqQL%jpE*3?bn#KUu)KWomu-Pv-ax^?d-nHX2zx}^ctUYi=mwz z$!}x?wC7{$oHvPOP&!I=-XiAUWUY_=R>s2VcNK19Iwa*$tbOP0BHiY&>USdUV0PJ* z7wA6Dog!ir_ZtQvHl24dVt{_gy_*pOxwy+UG~FYv-O*;{~&h-MS9tpLA4vQN(;9|FJmP zBhvTWn5lay`@SS{P?|mhJ5Po4burz8cZ=EGp*NTSZ#W&p-egYoS}1?*6Em=yyhqA` zza`Qw7w?;tNZ%IePK9?pWINvx=>p$dpa6eYq^n==`6BT5M7n77cFMr_i*&K(rF&b> z_eHuC@*Wul{D4STDc(p5_Jbl_O?Zfgcj-xa&QqAMlSv zI*EEe$^!neNGC?`Ep&PE2|KBIpCjiVW=9|IHYjm^$_^vmidn!vW9I~K2fm?Nj@t}c2CYcp!(~9{R}nh25@;>eN>6}U z*q;wt|DyCEYPuXWCnR7(wdW}gg*vFyz9-cJy;JI%%%{+uOwuGgizVSI7|1H2A3kSB6NQW2V_OklhYdMTq}T?3(W7)O}HcnbAX>uxK*we zfv+LlCesh2ySfRt%f}?(7ZI+?V=x!4iwSqg4`7YDt~v~3V&#Ixz^^7;lRHWNO~m7t zyU3+?QGJrUNC18};U2k21HO$0lrAHhIM;UK_sRQ7&Vz(!%Wh1$>#v08%JfvO>mkDZ z@|9%s!-NOqM{)bh^$6ib@_RPmkI`_8<=tfG6O?^QFx}*KVJw!a>&b7(D{j}b(=qw- z)00v49Q8K5@;p^b@w3`F*9%mw;t>V|b;Re@bFSS~i+}X3(Lgo*DW*l}#%4prBjGT> z^&(G#s9Ly%=JDlKKrK=?KCK6eA=vfmUf}FoY1eDbKsou}1Hkw?O|B#l8wvak3Sp}} z1ZQQ}n}pkBN~^AY)Ri8nqBWpD3hX+V2L`ny2rl&o44zjTbD><#w$cN7xp0}JUW(Nb zrv7CHJ)pM)&a$ZIU5!xY^+v!v78;rKYWoa}DL6hg=T-d{h$=-EgX;9LMSg@h%9f z@)kBf5H#mD=o0ZpN5EunFZnZzy=0$F)x&c}fb!&)Wh$(9S8}WPo^AxC?}& zjK-P9wV$DTnDl`(LYOJW=4 zTFg8-#NVh}S#F9=ncO)*z0l3yH3GQ8-TEz&>s7^|cW1yL?u2trd{Bmwh9@|at> zV;YDBtPk#mVMB9Oi8Nr3@&dxrRm+HU7{3>u_gp^~dR&S~lc%ggOuG89uAI_IvEQF@ zOUfq$KtwRYszfdXq2ENXDMh5g&OE{%E`*%8_Ysn=c%FWK!6MxSAH~h0!4Kz8v6|oU znGp@|ckr%}d;=1K9$d-h;7T?JSF$;{^mi1D;7T?JSF-Wl>8q3~Q}_-{qeHnK2T7NY zX9-f7fpzH0WQ3*+2?LSE`nZ*sXlBRow0@J6nUpVc_?xiIJ<2OMM7T;An@?$@;m%}4 zw(@cXh*_*pu5#D{Vm5y+l=_v)aUjb1wIBjYA;h>UczUm=RJo6QQ^|;GC6W46^IOr< zq0m3Y?W$qKMGAe(?W$$OCgsW{AnKXYdlbs7t_FSw`fO9CxNJy@Wc((s3Z#qF-%!s#?5(=Qp81c4p^TUnoP6}Ejm!dgx!hiGtr z<9ES3Klm&p;2(@l;(eJ4s2z;5^1hcTEOxS9Hr{v6bWo4;uc4cr&!mm#Db|z?0$Yzx z-?bJ;D>{%;C%@cIdAf*psIP_H53N>_#9C6 zyswLv_FMc!P>sB=|0qyzvjO0r$%sp)j&6Ph7Mevm51$z)5H|aG*8x5OCh3dspn35f zG%vn`=EZl=oY@bui83<#L8eblX>Y6IT!;9-!W3iiead_ut1rIK7@_G4>2ub{tuLf6 zjK!x-g}L7_!lRtd196OnWV&LR+e`SACvk3f9cODaTY-a-*qJ$g<%tFm-!meh2lx*x zz>AbuX(9c{T8fo)(sPm#B})1P5T_VXs(eCo`7_%h%a!qTI{AgQEKs%=fzY3@s8Ft| z1@Sv;saCp5K!g}kuhb(GyKn|U=r<}aQbM*0lz>{5-4x(5BRZ538VH4LI$g>-ILy_L z5v!Gr6eE$0SgTagc!o0KB8Bd3xMBqh*5C%^-UT2MnY1gE+bJ!NVr(0gb7)^1KGeUO zepkJ;cyn9loHGU{eN^zlBHjr4D3vw2?|4m+;( ztSy)KvE+0qbFiQH)l&FeE6@cGvINUj`gf$r5-eHWBv7(KmSEZHR@M(|pJl7t7=^XZ zveg|-1J*vvR(A@Nt?Kn`buVk$sAnsk*raDGo!FvhE1kH7_wke_|IRwyVdSoz!kdVK zdyL%mxbOj}ZAP|wLO23yJMX*AhJH^9CqO;S`zFvPwM+N~)T2fwdrAmL?C&)4)6>EL zP`h~Fe7a71Mu-LVEbsf3;_+Ew1gPCc&U;Q64Qem%ySEr^&kN&0y~cB%f%zQHCxb=W z%axs^FIuE?H>cc&qpiy!B8}siXrnYSM0^vytV)0Ix`v8hfUqf_B!Y-#Ep$GigoigV zkUVX)ky3aYR}8j0fD;(BMWTy2c9lnaEvt=0-v(&6QM{A;d-}pK?obacPiw5LD-cS(e4^4`a!75!WkfvSsw?~O@;;=jgyiE8}~%iJ_;g2WXHN!2)#6x zOnZ;epK<7b6A7h%h|D5=!)oIQJxS>O8HDoC84-s47tcQtDzMsULXlEY8&Bxv*ibD} z3Zdm}AIk=sTH^XlphuC@8aUVII)<(L3t>6xbYlr)#u_i3UC=|%;2d9mW^Cwh2k5_&3m;0~GyRuTOrIKes?6-+G6irzxAfEEub;{HxM#dvWhaEnxq&j@P` zs<(l|H9>4()h$$=gfL_8Akwu--zeGJi0ImZ+QGD|&;^RAnYOKH`T);$#1jAyUAO!R z&tt?>fDgKyG4YUNn4G>3Nc@nv7vh7icm9{$GMJc+bPc3)lcqk2(WC`p#}FeKO4mm^ zBPsb$#tO7&or*=)h@bR2a2Nfn@$mt2uq$yU(8-;I4#y0~7trMZE{}i~QY5&(#@dT7 z`X1dl>p-L#Yy4s&S-**WV#<4KOG4U_aNxLfBX!>!{wcr!}yX@)K#YMD&xFiB3U z1>TU4YO5TD^H=;*!WDU_6ZkSR%O;e?^f@d&l#!`d|y9k{|0U$iC0iDwfJ}hv2I=b-@U5*b_d;+BsRm9Q1 zLFPWqZwBre1KjHVg?}1^a%Tb>e&dgW6K@z}BXj@G2#FKcVe3jrco|&Q3xHY^Mt%pJ z-5E<5MJOVI{z-ce8BDQH{y>HTCH#uvCAznvLb%R>_pXxd7`63Uptcd7Jm7LO20SA5 zXA&cShQ&7`ja($j{f7WgC-HcV^+YuSC9N3z7HK9v2b1thAo>Uekw<$*BPy~4pw^_Z zbYpr^r!r^7gSD7gG4Pjj!8_)8 z;@u0>o-~IVh<6_2m7m1QNSa>-4U#+>IV5QTkGRIWq2vid*?xo@$izONj}}@g@g9&n z7BvygK!yAAI4(KE1KP6{s3W6zct{9c@Gf-<6P}`^xqma#5z>FHHdyZZX8kJ1d zlKk>w;G+nq*JX~AgyC2*o`hUfMZ^QONQFQLle#h>#-wK=`co1rshpsn#heW^Q2khA2yepElM8(S0){0SSz zEXmn%z;_JbAzPS?ouenj5&IzB95qa}rXT+yKh13$z z)0Tm@rU132zIhAq__mr_F7+)65l;4CB2wQbT#B#5@BgH}GX=7+w5}S2hIQM)FHtA! zm7pD|pYmvx>A~{U&sPA&4^3#mk6Z>^l2t@i>e0WD0QoU|rhfGVK5cS&GVo*6)h^E> zzkXK&T;+r>p*MAF9!86d4J{VwKK6M9tGR`JlG_~t@aus{E{JC24>SOr9#MhUK=3K- z_e0z#^dku@CR&J<@e>9na=k^OlQ3&1qggvD&+Dlq>-A0~SPv zIIO2O2;`s0Q#jzJF4ghBVpmFCrsIX!^-`O3JeB6Bnc>0@H8`~9QU;8?pbF?K!o?Vm zMT)_GVUfa+P$C!NBfXF(@%q;1Eq))Z>h#eVje4(ySWqWpup`x$c>J@6YPTK#Xs|jN z&YrKz*d7z(%_>S&}QMIE<;AK@=-0AbD58t0UZh-bqe9skB`bp$Mo`1k3({QJ}L^8_`PI{ zL@CW8c`<$VLPY84%pcgG?#5uH?|_bSWX$Ey2|^OR)Q~ZcB@9lnL0ZOqMo7wD*pjh; z5mw~{R%FIPM%WYyyHLg=M%a~!@I}UAM&QeJ`kp7Ff{q=opD zn(<-3*Mb%8_QK)z*_a1k0z+@h2Aasw^RWzlBN*zzWcrc_)h8iy#Cs5-zKV-0PCX1) z@#;P_3hJIp_!0*VjpH&s4}(WY!L($K`v$1h1GF?V_Xqe?&caM&P6z?zhkCj&- zZZZoN0@vi*MgcFPUzc*r{VZQAt}rc0p>QOi!MPrgl`` zjlx0hVHG{;VJFp+qoV2Tq9>}M=ow90lm0KrxlfvtS znsrPoX>xsy1v+Lq8;nnvhfu&l|Fl6#8>H z`)7gN$w>Tb^*N6rspLGaGfP~~`^X15Pw1q`oR&dMeF>wmo&svkx$|4#I{)3w!R#2E zbI(tx#-aJ`Oz@Xcq7Yt&Lvt1jkb|3E_;fh%p~pI5sHHiuNN#E?qBh15j>>3?gJ>IJ zq=S8clfn)!h(VK{qsOk@f^O>1V`&zD#LgwCEjcuQzm0;a>WWI5zsY`@IbjLST$K+~ z6{R9(IKD^5Esu~45o&m~74wcO%ng|MvA2_K;YI9RY#{ELuH_lcXmhQNxsBh#>1X1n=iAIU^2VM9fD&_)g)4=JP~ow2@EeBOT&mpx)FMr%+F3{o{>d#stuukz z{d>0o$B$0_wdCO<{(~IdD?m)N#;gm!E}C^QPwk zSLI3se_ja%h=UVe!WQjsXeF6@fZ8T`?ktn4y9sy5 z^zBXlo@vmF=dPv-kl$#7%!nyKg*&T3H^qXs-T^canD$YRzQ7D!AK4u^XB+zC;UEX_ znYuoDGdwVB3&KN{Q*hu5l2l^0;0p=&v7bi>EGC|8*@es(sG#~>`IRZaD+%{=R=Os(P0l>o zGl0os*Z??T(Rj2kr-2C_m^6PILx*E_{T|&IhWKMJl*LOS0i1N3jTqUkf4sl%9PZN129wSRyQnA=ODpo zYAr(EuYOlS>0~By0mnyaJ`_UKV+AOrsGG2d;r9UVz;tu=VXsG{K=rUsH7Yslu!ksh zP*Wj%gFpYUH#Pjm@-S`zCv3uguHC3r#DJesKv&oa-w!)c|YwU6@loXa$qF$9#VOim9!X0vT0Qelb_KubBg3}7i zDK~2J8q96sT*BS*2EykNo+QH$T;T#eYH0NpR?zB8H~d#PlDO0a_=#6{CzAhOLTDi! z*O32c7q_e1!=Zo^e$PkmbQ*x}`@#&eTD=|Njc+8%NJ1nI2ZGuP*NN(SndG#?X<_P0 z%uhHcEJG+1<_<$ITpYqz!t^MdNK@KSVVwrlS~U9x;Bssns^?HNaq^W2iK23vWo%XB z;E1BsyNG`*P_=0OJHX>twAXM&3%`R2xV_oX%oQ!7BZU;-RN2K9EhZePG6S4NX&+PH z(fIHbEt!K3Y%Yqb^|{z*154d^#4j&F*cH{&PrPC-`T=j)3S5;%EAXW>M-KT{q@SWj zT2-+!hxsmQIt?C8eidh#q86%m%Wo3iO24<0WcaOU97$DIVMv_1k$JuX6@q#ZrXQCn zkH@2jpN!M}T$Il=pI<@zN4(@``p0Cj>233Xv+$BW&MD*rwE^zqR0&37M(`=9SHTET zeKCt>0?bs>7%7Fji|Y&5o4ic?hU2sPL0P zu;<5vHa=|$)UX%PgZ+65PW>ILU#KBaTs?nn!gum1aD6uy9OORIauR_vUE`1$4Jd=ptj&p{@Y$Pab`76 zvzlQ&W-fu4;AnO!UJ2A5jOTO8dxq&Y_fIhQPc+P=7che(__^=~qO2Obb1)--{+=q@ zsDsJ;*S*3#W??C2VX20&WrgUT#?x}O;U&0WI#1DS$4hWQFGC#)1zK=4{{TFpv3F>K z89Xf&w?eOc2YvjN=$xb+9u6Xte*|nE_KtrriwQ_)@Aw-;HjaEG&i5l3yceiHn8V+U zaL^}toY~-9v%%xd22bcScw(QyezU=OW`idg2Gfi8!F)y-1_#UrPc|E@6EJu)a!fFD zD{S;!4>UJe#7~^pWAGHS!Bfo!7n=>9)@ShaK7(f%2D2G0VP*ZnQfe}+o(_R0%na} zq0AUu$Ou)T@3Ml6*fMY^pW<*DT+CDQid7y&CJ9#XbavB}sW=A(EBSRG;>Xe#Z^0!@ zfW%v{dc31iG3G}yH65re*vV%hwd(WVWj1w{+0=7&Q&W&_gXgi3Q}Bh!V93hOLw8RN z&_J+;|Djh_omp1BSyqEFZ2IMj;8NCNV=qMomoXpEJK(`a=4g5cJlMq0SbYMT8R6C^ zpv9OCO4z|xo=5Qe*h_uE<@}47LH&0Ef^F>5TmPMaU^{b$AJ;)Xbjk^l^=|=<4X)v< zaiY*YvDR$;1!n8l8J>WR7qYpqk&QZPS2X0v;6h@#_A@HYPSUIXqh8*r!DfV&I>==Hkb-AovsXtjg5hrbaMYgd?Q_nHmZ zY8cRnbQZji5isB;%8TRau8ikKpla|ze#D|44?JWx;9;`?j~E89ocuQ?%%*36zq1U0 zr@U{&jvAaW8p1rc0!<3;;IHbHywfcCakJzn49WBkS@222x4%|{*u~qifbHzvpx|@- zV;CoH#^=#+Cf-PD{6HPSPkDNTRG-4n%xXS2tNFrEL*H}+kMN&Bm=P&oveDS}74%R3 z3#0~BUqL!Cm=k`YoygxGYCI=_s=?R!1-&}oH0#`F*7=s9lm3aq;M;sY)44Yu#5;_D z(+<{w%Bv&E2Y{-<-TaPT$$QL_UouPHYe=TUZSZBjiAkmtTksY3OH7cQf*=o0qTj^y zcz`;B`}w$v9zVTrmVCf0`Jf@WWE{GGz;c64p&ua&e#i*BvXM5)L#z*`BP$3hkOax; znLq=xmk zyIy*;GkBUMF)v#yKeGhmoh+mN7nTLQgDL(0$`+*eD;ocAY;B}fH&=7P-&r(!U!&;@ zv5@o959S3qfkMH12W22$pvl9Lkvy&6sS9?{(QxGFP}8jz)T33sAJ=WXIwc0DO0^5! zMD-CI)g-kL!wypyz>DE(80szRUhGy@^|4qS&DFOdK~d*|r=PkEp0ue)C*rQ4dU+Wx z%hd-1xJ#oxG#u+i{VR6a0qSGeKnAKKAt6eA0x4WoEByGCUUeNz7_8Pz#ce6|F6?v; zbqD4vM%{u#>kxG_4#Y#%fk{YK>UqO(S4VvZ_BhoAkUUJ4pj}g6O~Wlp^(CZ`cy$7% zZMfPz0sFdo6k(Qt-%F;Q>y~T?)sO7KU345&KO973|9Jq7{RHv@j_f70$vit2tp?`{ zbh1!?6NvMh2;xk4keBGoK3ojsQpVj|-N*k9?PKbp0^)Zt$v-mwyRi~P^;=4fUIXc>gEUcn7(p(n4SL^aAT;>ZzP`TS(^6K) zV!`t2mhsf+-Jj`=Tw|oa(UMh{AQEslyOHE1 zRzMD(hl&R$&(kwC`YSL&iDh{8OB_~kp#)F!>YJE(@V-QwiIrakUR*=MVv9s4WQ#-> zf~jioDVF9Cf5E4D<2B*nGyKjG_#Uqjj_3CR19u^;#xrdYX8Q%A2-wZ$VW_2>P!?$f zHZS`qxN6Eu_GQyt4QLlb%h7qtDu#~82YN1hjO98^@YGu;AY3A@1!|Epfa(jP*ppR@ zfuz8BoSFkC3FXc?jMq>W%PNv3klT&eoTa6Av7J~Rf; z)2mM-8O&2V67e*>>c`?t6AMO5KnEZHksqv)D`edhx&sZ|7fKe55IM(SZLh2>P=X3S%lIpSA7vo^3Z)v z^pFWZ+&S%8y6bP>fWfbkidR=* zNeVsft9cEsQCkzJ{WzivcN-8hf_gsYT2w304?lTJ|6=j)hJoJk0Qgg1c%0wVGV5FW#GlFWo8Y8G5ibT*@yvA+F5lzFdeeFvRp;KdSH#r09% zD3CIWpz*cqh!15e)VMDHdFr|aMQh!nnNWM~TDN!?(D+SfGMX&qjRpN07s|`1Jf81h ztg}!#M_)1<_~lfdrGJc}>Q+!WUvGp$*R7;7J^1fQ&{K*5IF{g!E!=2_;^&H^>?>pm zJfveCFUmAHC`WY*RwHd%Gm14-EY)9wk9Dl4@;-eU265C<`6Tx6ypp4i$`|vF%>v#* zp5=4d9MLdn~A z82}FfO-kOg@Lmot0Z}FIx_JP61YE1+y#PPxXd$3i$qQTppp^p7LrPvQY~0}|;4vld z8z`=$?HV+DT**s=&N@12hwEh}k4_UDVFF%L^5~etaXB4RyrJav!!{gUg#h}MJe_75 zp_!gh@;qC$QZ;)=NRA_^=z)Uv=Z&$7H{@|3xiks^?Hb8`Tb~< zMx4{KBu1o;Uk}2{Dn!kVg(_yDtwb?xqkS^U>|ZyEV?HTkl7cqtF9ANqM18ZzV&Dz$ z$QEGcj6qr3kfOK&m~&uY8+3&hP&`z5gP8%`uCNf)H=L6@&`eu^@&V@(64$h5Y$!RG zjSHiPo(~`7Tuv;P>fe^3yn@OV`q5OBS5mn~e-2L5xr)jT{nt=g=Ngi&Q-5(YKCM)4 z)DIy~a29?aG@En?yP9K9wnNiD=O98fu z#-pQ_SK$7gegTe(>Kms4Y$LE+pADUJwo`eBUR{ZDkjlID{Z^DasJu^Kte_mC^0oSv z%_v_^QS}D>cNHjior71rMao_ZF>UyQPXTcE0Srs|3UX{%bRV=u`#XxZh9#sf`g5Sr zu#Bui(tke|<>j>cD=qZ=!G@JI3SzX?^4H4%u3=CfX|-H73ZRuiWrWqTzZhVls783?%Y3P%nxoL4PIFj_YF!ZLSG_*}p#!kab7S^Io z`WO_I$4Fp{nyLSzC}ueCB&}rk>g*Nnl^(O_Z_Y(|8F5pp--adGY@u?6PFoC{SJ1?2^zR__ z&3wP3!*VJ7>gLsA!c(1=d63;^Ls(OsmY-5fAuKuDX(@$WZ8n58*=cEnbJ}bOYm(EF zv>0HqAT`lx*#e{8Y!l!Fr=+A|p&A!-fO#zy#fKVKe%ghJ{1{9&uKp3`hj(cpF>W+$ z_;pOAv5=T=((O>_#$w8>y!tfc-;Fl1f4@Gr8f80?3F^XP}k}YAo4cyk?alnM3{Ob zAIaXLzk>MFxRJcv0sRz}`SAV@{cD7dMn1gn)vt%>8rekq^!x=VyXYwEu>R@@l-d05 zx7<4(Wnp{r)FYM&Z~=`TA+ae(EV)>kM#J{9k689YH5&t>cJdL+DZn$cufmF$4`l1tAs!JPF?;O z2^xvJdPwIKx{-3r0z8LH(jG*yVoN~?Wj2N_ON23yDsHg|Rh+A!yqpfFN-akq)h(=k zCV6D3q>M+P+nRp`ks61hbL*njQ6m^^T`YpZObCqvPA@gs}TUU3Qe|* zC_#CZnAcQ?We${ltD($O9F|vo01ai%c39qm!`*6F{v?M5K2zFiDDy;zWi6C>tD(#j z9F{c|01agx@34%@186AoIETfKh1+TuX;c}X6eAuJ^16tB#r}8uloq{xp*riO#v&M1 z+XGR$S8x)bZ^Ih6SCUzp^w*M5=3jf@{c%)YO?aH4Za@rj&$$+T)9X=G#={cb^X?#c z9EvHX8&OO#5plfg1E0#Lu+QfFCmC@PpJQpXcTgDjWBT~%zz22vSGnb%TL->{Ya(sH$Q`xG&Of%uzkZi0yo;t#p>d(V@ zc=$G?3Vm87%6uDAjs5`9+(2y{`hRAk%-+kXzd_|qgm2`m%+pB5*QDc7OOj^`*|%43 zM{eL@Pv+MxG%q*lM^K-=2<2w#8`isLqwJwe{3xrVr$y+{)Nac>Xo<&gZ&SK0zp4Xh zq!!uTmIW%ngtzOqd;$mN;YxKqtSY2fdVvRTdA{JN6qOjv#RMd@yra0+cOy(?cZ1gTQ7RV6C5dI}7tJVJ2v5KBC7zTjCtj(s=su!ciQ+7O`ONJGWxsJ#(N6H@uc86d^e-Sf zfAz&(MEOHd^RFjrxQ{j$J@Gp{i0s7>rfOf-#Kg0CfIWckSf5F|<4#BG* zqUo?V@ay-NpvM{|+=RAO4ET1T8%P(mzL0S?K}1 z{BG*M0>zw;1=NuHcNji}qEW}vi$JIGjkF!hXgfDUe-3+ zI#!Uz(|fas9sKGJpGpA+?3^{?DvY%V#fr{33sGkO)j3b3WW;Odf+C=i!o7u%)j4|= zfb@P8@hTJ)l_eM|G@}khZ83^9p-a0_W-6gM3W}0WR6_HvMY%#!rcnEtdjX_pqnKi% z=E@JV5j^Jo2u1AxinoLpezFri>9Q+aAmnyEY&^V#Ou(l1P?;~mO7+q3t6>Y7OohIb z+ApWwwiW3&sh8!+2OsU(_lU!zfaC5kB~l5WP7)sl316`yk9)0MsK#Q?m^~Ddh-pW(zTM-s#KpvaR@UQVm6ZJw8D`{(Wa|Wo~1v9{4CnsCQ)GiZ2`(2qM5H>xg2FLl?yPH?f9N^JLYDJ7AFyL z^B*^$zL=k@N^`v(IOVPJ!1-v#+4O^!*c1~>H3|vGrkdWDfUihGImZMcNZBW6pgc|d zmZKZwVzW)a;Gy-Kgx(O!&0R!S%^RgJj9{5H*+x&f_1*gdh1j_=$fg z$}_PL@sC7#r-JfdL|KQx;~$H1FGh@i!sR*FK^kiOqFl5WKi{Tbi^RW`Y4Vbpel8OK zjse+BzZZ$)m&2&RL46-p$;t@y$)2= z&JsKenqwGH&4D=}IhFxzSMR48j8mQ=(%ln@_o+(z0O?%j!w|iujlnt$(Z3FN8}Bq`wwgo|Vj#)930^ZE zW*}M0&X@=2a;1#MnO6ii6u(mWlE$H9n)p>*miSh>_)dkaOf%DOl;XPt>*kfTsC$?i z9uZ7>t6np3G?M))Bp=_WJPd-_54WOxwK56ScsvU}7u}3Vkt4?+QqEq70b#0A{85E` zfjH=hKgNK`+z!tW|2YGinSMwa{{;hS=A$ZrUn*5lsSNW^33!|(lV#oo2O58ZfwAV9 zB(o=(N!;X1^FPkO1oJaGfL}2%(cFZ99)F5~N#_3<2jFQ2CYz600X)kP3mO@_3%&lut^9ir|O7r9M0er=#XfyAn$t9`dupAZUPl)Sel`OW#yqG4J!N4Z7 z3%Oc+f=W89&Tg-=7 z16aer0rTI<>scAN!+bk&UC2PM`REb=>s7MWKJz#00Mzmn4x44tgE|K8H~%-)IJnsn z^DXHB>eapI^N{&fTC5E`g~!ZcQo)T3{M2m0G^=Er zC(ZXjFXOFD`Z;sB6o8+BQ|2aGg*GPeviU5@pq)v-X1--EfUtTR=KO~FDrkB9a&Fdd zK2Ou$!OhN?J!D8bRf=Y3&7Z=^kMO0!TXI!b$ZoY$S|9J#T-AVYS)vo zQ=>Ug!UoggCQ}47A=whldw*W^8!uStW8@&x zOz9wV# zWZpdiK%*%YV%E$bkd1FKy@6(F=6^T=Y-J$BoIwlV;$~Uqy_W)LHvMEj5;*f|l4=VB zlg*7};~m^A$NVOF+)ida&wR)VAjH57eobFI!cv)Krh8N3Q3mFiyQo==0lZU(IM`-- z9O5r9zfGjOP2>uKW(Q?6+fAgnVe_(?0IuNQ+eXcQrf_g21Ks9Z$+7HUV23%74B#pT zcAGU1fSnBN6N|K)2fdbGNEH7b12>qjBT?;P;1=@{Que(J91v@{kAXYP-zO8jnt@*P z`|SX(VW7`Eh6Mk81`eC=Bon=sr*OY{0?F+<29B6tBul=YfrrdTNxVN`;4$-r3;;JU z@VHqgoxPEP6XwTB7j9xTJ86D*J%C$yoR{Z%@bId54+F1>$g$rd>!Ic_ykzSJ)w z#{mZ3HczFc|DlN@;u#UzZ{x-KZ}WN5_S+eF*L*(#cQEj0bJ|n@KVslL^Pj2aP6o~i z<-Uu7^Fq0M8F=43Z8n|; zLxpky2gcJ(vs5nN$k@;GtB?!sqGkDmX*|r+DHl``FK0|^05!@5B`X2FV_FBO2|kco z{>ii*kQXD6wVX9|0P@QP4P-9=%_9Wmg3HJwzROTpF8Dbq%byvF$_35D^?M9;%LOKq z#5tDW4!PhK8PIu#cFP4%U}@s-v)S&G3pz#v`hcNp@jz9o`;eg<a(ia>40*K;|Th0*~WSuQa1nhMtfM&JvWy{Z7aQ zA?zQ;M{vKBazQ&m=?pz57yO=}kqn)}N)wd9(93vOF0IkTBuY$PlM8-KbyJeaCBGpT z(34ixT=2CD zXbwXkK=cmbC8sRE64)slfJ+lOiDpLg`5pZ<8MXCQ3}S8AKb)qNK*>3 zD7J59C_^c@(F4fEP?l2g2Ol6eL*tbKPH0=0m&r=OBiQkX2YB=xrQm+@1Z@oE;p(!i z1>kto5g0t4PlD)}y@OboXnKk<&*5`C#k_G8E5{W=?oxJpDq2i3o#htisRj89(Smel z9K{|fdyEOqCYw?)vlP<^e2yox<7QHJ5iMl4DUT~>QzcoUph0Ub9!{EFJPOUGas(d8nt3tU|&XpzS)vd3;ld4}m~Zv6vlO)+^0lS4*v(kOFG4|CgJ zQd?3f(KZg5jH6je**_wl7nu6F**o|g+XghPoM=jkqm=!&1+CVZzU5XXEaX_yR$5Wf zN(kqpv1nCc$^#lt_QL1*=TH?gjkLgL~ap?_Xy#n7Oett0}*u*!Y>g0gxH7BB?koJ zG3v6y3PhVgTuX?(2o7?)K%Aj2wBsoU1>y~A@q8{29RhJ=F%WdIEq7|WNn$Tki$BA0 z%OQd2B^sTuZ#gWw>?Xt~B(ci{qMHyu!6l&FB@nL>jU6r^A_8#-A!=cXa#SELQkN^? zKIND|JWhPPR0Kp^Aa+oTyGnrACJ+Y*F|8DcZh?4+5W!7AY!`@IXcVl1Bwu0BAfnHZ zeq1RKyQ#&gA&6^<#`DlIdB=@Er0Ks0M2e|qI}}SP1o|q0-bWojPXS^VZN4U{C($l# zjVwveqZ{v%Ex_U|MuYGDoC%%GM2~&Yad|JD&n2mcX{fArAg+EuBg6%2F_M<=8i6q3 zbbEEA#Vg6z3U!WBmwsa7Iy>Z@q)IfQdx&TPK`kC6IbMGb+$E`>7Xb14WkCEu(72yk z9E9P@H->Jb7PkO_dl}#|Xa0&P-JDxP=ss$Zh-9X5)z>Eh6)}94JFp~-MOBzox z+T;*sM9UCN9$`)+4#}#~W)@*4kr)%0hYEnPHUnca+RULg=Zc45@(GiII4>s~Z3+mZ z5hlgJJO(<2cvyoZ>jq{S+7!+X0F!E9RuX0gVbTnYl`uDv?T;`pLCn2yJ85pZfe90) zoP5kk17kz4qIH#$oM9lM)Fd10A&)XJ-N3NgUUdhao%#({;eAyqG|@6-%0b|g)Fv8x z{wiR`7@c+ynRjOcGtR)2jtAy@q%7kNOa)Jg}N;VDw~X>t@}C8=RHf``W7;XvQtI24brg%?Q)^NeZi zqsglz!x;wVTEaMpsY?vZ4TRZ5m{|tq7Q&bif@JX;nk2Px0x*Y3h;xiKO@!$qWtnGS zyoC7~VdfhcKVj}|1!jSP=_U>z7=|H{?3so(3yn5+(0s2Oin)P$bt3tZ3-~1&N$S}G zVESQ31DI3PE1OJMyap#pJwUU#hRkbef-+(5#7f{7u)+j`#Nj=JS#Ds$g!!x-n3V=5 zN|=|(DJ3x7gsI2U%d3nwI|wtI+~aBkvzsux)&pZTFugSTVhZnt2BwcN>IPtn z`l#0!T9XqI9+N5dtNqkBSm3}Ymzj}!kR3G<|ZIYpQjXrz2Xq4<-e_5;J7t_4Jx z^9-r*!aB5gUfBQ?ECBCM;}+K@T8xqklgYuqpmcMK3usZ8Mws6i7>yj#lC8jqx6MO~ zXyo%4QWmeA2i?TTXA^YSNQHmRMvIq~*O+b&sPM?jL4&sjsc<8$$E(U0+@gub`8C<= zIlf3uQlq3*ug(JIyn%U)Fn2Wq^S*)kn)IwA6POPSOqkldHy@Y}*#bZZdX`28unS`k zM1U(uT|Y8)0*5Rk7yi?OpV7#Tda#f%yNS$165bZQi7}^0UFkOr1DFpmxcE_>e2e}K z2xV2Qf>^S)QV`9mapQO`>m&k=nl%Rg)s%G;)-Oqj!F9IkP%`mX19OBh4KskbE>&>&8Ymah`Lx`hK^KBa>c?nf z%^*+qhYY$tga#7^Pg;=VGZ}PEhIs)~{OD!Cj2cCBZhHy$olvywU3oX|G5HJRhZ>6v zG4@Ed4=D{BHL4xtl^&DrV_KTgqb_Aov$bp;0;buv)-yP!h8kzs%Gw#E!%?Lt%lZMu zwyaS!3ap;^auD$`qv)VX>2X@~=K>tdOesAMt0fKKI0LM)9?AnaeiZG?D?O#wWyI%% zQOB9M&01dvaN;PshE#f*tj{e4ILQFL){khQ$)o6`OzH7kOGw|dc~VL0bKnFIqm!o? zBLz!BFH2I7iU)d)8jW_1j3*7l{X>vS@dyRj&oW4MmqKK1?Awkm0S(w39_Zkcq4P!6?2?i68U@!q03>FPz&^C-g`%nf; zhBBA{n85@922(bI!Q~m*U{EakT?q!44`VO^2?i68U@!q03@%SFD6RX)N>Cq_aprl1 zA)bEbVNBmixWw`_3<4&x0;7!nnsqb9vP?tW!lcq!M!%rFZ4mI=4^04jfA$k7)cJC*NjQTg&^0uqjDVcMQYV9gj%K6BccNB+X|}^7 z85Epn*p|&00%ln^P;Jx5Z^5(L^Vklnbv$7AND9Gf&w(qfzo(&^N0PHpdK#_0WX~RB zWSjLp?Ayv-19VzH911$@$k2T}8>Od4Otyu&!a%$1UDyaQp!;{(;X4!1kzIBubOL&4 zm(@w`sCDESq)KYfh3$4MgrCW(JtubAu@VXB@m(Ze0VzEd_6i?3NPt$m0~bnxkt9#} zEqhhAp3k?JOn(l)s={hpf7F2C&hVVno{zVayQx8=ioVIff0KUI(~|TO zYeoHkNK(mufDci(pDaT4Khr7DDm_7(`?u*r=6-u6#fI1h#gs3j*(Vv7rlY<(RF zxn^X-l@_A!0BE%qEExdRp2v4tucT~Ev{ri{mt@3NdHqPrf&pIzg5@Q!1_Y zJhe+IKS?Y!Kn)3R zl>q6UDVUyB$wBR%scea{3VTVFB;S?FD-yf7!`_0Oon9uY#H{3Sf6Ray`+5g?+yr!C zhxL8R3=XD}HY%}F>r+Vp52dDI6gAen!*1`4OLAW-b04!=pCv`P+Zd6fHP_odSG)Yz$Q)@c-v?lGGkz%b1sD*f5VuDmpGQ(JXYgd) znluyDkEU9Y2dJ^LF?+YiC&`bcx)80wLCpFo&G6@`^k#cC_IcELb0Oegq~3+0l~|*d zw?`j0zkXL^2X+Y?dp4D9 zOpWz-mHg=;oDHT*hOO)#agkT|m9RCd86CejqK#MQ+Fe!jJ_dQu2y#@_)Cp3S9z|p8 zZ%D@bjE1-DvSvUT2jClaNhQsXOVXdw+P;qDQIO6aId&{;T|p6Nu`ue`D_!IamI&L5 zfn6z$=1Tk+*VAbTB2wDV4EQ^#X08SOds5#yfY(EyO72~V%CblRUb9C?898*#?d7QY zLFxl&Rlu#B1Fe2A&}w}LCMwsYzH&3pq-g@ZwI2|sEHw%4=Sg58S70AOU)ysenzB^d zDkj@zttm^TCv8z!y@J%bES2tJS9&yQT`}orVd_E9Kqvr>_ld@Q;;Jx}eoaU;=+1Y5 zqLWElS4Prak-BG~)8r$GPAi6YS~1Y6Jcrcxg87{ra0IEK*n7u7rwis`BV8~XBME)@ zyV>x$_HYyd_AB!c_xv?qzfgX^YYJ%o!<_KJb$8DJoR|93n=q?&kLUp2G2ex;i+Psc z(b#;V@{XB)OFST{cg({i^^U=chF>JfXL+znsEH`qn`14K{NFsL($guef60SkUN`T+ zFjIM$@{k#rC(Qr-14%+~z@#5Iih(Ps-4kZ|xd9D4i!|j4Gu;YJOVoqQ0f6+2IV_P7 z{u2ftX+k8&4UsslyqkZ*OxyXm_z)8Ml_8;E$pUb)2IJZ}TD@SVXoX;npt@}V2D!uB zdp#;;6noQ-fic#dJIo2);q#Io8KBAfqp@gsmzmzLg>1n3loQ~O4Vr#oKL^cZKS)I+ zNAU(!ySek--^a6}c+Hn!6zg2Nu=AMd2b`cI6+c3b%3&_{!UoW?g9Wvd_&E<>h8i)V zWPO4fZs3N*z{qI;H=5}MGnl*NxQMCBX*}ZXdnM_|D!|?s21ZOzj3|UQG9fe}(u{;i zrQ#!#(9vWj+v)(F+04&(#7~SEFb&AZ+QMMME{bzA0KceH$N2Xo=_?sv?;{T;I=-kU z1j|PGqJCS5I5*jt&WpNXlqL6}?-S^29Z>-Sujxg*shP3XzthE9I|SRW>%ur}R@S25 z>q3jHLKEK54O^+l93*?44>`+6I%xr=nLw3~UW_3g&@(ZFhuK{O?Xq0@KNi8q7x^7as!CfyQ?Mn+m`qn8y9fSQ$_>L*`qG=?HC8wWU|11sf&tc%I| z9!`*r3?~~IPBsB*_6WJTm@ZOVzZfMxFiQFJl$5vWf7zK}{PBSi+J=wNHhhFO<_tbX zkPHrxEdHYzBwbv6AIRF6@sW=t7lz@tY4t$A0kZA^vg>D2UR71<155GFuPT=KoG z(W}6rS39h4lIQq?CNBBj+b%8v&uHJ~Q~lX)>ohm&|ER6Jo2Uh?`IiCwla?}9Sla8A z0MBZ)kaQg&{JcizJ!;SSxRoze-({Y$A5`+lm6EiZ?6nX)%2N#~`>juqYUdcBS6nRS z>fiuG;e%65R4lKWf>uvy%e(PIFt)(`G@-oMuH)ejZbM3wHhViCkL2C zcuD|Hsr+$d+wux636Xp;XAX0Io}j*BfcoZ3xKV<7^H5ML1NB7Hv@%dn02zE`uu3C} zYR?BdDFt3_&+OvD7IEO6e z=4#KytL)`?)0%8Ey8FdNg<-m9!}QomB8b7S3C6r!%s zu8ZNC_c?romBb?MHQIQ^DeOLj;vH9sGuQ-t;415P6s@l|bfKo?#yB30N4mg^f6yS) zBo;pb!mW#Iyp<3g=Z_w#oL`IqB8L=d0c`|K|gw!0~1nC)D_f)P_x}fIr^p)F{?D&=D-jzLs+&eMOgL$ z!?L|8!m=+ImhDRsmi@V5*@2W{mffBrEZb{k%MKc2`GsY7qzKFYdt6#~gj3y=Tf&J| zsQ4wO^Dwbg$P=Zgz@7J9MP0HY)+@aK{i0Yo%fiP6p<`k%h%YdQR%hQt61d(=#+{t zBNj$51V|f$*0U5}64g!CSBBDUv>qlYB#1r48-5wdLex&{ zC6tYhN?wEMsXb5c5<9V@lZ9zHtPyf)naRA#(qpZZ*d`i9rPutPWx`B|h458PM zU0=!oUDJvZ?JPnNvkgHUW~`?xz-0!7Qn5LZ0Ff=MTS3eEi==aIyhxk9K<|?f zJShHx@6d!IltHoyz*Gi@k^rI%^Xf5xMxn{xB%#Sp z>z5Yv^cl4k)~^X{F~HK2H?YDABq0*s14%-Mzusw0CByll(au3Cb(;ayAQ|{x^awlL^oy7^ydEgMyI_2Iv<;avC7S@MRImeqy?-9$N{xRFiu* zo=BL;Cw#a{4vy#c37@`FuEldpfSR$nY7$erxKnINe{QsPiW&aZ03EzT{e?;FP&ZPv z`O>JWp=gr;DoXBdkfi^F#H<0ZCeKNFBb^lfByz{%&q=#(X71j?Dn84Sc@uowUQXqj zM4Wjmi$Nnkl5l&B!GczE8S3^MQ}kD|Q@E8u>j&hr4j5HldnDF@B{DiTN#%XeYI&I{ zR!297qu5*gD-1os&sZvxdT)fXFXJDpl2c*o%T3}iBWQh{Gb$6=u+r0R-#}+1D~$oX zb&(~YWH+4weI$i6@8Z`YNDdFa{G8^@sa?OariSC@cAiiV9N0Z!m5wWoiFb@LR! z6IGF5U%1jbk>bQ8V**Hh>Yacmt28%L&trdz2usX1hN`fxBKal2pis&ws!&RsbrVI7 zsYYWXlg?2olQ#97c_(6hBnS1mDkW01TTr(g7e{iJ`ond|majnyJD-g8+*Ba<8$_%n z&j5b`YGStqFv~lbRZu$4cj;$UU&q67QR?#SAun18B_%WIg52SV8n_ zC4|+x9!R`A*M{S_0Cd-I+FHx+J7W2Zv9z}TB9 zs|X>MCcqksrF#roLCPr-05Yc!nn9zRD}RsB`3ZBhnMekSWVb=mUv@>J8Ew=S2QiQw z;ck`ab`5vi&)sO~$k1-08FyPd4&BPR+q*@0rV3AB)w78SlpEbj#RL+dl|py9V%#r4 zp*sO&S@}}5#+aPf%9o<+4bWkI6H!dAHNYn8J43-5dkM(aB{;R0fUd)UaH+b2?4(dx z0ydBE>~0ufvruW+Lvn`LX|f5Blec1HFqX6U6*gt4<-O#e7bxk4$OU=U-+-KrPbU{7 z$l3UGG69-wd^(u`H5(sJCcrdW)I~!FD=+{o>h04p*kwGItyUbKGXE=n4KYJe1)j77 zOM02nNu%UzZbBAPan3|gn8|PoC?HFKriF<@cLI-T5rvrv3R1Bz39WLulYLDhFy2R< zSeHbN(Jgnd+cMaqJej+FxEjBP;<4W0ZX{k&V|1H5*exdq-9{=DZ0V)jg2l||Fj^#m z#}e7YaH8A@W+fG;ZAGVl@C|w+(P=M_6+pvmq*D7wh^FXD2@ z?pZhpb=q+*_D`lr3te1Ff&Ej4$(0}E5q?Q*At-$+3wMXNHw^-&GR#u+AR{TCoe2tm zl*gdAki|vfkMAP*qx?49B>1yFn~z3k`KG^t9iw+;YN_@d-YKr<)1Ei3=YJzP-v!X*DQ9x}f+X4b0nET!E1{Edy)vJ0c}% z+{_8fyCRPYN{u7nE9KvRu>!XUaQ{z;Bfii5_f#a#@#fUq@Hon@477ao7PM^UmZH_8 zMystJ+5>y)aa7}blsqFnGgVEWls-xxoty#Jq>Po+^yR55Qp>OeYMzvux*GL}KrBnx2|UePw|9hyg;&(9CRrNoAP?rY43#ypiRyOzJTr7ei2J zNY6yql@su^j{-phoz_es1b*wA;7%Y$MotqfNe>8ut(9@U*H<>fAS`5xLMlzOXp20uY%^$48Hu|{4Ds$ZegJG7(LJTl4l|=(H z ztQ;egY*s;T(rQT3kjt70B*`^{q9xF3fZ&$E!a-0pFEaY0ULcC+$!jKv2@Cx`HIlT|m`y6pMxwj@6{!<$QkMTGeFQ#bLgSx2KNjhl9}G0lZ}oWQ z2bL^bGB+6LjCId#?TpP|GC$Di3C6rWiCY=K{J^4Nt+1~W8P;GJ@UN{S+lM!v-|346 z@Nal0=Yj~qJQ*X`nyp< zW8xc%Rv7Mz%=2JLrAXB4^|j2y6}2Qqw}*WZ6ct7XLMW!X_AqL`Ab` zpu;Cxb-07UkVljgbWETVXpQ)WHzw-7AS8vxXc3P3yL@hMq7RSlHhRQ5F_KphZS_S% zVZwu@NXXOf_IkSjQF}m%G0;5FX|xJ-q8_djJaoE)q9-)R+iVc=McX>Uf`lj35q3vO zGXdkjqMG%EHMMmD=x|59b|;EjbNq~9H(Nl`H}1l{3gsSz5&_k_GOU4jB3kKf(d=_5IECl5i1(Q(Aw66^Gk z^r$lGi$r75KrjKveO-}2h$P0fyx;(EG0gKs5f{g;xYajC!%;cx?s5~?RQ3czkyuxv zW?(g`N|@ZxK9R7G*+4DZ9_kQhh0V2uST)iTaL~Oy6eDE;1_qZ9IWiAGo=}j5DP(1c@{jY$Yl@(5wNZC)O1i!mKewwB6Sk>!7aK2ZCd9dpy2iYgZ^nN-t0}<-|e> z%z#7%==C+nNJR|_-nLjI+5t`nP?6|%o~~%nMUoN4Z2>P#R)BCi9f1hdA-e}B_+g?q zv~8d%6h8{RV{H_^nMFx>w zzD}>NYsh#}tWpP*eQ*rIK&Hd{5;7j}ZG&#aItDq6hFV*L5Y({2qrUEF)IBIW1O69+ zXcUMJWdsQL_?984KnKYO_%U|u66qEd6{tLIiweWoI0xh#gTYYYS?q)532Zf_1xg|M%V%27Cx)#$`pGP56 zYi&^fEIYM|YqVRnJZ<5Z{`pTBEtUK+t;)izhPbv65yPZzr;l^=ah^VuOEd8WlK50w zlKrc;X}SJZ0>n_|$;!;kRa>;<%JR(3+Kb8|nZFA7b48|7i$ZSCer0K{slOy=HY&5nX{QJw)loUII7EL=xg={7{lb^J}Y4YkRfW z<`dvOce64x3;p+Mxm&oZpQ{Ki#K$=;t{&SpPyH|Hp!)lrZ>ldyU#K5TIqEArPpPx# zsn^Rno3*3b{CxUYq|DCLGS#u#Xk}U^vHLSQ>rnry&5YK@K>GB5Ru8FEEHF$4@9wsiLf-#|~-xG{3TRjMAD}fq&IXDgK?1$KtzE zo2hMrK+mCE@xMQng3N&mRWH9)%RSwX73e>t9Sdl!v7=gpwuz^EF!^o%)<)wC;yOfM z-)qqB$sdB|N>v*TIcWJ;aYak=9ew@EEpq1F{MomKv2P~7<=39xcDf(4Y&`*8$ij-n z`;^t0N)=w%Yf?|phc=%+6$?pMRo3&D9c4MWJXtMzQyssuNS&2)wbqV@*2MSk*H&q( zj%lmVKvB1si*^JgtEp_SYDA-N?mfEYgwed>gfb&@Ka`L=w+|)KHjK!`gG5Y_Zycm_ z>B0Zkq0M6G=wOHRmTlT1C2tI~atgN1g@efu#OXd|6-{4G-a}*2hpOcyYq_G0_GYp+ z_E-HR8ySuUV&12$%QEVCU0795CBMimqC|r}1Px{O*w(;0c2;VT&@6}v2VXjVl7T&j zV()``W9{U1Y(;B_(Ng11<+Ag?*p{UW=AhHh>CQ6)bUfAM&}wrbr@bwmpc zZ$Z}4RXgBz4q%S`C(dif;ml4$^AEt!(;rJ%Q7<2m#^_V3Ir^nG4Fjk@q>q03V8c^2 zT47b)rqP1)I;QTisp*BHJJT9ulityHtMoTCqF(^Xx2 zZ;RIU@Qr&nYXA8NKGhCwo;pQaiD+=i8KT#qW<<5T?gziTz|>iT-=qOslHWpH+4f}7 z%to!IuUj3j*zm$WFz_Tk75Y#QCjSSy+q^98Z{jM^Ia+z-%Edl?QK zL44IY)$LSs=c(O$;4H~jWNn%@z2WLFwfu&K+M@Hynz7(snKf>2k5ZWR?>->7el7U6 zwpW>*MQb>FjIv;&wrbxtZCXrQ*9wuHU)88B_~765WgG~cL}(l6p9z!ER`1)PP2)+9 zL0HuG^=V_Z{YV5hX@S$oKiahE{Q(4zYk+KcU+r3n{q)>MEi(qw`TOzX$4{#IN^SM& zZmoy^KY*-@#Q~rC;3n<#``X_q)j$@Y9iV_FCm&4y!(O#*-Wv2%vvO{J;%1*$nLlx_ z+EA`ucF?c=Mp-rXz>CMNzr|m}0;~g4q6^BhO#Es4k=&5V|NrrZpVZUJ@VEFrYSlQ-ijdf(yDPrZFq?w87)ztkyo#ojxR|S{}@s zOC%SyTgzc7A$W~!L7sC+o35-OZ^d253gJWSCzR?er6da~nWYqG!4Y7B=lfqghP7x_ zmSieRvXnJhr0Dot09_x8jDOWQWzBe~FGfCwY=-`)?_=P|ai4D*M+L)y7Ref@{jGgpBbS^cT<<|eHNwWfw&X}QW}nObf@tHPw?P&R1c zW$?kPPVX4zDqcK<|NFF$eK+0gRpw2oP=kBaal#*D-KteW%+wjzoRvqn9XfyLL+z<^ zM-Qo~2haCiKr~Wk9PB@Du=5iwrc|&K((pni9IV}g2=-^msr@#l-L6%%9>V|kdcl8>B&pky_ZvtqS}zfHx3;$L>*+am z!GFwu&pPV&Ad`wFNF}S6?os_tG|{rqW}TM#GG9_DYK(F%PH-~z{C}l2YmXY3XAHOQ zWg2N84;LF8ZsZ;W3ROQbIL&A(N9`u1%NE+j@d*ZR-FsledzbuTi3!1+V4`E~vG zYUlf?MvK8bP{8G__I(Kb8fETyT$_qNT4w0X?DfJ5qC#8=hMJ(gd=LU+QPLi zdzFJI0xYU_II1gM_`$ZrRa{+L1$0|H0JfTWKiWk{{A*o~>UH)i)K^xbr>nBQ!cit| zkNN|i_D+zNTxHcR4DZ5*n^YQ#L>JmZ+d3s|~KXqZfsyd{8#v-Zfs{oB7x3UDbgMYyKqA|cGYR`$`y7; zA}((v?CNkw+NHu+G*l7@V%yGv1?rMI+-;#QF^#pZn!?(`N|()EQ)@3Sbl_!UlwwE%V?o6hEKxQsf+ebF-0gvCw`+H3A;VS zBz|xmanYuHD<*(1FD*d@SaI5T#aciQw`0AHd0?ZNZG{N0t*rqDZ)uw!JG92y@M1z^qEVmJ=ED9xRI&~yAp;h< zp{%aHu)3zoQW+!Dh{qiZcGAl>~-6R)hUud_=L_cm9dH`MHd zsJq&s5!+y7zTqh7csEQ}sA`>~&{0P}tWM4ftTfYcWC$F2b;N zb_nQ;_y3Y*;GD)qhc3L28W^IZye1>!C~e?SW~Z4SCRLy`+e z0WPSJuPg4ugj?Mm9d44x0=%yZ_COAX4@od_!_XsAXQ&HDjjmP?F&1sF_0-V;gcOLl zBB59p%!33K!x*M+k*Od*2FdV=r+lHc9s-RAD{4QMDyP!eh?4n4?Ice&^gZsA~Yk%R*V zER~B6QQ_{{wb8nfFL2oHLyXK-Yp<{uVli9UFO}QM9HsVJS5;r>~RXiFYGzXQ%K4p$@8#!*&X1>%k}+&~HO3>Y;Xh`|4Z zIwUA)v#Yr)gaak+Q&`M>$P>8A>Vlzd&@-H*!5$J0#!*2xv~Dc3IZ7R674|xb{K!ID zCa;fHlN<-k5OJsjmWww#(HU?;Wr-~gMm4q7j%rtJb+rTG%?KAzp9;*JqZuntB95S< zUW#;tLWn-l0mIPiqMfxEvCCV86Hy#$LNk_0tu4629R27(jFyoVr3{BGUF3bPV4Z+^ zdE4!DDpx10f{tjxA^CdaJaf=hJIGbLn&Egmg-eof5(w+SD@)->S%2XYTS9o~Hd>G- z7}Bq(brn{vt*}F@;Nw}Ub+|ivS9Y*waxkybZr@?OnBhV;z0#Y~o zAXc9mI<%`X)S+%Wj`f04Ei9}Is}zyMf;yb^$fcnn2m@gmDF9JY)kV%9ni^;c;GUOm z5dkAEECtJyJyE2l!r_XBC09jRk!yp!whpdDXa(P!;Ob~aj_8ZRv_uT?1Owsb5F9A0 z3kHc8-btiIoD?{Pi=q6WK^k($i6I$VC1w%{1>-&k-$x*o(K$LjtEhuANEh6ByVTv` zhKsp8M!^X7Erw)&M&Y4r8#}{Vw>RL1IB-g9q>LOBAWy!D2~&mg!=MtE=MY#dHb z+Sb8wz=#IjJW+UpaMn(LWLgR#(a}NfRQ{z$k32ZAe$WGv#Ik! z+?#^yg@~JjG~YmkxsZNfB8JMNyA#|A!Pg31;&322*ZH=KQg5d0l`4VM7X`-PhvKBm#89sHupH}jfkI2&^QYHKcvVO<~SryVD{#q!$7KyI{@wHgo z+Tx;{Qe3!@g4coTJhN~h%_JdlK47Q;l3xxH6oy;eF&r3C3(Dw>2IyK=CWYbH zL~1AO(ur$A=z;JjF5Fopb#!#Qpuo5(4p(rrx)FaU=#?U|X7Wk6or#tR7kNd9yod;t z*mCC1;~CjL#~6+UaG{{t?e5%8y6%M%A~|jjz*0lo$U#U5#S{msnV8T9&X*-;r8_)q zamwkcuB@&CPp-pN5+W{ctHPxwO|#C9SX8yvWn?c^_KhsEn(B(O;s#fh9sX+|$%X2Z zr-p+DKkVu_`DQvu;~llt4G7G*G;+b!wuVZu5;h+cJHV?URl<3DjntbBBiaQ|(}LWU zQ%x)sOv~=tP-fpq7YX&1Rj_?0t`^A)h>X3N@)dWSWq^w)-!@mMvxsjosi8;%@|0i} zK{zDBx-eW7(gSw{c96)_u{ltMtga06>Oxus^`i`puVLYo>wIvMe%wVe&|YMY$bKst zB;InMXbL+Z;SI^hDk)W@2usT8>%^V_#-u9|Vx&F{w!jKJB`$bzwMxTc6|j0Pp$l=o zqeQGoDZCSsA0yG&fLX$!;R>%Va0OlB(!hq(*-%#Nz?BtcK;&=OmxF(dF9H?$bs;!h z^+s{UNLLShEkL>Wp!f+*mxFv=3q3=O=)_YU{-46m1xnJhtn=R_uv~;Bgoq>pX$-Op zgwAwlG8tIFsjj|N(l@%QGu2Tk`ci#iy1Odf)id4M2ysEk(FlW4As{HGfmwjvuql&vSkMFRx>W*gUw@XR4)=(m-??10HVH>NWUa3&Xf) z=Gk@QweeKd#b&IH)TU~UMQQDg8ogA*WkR<$JK2U?WuPuCZ0SvzQyW5Wuz+Fv+9BNz zTY?a~48xuIM7c*%VOF^tSj1R!js;$8L`@{M2^b0RgsmQ%-Hh7378Y)J`dTO2nKpWx zjI?+HzcK{Z0kgS@y6f{e;#?-EY)gAAb9gxF1G)*LC0;)bn-{m&rcr#Ll;~x*yWLov z>a16Kz1^zWWk_Te6pJWmg{|i795_?9eW(Cb*m?Va(cA>z+Fap_&!@vUX2%nzwbF)9 zWA*WbCdvjlDuEJsVpO(ZizRfk0Kv_hY2_T^RHad!%z4RdwZS^BtghD9P;SRN z`z#yd5ujTPwe#?0;R@m!%_v-eJzUBR$1kYy{+DC%%Qf-K@%ZIL{PF_h=m87Gu%3dc zPx%~R^&*>HBMp{veQ|nZb}C~Rqk@TPmXavFbTI+xejv6-*7Mk+ue%`rpk!umvt zC0i1qHq}{~6N-xNw_K+-B20=tI9%Ln0*Q7B`n8TH0?mMx<m>(@8AVphQV`%U(g7!-!*mVq{?gsd2R`<``Qajclva z>7r8xNm~;as*8QLXZFFcH&;~4&G8UKs~E+Y*sNCc8Pn*5xJYYs=uvj=ZhH-urhP5G z8F;0sw5C2Ut~sWMf#LWHDJKTYj{EC1Kj4= zPc!r1i#|VLff|;i<;h6TO;OYxVdtD)5Iq1f1G}5eBlj90e=H#MA?Gml8)~C1yH4O= z9X-waVt$+Gl96Ob8ZR?bX08mIPAwh^SA~UQOjV@LOCDe*Yk#)(bdGEoGllne+!!w0 zG3x-X#8xk{spa)i-_3;geeQE>?J`RoA4a_nucBkeP2)fdio2bTqNgGJ#Gm%!rr9xf z2lLAc!gP~b@9P?y8Y2aMCG~-pV<~A3Ewg@5WbqVq(DuUQPm&q!CTg~{)7d%P7Str< zVixhK?W=W)Lnd)XSx+S0S#P=aS2L%OW{15#2edUZ+oUVe6Vp0tz7Tks?54?z+-I{3 zjZA`mF7PxB5K5h3rF|d(t&pIKn-($67WHYI9|HFX zir&oZ{50}WjWax50B}U=Hc+j3AD>vh>FU7st()7V5w)7m_H1QiVPoeUtfGX0P+&nR zvLD-ND3~2uKCFJ{!@@1x#1Hm;OS+Ij-=;f=owcaJVGB?Ymn~(Ozv8>$6zvtQyIpWv zrC+pH2c!j9>#rYM%;D-_Zudc?>fvN%W^~BT);BP5m>y7roSm|-g=W#$Ua=g*LTt3R zyMk}DO%0G3oj{>Q;(_TM$eR?vPzMeRaD{1-Bf<<^0}z~Vb)50r(nj*mvat7jSu>Ec z)mB)St+UuEt|}Rfmd{JBhg(B^r=Q4mWCNpIEwxp%b9x6v(iaX(!*z-X$-&LsZ(#!- zogDdi3yW~oF7JkHM<8p%OVLIU@L`khw9gugt4&vfcAYyA>loF+IL5Ujlis+nTPAz# z!~lB<8XpJu$#T!Om7ckQ(}%hU_-h@e zHiH|R#`|*jP761oj3p^GNJH)(T$pC^0)Pok2N80fvg*>@wKh4I$Jl#lV&b}5b`EI- zBhChHm{o5>S7-UQshvWXIWf`CTp+=`$l)^N!I({``F4B~Q z%H)4;Nn9f%)>qA|j1gKw!6qC$Wj&%Hq38+vHD=Q^xgVMj_cL|Bn{BSF1oarN8QR69 zL5MV03PI-(6-BF{vn+eXI)V9Y$U{(q#03^}ov78^-JT=?ZDd~(0wW>?Vk%RoDvR|* zNaUcgtDW`98W9PmTS>eH9V9@k1tc$*OcRr1tG(zP9-o>kYQz%Yg_QN2cNDkA#-(w1Zumh&ksG4bDQF6Tt3ZO-X9>R340#$Hh?Lh2wIFfnf@XlrCW!B@RX|W|XK#xur%peyQ zbc)s7makd9Q$Vw*87W9WdXji9 zxv@4b-#@swwl|iCu?@3K?7VmRVYHz2>m*gy{%!%>?g(tj)O06ICo=hce6hy;QcMr)r9+1HzhVM1X7PX#OpS z%7${RY$ylIhH|uQD2K}khzSbG(6#xu96B3%K}LO4A-vmkXQc&umf8?n=pzKG!h$gD z!$Sf0icmoDgDrB2kqRbEP8t5K<;-8i-(aGOL+F`wS_WotU1kOH^HTH^~-Q%IpPxTzpLF@;vk zlK!QVS^$)sd;Nd8CcD9c=W3%Y(_Q)70)j%$u(?*+UG^%^1u6oD2)`+OZ+n(QH%jRu#~O z5D@v7VLw^bPFFmZhSY5(nQdAxdpI(8t?RP2HIR7Gh$)jaGHu=StNnZ8y~qx9nR6a7 z{np65f>CYoM`s%r1R$2k@(B8I;a$`Gi}Ksa)waF4s+-Z^vjS^aTi7cGP#f3R23DX7 z#v3R+v* z-Xs>(9dxFiXm1f!hL-SBRkX+zR3ugRGdqNm+Mp;;>AX(UCpG(Zv(=-xl zyfzQKtDWdd0a2$xUD5L}?~rrV4w@1}D5K0YH!vLGxB|uPM#NQt45P}-OpM`k26ECL zvh|?i+eUIOD1tcc6?5H-mp^uMtXYo2wtI=w0Mu&H?=0r5c!WOD_o#7!OiHHBBo zp!ZZR3Y0j)4sLtiSE1HxbAmuNz;D+rEaE&t(qvJq&-JqbSjV7!LAYvvxu_98og;>5dOG=%;ZCp zW4zJv6$YXM{FBXEeZ&LW=0GMyI=lj;2}q1zR;bHpTTvOp-e8AY*+zSR7d38kg*{+_ zf88~KAPV83B_R)i-Dg^U?6(3zT)2dJNB3qW@kWEu8aW0QVU`5g?0T?!FeW!cP+S%i zLkEgn{RSUB8~v8f^H}AAb~$W8d^6~M^KB^%*~%e|ye{s%iG>)wxDUfceVp9Y-JCWn z$d?kV)_njTjxrwO+->^=JwW2ev<@?i-4L|3Eg*)5Y0D~_9<^0bO`1{(V0K6`wc`qo z_a&pukTrHA+Idg}#%9Oam|Ev)kRRKN@QAFk-k!3E1e;mePLq||ygi`?YHV@mrq}p} z4UvzED7V#|`{8waEfm6}?a_T6y^*Pf`4LkqZHlExAxD`UoZ5k35Yi^0Z%+Z6hab0F z+UROlp9WPKnY{tPRvHV#F5d%uTxYq>kbwBqou0%b7M71mwTc(Z&?|;>4FyuB!w5kc z#Mmz#I&7z?e$)CaUfO*K@~Yr6wqywRukWd=)=rPuvdLqb=oMi}XUuO?d7uWN zEJoA=+XL&b&4d>Emqiw17XXrU73m)o+)a-LkmSe(hi|uFe9J;|RU>OvdZ(vJ5HZ%~ zEt8x^bEIyUl#RMWH__WXy-+tluh6gD(l+PGH3?@Yl0t)tH`MK zduXg2Uv4eTT+h2zT~!TvR)&P9fHC)BRzp#_7>R*@lHjuirfy_j5%#toB@kmC6bRwc z8JMr^w|ErysRTSK9Bw4HfwNQ1DLleO+^6SEX${z}m++Xga&rZTR&Uy{wL{0-KgItMjy}7pvaH5e&KzA8Oi>*8`Vsal{Tx<^| z8a6@nkoPFaEQWyayD3MZ3>m@x_4o~+bS7=0nkn+iO$MZ;!i86rH53?#Jmi{ahjul0 zfMEIs1Bx;NSQ|0y(wRuIvpmn;Mm+f!Ocg~JT2}|4n!TaJu z!L$T|>%+9jZP1lv8NFR_OY!Xng->k!mXm<^ko4BWIID%&0IcoH6sGOfT z2yDYxji9dT^y2llS~mKUywp!5?$w14Vti_BK~V-t`6|{U! zDIt7q1fS4p8@!RJ$_$93rwMuYEcDeNL#+woG-w_IQR5g)If)O3S~md%nQw13_1|K0 zx^oeOCCp-!9cBVXpq1H*T%ZIbLdIk~SzAVD8}e)CaWkmzoI--gChBBJ(O6*#^#jZ- zI{_L!!5D@}}*4<3GW?3O%SA*Q}g@i~w$~2ggAmox5 zQ3dRVfz*jUWN1gNxmt6&GS@#9ZeU@q_V5(CcfgHHG@K<*VnKf(;31lxupk6ZlE)ex zn&^}k@-L2aGn^4SO5xXHiSV^iQgh~_IRqPJN4F*_sofLpU*btHi;cF352rfIp)A3PBok|A`h@f4vE7WJt8eHh~X3t-M+5IU%gGch+Jd5xbq)JR%{KtMb< zt?~KUX~7-58)BCRn<$fai0~Ui=UT(I#Y`d^(z16NV27kUDY=<&-=JaIEcSI(0abEq zjxtSYc!9j0?4-jTavM8B^fXw4g;w#zo^}0GW6P0Tf{Y`_TKX?D^*~`KK#~|r;-QQZ zv5GQWR!q0)&pV64+$F;v5I>L;gF0X*8gL1JdEzGLYwg`Yje_%{l4mK!qCnyP)C*-z>vW;3TxtYk;aa|2H zZB9aCL+prGQh;dFqZIBPFwsN}+`L-2Tcz*Gp6z)=f(Pn|^p;duoiS(%TS z<)1k>bGJXM!gIacST(<-Ni56vWM$Y>E@JK{v@~WE zgIgI_1qN$5OHWf5+-hkQb|1tQ7Q06j$q;UolS?WK4cxFd5fjKNZHh*14kN1%G2~Su zT=_^=fzM_U%_5*csyN6tj&%)EFrz{ai`T0_Nm7*n%;_}4l*Ou$6XVVX=r_@0f{Jbl zwS*xDHiIZ*Z3z;>!DA8NQa=sXCP+yr7I<0=a%~~bLIR%UNG+feoDe)<94RARVxt%G zp|l=RL)oc~rEn%rEg*U;3kA+d()>VyAs&lfsuk&?e1z0ewkAK9PN9 zIc2@Gpd~8M5v5|TPfS&sts5#+wNWY@5C|O#fRKr`PL50texW_9kjlKmF{|!Q7`NmV zt*TMNJOKV@YIPtbXN2w%ML35bO%~F2x5&cHL(8UMqna{vY6jPs?PkktH5*xbHKd!gVv>=jWV*djOoUvHMKE_TwkfCR;ga^2*IKb2dUmNao#&a`foTmTg-dnQMxXG z@-PXWZJ`pDwCeq4M_G)K`(905^o3wGeuvo=>MOCuU~fX7we2jwG?-Y;QAy>Fz*7W@ zH&iDD)T1&}B|sj1!eA8El5p*)G1lr}!-74>IZ))L9kd86F{}DIE7&qU)|i}?rrA3^ z5&!{0xCjWV6Hm(w^0W{cZ=Arz$(~6BWp;W^9c(gcAgojOLFoajc&2n+u8@%^=%E#7 zJ(h{xL4-599J(ih6St(7PXKPU6dThy8=%vOv0Y-B*|@!%&6dm+eYWp`vgUC%0Dn>u z24gT6N4r!}f<_|V> zi6`v#Kq(45)O-jEf6jwptbz}DGYG++@&!W92=-FIqG8G;x}w)wXgckSN+_qM9kEag z>;)7wlgeN-NEkpE@Q887RoxW_UpE~fJJ{cmhR%=@*$zS~oWesQ3_2zmOaA6`VdZVJ zXuAmtlWSx*SBM!F`$-|TtNVNv(q;iF*j}lt*_J?9s2~!a;S5UUX@`24bw-V}#mBbW zZ5y*R^i)`tD}g5H!`+m8C)F=%5j+s=)HPuy+L>=mD0lP$*lZxUXLE2*WyZBn)YYa7DxE*7_2W~s)GV?4=bjSlM(z`5xl7css3_(Tpcdj2 zaFWYjYgpB%k=jgUp3pA27Z_Aoww9=bnX`iD&P0mrTX>*yTO=wB1@c)Wse)KOSxG<> zw#8Dmz+i*%14_xJ!*KUi=1~D?s~8Z9{mjdKWa46BNui}F3)^8R8!pvTw;8c$PXHfz z5&%Q3SvM=HVPa-spgJ@(aD4FU!J`AiM~ALGdd<-Bf#+}c_IKJZ4m%feX?JDg#d__@ z!1IX%1bGLdp9?}?5t)ym`Y09IFjJX6s0f>Gt}0;J|K22~haKB$4q1d?u6E@P*2aid zs-jDL(}n1^J@NVVVFI4?Y7$Ec)+&rTNRE=2020F?ZL==~JBfXrof-p}kKkQ2-}+K4 zRtotFSAh>#0tD+J*%sY^P(aEOw&CmC7nlP=K>}Kdh1Hh7dco!dAXt%ApxRX4vHUYP zk}L_wDk9WoEs->M-GxRbIV^0KQSHgQObZl2* zIzdGuxR>>7yotqw?ngZ^>J|u&_p(bUlt{l2Uxa=if&cH&L&(C~EFCm4}76%4D)C>bK+~EMb-g@G-ik0oqmbW(WafkZy4NH*KYg zoz(TNi=4+!$#tx;ld(ZfD@h->tD}cWY=@h=Pt-VCGkW}814Eo5YPSV6<6%W(F$pV| zWx&I5`n7jaWn6=1^DCOdJ0wWO5q@`yiNW{^SDUoTWylf}r?N1mYzRk-o0RhXdB!1t|9VF|Bj;4vkkR0ygA!T8(WJd3?BwrIMRi{?CH zD$nVqmn~Klp&2s2(6!z34fq6eUb6TmiB^CLn-r-^o+$<{?4=*3>?Jai1@kLzH>86R zx#A{>h%X^8&X(gZW<)I=Ae*D_&#)6TNJWgg(dSimvaKzxbCt?k%hvYwT9`g}xL}zi zUtt6JB8l83(a)c3zHE9U&>xE)?_FzRN*!$$sEDr^ITs=rMf#;&1$vqSRJ7`BpXY8= z88HhpW=iBLnTPBmpD4*lPCqdgIO_5q3KF%QC|iU*uEIfMHtB9dT8^Q6|2%0MOjSVw z2P-i>JuU}apbfdYvNfy3;4r_8LB?}`3%%H}#G()JLYb}!*zI0p{D>@Sb`t*5!0Xk_ z(OPACc4jnq%g(w@V8DY7CTxzkQ7I)GQ8cR}RC+Gil`%WYg3K5K#A{#47KT4)*XdP^ z7lTDB6qT2&ogvvPH^BQ)={jcP^^2ZDYRqLgL}0BKfC-9m;=eOjBuc)zSD&>&e=i@X zRVQr=9+4>Ndn1Q9gGp^L*OTgIEnCxYvq}XSu>bmC$q^7Eg
+Qvr6v%ShFYg*8X zkC87o^Pmc9(bI#G18)dUx}=sS36KZ9QGx9mm{HHFh*=JBA}Pl<9eh#rqDL8YH}i!6 z!q~N%G5+8J^^Cv;x1F(EriL_Dn|&bwgbK_PO~Nu!-8j5T+lmqGvPgt3n^M~+mXb6B zXBSu$mdR|WnQ0Oo92_ct>Rd)r76m3ev4Tg$O5Zg{XGTNnW3@V$9lEOFPEteCwP1|{ zqi{J`uha!EB25VW=4uI{AiAfCaZ{It?MNozaxyfOq!thQmXdGD z>bOa4vdp=*8|!Fs4N0Uzq?iQwjE};q@L#Fy?u7~ZRy?2+EU`YL+}AMJP0etd63uWVPh7IM9amjD5he>({Ti5 zyJhP3c5YtyZbMU#?{Km!D|z9;F;r11Bf7irn&a2lQ!4TYU;x$>P=HjZdf$dWcM#iibT3@g}zF;N8Q2E-7J==r=eAdwy{L!kLY24OW=af=N z!%Qo7+ak<0G%}^!oNg`%zYFT474lVvziRmkQj!^OO|xVsuXe-KS{Vm}`owEbHRn*} z>$=$5574AULiZ zhS6~-I2Fm>a^qFHwCR9IFMe~|87yY79cdL(Ce-l=z!;>0+`#J(J|+LL3TbOZQg6C| zFHdzrdxfug#DJ=<^kXxYp}S7}C;Un5&M-`4rx z5a^1~VTegD*#l_{EzK4sn5-z07gs?z+6G~%C_TPIaWiFEU{y;RN?IruJwUuN-YF&v zLV~gMFz@VyD(;#z69WaPz3TJ)nrE`_)^|(UvKy@)+dT7~^bWmA(9x+jibs9{F z1p~@z;G|^|qAeUA7)r_OZi+)Llj7~NKjxGnnR}Nr7rh4X$ zAqi}9cJ}(ZZ~=uLx`YYNZHX9F#Kp!0mN7(_`B=%sK!S>ByU@TDGE2j1hbxp0~Y&iOrjSi{vSp#^QAX3j;0$w-t-%a}<$mcM7XL8hEf(6M53}naRWW z`U%_2N<8DXCi*R@-Z&O2vZ1WHugZH(xYLaR;%V!so(>1&oK+bp?IusJ_NW7U6NZ;* z(N4jJ2%xRvI^f7`9I+3pu#1C&@P%ETvy#_{-=!%|n z8&Yu5W!X&^(+j?PI1H_H@A3C3O; zrg5(4)Sx_R=~2DkadZ8BxX;z4znHrt7Jr1_d;NQt)T1twW;(`Bi?YK_`Ry%&z*3OJ zJl!@4D6^Cnp@k&wRq%)~vDk?Co%L&j$s0khcZZ6e8mV6hAZ9R{wEl(2A%DFkl2 ze?KG@!%`I)ZQ~G?s0KHRid3px>F*guR8ZCfUne}n!rX8g-+55HQ zA`B5eI32Gi_bBS`>R}N6s%DYnXCC8S1WZ^*tRH63o0p;s^TQtUaJOu~hPfSW+DY`F zOlmn!Vf@(uu|f`PvP`iHsPIq`R3YgIBjg@HAM4va#>9n;svVd)V;K(n{lEnYMajWKxK2c?V#H%5pWg+5Gxx1SR0m__$KXm(N2!x~DX7UH5%>5u?p2cu z9tEvJaf*Z+XNh7VhSHloDEz(Ru+*M8sqsX@Cfz zayO@AsDaap4Ox{=IEBo*Q0XMhae^R=!DwAg15sr2X%MWxg9l*Imt5epj7+GdFLW6Q z0);SE@#IZVfGLk4Dg`%y%W*JTf~uK5Rm07;y>!TXb3#;yG*Pgx0-aF3IgC>mD+=Ku zBLPK@uzH^hHh_QAR4>H$dR$kXMQF%qB^26SQ^hU@6g03!xx7|f0Tt0A?%lxBSZJk8 zqkQsC0n)+LC4;BT0Mmm?20_ebd)`Er{USea;OF=F`G0*HNBrpdnSa^HX?rJoc3V!L zZztZH(~mOxYdQUBqd#|1yx+gGFC)*4^keMHz!i~xtkchm^yBQygE{?pr=J&(|B!#V zGSW}5FBiQq(oeK6137(x(I5ImJkD$D`JBsXZ|KHf$Ky}3FIRpk(ihv8(F?qT=Vwng zdNQXkF?uSef7s}`oPLVY=Pr!b|A^7qMUj50(RV#L(w7=NFc9g>{QU6$`Pq+_=%^9K=SOAV_`XIs_U}mc!~5;kB(%QWp#eX@jH@TlHCkFmz@7v=s4a-81G+)jvuw>w;?XR&>w>yNa#;NKP#cX0R0~l`YX`)9gFw7Ec+MeE0g0qBs-eWPk=s_&`*SZ zPjdaG(EsJtS@sSZtns)K`d40;W&g(35?zJu?Z_dtKL!O8ZyAo~FH=RZ);4?rIz$NvcW z^$GoP=;I0f7tkbshR+4rgV3)|=r2HTC-g(m%L)Czp>Yf3*MA-QR6>6f`Wf#oj(->W z$omWWJjV58LO&Mz&)!!YzW{pjcMJLw=+7tgWzgUGAH{KQpMSLe1~~rEKl-1JWEW?H z(CPljPv(oxe<8;sf61~ZWz*1+KOD)PlHC9u_d~{dUx$wCU-TLa`!4vESf=LlW{yYx zaU^?cc8BQj5x4r)68*a+`jgOWds+6&oO?0%`)la&*(@6h^p~N}u|C9^pTvIsdg=Pd zXyb*Co_8tqSHgPI`Ok*__~pKTp2U8<5_;?>vg{8zSI--U{^BoW*`0xY3G~;J>qnsD z=g0W+vV_+2I?&&l%(7`ji|%(=I{r53dy@P88uSB6d+vjNcHsXPpLap_N6=qS&i^#@ z%TB@rc$SS1^tsDe1Z$p|83r%dTZzsJ(wzI{ppl+mrTv3;H5xeJ*1Bz6ZVi>MVOMw64Dp zmEj<1-&0(Lu=CZvXF=bR9Di=<_=`$(twb+Czy4>qM|j>(K|eQ{|J~C0x0UF(L%$~J z&#yz@N_(V&Xg+@n`rf2{zYG1sgDl&j%j(}BLdTE#^H(MMH&7X({2yR^{*~kRCHFgz zb^Z|T)i6Ja5quJK{OEpHK!0*H%l?7ydfxL(#~eBgdDbeqO{`rq&*?j2#{iWmQpzr7w{O4QH?@#W3zN?6Nd!GXRQO5rw{-W_7 zC>_5F`hKogH+B3arQ_E_-<{0gjiuwKq0e#s9Vj}w{t&u568nEy_8RCnyb2!1{WZRC zg1#jgpSz&rN8|f}68#s@cO=h$5L)_YoX@{5o&T*8{diZA?Gd`a6otpV85!~Ky*ifT{=DneRt5WpLE`( z**x@T&?llidRgiGof7?XCHl@1{k{_Y$0hp9CHk?Y{dgI4Gg;qPl#U;Ve*Eue86w;I zH(om4guW|TU(3*cgM1kd=Wjs2{HaH>e}&d~??d0s_{aTyD|Gy5{NGxle+T-%qMtsE zV;bMzFCG6l^hXnU^(p9EllAb~()s@ged3bh`QI%azZ?_q{mFPd2l~v7;G_L|adu($435W-`upM%JzJu8 zp>Ivv^UBikpD)qxDADhO-bk+h^Tfo|^FPe-bIkuyzN&i`ZRlgWPk4D=-YBJziapg;Ff)>%0J|3Kfx#gI1N--3=G_2&r}vi=i&`V#05 zCH&!O&{N6%p938~y8cDbZ%x`?Egf%_=$lIP_t7Wbo?QPbj-UV1EZYtG>g!79zYV&V ztjD*Pj=#S||3QiVn-cvU=$A8|U%@WWemGBxOZcdNmq70Wf~4=vS2J zUntQx@sPWc{@+-;=cO zV(9lnYgna^{wQ=eS)b2?z5~2$Io$6A^v|Fld@S_80)5v}2sW^;uR;IqQkH!>tp8Kc z@uRO@{`+Y1{4>x8iGF(r4CwgLrO$_c@~v6667K(E=(`jCHU|B<lz7GASWIn!II{s+vk$Voa?C;=ry8ngH@uTanF40ra zUrGA=($evz61^iDkd!I5^?U&R)mIkw*v~;ffPO!0$1lxpFI|6ciGC&aRhRp@e7h|B zXzBPl=w5RCq0;fku^-|`{d*epvDX#*`?=5;!k>URY&?dc?}VRK16_gcCi|-feULnF z4my5x|LqdJU!va(eM@rvozMf!|4FXZ{C^&KbZc__iQM!x34J%`NBlwf%)3hW|Gg4@ z4*Is_`epb^Hp=GUa}oUJ%N$=#`u9)Jw+DP*`q*P}iQJxCf1$fb?0WV0Ina;p0hxvM zdTr@=twe7@-;vz!rqc0SO7t6{Pkk`U-W~SyUC@tZy!331*Kd^0|DPrLlO_6V&~Hkf z|DDqDC*tyXJ@(iF_t*Y-R>|JEEVzU;0BXZvi5@A@r=aiTW}idP(fwWleHY`M@lWl) z3Hr8VzupWT`J3kFwb1dS=iLK6eSguu_mz%+q(pzZL_Y-m)};SmEge74U0n7^J?~=Z zTa)#1IrLeC`RjFz{tTDSABBE--o_8x&L{WaUgs&9+#KstDx^o&c6owIUg(d zZ?$y(BJ_JWU)xUl&>Q*kKyv*u#~+V8c?ZXBKS6IL`{zGFzdfN}2OU3Z-`h&`uj>4t zM?MAq@-FC)@;t#pqqJs*LNAKm}K68)$jjYoBTmJL83B<(v| zI{v3DyJWrCc%I? zrvCjI^yiZ6Kb>5!_J65FpZ_%Q+{9kI5c&@Gx5SL@cR6(Y==wqEbIJW*R60IWqPx)V znjj{EYjwX@mX5!rM86mM3&`)ggZ}*C((wmN^w&!C_n;q2+IJd$@Kecte8SUXZ+t#~ zyhM*fzcrcPmnO%>16C4R<8c7}mE?J^EFHfyp$9ns8uX#Baemw%?@W&Ce)pH?kC*5# zCbaJNZ_uMjdw=K|te=Fw7&?A*|0|*2_>zJjTn+t}k1^-i5t^TqrSorq{>@kN46fDj z<%gKYy!q{kx&Ros8!POUM7JM1K|fyUF=q zFCC|#2`@Mxka&;~y4H2od2$H}J8co&qe}LQPj3-nN3{sO--_Z49bSxLZ(v)cJORaq z_YaEnn8D-MoVfOpPa@fJXHyCJOS~}M68SuH-jgv^IYwnVj3O?TlH}>BvBYTpO5`F= zy(o-d6#pv%R*CuxVd#Bni%EETS_G}H++)aJP0JwufRxt$AhJ@48Un$HBFih*C=O2X zlS+}bFZ#nu-)r{#odko|yx_#~t4kro`s203+2GWW{eSG*7wG#nC-ndEqxS!h{cq=R zx&D64{=dflKW_hD%m2qt==@_Rbmp-WI`h~Goq6np&OCNPXCAZ39Oo6MV=Z1#$fEES z62DWUrZqN6aZ{Z@kZaZ&U7V>*Q!-2$s>vKGJ2&|Qv3(>hkn2A?LY)=D(1{r%7E$kf zu%yB~VBTt#YJ{xz!^x9#GZQ3nQJscAS&rC#mndU@U43yheIG?k17#Ey9&}O|J>(g@KePNWP>6_BWcm4n#HU=-SEw*`lHJ zR&k4=!K?Mk=cU!+Pe)6&OY#L}?+I1}W6_JEL`q*_yjJVr#PLCL^;%tm4fPV>LF&Gh z6JQD7^Y;YCpjmbMjQ3l`4iv`Q?(43GRCgt>&*~Hv4T&`)37J&dEBQQ)PE7B~-)EOc z)+d?G_O-z!l$ar0*pr?^q@*6F2_Wr@T295o)J`RY+WToV{lr8Pa_a9f+&)buoOCqf zUD#w^ldZT>Y@r9kH|@=BmKLwjMrxb1Ej(RW8NAcbT53U_A)Go?_ac>9$xr0!EO!(# z%D?pS@jczj$B2Q#TITVk6^}4iE4=xQqK6DW31)rwqT?QeY~!N*EmoSnf~A?QtgR=Z z*2CnOEv6e^7Qrnq|IDlBvhvY6B?P-ZBUj zn>=j%$oCDjMxLBJdzDj_q&hol%T=37G4XJWd0L|4lugys^jY#?nK`xti)gFjCVtC5eoSTJSAfxQ6Nc(LS9`!_~VK_l}nMruTbxj!u`AZx^^4H$O+ieMqB-K(T8D6Ak7;kS;&C<)F zssY9-$-2>|(3pu44EYOSIy;{JG^ccIn59h-+mjlP#oSDeQCqm--9rR$gFfC?S_9T) ztBe+wfxWF*e~krPyd1mNr{N7l{q-e^I@QK+U_QL9Y@M{9;x#Yc&G16Nf^qj1_2#Zq zofWI8qXcJVBB}aV|E1c@%jp{wSVY$ILTd_4M7i)kh$Cwy#Fx}GYnIVzMLc>P%Xdzf znI0c<*Gj5DT%4|+d5Uy6GhZ7$5{AyU`y_Tzs9(2^LLdrWG4YnzANlC;2;=5ybHdEo z{!yldRDzun4`M$0_Q50Q0L$oWY)89|?0{nBs8K<_YOMG36<`X=VzF5)-7!@=!roTF z(b9}aJgK~fL`aF@>T$MLOwVR6HhZ2city5FiafW)o?0jpN!FyUPb3iO_`5A~)e+m& zlPemV?`&%|Wyk1N`F%<#VWSsWP?b5;6|M+qZ<^{8GWGplN;Wo4 z%jy@!vR*pIvhkO3D*HLpYmO*KQ+FXA%Tn2Rd%j&5_3Nk0jg0jg^Z?2QFeXtAC^4~o zuehO|FE(46(T2*)8`JLg&Y5(bkM?Jms}JR^qU9NKg&u*QMVThHnva&T2A4e{Q5B(^ zDj7>Fojx&4zIfWIP*cNR(4i_(lO?7Jkv0xzm3p;S z(<`|OF2%?EA zEa&N^ZWw>tRmfXka$;SoD>7_#MX29b-0Y|gPGMveE3Jh#fSno>qV2pynb7heA@hvt zg`~GLwS=i{OjiTmp`kwO_4Ra-aWb11o1$!XXX{Yhq{tVXS z26k9HD8hG5tHWb^KetVJafarxe+RV>Hv1H8jc(Yq8v7zUISMfjx?vx6EvgZ#B3;&6 zX6vEBXtP=u{bh#*i%o8AE7K%#9UIShL{j|42cqtXfN5{Bpdx4cdv$r|kQGrE7HYE5 z8Mi8(D3iM+9OwGqa^wwhorBg}V}13CPp!8?!@V}EJ-=z^6dFvfTf!^*#IE-x;B*rY zuZ)EGwA(MTv{{Bp-M8)Hmq!7)vImqWNNhU1t=+2|X1;5h8CJ$-$}Remtkua9KcJ?k z;ZrtU(zSc2&xQF>(nX|i#YM(`*en5!Ij#fOf`ePRdp*+!GGEy;;-{FA3WZ}gF*4Xy zHeZpWJn~}K!u4$ehs7wjF$kNGeD8xkTN@V7QcZhOwdzCR4I47IVF!AHdp;({1ARrS zHVnlKwn}fR$X`RH4PsgC2IC!2%wns3Ff839BZFOcj5{Olo4oH5lWDWW;*S>iqb&M- zgqN?M7%jGOUYj?*Bluxe%uJ95kboKUrU%^imugI=p`D_|9P?`%4%0DZ3HXm+!;(x?yl zz6glyBR>oqNAErj`fWMHJ>(D%>7utCLVqpN@i`hC@hqyzr&O$ zfw7)W`@`~XQ^}EfSbEbJtA2xByL>24ke+5k=|UNQ@59tORv_9YbEpAr(%0} zS$rL0ckd|t9H=Em8&y@k^aB|qVF|q_a4zFS%TYRH&g+j!fbG-(`ye_MrzOR@#+Pq)_3*?m-m4=o=;)wK~WT$*~kW0 z4|lkq|HjR0N8+o&QliB%ik|Cy|I*#+WrN1=2KhQjCE{$*l+Z!jhl9HvGjRvo8^Kk+ zLFJU3@=M)kp4k=g`zuyBji)SOL(rT~Pq*hUDmXWY0+J1~PtoM`H+x+*$RD-B`MZz?&Tc)oa8%U9`@0B`kCQJDN{P{ zYn-E>uM@*WxTCdA=O{Mq27U-Rw)0ePL_cdf5I$UHpO^9f_rr5Xo|$F(Q4NClTs=oW zr}_C_I8XIStVRjv>ACvRbM?8IAEor^nt^Be&-?iv@2B$=>-B1WblwO*s%K&~O&BPh zr;xyS9-&3nFFiwX^ZL=)$B)j_=XLzh9BYduA79BhC`d7U)ODTvMtG^z$JR;S>A&LFjm%>apnO{wKt3(lr zI?wiFJTu-;zmsK|-N$*iGJYDupXNvNaS=b-;~L}mIr?*4b$O(UekfM2?>qtuoAF^B Hi(mgQKA4?4 diff --git a/igd_desc_parse.h b/igd_desc_parse.h deleted file mode 100644 index 0de546b..0000000 --- a/igd_desc_parse.h +++ /dev/null @@ -1,49 +0,0 @@ -/* $Id: igd_desc_parse.h,v 1.12 2014/11/17 17:19:13 nanard Exp $ */ -/* Project : miniupnp - * http://miniupnp.free.fr/ - * Author : Thomas Bernard - * Copyright (c) 2005-2014 Thomas Bernard - * This software is subject to the conditions detailed in the - * LICENCE file provided in this distribution. - * */ -#ifndef IGD_DESC_PARSE_H_INCLUDED -#define IGD_DESC_PARSE_H_INCLUDED - -/* Structure to store the result of the parsing of UPnP - * descriptions of Internet Gateway Devices */ -#define MINIUPNPC_URL_MAXSIZE (128) -struct IGDdatas_service { - char controlurl[MINIUPNPC_URL_MAXSIZE]; - char eventsuburl[MINIUPNPC_URL_MAXSIZE]; - char scpdurl[MINIUPNPC_URL_MAXSIZE]; - char servicetype[MINIUPNPC_URL_MAXSIZE]; - /*char devicetype[MINIUPNPC_URL_MAXSIZE];*/ -}; - -struct IGDdatas { - char cureltname[MINIUPNPC_URL_MAXSIZE]; - char urlbase[MINIUPNPC_URL_MAXSIZE]; - char presentationurl[MINIUPNPC_URL_MAXSIZE]; - int level; - /*int state;*/ - /* "urn:schemas-upnp-org:service:WANCommonInterfaceConfig:1" */ - struct IGDdatas_service CIF; - /* "urn:schemas-upnp-org:service:WANIPConnection:1" - * "urn:schemas-upnp-org:service:WANPPPConnection:1" */ - struct IGDdatas_service first; - /* if both WANIPConnection and WANPPPConnection are present */ - struct IGDdatas_service second; - /* "urn:schemas-upnp-org:service:WANIPv6FirewallControl:1" */ - struct IGDdatas_service IPv6FC; - /* tmp */ - struct IGDdatas_service tmp; -}; - -void IGDstartelt(void *, const char *, int); -void IGDendelt(void *, const char *, int); -void IGDdata(void *, const char *, int); -#ifdef DEBUG -void printIGD(struct IGDdatas *); -#endif /* DEBUG */ - -#endif /* IGD_DESC_PARSE_H_INCLUDED */ diff --git a/mailapi.c b/mailapi.c index fad0897..c1f60d8 100644 --- a/mailapi.c +++ b/mailapi.c @@ -871,8 +871,9 @@ void SendBBSDataToPktMap() { char Return[4096]; char Request[64]; - char Params[50000]; - char * ptr = Params; + char * Params; + char * ptr; + int paramLen; struct MsgInfo * Msg; struct UserInfo * ourBBSRec = LookupCall(BBSName); @@ -1067,6 +1068,17 @@ int unroutableCount = 0; tm->tm_year + 1900, tm->tm_mon+1, tm->tm_mday, tm->tm_hour, tm->tm_min, tm->tm_sec); + paramLen = strlen(Peers) + strlen(MsgQueues) + strlen(Messages) + strlen(Unroutables); + + Params = malloc(paramLen + 1000); + + if (Params == 0) + { + free(Messages); + free(Unroutables); + return; + } + ptr = Params; sprintf(Request, "/api/bbsdata/%s", BBSName); @@ -1092,4 +1104,5 @@ int unroutableCount = 0; SendWebRequest("packetnodes.spots.radio", Request, Params, Return); free(Messages); free(Unroutables); + free(Params); } diff --git a/miniupnpc.h b/miniupnpc.h deleted file mode 100644 index 5a9b7c5..0000000 --- a/miniupnpc.h +++ /dev/null @@ -1,153 +0,0 @@ -/* $Id: miniupnpc.h,v 1.56 2020/12/20 18:07:35 nanard Exp $ */ -/* vim: tabstop=4 shiftwidth=4 noexpandtab - * Project: miniupnp - * http://miniupnp.free.fr/ - * Author: Thomas Bernard - * Copyright (c) 2005-2018 Thomas Bernard - * This software is subjects to the conditions detailed - * in the LICENCE file provided within this distribution */ -#ifndef MINIUPNPC_H_INCLUDED -#define MINIUPNPC_H_INCLUDED - -#include "miniupnpc_declspec.h" -#include "igd_desc_parse.h" -#include "upnpdev.h" - -/* error codes : */ -#define UPNPDISCOVER_SUCCESS (0) -#define UPNPDISCOVER_UNKNOWN_ERROR (-1) -#define UPNPDISCOVER_SOCKET_ERROR (-101) -#define UPNPDISCOVER_MEMORY_ERROR (-102) - -/* versions : */ -#define MINIUPNPC_VERSION "2.2.2" -#define MINIUPNPC_API_VERSION 17 - -/* Source port: - Using "1" as an alias for 1900 for backwards compatibility - (presuming one would have used that for the "sameport" parameter) */ -#define UPNP_LOCAL_PORT_ANY 0 -#define UPNP_LOCAL_PORT_SAME 1 - -#ifdef __cplusplus -extern "C" { -#endif - -/* Structures definitions : */ -struct UPNParg { const char * elt; const char * val; }; - -char * -simpleUPnPcommand(int, const char *, const char *, - const char *, struct UPNParg *, - int *); - -/* upnpDiscover() - * discover UPnP devices on the network. - * The discovered devices are returned as a chained list. - * It is up to the caller to free the list with freeUPNPDevlist(). - * delay (in millisecond) is the maximum time for waiting any device - * response. - * If available, device list will be obtained from MiniSSDPd. - * Default path for minissdpd socket will be used if minissdpdsock argument - * is NULL. - * If multicastif is not NULL, it will be used instead of the default - * multicast interface for sending SSDP discover packets. - * If localport is set to UPNP_LOCAL_PORT_SAME(1) SSDP packets will be sent - * from the source port 1900 (same as destination port), if set to - * UPNP_LOCAL_PORT_ANY(0) system assign a source port, any other value will - * be attempted as the source port. - * "searchalltypes" parameter is useful when searching several types, - * if 0, the discovery will stop with the first type returning results. - * TTL should default to 2. */ -MINIUPNP_LIBSPEC struct UPNPDev * -upnpDiscover(int delay, const char * multicastif, - const char * minissdpdsock, int localport, - int ipv6, unsigned char ttl, - int * error); - -MINIUPNP_LIBSPEC struct UPNPDev * -upnpDiscoverAll(int delay, const char * multicastif, - const char * minissdpdsock, int localport, - int ipv6, unsigned char ttl, - int * error); - -MINIUPNP_LIBSPEC struct UPNPDev * -upnpDiscoverDevice(const char * device, int delay, const char * multicastif, - const char * minissdpdsock, int localport, - int ipv6, unsigned char ttl, - int * error); - -MINIUPNP_LIBSPEC struct UPNPDev * -upnpDiscoverDevices(const char * const deviceTypes[], - int delay, const char * multicastif, - const char * minissdpdsock, int localport, - int ipv6, unsigned char ttl, - int * error, - int searchalltypes); - -/* parserootdesc() : - * parse root XML description of a UPnP device and fill the IGDdatas - * structure. */ -MINIUPNP_LIBSPEC void parserootdesc(const char *, int, struct IGDdatas *); - -/* structure used to get fast access to urls - * controlURL: controlURL of the WANIPConnection - * ipcondescURL: url of the description of the WANIPConnection - * controlURL_CIF: controlURL of the WANCommonInterfaceConfig - * controlURL_6FC: controlURL of the WANIPv6FirewallControl - */ -struct UPNPUrls { - char * controlURL; - char * ipcondescURL; - char * controlURL_CIF; - char * controlURL_6FC; - char * rootdescURL; -}; - -/* UPNP_GetValidIGD() : - * return values : - * 0 = NO IGD found - * 1 = A valid connected IGD has been found - * 2 = A valid IGD has been found but it reported as - * not connected - * 3 = an UPnP device has been found but was not recognized as an IGD - * - * In any non zero return case, the urls and data structures - * passed as parameters are set. Donc forget to call FreeUPNPUrls(urls) to - * free allocated memory. - */ -MINIUPNP_LIBSPEC int -UPNP_GetValidIGD(struct UPNPDev * devlist, - struct UPNPUrls * urls, - struct IGDdatas * data, - char * lanaddr, int lanaddrlen); - -/* UPNP_GetIGDFromUrl() - * Used when skipping the discovery process. - * When succeding, urls, data, and lanaddr arguments are set. - * return value : - * 0 - Not ok - * 1 - OK */ -MINIUPNP_LIBSPEC int -UPNP_GetIGDFromUrl(const char * rootdescurl, - struct UPNPUrls * urls, - struct IGDdatas * data, - char * lanaddr, int lanaddrlen); - -MINIUPNP_LIBSPEC void -GetUPNPUrls(struct UPNPUrls *, struct IGDdatas *, - const char *, unsigned int); - -MINIUPNP_LIBSPEC void -FreeUPNPUrls(struct UPNPUrls *); - -/* return 0 or 1 */ -MINIUPNP_LIBSPEC int UPNPIGD_IsConnected(struct UPNPUrls *, struct IGDdatas *); - - -#ifdef __cplusplus -} -#endif - -#endif - diff --git a/miniupnpctypes.h b/miniupnpctypes.h deleted file mode 100644 index 591c32f..0000000 --- a/miniupnpctypes.h +++ /dev/null @@ -1,19 +0,0 @@ -/* $Id: miniupnpctypes.h,v 1.2 2012/09/27 15:42:10 nanard Exp $ */ -/* Miniupnp project : http://miniupnp.free.fr/ or http://miniupnp.tuxfamily.org - * Author : Thomas Bernard - * Copyright (c) 2011 Thomas Bernard - * This software is subject to the conditions detailed in the - * LICENCE file provided within this distribution */ -#ifndef MINIUPNPCTYPES_H_INCLUDED -#define MINIUPNPCTYPES_H_INCLUDED - -#if (defined __STDC_VERSION__ && __STDC_VERSION__ >= 199901L) -#define UNSIGNED_INTEGER unsigned long long -#define STRTOUI strtoull -#else -#define UNSIGNED_INTEGER unsigned int -#define STRTOUI strtoul -#endif - -#endif - diff --git a/pcap.h b/pcap.h deleted file mode 100644 index fa67dba..0000000 --- a/pcap.h +++ /dev/null @@ -1,257 +0,0 @@ -/* -*- Mode: c; tab-width: 8; indent-tabs-mode: 1; c-basic-offset: 8; -*- */ -/* - * Copyright (c) 1993, 1994, 1995, 1996, 1997 - * The Regents of the University of California. All rights reserved. - * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * 1. Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * 2. Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. - * 3. All advertising materials mentioning features or use of this software - * must display the following acknowledgement: - * This product includes software developed by the Computer Systems - * Engineering Group at Lawrence Berkeley Laboratory. - * 4. Neither the name of the University nor of the Laboratory may be used - * to endorse or promote products derived from this software without - * specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND - * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE - * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL - * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS - * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) - * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT - * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY - * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF - * SUCH DAMAGE. - * - * @(#) $Header: /tcpdump/master/libpcap/pcap.h,v 1.45.2.3 2003/11/21 10:20:50 guy Exp $ (LBL) - */ - -#ifndef lib_pcap_h -#define lib_pcap_h - -#ifdef WIN32 -//#include "pcap-stdinc.h" -#else /* WIN32 */ -#include -#include -#endif /* WIN32 */ - -#ifndef PCAP_DONT_INCLUDE_PCAP_BPF_H -#include "pcap-bpf.h" -#endif - -#include - -#ifdef __cplusplus -extern "C" { -#endif - -#define PCAP_VERSION_MAJOR 2 -#define PCAP_VERSION_MINOR 4 - -#define PCAP_ERRBUF_SIZE 256 - -/* - * Compatibility for systems that have a bpf.h that - * predates the bpf typedefs for 64-bit support. - */ -#if BPF_RELEASE - 0 < 199406 -typedef int bpf_int32; -typedef u_int bpf_u_int32; -#endif - -typedef struct pcap pcap_t; -typedef struct pcap_dumper pcap_dumper_t; -typedef struct pcap_if pcap_if_t; -typedef struct pcap_addr pcap_addr_t; - -/* - * The first record in the file contains saved values for some - * of the flags used in the printout phases of tcpdump. - * Many fields here are 32 bit ints so compilers won't insert unwanted - * padding; these files need to be interchangeable across architectures. - * - * Do not change the layout of this structure, in any way (this includes - * changes that only affect the length of fields in this structure). - * - * Also, do not change the interpretation of any of the members of this - * structure, in any way (this includes using values other than - * LINKTYPE_ values, as defined in "savefile.c", in the "linktype" - * field). - * - * Instead: - * - * introduce a new structure for the new format, if the layout - * of the structure changed; - * - * send mail to "tcpdump-workers@tcpdump.org", requesting a new - * magic number for your new capture file format, and, when - * you get the new magic number, put it in "savefile.c"; - * - * use that magic number for save files with the changed file - * header; - * - * make the code in "savefile.c" capable of reading files with - * the old file header as well as files with the new file header - * (using the magic number to determine the header format). - * - * Then supply the changes to "patches@tcpdump.org", so that future - * versions of libpcap and programs that use it (such as tcpdump) will - * be able to read your new capture file format. - */ -struct pcap_file_header { - bpf_u_int32 magic; - u_short version_major; - u_short version_minor; - bpf_int32 thiszone; /* gmt to local correction */ - bpf_u_int32 sigfigs; /* accuracy of timestamps */ - bpf_u_int32 snaplen; /* max length saved portion of each pkt */ - bpf_u_int32 linktype; /* data link type (LINKTYPE_*) */ -}; - -/* - * Each packet in the dump file is prepended with this generic header. - * This gets around the problem of different headers for different - * packet interfaces. - */ -struct pcap_pkthdr { - struct timeval ts; /* time stamp */ - bpf_u_int32 caplen; /* length of portion present */ - bpf_u_int32 len; /* length this packet (off wire) */ -}; - -/* - * As returned by the pcap_stats() - */ -struct pcap_stat { - u_int ps_recv; /* number of packets received */ - u_int ps_drop; /* number of packets dropped */ - u_int ps_ifdrop; /* drops by interface XXX not yet supported */ -#ifdef WIN32 - u_int bs_capt; /* number of packets that reach the application */ -#endif /* WIN32 */ -}; - -/* - * Item in a list of interfaces. - */ -struct pcap_if { - struct pcap_if *next; - char *name; /* name to hand to "pcap_open_live()" */ - char *description; /* textual description of interface, or NULL */ - struct pcap_addr *addresses; - bpf_u_int32 flags; /* PCAP_IF_ interface flags */ -}; - -#define PCAP_IF_LOOPBACK 0x00000001 /* interface is loopback */ - -/* - * Representation of an interface address. - */ -struct pcap_addr { - struct pcap_addr *next; - struct sockaddr *addr; /* address */ - struct sockaddr *netmask; /* netmask for that address */ - struct sockaddr *broadaddr; /* broadcast address for that address */ - struct sockaddr *dstaddr; /* P2P destination address for that address */ -}; - -typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *, - const u_char *); - -char *pcap_lookupdev(char *); -int pcap_lookupnet(const char *, bpf_u_int32 *, bpf_u_int32 *, char *); -pcap_t *pcap_open_live(const char *, int, int, int, char *); -pcap_t *pcap_open_dead(int, int); -pcap_t *pcap_open_offline(const char *, char *); -void pcap_close(pcap_t *); -int pcap_loop(pcap_t *, int, pcap_handler, u_char *); -int pcap_dispatch(pcap_t *, int, pcap_handler, u_char *); -const u_char* - pcap_next(pcap_t *, struct pcap_pkthdr *); -int pcap_next_ex(pcap_t *, struct pcap_pkthdr **, const u_char **); -void pcap_breakloop(pcap_t *); -int pcap_stats(pcap_t *, struct pcap_stat *); -int pcap_setfilter(pcap_t *, struct bpf_program *); -int pcap_getnonblock(pcap_t *, char *); -int pcap_setnonblock(pcap_t *, int, char *); -void pcap_perror(pcap_t *, char *); -char *pcap_strerror(int); -char *pcap_geterr(pcap_t *); -int pcap_compile(pcap_t *, struct bpf_program *, char *, int, - bpf_u_int32); -int pcap_compile_nopcap(int, int, struct bpf_program *, - char *, int, bpf_u_int32); -void pcap_freecode(struct bpf_program *); -int pcap_datalink(pcap_t *); -int pcap_list_datalinks(pcap_t *, int **); -int pcap_set_datalink(pcap_t *, int); -int pcap_datalink_name_to_val(const char *); -const char *pcap_datalink_val_to_name(int); -const char *pcap_datalink_val_to_description(int); -int pcap_snapshot(pcap_t *); -int pcap_is_swapped(pcap_t *); -int pcap_major_version(pcap_t *); -int pcap_minor_version(pcap_t *); - -/* XXX */ -FILE *pcap_file(pcap_t *); -int pcap_fileno(pcap_t *); - -pcap_dumper_t *pcap_dump_open(pcap_t *, const char *); -int pcap_dump_flush(pcap_dumper_t *); -void pcap_dump_close(pcap_dumper_t *); -void pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *); -FILE *pcap_dump_file(pcap_dumper_t *); - -int pcap_findalldevs(pcap_if_t **, char *); -void pcap_freealldevs(pcap_if_t *); - -const char *pcap_lib_version(void); - -/* XXX this guy lives in the bpf tree */ -u_int bpf_filter(struct bpf_insn *, u_char *, u_int, u_int); -int bpf_validate(struct bpf_insn *f, int len); -char *bpf_image(struct bpf_insn *, int); -void bpf_dump(struct bpf_program *, int); - -#ifdef WIN32 -/* - * Win32 definitions - */ - -int pcap_setbuff(pcap_t *p, int dim); -int pcap_setmode(pcap_t *p, int mode); -int pcap_sendpacket(pcap_t *p, u_char *buf, int size); -int pcap_setmintocopy(pcap_t *p, int size); - -#ifdef WPCAP -/* Include file with the wpcap-specific extensions */ -#include -#endif - -#define MODE_CAPT 0 -#define MODE_STAT 1 - -#else -/* - * UN*X definitions - */ - -int pcap_get_selectable_fd(pcap_t *); - -#endif /* WIN32 */ - -#ifdef __cplusplus -} -#endif - -#endif diff --git a/upnpcommands.h b/upnpcommands.h deleted file mode 100644 index 994104e..0000000 --- a/upnpcommands.h +++ /dev/null @@ -1,348 +0,0 @@ -/* $Id: upnpcommands.h,v 1.33 2019/02/10 12:29:25 nanard Exp $ */ -/* Miniupnp project : http://miniupnp.free.fr/ - * Author : Thomas Bernard - * Copyright (c) 2005-2018 Thomas Bernard - * This software is subject to the conditions detailed in the - * LICENCE file provided within this distribution */ -#ifndef UPNPCOMMANDS_H_INCLUDED -#define UPNPCOMMANDS_H_INCLUDED - -#include "miniupnpc_declspec.h" -#include "miniupnpctypes.h" - -/* MiniUPnPc return codes : */ -#define UPNPCOMMAND_SUCCESS (0) -#define UPNPCOMMAND_UNKNOWN_ERROR (-1) -#define UPNPCOMMAND_INVALID_ARGS (-2) -#define UPNPCOMMAND_HTTP_ERROR (-3) -#define UPNPCOMMAND_INVALID_RESPONSE (-4) -#define UPNPCOMMAND_MEM_ALLOC_ERROR (-5) - -#ifdef __cplusplus -extern "C" { -#endif - -struct PortMappingParserData; - -MINIUPNP_LIBSPEC UNSIGNED_INTEGER -UPNP_GetTotalBytesSent(const char * controlURL, - const char * servicetype); - -MINIUPNP_LIBSPEC UNSIGNED_INTEGER -UPNP_GetTotalBytesReceived(const char * controlURL, - const char * servicetype); - -MINIUPNP_LIBSPEC UNSIGNED_INTEGER -UPNP_GetTotalPacketsSent(const char * controlURL, - const char * servicetype); - -MINIUPNP_LIBSPEC UNSIGNED_INTEGER -UPNP_GetTotalPacketsReceived(const char * controlURL, - const char * servicetype); - -/* UPNP_GetStatusInfo() - * status and lastconnerror are 64 byte buffers - * Return values : - * UPNPCOMMAND_SUCCESS, UPNPCOMMAND_INVALID_ARGS, UPNPCOMMAND_UNKNOWN_ERROR - * or a UPnP Error code */ -MINIUPNP_LIBSPEC int -UPNP_GetStatusInfo(const char * controlURL, - const char * servicetype, - char * status, - unsigned int * uptime, - char * lastconnerror); - -/* UPNP_GetConnectionTypeInfo() - * argument connectionType is a 64 character buffer - * Return Values : - * UPNPCOMMAND_SUCCESS, UPNPCOMMAND_INVALID_ARGS, UPNPCOMMAND_UNKNOWN_ERROR - * or a UPnP Error code */ -MINIUPNP_LIBSPEC int -UPNP_GetConnectionTypeInfo(const char * controlURL, - const char * servicetype, - char * connectionType); - -/* UPNP_GetExternalIPAddress() call the corresponding UPNP method. - * if the third arg is not null the value is copied to it. - * at least 16 bytes must be available - * - * Return values : - * 0 : SUCCESS - * NON ZERO : ERROR Either an UPnP error code or an unknown error. - * - * possible UPnP Errors : - * 402 Invalid Args - See UPnP Device Architecture section on Control. - * 501 Action Failed - See UPnP Device Architecture section on Control. */ -MINIUPNP_LIBSPEC int -UPNP_GetExternalIPAddress(const char * controlURL, - const char * servicetype, - char * extIpAdd); - -/* UPNP_GetLinkLayerMaxBitRates() - * call WANCommonInterfaceConfig:1#GetCommonLinkProperties - * - * return values : - * UPNPCOMMAND_SUCCESS, UPNPCOMMAND_INVALID_ARGS, UPNPCOMMAND_UNKNOWN_ERROR - * or a UPnP Error Code. */ -MINIUPNP_LIBSPEC int -UPNP_GetLinkLayerMaxBitRates(const char* controlURL, - const char* servicetype, - unsigned int * bitrateDown, - unsigned int * bitrateUp); - -/* UPNP_AddPortMapping() - * if desc is NULL, it will be defaulted to "libminiupnpc" - * remoteHost is usually NULL because IGD don't support it. - * - * Return values : - * 0 : SUCCESS - * NON ZERO : ERROR. Either an UPnP error code or an unknown error. - * - * List of possible UPnP errors for AddPortMapping : - * errorCode errorDescription (short) - Description (long) - * 402 Invalid Args - See UPnP Device Architecture section on Control. - * 501 Action Failed - See UPnP Device Architecture section on Control. - * 606 Action not authorized - The action requested REQUIRES authorization and - * the sender was not authorized. - * 715 WildCardNotPermittedInSrcIP - The source IP address cannot be - * wild-carded - * 716 WildCardNotPermittedInExtPort - The external port cannot be wild-carded - * 718 ConflictInMappingEntry - The port mapping entry specified conflicts - * with a mapping assigned previously to another client - * 724 SamePortValuesRequired - Internal and External port values - * must be the same - * 725 OnlyPermanentLeasesSupported - The NAT implementation only supports - * permanent lease times on port mappings - * 726 RemoteHostOnlySupportsWildcard - RemoteHost must be a wildcard - * and cannot be a specific IP address or DNS name - * 727 ExternalPortOnlySupportsWildcard - ExternalPort must be a wildcard and - * cannot be a specific port value - * 728 NoPortMapsAvailable - There are not enough free ports available to - * complete port mapping. - * 729 ConflictWithOtherMechanisms - Attempted port mapping is not allowed - * due to conflict with other mechanisms. - * 732 WildCardNotPermittedInIntPort - The internal port cannot be wild-carded - */ -MINIUPNP_LIBSPEC int -UPNP_AddPortMapping(const char * controlURL, const char * servicetype, - const char * extPort, - const char * inPort, - const char * inClient, - const char * desc, - const char * proto, - const char * remoteHost, - const char * leaseDuration); - -/* UPNP_AddAnyPortMapping() - * if desc is NULL, it will be defaulted to "libminiupnpc" - * remoteHost is usually NULL because IGD don't support it. - * - * Return values : - * 0 : SUCCESS - * NON ZERO : ERROR. Either an UPnP error code or an unknown error. - * - * List of possible UPnP errors for AddPortMapping : - * errorCode errorDescription (short) - Description (long) - * 402 Invalid Args - See UPnP Device Architecture section on Control. - * 501 Action Failed - See UPnP Device Architecture section on Control. - * 606 Action not authorized - The action requested REQUIRES authorization and - * the sender was not authorized. - * 715 WildCardNotPermittedInSrcIP - The source IP address cannot be - * wild-carded - * 716 WildCardNotPermittedInExtPort - The external port cannot be wild-carded - * 728 NoPortMapsAvailable - There are not enough free ports available to - * complete port mapping. - * 729 ConflictWithOtherMechanisms - Attempted port mapping is not allowed - * due to conflict with other mechanisms. - * 732 WildCardNotPermittedInIntPort - The internal port cannot be wild-carded - */ -MINIUPNP_LIBSPEC int -UPNP_AddAnyPortMapping(const char * controlURL, const char * servicetype, - const char * extPort, - const char * inPort, - const char * inClient, - const char * desc, - const char * proto, - const char * remoteHost, - const char * leaseDuration, - char * reservedPort); - -/* UPNP_DeletePortMapping() - * Use same argument values as what was used for AddPortMapping(). - * remoteHost is usually NULL because IGD don't support it. - * Return Values : - * 0 : SUCCESS - * NON ZERO : error. Either an UPnP error code or an undefined error. - * - * List of possible UPnP errors for DeletePortMapping : - * 402 Invalid Args - See UPnP Device Architecture section on Control. - * 606 Action not authorized - The action requested REQUIRES authorization - * and the sender was not authorized. - * 714 NoSuchEntryInArray - The specified value does not exist in the array */ -MINIUPNP_LIBSPEC int -UPNP_DeletePortMapping(const char * controlURL, const char * servicetype, - const char * extPort, const char * proto, - const char * remoteHost); - -/* UPNP_DeletePortRangeMapping() - * Use same argument values as what was used for AddPortMapping(). - * remoteHost is usually NULL because IGD don't support it. - * Return Values : - * 0 : SUCCESS - * NON ZERO : error. Either an UPnP error code or an undefined error. - * - * List of possible UPnP errors for DeletePortMapping : - * 606 Action not authorized - The action requested REQUIRES authorization - * and the sender was not authorized. - * 730 PortMappingNotFound - This error message is returned if no port - * mapping is found in the specified range. - * 733 InconsistentParameters - NewStartPort and NewEndPort values are not consistent. */ -MINIUPNP_LIBSPEC int -UPNP_DeletePortMappingRange(const char * controlURL, const char * servicetype, - const char * extPortStart, const char * extPortEnd, - const char * proto, - const char * manage); - -/* UPNP_GetPortMappingNumberOfEntries() - * not supported by all routers */ -MINIUPNP_LIBSPEC int -UPNP_GetPortMappingNumberOfEntries(const char * controlURL, - const char * servicetype, - unsigned int * numEntries); - -/* UPNP_GetSpecificPortMappingEntry() - * retrieves an existing port mapping - * params : - * in extPort - * in proto - * in remoteHost - * out intClient (16 bytes) - * out intPort (6 bytes) - * out desc (80 bytes) - * out enabled (4 bytes) - * out leaseDuration (16 bytes) - * - * return value : - * UPNPCOMMAND_SUCCESS, UPNPCOMMAND_INVALID_ARGS, UPNPCOMMAND_UNKNOWN_ERROR - * or a UPnP Error Code. - * - * List of possible UPnP errors for _GetSpecificPortMappingEntry : - * 402 Invalid Args - See UPnP Device Architecture section on Control. - * 501 Action Failed - See UPnP Device Architecture section on Control. - * 606 Action not authorized - The action requested REQUIRES authorization - * and the sender was not authorized. - * 714 NoSuchEntryInArray - The specified value does not exist in the array. - */ -MINIUPNP_LIBSPEC int -UPNP_GetSpecificPortMappingEntry(const char * controlURL, - const char * servicetype, - const char * extPort, - const char * proto, - const char * remoteHost, - char * intClient, - char * intPort, - char * desc, - char * enabled, - char * leaseDuration); - -/* UPNP_GetGenericPortMappingEntry() - * params : - * in index - * out extPort (6 bytes) - * out intClient (16 bytes) - * out intPort (6 bytes) - * out protocol (4 bytes) - * out desc (80 bytes) - * out enabled (4 bytes) - * out rHost (64 bytes) - * out duration (16 bytes) - * - * return value : - * UPNPCOMMAND_SUCCESS, UPNPCOMMAND_INVALID_ARGS, UPNPCOMMAND_UNKNOWN_ERROR - * or a UPnP Error Code. - * - * Possible UPNP Error codes : - * 402 Invalid Args - See UPnP Device Architecture section on Control. - * 606 Action not authorized - The action requested REQUIRES authorization - * and the sender was not authorized. - * 713 SpecifiedArrayIndexInvalid - The specified array index is out of bounds - */ -MINIUPNP_LIBSPEC int -UPNP_GetGenericPortMappingEntry(const char * controlURL, - const char * servicetype, - const char * index, - char * extPort, - char * intClient, - char * intPort, - char * protocol, - char * desc, - char * enabled, - char * rHost, - char * duration); - -/* UPNP_GetListOfPortMappings() Available in IGD v2 - * - * - * Possible UPNP Error codes : - * 606 Action not Authorized - * 730 PortMappingNotFound - no port mapping is found in the specified range. - * 733 InconsistantParameters - NewStartPort and NewEndPort values are not - * consistent. - */ -MINIUPNP_LIBSPEC int -UPNP_GetListOfPortMappings(const char * controlURL, - const char * servicetype, - const char * startPort, - const char * endPort, - const char * protocol, - const char * numberOfPorts, - struct PortMappingParserData * data); - -/* IGD:2, functions for service WANIPv6FirewallControl:1 */ -MINIUPNP_LIBSPEC int -UPNP_GetFirewallStatus(const char * controlURL, - const char * servicetype, - int * firewallEnabled, - int * inboundPinholeAllowed); - -MINIUPNP_LIBSPEC int -UPNP_GetOutboundPinholeTimeout(const char * controlURL, const char * servicetype, - const char * remoteHost, - const char * remotePort, - const char * intClient, - const char * intPort, - const char * proto, - int * opTimeout); - -MINIUPNP_LIBSPEC int -UPNP_AddPinhole(const char * controlURL, const char * servicetype, - const char * remoteHost, - const char * remotePort, - const char * intClient, - const char * intPort, - const char * proto, - const char * leaseTime, - char * uniqueID); - -MINIUPNP_LIBSPEC int -UPNP_UpdatePinhole(const char * controlURL, const char * servicetype, - const char * uniqueID, - const char * leaseTime); - -MINIUPNP_LIBSPEC int -UPNP_DeletePinhole(const char * controlURL, const char * servicetype, const char * uniqueID); - -MINIUPNP_LIBSPEC int -UPNP_CheckPinholeWorking(const char * controlURL, const char * servicetype, - const char * uniqueID, int * isWorking); - -MINIUPNP_LIBSPEC int -UPNP_GetPinholePackets(const char * controlURL, const char * servicetype, - const char * uniqueID, int * packets); - -#ifdef __cplusplus -} -#endif - -#endif - diff --git a/upnpdev.h b/upnpdev.h deleted file mode 100644 index 9b2cb43..0000000 --- a/upnpdev.h +++ /dev/null @@ -1,44 +0,0 @@ -/* $Id: upnpdev.h,v 1.3 2020/05/29 15:57:42 nanard Exp $ */ -/* Project : miniupnp - * Web : http://miniupnp.free.fr/ or https://miniupnp.tuxfamily.org/ - * Author : Thomas BERNARD - * copyright (c) 2005-2020 Thomas Bernard - * This software is subjet to the conditions detailed in the - * provided LICENSE file. */ -#ifndef UPNPDEV_H_INCLUDED -#define UPNPDEV_H_INCLUDED - -#include "miniupnpc_declspec.h" - -#ifdef __cplusplus -extern "C" { -#endif - -struct UPNPDev { - struct UPNPDev * pNext; - char * descURL; - char * st; - char * usn; - unsigned int scope_id; -#if defined(__STDC_VERSION) && __STDC_VERSION__ >= 199901L - /* C99 flexible array member */ - char buffer[]; -#elif defined(__GNUC__) - char buffer[0]; -#else - /* Fallback to a hack */ - char buffer[1]; -#endif -}; - -/* freeUPNPDevlist() - * free list returned by upnpDiscover() */ -MINIUPNP_LIBSPEC void freeUPNPDevlist(struct UPNPDev * devlist); - - -#ifdef __cplusplus -} -#endif - - -#endif /* UPNPDEV_H_INCLUDED */ diff --git a/upnperrors.h b/upnperrors.h deleted file mode 100644 index 3115aee..0000000 --- a/upnperrors.h +++ /dev/null @@ -1,26 +0,0 @@ -/* $Id: upnperrors.h,v 1.6 2015/07/21 13:16:55 nanard Exp $ */ -/* (c) 2007-2015 Thomas Bernard - * All rights reserved. - * MiniUPnP Project. - * http://miniupnp.free.fr/ or http://miniupnp.tuxfamily.org/ - * This software is subjet to the conditions detailed in the - * provided LICENCE file. */ -#ifndef UPNPERRORS_H_INCLUDED -#define UPNPERRORS_H_INCLUDED - -#include "miniupnpc_declspec.h" - -#ifdef __cplusplus -extern "C" { -#endif - -/* strupnperror() - * Return a string description of the UPnP error code - * or NULL for undefinded errors */ -MINIUPNP_LIBSPEC const char * strupnperror(int err); - -#ifdef __cplusplus -} -#endif - -#endif diff --git a/zconf.h b/zconf.h deleted file mode 100644 index a359cd1..0000000 --- a/zconf.h +++ /dev/null @@ -1,333 +0,0 @@ -/* zconf.h -- configuration of the zlib compression library - * Copyright (C) 1995-2005 Jean-loup Gailly. - * For conditions of distribution and use, see copyright notice in zlib.h - */ - -/* @(#) $Id$ */ - -#ifndef ZCONF_H -#define ZCONF_H - -/* - * If you *really* need a unique prefix for all types and library functions, - * compile with -DZ_PREFIX. The "standard" zlib should be compiled without it. - */ -#ifdef Z_PREFIX -# define deflateInit_ z_deflateInit_ -# define deflate z_deflate -# define deflateEnd z_deflateEnd -# define inflateInit_ z_inflateInit_ -# define inflate z_inflate -# define inflateEnd z_inflateEnd -# define deflateInit2_ z_deflateInit2_ -# define deflateSetDictionary z_deflateSetDictionary -# define deflateCopy z_deflateCopy -# define deflateReset z_deflateReset -# define deflateParams z_deflateParams -# define deflateBound z_deflateBound -# define deflatePrime z_deflatePrime -# define inflateInit2_ z_inflateInit2_ -# define inflateSetDictionary z_inflateSetDictionary -# define inflateSync z_inflateSync -# define inflateSyncPoint z_inflateSyncPoint -# define inflateCopy z_inflateCopy -# define inflateReset z_inflateReset -# define inflateBack z_inflateBack -# define inflateBackEnd z_inflateBackEnd -# define compress z_compress -# define compress2 z_compress2 -# define compressBound z_compressBound -# define uncompress z_uncompress -# define adler32 z_adler32 -# define crc32 z_crc32 -# define get_crc_table z_get_crc_table -# define zError z_zError - -# define alloc_func z_alloc_func -# define free_func z_free_func -# define in_func z_in_func -# define out_func z_out_func -# define Byte z_Byte -# define uInt z_uInt -# define uLong z_uLong -# define Bytef z_Bytef -# define charf z_charf -# define intf z_intf -# define uIntf z_uIntf -# define uLongf z_uLongf -# define voidpf z_voidpf -# define voidp z_voidp -#endif - -#if defined(__MSDOS__) && !defined(MSDOS) -# define MSDOS -#endif -#if (defined(OS_2) || defined(__OS2__)) && !defined(OS2) -# define OS2 -#endif -#if defined(_WINDOWS) && !defined(WINDOWS) -# define WINDOWS -#endif -#if defined(_WIN32) || defined(_WIN32_WCE) || defined(__WIN32__) -# ifndef WIN32 -# define WIN32 -# endif -#endif -#if (defined(MSDOS) || defined(OS2) || defined(WINDOWS)) && !defined(WIN32) -# if !defined(__GNUC__) && !defined(__FLAT__) && !defined(__386__) -# ifndef SYS16BIT -# define SYS16BIT -# endif -# endif -#endif - -/* - * Compile with -DMAXSEG_64K if the alloc function cannot allocate more - * than 64k bytes at a time (needed on systems with 16-bit int). - */ -#ifdef SYS16BIT -# define MAXSEG_64K -#endif -#ifdef MSDOS -# define UNALIGNED_OK -#endif - -#ifdef __STDC_VERSION__ -# ifndef STDC -# define STDC -# endif -# if __STDC_VERSION__ >= 199901L -# ifndef STDC99 -# define STDC99 -# endif -# endif -#endif -#if !defined(STDC) && (defined(__STDC__) || defined(__cplusplus)) -# define STDC -#endif -#if !defined(STDC) && (defined(__GNUC__) || defined(__BORLANDC__)) -# define STDC -#endif -#if !defined(STDC) && (defined(MSDOS) || defined(WINDOWS) || defined(WIN32)) -# define STDC -#endif -#if !defined(STDC) && (defined(OS2) || defined(__HOS_AIX__)) -# define STDC -#endif - -#if defined(__OS400__) && !defined(STDC) /* iSeries (formerly AS/400). */ -# define STDC -#endif - -#ifndef STDC -# ifndef const /* cannot use !defined(STDC) && !defined(const) on Mac */ -# define const /* note: need a more gentle solution here */ -# endif -#endif - -/* Some Mac compilers merge all .h files incorrectly: */ -#if defined(__MWERKS__)||defined(applec)||defined(THINK_C)||defined(__SC__) -# define NO_DUMMY_DECL -#endif - -/* Maximum value for memLevel in deflateInit2 */ -#ifndef MAX_MEM_LEVEL -# ifdef MAXSEG_64K -# define MAX_MEM_LEVEL 8 -# else -# define MAX_MEM_LEVEL 9 -# endif -#endif - -/* Maximum value for windowBits in deflateInit2 and inflateInit2. - * WARNING: reducing MAX_WBITS makes minigzip unable to extract .gz files - * created by gzip. (Files created by minigzip can still be extracted by - * gzip.) - */ -#ifndef MAX_WBITS -# define MAX_WBITS 15 /* 32K LZ77 window */ -#endif - -/* The memory requirements for deflate are (in bytes): - (1 << (windowBits+2)) + (1 << (memLevel+9)) - that is: 128K for windowBits=15 + 128K for memLevel = 8 (default values) - plus a few kilobytes for small objects. For example, if you want to reduce - the default memory requirements from 256K to 128K, compile with - make CFLAGS="-O -DMAX_WBITS=14 -DMAX_MEM_LEVEL=7" - Of course this will generally degrade compression (there's no free lunch). - - The memory requirements for inflate are (in bytes) 1 << windowBits - that is, 32K for windowBits=15 (default value) plus a few kilobytes - for small objects. -*/ - - /* Type declarations */ - -#ifndef OF /* function prototypes */ -# ifdef STDC -# define OF(args) args -# else -# define OF(args) () -# endif -#endif - -/* The following definitions for FAR are needed only for MSDOS mixed - * model programming (small or medium model with some far allocations). - * This was tested only with MSC; for other MSDOS compilers you may have - * to define NO_MEMCPY in zutil.h. If you don't need the mixed model, - * just define FAR to be empty. - */ -#ifdef SYS16BIT -# if defined(M_I86SM) || defined(M_I86MM) - /* MSC small or medium model */ -# define SMALL_MEDIUM -# ifdef _MSC_VER -# define FAR _far -# else -# define FAR far -# endif -# endif -# if (defined(__SMALL__) || defined(__MEDIUM__)) - /* Turbo C small or medium model */ -# define SMALL_MEDIUM -# ifdef __BORLANDC__ -# define FAR _far -# else -# define FAR far -# endif -# endif -#endif - -#if defined(WINDOWS) || defined(WIN32) - /* If building or using zlib as a DLL, define ZLIB_DLL. - * This is not mandatory, but it offers a little performance increase. - */ -# ifdef ZLIB_DLL -# if defined(WIN32) && (!defined(__BORLANDC__) || (__BORLANDC__ >= 0x500)) -# ifdef ZLIB_INTERNAL -# define ZEXTERN extern __declspec(dllexport) -# else -# define ZEXTERN extern __declspec(dllimport) -# endif -# endif -# endif /* ZLIB_DLL */ - /* If building or using zlib with the WINAPI/WINAPIV calling convention, - * define ZLIB_WINAPI. - * Caution: the standard ZLIB1.DLL is NOT compiled using ZLIB_WINAPI. - */ -# ifdef ZLIB_WINAPI -# ifdef FAR -# undef FAR -# endif -# include - /* No need for _export, use ZLIB.DEF instead. */ - /* For complete Windows compatibility, use WINAPI, not __stdcall. */ -# define ZEXPORT WINAPI -# ifdef WIN32 -# define ZEXPORTVA WINAPIV -# else -# define ZEXPORTVA FAR CDECL -# endif -# endif -#endif - - -#if defined (__BEOS__) -# ifdef ZLIB_DLL -# ifdef ZLIB_INTERNAL -# define ZEXPORT __declspec(dllexport) -# define ZEXPORTVA __declspec(dllexport) -# else -# define ZEXPORT __declspec(dllimport) -# define ZEXPORTVA __declspec(dllimport) -# endif -# endif -#endif - -#ifndef ZEXTERN -# define ZEXTERN extern -#endif -#ifndef ZEXPORT -# define ZEXPORT -#endif -#ifndef ZEXPORTVA -# define ZEXPORTVA -#endif - -#ifndef FAR -# define FAR -#endif - -#if !defined(__MACTYPES__) -typedef unsigned char Byte; /* 8 bits */ -#endif -typedef unsigned int uInt; /* 16 bits or more */ -typedef unsigned long uLong; /* 32 bits or more */ - -#ifdef SMALL_MEDIUM - /* Borland C/C++ and some old MSC versions ignore FAR inside typedef */ -# define Bytef Byte FAR -#else - typedef Byte FAR Bytef; -#endif -typedef char FAR charf; -typedef int FAR intf; -typedef uInt FAR uIntf; -typedef uLong FAR uLongf; - -#ifdef STDC - typedef void const *voidpc; - typedef void FAR *voidpf; - typedef void *voidp; -#else - typedef Byte const *voidpc; - typedef Byte FAR *voidpf; - typedef Byte *voidp; -#endif - -#if 0 /* HAVE_UNISTD_H -- this line is updated by ./configure */ -# include /* for off_t */ -# include /* for SEEK_* and off_t */ -# ifdef VMS -# include /* for off_t */ -# endif -# define z_off_t off_t -#endif -#ifndef SEEK_SET -# define SEEK_SET 0 /* Seek from beginning of file. */ -# define SEEK_CUR 1 /* Seek from current position. */ -# define SEEK_END 2 /* Set file pointer to EOF plus "offset" */ -#endif -#ifndef z_off_t -# define z_off_t long -#endif - -#if defined(__OS400__) -# define NO_vsnprintf -#endif - -#if defined(__MVS__) -# define NO_vsnprintf -# ifdef FAR -# undef FAR -# endif -#endif - -/* MVS linker does not support external names larger than 8 bytes */ -#if defined(__MVS__) -# pragma map(deflateInit_,"DEIN") -# pragma map(deflateInit2_,"DEIN2") -# pragma map(deflateEnd,"DEEND") -# pragma map(deflateBound,"DEBND") -# pragma map(inflateInit_,"ININ") -# pragma map(inflateInit2_,"ININ2") -# pragma map(inflateEnd,"INEND") -# pragma map(inflateSync,"INSY") -# pragma map(inflateSetDictionary,"INSEDI") -# pragma map(compressBound,"CMBND") -# pragma map(inflate_table,"INTABL") -# pragma map(inflate_fast,"INFA") -# pragma map(inflate_copyright,"INCOPY") -#endif - -#endif /* ZCONF_H */ diff --git a/zlib.h b/zlib.h deleted file mode 100644 index 10eb981..0000000 --- a/zlib.h +++ /dev/null @@ -1,1358 +0,0 @@ -/* zlib.h -- interface of the 'zlib' general purpose compression library - version 1.2.3, July 18th, 2005 - - Copyright (C) 1995-2005 Jean-loup Gailly and Mark Adler - - This software is provided 'as-is', without any express or implied - warranty. In no event will the authors be held liable for any damages - arising from the use of this software. - - Permission is granted to anyone to use this software for any purpose, - including commercial applications, and to alter it and redistribute it - freely, subject to the following restrictions: - - 1. The origin of this software must not be misrepresented; you must not - claim that you wrote the original software. If you use this software - in a product, an acknowledgment in the product documentation would be - appreciated but is not required. - 2. Altered source versions must be plainly marked as such, and must not be - misrepresented as being the original software. - 3. This notice may not be removed or altered from any source distribution. - - Jean-loup Gailly Mark Adler - jloup@gzip.org madler@alumni.caltech.edu - - - The data format used by the zlib library is described by RFCs (Request for - Comments) 1950 to 1952 in the files http://www.ietf.org/rfc/rfc1950.txt - (zlib format), rfc1951.txt (deflate format) and rfc1952.txt (gzip format). -*/ - -#ifndef ZLIB_H -#define ZLIB_H - -#include "zconf.h" - -#ifdef __cplusplus -extern "C" { -#endif - -#define ZLIB_VERSION "1.2.3" -#define ZLIB_VERNUM 0x1230 - -/* - The 'zlib' compression library provides in-memory compression and - decompression functions, including integrity checks of the uncompressed - data. This version of the library supports only one compression method - (deflation) but other algorithms will be added later and will have the same - stream interface. - - Compression can be done in a single step if the buffers are large - enough (for example if an input file is mmap'ed), or can be done by - repeated calls of the compression function. In the latter case, the - application must provide more input and/or consume the output - (providing more output space) before each call. - - The compressed data format used by default by the in-memory functions is - the zlib format, which is a zlib wrapper documented in RFC 1950, wrapped - around a deflate stream, which is itself documented in RFC 1951. - - The library also supports reading and writing files in gzip (.gz) format - with an interface similar to that of stdio using the functions that start - with "gz". The gzip format is different from the zlib format. gzip is a - gzip wrapper, documented in RFC 1952, wrapped around a deflate stream. - - This library can optionally read and write gzip streams in memory as well. - - The zlib format was designed to be compact and fast for use in memory - and on communications channels. The gzip format was designed for single- - file compression on file systems, has a larger header than zlib to maintain - directory information, and uses a different, slower check method than zlib. - - The library does not install any signal handler. The decoder checks - the consistency of the compressed data, so the library should never - crash even in case of corrupted input. -*/ - -typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size)); -typedef void (*free_func) OF((voidpf opaque, voidpf address)); - -struct internal_state; - -typedef struct z_stream_s { - Bytef *next_in; /* next input byte */ - uInt avail_in; /* number of bytes available at next_in */ - uLong total_in; /* total nb of input bytes read so far */ - - Bytef *next_out; /* next output byte should be put there */ - uInt avail_out; /* remaining free space at next_out */ - uLong total_out; /* total nb of bytes output so far */ - - char *msg; /* last error message, NULL if no error */ - struct internal_state FAR *state; /* not visible by applications */ - - alloc_func zalloc; /* used to allocate the internal state */ - free_func zfree; /* used to free the internal state */ - voidpf opaque; /* private data object passed to zalloc and zfree */ - - int data_type; /* best guess about the data type: binary or text */ - uLong adler; /* adler32 value of the uncompressed data */ - uLong reserved; /* reserved for future use */ -} z_stream; - -typedef z_stream FAR *z_streamp; - -/* - gzip header information passed to and from zlib routines. See RFC 1952 - for more details on the meanings of these fields. -*/ -typedef struct gz_header_s { - int text; /* true if compressed data believed to be text */ - uLong time; /* modification time */ - int xflags; /* extra flags (not used when writing a gzip file) */ - int os; /* operating system */ - Bytef *extra; /* pointer to extra field or Z_NULL if none */ - uInt extra_len; /* extra field length (valid if extra != Z_NULL) */ - uInt extra_max; /* space at extra (only when reading header) */ - Bytef *name; /* pointer to zero-terminated file name or Z_NULL */ - uInt name_max; /* space at name (only when reading header) */ - Bytef *comment; /* pointer to zero-terminated comment or Z_NULL */ - uInt comm_max; /* space at comment (only when reading header) */ - int hcrc; /* true if there was or will be a header crc */ - int done; /* true when done reading gzip header (not used - when writing a gzip file) */ -} gz_header; - -typedef gz_header FAR *gz_headerp; - -/* - The application must update next_in and avail_in when avail_in has - dropped to zero. It must update next_out and avail_out when avail_out - has dropped to zero. The application must initialize zalloc, zfree and - opaque before calling the init function. All other fields are set by the - compression library and must not be updated by the application. - - The opaque value provided by the application will be passed as the first - parameter for calls of zalloc and zfree. This can be useful for custom - memory management. The compression library attaches no meaning to the - opaque value. - - zalloc must return Z_NULL if there is not enough memory for the object. - If zlib is used in a multi-threaded application, zalloc and zfree must be - thread safe. - - On 16-bit systems, the functions zalloc and zfree must be able to allocate - exactly 65536 bytes, but will not be required to allocate more than this - if the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS, - pointers returned by zalloc for objects of exactly 65536 bytes *must* - have their offset normalized to zero. The default allocation function - provided by this library ensures this (see zutil.c). To reduce memory - requirements and avoid any allocation of 64K objects, at the expense of - compression ratio, compile the library with -DMAX_WBITS=14 (see zconf.h). - - The fields total_in and total_out can be used for statistics or - progress reports. After compression, total_in holds the total size of - the uncompressed data and may be saved for use in the decompressor - (particularly if the decompressor wants to decompress everything in - a single step). -*/ - - /* constants */ - -#define Z_NO_FLUSH 0 -#define Z_PARTIAL_FLUSH 1 /* will be removed, use Z_SYNC_FLUSH instead */ -#define Z_SYNC_FLUSH 2 -#define Z_FULL_FLUSH 3 -#define Z_FINISH 4 -#define Z_BLOCK 5 -/* Allowed flush values; see deflate() and inflate() below for details */ - -#define Z_OK 0 -#define Z_STREAM_END 1 -#define Z_NEED_DICT 2 -#define Z_ERRNO (-1) -#define Z_STREAM_ERROR (-2) -#define Z_DATA_ERROR (-3) -#define Z_MEM_ERROR (-4) -#define Z_BUF_ERROR (-5) -#define Z_VERSION_ERROR (-6) -/* Return codes for the compression/decompression functions. Negative - * values are errors, positive values are used for special but normal events. - */ - -#define Z_NO_COMPRESSION 0 -#define Z_BEST_SPEED 1 -#define Z_BEST_COMPRESSION 9 -#define Z_DEFAULT_COMPRESSION (-1) -/* compression levels */ - -#define Z_FILTERED 1 -#define Z_HUFFMAN_ONLY 2 -#define Z_RLE 3 -#define Z_FIXED 4 -#define Z_DEFAULT_STRATEGY 0 -/* compression strategy; see deflateInit2() below for details */ - -#define Z_BINARY 0 -#define Z_TEXT 1 -#define Z_ASCII Z_TEXT /* for compatibility with 1.2.2 and earlier */ -#define Z_UNKNOWN 2 -/* Possible values of the data_type field (though see inflate()) */ - -#define Z_DEFLATED 8 -/* The deflate compression method (the only one supported in this version) */ - -#define Z_NULL 0 /* for initializing zalloc, zfree, opaque */ - -#define zlib_version zlibVersion() -/* for compatibility with versions < 1.0.2 */ - - /* basic functions */ - -ZEXTERN const char * ZEXPORT zlibVersion OF((void)); -/* The application can compare zlibVersion and ZLIB_VERSION for consistency. - If the first character differs, the library code actually used is - not compatible with the zlib.h header file used by the application. - This check is automatically made by deflateInit and inflateInit. - */ - -/* -ZEXTERN int ZEXPORT deflateInit OF((z_streamp strm, int level)); - - Initializes the internal stream state for compression. The fields - zalloc, zfree and opaque must be initialized before by the caller. - If zalloc and zfree are set to Z_NULL, deflateInit updates them to - use default allocation functions. - - The compression level must be Z_DEFAULT_COMPRESSION, or between 0 and 9: - 1 gives best speed, 9 gives best compression, 0 gives no compression at - all (the input data is simply copied a block at a time). - Z_DEFAULT_COMPRESSION requests a default compromise between speed and - compression (currently equivalent to level 6). - - deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not - enough memory, Z_STREAM_ERROR if level is not a valid compression level, - Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible - with the version assumed by the caller (ZLIB_VERSION). - msg is set to null if there is no error message. deflateInit does not - perform any compression: this will be done by deflate(). -*/ - - -ZEXTERN int ZEXPORT deflate OF((z_streamp strm, int flush)); -/* - deflate compresses as much data as possible, and stops when the input - buffer becomes empty or the output buffer becomes full. It may introduce some - output latency (reading input without producing any output) except when - forced to flush. - - The detailed semantics are as follows. deflate performs one or both of the - following actions: - - - Compress more input starting at next_in and update next_in and avail_in - accordingly. If not all input can be processed (because there is not - enough room in the output buffer), next_in and avail_in are updated and - processing will resume at this point for the next call of deflate(). - - - Provide more output starting at next_out and update next_out and avail_out - accordingly. This action is forced if the parameter flush is non zero. - Forcing flush frequently degrades the compression ratio, so this parameter - should be set only when necessary (in interactive applications). - Some output may be provided even if flush is not set. - - Before the call of deflate(), the application should ensure that at least - one of the actions is possible, by providing more input and/or consuming - more output, and updating avail_in or avail_out accordingly; avail_out - should never be zero before the call. The application can consume the - compressed output when it wants, for example when the output buffer is full - (avail_out == 0), or after each call of deflate(). If deflate returns Z_OK - and with zero avail_out, it must be called again after making room in the - output buffer because there might be more output pending. - - Normally the parameter flush is set to Z_NO_FLUSH, which allows deflate to - decide how much data to accumualte before producing output, in order to - maximize compression. - - If the parameter flush is set to Z_SYNC_FLUSH, all pending output is - flushed to the output buffer and the output is aligned on a byte boundary, so - that the decompressor can get all input data available so far. (In particular - avail_in is zero after the call if enough output space has been provided - before the call.) Flushing may degrade compression for some compression - algorithms and so it should be used only when necessary. - - If flush is set to Z_FULL_FLUSH, all output is flushed as with - Z_SYNC_FLUSH, and the compression state is reset so that decompression can - restart from this point if previous compressed data has been damaged or if - random access is desired. Using Z_FULL_FLUSH too often can seriously degrade - compression. - - If deflate returns with avail_out == 0, this function must be called again - with the same value of the flush parameter and more output space (updated - avail_out), until the flush is complete (deflate returns with non-zero - avail_out). In the case of a Z_FULL_FLUSH or Z_SYNC_FLUSH, make sure that - avail_out is greater than six to avoid repeated flush markers due to - avail_out == 0 on return. - - If the parameter flush is set to Z_FINISH, pending input is processed, - pending output is flushed and deflate returns with Z_STREAM_END if there - was enough output space; if deflate returns with Z_OK, this function must be - called again with Z_FINISH and more output space (updated avail_out) but no - more input data, until it returns with Z_STREAM_END or an error. After - deflate has returned Z_STREAM_END, the only possible operations on the - stream are deflateReset or deflateEnd. - - Z_FINISH can be used immediately after deflateInit if all the compression - is to be done in a single step. In this case, avail_out must be at least - the value returned by deflateBound (see below). If deflate does not return - Z_STREAM_END, then it must be called again as described above. - - deflate() sets strm->adler to the adler32 checksum of all input read - so far (that is, total_in bytes). - - deflate() may update strm->data_type if it can make a good guess about - the input data type (Z_BINARY or Z_TEXT). In doubt, the data is considered - binary. This field is only for information purposes and does not affect - the compression algorithm in any manner. - - deflate() returns Z_OK if some progress has been made (more input - processed or more output produced), Z_STREAM_END if all input has been - consumed and all output has been produced (only when flush is set to - Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example - if next_in or next_out was NULL), Z_BUF_ERROR if no progress is possible - (for example avail_in or avail_out was zero). Note that Z_BUF_ERROR is not - fatal, and deflate() can be called again with more input and more output - space to continue compressing. -*/ - - -ZEXTERN int ZEXPORT deflateEnd OF((z_streamp strm)); -/* - All dynamically allocated data structures for this stream are freed. - This function discards any unprocessed input and does not flush any - pending output. - - deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the - stream state was inconsistent, Z_DATA_ERROR if the stream was freed - prematurely (some input or output was discarded). In the error case, - msg may be set but then points to a static string (which must not be - deallocated). -*/ - - -/* -ZEXTERN int ZEXPORT inflateInit OF((z_streamp strm)); - - Initializes the internal stream state for decompression. The fields - next_in, avail_in, zalloc, zfree and opaque must be initialized before by - the caller. If next_in is not Z_NULL and avail_in is large enough (the exact - value depends on the compression method), inflateInit determines the - compression method from the zlib header and allocates all data structures - accordingly; otherwise the allocation will be deferred to the first call of - inflate. If zalloc and zfree are set to Z_NULL, inflateInit updates them to - use default allocation functions. - - inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough - memory, Z_VERSION_ERROR if the zlib library version is incompatible with the - version assumed by the caller. msg is set to null if there is no error - message. inflateInit does not perform any decompression apart from reading - the zlib header if present: this will be done by inflate(). (So next_in and - avail_in may be modified, but next_out and avail_out are unchanged.) -*/ - - -ZEXTERN int ZEXPORT inflate OF((z_streamp strm, int flush)); -/* - inflate decompresses as much data as possible, and stops when the input - buffer becomes empty or the output buffer becomes full. It may introduce - some output latency (reading input without producing any output) except when - forced to flush. - - The detailed semantics are as follows. inflate performs one or both of the - following actions: - - - Decompress more input starting at next_in and update next_in and avail_in - accordingly. If not all input can be processed (because there is not - enough room in the output buffer), next_in is updated and processing - will resume at this point for the next call of inflate(). - - - Provide more output starting at next_out and update next_out and avail_out - accordingly. inflate() provides as much output as possible, until there - is no more input data or no more space in the output buffer (see below - about the flush parameter). - - Before the call of inflate(), the application should ensure that at least - one of the actions is possible, by providing more input and/or consuming - more output, and updating the next_* and avail_* values accordingly. - The application can consume the uncompressed output when it wants, for - example when the output buffer is full (avail_out == 0), or after each - call of inflate(). If inflate returns Z_OK and with zero avail_out, it - must be called again after making room in the output buffer because there - might be more output pending. - - The flush parameter of inflate() can be Z_NO_FLUSH, Z_SYNC_FLUSH, - Z_FINISH, or Z_BLOCK. Z_SYNC_FLUSH requests that inflate() flush as much - output as possible to the output buffer. Z_BLOCK requests that inflate() stop - if and when it gets to the next deflate block boundary. When decoding the - zlib or gzip format, this will cause inflate() to return immediately after - the header and before the first block. When doing a raw inflate, inflate() - will go ahead and process the first block, and will return when it gets to - the end of that block, or when it runs out of data. - - The Z_BLOCK option assists in appending to or combining deflate streams. - Also to assist in this, on return inflate() will set strm->data_type to the - number of unused bits in the last byte taken from strm->next_in, plus 64 - if inflate() is currently decoding the last block in the deflate stream, - plus 128 if inflate() returned immediately after decoding an end-of-block - code or decoding the complete header up to just before the first byte of the - deflate stream. The end-of-block will not be indicated until all of the - uncompressed data from that block has been written to strm->next_out. The - number of unused bits may in general be greater than seven, except when - bit 7 of data_type is set, in which case the number of unused bits will be - less than eight. - - inflate() should normally be called until it returns Z_STREAM_END or an - error. However if all decompression is to be performed in a single step - (a single call of inflate), the parameter flush should be set to - Z_FINISH. In this case all pending input is processed and all pending - output is flushed; avail_out must be large enough to hold all the - uncompressed data. (The size of the uncompressed data may have been saved - by the compressor for this purpose.) The next operation on this stream must - be inflateEnd to deallocate the decompression state. The use of Z_FINISH - is never required, but can be used to inform inflate that a faster approach - may be used for the single inflate() call. - - In this implementation, inflate() always flushes as much output as - possible to the output buffer, and always uses the faster approach on the - first call. So the only effect of the flush parameter in this implementation - is on the return value of inflate(), as noted below, or when it returns early - because Z_BLOCK is used. - - If a preset dictionary is needed after this call (see inflateSetDictionary - below), inflate sets strm->adler to the adler32 checksum of the dictionary - chosen by the compressor and returns Z_NEED_DICT; otherwise it sets - strm->adler to the adler32 checksum of all output produced so far (that is, - total_out bytes) and returns Z_OK, Z_STREAM_END or an error code as described - below. At the end of the stream, inflate() checks that its computed adler32 - checksum is equal to that saved by the compressor and returns Z_STREAM_END - only if the checksum is correct. - - inflate() will decompress and check either zlib-wrapped or gzip-wrapped - deflate data. The header type is detected automatically. Any information - contained in the gzip header is not retained, so applications that need that - information should instead use raw inflate, see inflateInit2() below, or - inflateBack() and perform their own processing of the gzip header and - trailer. - - inflate() returns Z_OK if some progress has been made (more input processed - or more output produced), Z_STREAM_END if the end of the compressed data has - been reached and all uncompressed output has been produced, Z_NEED_DICT if a - preset dictionary is needed at this point, Z_DATA_ERROR if the input data was - corrupted (input stream not conforming to the zlib format or incorrect check - value), Z_STREAM_ERROR if the stream structure was inconsistent (for example - if next_in or next_out was NULL), Z_MEM_ERROR if there was not enough memory, - Z_BUF_ERROR if no progress is possible or if there was not enough room in the - output buffer when Z_FINISH is used. Note that Z_BUF_ERROR is not fatal, and - inflate() can be called again with more input and more output space to - continue decompressing. If Z_DATA_ERROR is returned, the application may then - call inflateSync() to look for a good compression block if a partial recovery - of the data is desired. -*/ - - -ZEXTERN int ZEXPORT inflateEnd OF((z_streamp strm)); -/* - All dynamically allocated data structures for this stream are freed. - This function discards any unprocessed input and does not flush any - pending output. - - inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state - was inconsistent. In the error case, msg may be set but then points to a - static string (which must not be deallocated). -*/ - - /* Advanced functions */ - -/* - The following functions are needed only in some special applications. -*/ - -/* -ZEXTERN int ZEXPORT deflateInit2 OF((z_streamp strm, - int level, - int method, - int windowBits, - int memLevel, - int strategy)); - - This is another version of deflateInit with more compression options. The - fields next_in, zalloc, zfree and opaque must be initialized before by - the caller. - - The method parameter is the compression method. It must be Z_DEFLATED in - this version of the library. - - The windowBits parameter is the base two logarithm of the window size - (the size of the history buffer). It should be in the range 8..15 for this - version of the library. Larger values of this parameter result in better - compression at the expense of memory usage. The default value is 15 if - deflateInit is used instead. - - windowBits can also be -8..-15 for raw deflate. In this case, -windowBits - determines the window size. deflate() will then generate raw deflate data - with no zlib header or trailer, and will not compute an adler32 check value. - - windowBits can also be greater than 15 for optional gzip encoding. Add - 16 to windowBits to write a simple gzip header and trailer around the - compressed data instead of a zlib wrapper. The gzip header will have no - file name, no extra data, no comment, no modification time (set to zero), - no header crc, and the operating system will be set to 255 (unknown). If a - gzip stream is being written, strm->adler is a crc32 instead of an adler32. - - The memLevel parameter specifies how much memory should be allocated - for the internal compression state. memLevel=1 uses minimum memory but - is slow and reduces compression ratio; memLevel=9 uses maximum memory - for optimal speed. The default value is 8. See zconf.h for total memory - usage as a function of windowBits and memLevel. - - The strategy parameter is used to tune the compression algorithm. Use the - value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a - filter (or predictor), Z_HUFFMAN_ONLY to force Huffman encoding only (no - string match), or Z_RLE to limit match distances to one (run-length - encoding). Filtered data consists mostly of small values with a somewhat - random distribution. In this case, the compression algorithm is tuned to - compress them better. The effect of Z_FILTERED is to force more Huffman - coding and less string matching; it is somewhat intermediate between - Z_DEFAULT and Z_HUFFMAN_ONLY. Z_RLE is designed to be almost as fast as - Z_HUFFMAN_ONLY, but give better compression for PNG image data. The strategy - parameter only affects the compression ratio but not the correctness of the - compressed output even if it is not set appropriately. Z_FIXED prevents the - use of dynamic Huffman codes, allowing for a simpler decoder for special - applications. - - deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough - memory, Z_STREAM_ERROR if a parameter is invalid (such as an invalid - method). msg is set to null if there is no error message. deflateInit2 does - not perform any compression: this will be done by deflate(). -*/ - -ZEXTERN int ZEXPORT deflateSetDictionary OF((z_streamp strm, - const Bytef *dictionary, - uInt dictLength)); -/* - Initializes the compression dictionary from the given byte sequence - without producing any compressed output. This function must be called - immediately after deflateInit, deflateInit2 or deflateReset, before any - call of deflate. The compressor and decompressor must use exactly the same - dictionary (see inflateSetDictionary). - - The dictionary should consist of strings (byte sequences) that are likely - to be encountered later in the data to be compressed, with the most commonly - used strings preferably put towards the end of the dictionary. Using a - dictionary is most useful when the data to be compressed is short and can be - predicted with good accuracy; the data can then be compressed better than - with the default empty dictionary. - - Depending on the size of the compression data structures selected by - deflateInit or deflateInit2, a part of the dictionary may in effect be - discarded, for example if the dictionary is larger than the window size in - deflate or deflate2. Thus the strings most likely to be useful should be - put at the end of the dictionary, not at the front. In addition, the - current implementation of deflate will use at most the window size minus - 262 bytes of the provided dictionary. - - Upon return of this function, strm->adler is set to the adler32 value - of the dictionary; the decompressor may later use this value to determine - which dictionary has been used by the compressor. (The adler32 value - applies to the whole dictionary even if only a subset of the dictionary is - actually used by the compressor.) If a raw deflate was requested, then the - adler32 value is not computed and strm->adler is not set. - - deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a - parameter is invalid (such as NULL dictionary) or the stream state is - inconsistent (for example if deflate has already been called for this stream - or if the compression method is bsort). deflateSetDictionary does not - perform any compression: this will be done by deflate(). -*/ - -ZEXTERN int ZEXPORT deflateCopy OF((z_streamp dest, - z_streamp source)); -/* - Sets the destination stream as a complete copy of the source stream. - - This function can be useful when several compression strategies will be - tried, for example when there are several ways of pre-processing the input - data with a filter. The streams that will be discarded should then be freed - by calling deflateEnd. Note that deflateCopy duplicates the internal - compression state which can be quite large, so this strategy is slow and - can consume lots of memory. - - deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not - enough memory, Z_STREAM_ERROR if the source stream state was inconsistent - (such as zalloc being NULL). msg is left unchanged in both source and - destination. -*/ - -ZEXTERN int ZEXPORT deflateReset OF((z_streamp strm)); -/* - This function is equivalent to deflateEnd followed by deflateInit, - but does not free and reallocate all the internal compression state. - The stream will keep the same compression level and any other attributes - that may have been set by deflateInit2. - - deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source - stream state was inconsistent (such as zalloc or state being NULL). -*/ - -ZEXTERN int ZEXPORT deflateParams OF((z_streamp strm, - int level, - int strategy)); -/* - Dynamically update the compression level and compression strategy. The - interpretation of level and strategy is as in deflateInit2. This can be - used to switch between compression and straight copy of the input data, or - to switch to a different kind of input data requiring a different - strategy. If the compression level is changed, the input available so far - is compressed with the old level (and may be flushed); the new level will - take effect only at the next call of deflate(). - - Before the call of deflateParams, the stream state must be set as for - a call of deflate(), since the currently available input may have to - be compressed and flushed. In particular, strm->avail_out must be non-zero. - - deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source - stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR - if strm->avail_out was zero. -*/ - -ZEXTERN int ZEXPORT deflateTune OF((z_streamp strm, - int good_length, - int max_lazy, - int nice_length, - int max_chain)); -/* - Fine tune deflate's internal compression parameters. This should only be - used by someone who understands the algorithm used by zlib's deflate for - searching for the best matching string, and even then only by the most - fanatic optimizer trying to squeeze out the last compressed bit for their - specific input data. Read the deflate.c source code for the meaning of the - max_lazy, good_length, nice_length, and max_chain parameters. - - deflateTune() can be called after deflateInit() or deflateInit2(), and - returns Z_OK on success, or Z_STREAM_ERROR for an invalid deflate stream. - */ - -ZEXTERN uLong ZEXPORT deflateBound OF((z_streamp strm, - uLong sourceLen)); -/* - deflateBound() returns an upper bound on the compressed size after - deflation of sourceLen bytes. It must be called after deflateInit() - or deflateInit2(). This would be used to allocate an output buffer - for deflation in a single pass, and so would be called before deflate(). -*/ - -ZEXTERN int ZEXPORT deflatePrime OF((z_streamp strm, - int bits, - int value)); -/* - deflatePrime() inserts bits in the deflate output stream. The intent - is that this function is used to start off the deflate output with the - bits leftover from a previous deflate stream when appending to it. As such, - this function can only be used for raw deflate, and must be used before the - first deflate() call after a deflateInit2() or deflateReset(). bits must be - less than or equal to 16, and that many of the least significant bits of - value will be inserted in the output. - - deflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source - stream state was inconsistent. -*/ - -ZEXTERN int ZEXPORT deflateSetHeader OF((z_streamp strm, - gz_headerp head)); -/* - deflateSetHeader() provides gzip header information for when a gzip - stream is requested by deflateInit2(). deflateSetHeader() may be called - after deflateInit2() or deflateReset() and before the first call of - deflate(). The text, time, os, extra field, name, and comment information - in the provided gz_header structure are written to the gzip header (xflag is - ignored -- the extra flags are set according to the compression level). The - caller must assure that, if not Z_NULL, name and comment are terminated with - a zero byte, and that if extra is not Z_NULL, that extra_len bytes are - available there. If hcrc is true, a gzip header crc is included. Note that - the current versions of the command-line version of gzip (up through version - 1.3.x) do not support header crc's, and will report that it is a "multi-part - gzip file" and give up. - - If deflateSetHeader is not used, the default gzip header has text false, - the time set to zero, and os set to 255, with no extra, name, or comment - fields. The gzip header is returned to the default state by deflateReset(). - - deflateSetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source - stream state was inconsistent. -*/ - -/* -ZEXTERN int ZEXPORT inflateInit2 OF((z_streamp strm, - int windowBits)); - - This is another version of inflateInit with an extra parameter. The - fields next_in, avail_in, zalloc, zfree and opaque must be initialized - before by the caller. - - The windowBits parameter is the base two logarithm of the maximum window - size (the size of the history buffer). It should be in the range 8..15 for - this version of the library. The default value is 15 if inflateInit is used - instead. windowBits must be greater than or equal to the windowBits value - provided to deflateInit2() while compressing, or it must be equal to 15 if - deflateInit2() was not used. If a compressed stream with a larger window - size is given as input, inflate() will return with the error code - Z_DATA_ERROR instead of trying to allocate a larger window. - - windowBits can also be -8..-15 for raw inflate. In this case, -windowBits - determines the window size. inflate() will then process raw deflate data, - not looking for a zlib or gzip header, not generating a check value, and not - looking for any check values for comparison at the end of the stream. This - is for use with other formats that use the deflate compressed data format - such as zip. Those formats provide their own check values. If a custom - format is developed using the raw deflate format for compressed data, it is - recommended that a check value such as an adler32 or a crc32 be applied to - the uncompressed data as is done in the zlib, gzip, and zip formats. For - most applications, the zlib format should be used as is. Note that comments - above on the use in deflateInit2() applies to the magnitude of windowBits. - - windowBits can also be greater than 15 for optional gzip decoding. Add - 32 to windowBits to enable zlib and gzip decoding with automatic header - detection, or add 16 to decode only the gzip format (the zlib format will - return a Z_DATA_ERROR). If a gzip stream is being decoded, strm->adler is - a crc32 instead of an adler32. - - inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough - memory, Z_STREAM_ERROR if a parameter is invalid (such as a null strm). msg - is set to null if there is no error message. inflateInit2 does not perform - any decompression apart from reading the zlib header if present: this will - be done by inflate(). (So next_in and avail_in may be modified, but next_out - and avail_out are unchanged.) -*/ - -ZEXTERN int ZEXPORT inflateSetDictionary OF((z_streamp strm, - const Bytef *dictionary, - uInt dictLength)); -/* - Initializes the decompression dictionary from the given uncompressed byte - sequence. This function must be called immediately after a call of inflate, - if that call returned Z_NEED_DICT. The dictionary chosen by the compressor - can be determined from the adler32 value returned by that call of inflate. - The compressor and decompressor must use exactly the same dictionary (see - deflateSetDictionary). For raw inflate, this function can be called - immediately after inflateInit2() or inflateReset() and before any call of - inflate() to set the dictionary. The application must insure that the - dictionary that was used for compression is provided. - - inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a - parameter is invalid (such as NULL dictionary) or the stream state is - inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the - expected one (incorrect adler32 value). inflateSetDictionary does not - perform any decompression: this will be done by subsequent calls of - inflate(). -*/ - -ZEXTERN int ZEXPORT inflateSync OF((z_streamp strm)); -/* - Skips invalid compressed data until a full flush point (see above the - description of deflate with Z_FULL_FLUSH) can be found, or until all - available input is skipped. No output is provided. - - inflateSync returns Z_OK if a full flush point has been found, Z_BUF_ERROR - if no more input was provided, Z_DATA_ERROR if no flush point has been found, - or Z_STREAM_ERROR if the stream structure was inconsistent. In the success - case, the application may save the current current value of total_in which - indicates where valid compressed data was found. In the error case, the - application may repeatedly call inflateSync, providing more input each time, - until success or end of the input data. -*/ - -ZEXTERN int ZEXPORT inflateCopy OF((z_streamp dest, - z_streamp source)); -/* - Sets the destination stream as a complete copy of the source stream. - - This function can be useful when randomly accessing a large stream. The - first pass through the stream can periodically record the inflate state, - allowing restarting inflate at those points when randomly accessing the - stream. - - inflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not - enough memory, Z_STREAM_ERROR if the source stream state was inconsistent - (such as zalloc being NULL). msg is left unchanged in both source and - destination. -*/ - -ZEXTERN int ZEXPORT inflateReset OF((z_streamp strm)); -/* - This function is equivalent to inflateEnd followed by inflateInit, - but does not free and reallocate all the internal decompression state. - The stream will keep attributes that may have been set by inflateInit2. - - inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source - stream state was inconsistent (such as zalloc or state being NULL). -*/ - -ZEXTERN int ZEXPORT inflatePrime OF((z_streamp strm, - int bits, - int value)); -/* - This function inserts bits in the inflate input stream. The intent is - that this function is used to start inflating at a bit position in the - middle of a byte. The provided bits will be used before any bytes are used - from next_in. This function should only be used with raw inflate, and - should be used before the first inflate() call after inflateInit2() or - inflateReset(). bits must be less than or equal to 16, and that many of the - least significant bits of value will be inserted in the input. - - inflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source - stream state was inconsistent. -*/ - -ZEXTERN int ZEXPORT inflateGetHeader OF((z_streamp strm, - gz_headerp head)); -/* - inflateGetHeader() requests that gzip header information be stored in the - provided gz_header structure. inflateGetHeader() may be called after - inflateInit2() or inflateReset(), and before the first call of inflate(). - As inflate() processes the gzip stream, head->done is zero until the header - is completed, at which time head->done is set to one. If a zlib stream is - being decoded, then head->done is set to -1 to indicate that there will be - no gzip header information forthcoming. Note that Z_BLOCK can be used to - force inflate() to return immediately after header processing is complete - and before any actual data is decompressed. - - The text, time, xflags, and os fields are filled in with the gzip header - contents. hcrc is set to true if there is a header CRC. (The header CRC - was valid if done is set to one.) If extra is not Z_NULL, then extra_max - contains the maximum number of bytes to write to extra. Once done is true, - extra_len contains the actual extra field length, and extra contains the - extra field, or that field truncated if extra_max is less than extra_len. - If name is not Z_NULL, then up to name_max characters are written there, - terminated with a zero unless the length is greater than name_max. If - comment is not Z_NULL, then up to comm_max characters are written there, - terminated with a zero unless the length is greater than comm_max. When - any of extra, name, or comment are not Z_NULL and the respective field is - not present in the header, then that field is set to Z_NULL to signal its - absence. This allows the use of deflateSetHeader() with the returned - structure to duplicate the header. However if those fields are set to - allocated memory, then the application will need to save those pointers - elsewhere so that they can be eventually freed. - - If inflateGetHeader is not used, then the header information is simply - discarded. The header is always checked for validity, including the header - CRC if present. inflateReset() will reset the process to discard the header - information. The application would need to call inflateGetHeader() again to - retrieve the header from the next gzip stream. - - inflateGetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source - stream state was inconsistent. -*/ - -/* -ZEXTERN int ZEXPORT inflateBackInit OF((z_streamp strm, int windowBits, - unsigned char FAR *window)); - - Initialize the internal stream state for decompression using inflateBack() - calls. The fields zalloc, zfree and opaque in strm must be initialized - before the call. If zalloc and zfree are Z_NULL, then the default library- - derived memory allocation routines are used. windowBits is the base two - logarithm of the window size, in the range 8..15. window is a caller - supplied buffer of that size. Except for special applications where it is - assured that deflate was used with small window sizes, windowBits must be 15 - and a 32K byte window must be supplied to be able to decompress general - deflate streams. - - See inflateBack() for the usage of these routines. - - inflateBackInit will return Z_OK on success, Z_STREAM_ERROR if any of - the paramaters are invalid, Z_MEM_ERROR if the internal state could not - be allocated, or Z_VERSION_ERROR if the version of the library does not - match the version of the header file. -*/ - -typedef unsigned (*in_func) OF((void FAR *, unsigned char FAR * FAR *)); -typedef int (*out_func) OF((void FAR *, unsigned char FAR *, unsigned)); - -ZEXTERN int ZEXPORT inflateBack OF((z_streamp strm, - in_func in, void FAR *in_desc, - out_func out, void FAR *out_desc)); -/* - inflateBack() does a raw inflate with a single call using a call-back - interface for input and output. This is more efficient than inflate() for - file i/o applications in that it avoids copying between the output and the - sliding window by simply making the window itself the output buffer. This - function trusts the application to not change the output buffer passed by - the output function, at least until inflateBack() returns. - - inflateBackInit() must be called first to allocate the internal state - and to initialize the state with the user-provided window buffer. - inflateBack() may then be used multiple times to inflate a complete, raw - deflate stream with each call. inflateBackEnd() is then called to free - the allocated state. - - A raw deflate stream is one with no zlib or gzip header or trailer. - This routine would normally be used in a utility that reads zip or gzip - files and writes out uncompressed files. The utility would decode the - header and process the trailer on its own, hence this routine expects - only the raw deflate stream to decompress. This is different from the - normal behavior of inflate(), which expects either a zlib or gzip header and - trailer around the deflate stream. - - inflateBack() uses two subroutines supplied by the caller that are then - called by inflateBack() for input and output. inflateBack() calls those - routines until it reads a complete deflate stream and writes out all of the - uncompressed data, or until it encounters an error. The function's - parameters and return types are defined above in the in_func and out_func - typedefs. inflateBack() will call in(in_desc, &buf) which should return the - number of bytes of provided input, and a pointer to that input in buf. If - there is no input available, in() must return zero--buf is ignored in that - case--and inflateBack() will return a buffer error. inflateBack() will call - out(out_desc, buf, len) to write the uncompressed data buf[0..len-1]. out() - should return zero on success, or non-zero on failure. If out() returns - non-zero, inflateBack() will return with an error. Neither in() nor out() - are permitted to change the contents of the window provided to - inflateBackInit(), which is also the buffer that out() uses to write from. - The length written by out() will be at most the window size. Any non-zero - amount of input may be provided by in(). - - For convenience, inflateBack() can be provided input on the first call by - setting strm->next_in and strm->avail_in. If that input is exhausted, then - in() will be called. Therefore strm->next_in must be initialized before - calling inflateBack(). If strm->next_in is Z_NULL, then in() will be called - immediately for input. If strm->next_in is not Z_NULL, then strm->avail_in - must also be initialized, and then if strm->avail_in is not zero, input will - initially be taken from strm->next_in[0 .. strm->avail_in - 1]. - - The in_desc and out_desc parameters of inflateBack() is passed as the - first parameter of in() and out() respectively when they are called. These - descriptors can be optionally used to pass any information that the caller- - supplied in() and out() functions need to do their job. - - On return, inflateBack() will set strm->next_in and strm->avail_in to - pass back any unused input that was provided by the last in() call. The - return values of inflateBack() can be Z_STREAM_END on success, Z_BUF_ERROR - if in() or out() returned an error, Z_DATA_ERROR if there was a format - error in the deflate stream (in which case strm->msg is set to indicate the - nature of the error), or Z_STREAM_ERROR if the stream was not properly - initialized. In the case of Z_BUF_ERROR, an input or output error can be - distinguished using strm->next_in which will be Z_NULL only if in() returned - an error. If strm->next is not Z_NULL, then the Z_BUF_ERROR was due to - out() returning non-zero. (in() will always be called before out(), so - strm->next_in is assured to be defined if out() returns non-zero.) Note - that inflateBack() cannot return Z_OK. -*/ - -ZEXTERN int ZEXPORT inflateBackEnd OF((z_streamp strm)); -/* - All memory allocated by inflateBackInit() is freed. - - inflateBackEnd() returns Z_OK on success, or Z_STREAM_ERROR if the stream - state was inconsistent. -*/ - -ZEXTERN uLong ZEXPORT zlibCompileFlags OF((void)); -/* Return flags indicating compile-time options. - - Type sizes, two bits each, 00 = 16 bits, 01 = 32, 10 = 64, 11 = other: - 1.0: size of uInt - 3.2: size of uLong - 5.4: size of voidpf (pointer) - 7.6: size of z_off_t - - Compiler, assembler, and debug options: - 8: DEBUG - 9: ASMV or ASMINF -- use ASM code - 10: ZLIB_WINAPI -- exported functions use the WINAPI calling convention - 11: 0 (reserved) - - One-time table building (smaller code, but not thread-safe if true): - 12: BUILDFIXED -- build static block decoding tables when needed - 13: DYNAMIC_CRC_TABLE -- build CRC calculation tables when needed - 14,15: 0 (reserved) - - Library content (indicates missing functionality): - 16: NO_GZCOMPRESS -- gz* functions cannot compress (to avoid linking - deflate code when not needed) - 17: NO_GZIP -- deflate can't write gzip streams, and inflate can't detect - and decode gzip streams (to avoid linking crc code) - 18-19: 0 (reserved) - - Operation variations (changes in library functionality): - 20: PKZIP_BUG_WORKAROUND -- slightly more permissive inflate - 21: FASTEST -- deflate algorithm with only one, lowest compression level - 22,23: 0 (reserved) - - The sprintf variant used by gzprintf (zero is best): - 24: 0 = vs*, 1 = s* -- 1 means limited to 20 arguments after the format - 25: 0 = *nprintf, 1 = *printf -- 1 means gzprintf() not secure! - 26: 0 = returns value, 1 = void -- 1 means inferred string length returned - - Remainder: - 27-31: 0 (reserved) - */ - - - /* utility functions */ - -/* - The following utility functions are implemented on top of the - basic stream-oriented functions. To simplify the interface, some - default options are assumed (compression level and memory usage, - standard memory allocation functions). The source code of these - utility functions can easily be modified if you need special options. -*/ - -ZEXTERN int ZEXPORT compress OF((Bytef *dest, uLongf *destLen, - const Bytef *source, uLong sourceLen)); -/* - Compresses the source buffer into the destination buffer. sourceLen is - the byte length of the source buffer. Upon entry, destLen is the total - size of the destination buffer, which must be at least the value returned - by compressBound(sourceLen). Upon exit, destLen is the actual size of the - compressed buffer. - This function can be used to compress a whole file at once if the - input file is mmap'ed. - compress returns Z_OK if success, Z_MEM_ERROR if there was not - enough memory, Z_BUF_ERROR if there was not enough room in the output - buffer. -*/ - -ZEXTERN int ZEXPORT compress2 OF((Bytef *dest, uLongf *destLen, - const Bytef *source, uLong sourceLen, - int level)); -/* - Compresses the source buffer into the destination buffer. The level - parameter has the same meaning as in deflateInit. sourceLen is the byte - length of the source buffer. Upon entry, destLen is the total size of the - destination buffer, which must be at least the value returned by - compressBound(sourceLen). Upon exit, destLen is the actual size of the - compressed buffer. - - compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough - memory, Z_BUF_ERROR if there was not enough room in the output buffer, - Z_STREAM_ERROR if the level parameter is invalid. -*/ - -ZEXTERN uLong ZEXPORT compressBound OF((uLong sourceLen)); -/* - compressBound() returns an upper bound on the compressed size after - compress() or compress2() on sourceLen bytes. It would be used before - a compress() or compress2() call to allocate the destination buffer. -*/ - -ZEXTERN int ZEXPORT uncompress OF((Bytef *dest, uLongf *destLen, - const Bytef *source, uLong sourceLen)); -/* - Decompresses the source buffer into the destination buffer. sourceLen is - the byte length of the source buffer. Upon entry, destLen is the total - size of the destination buffer, which must be large enough to hold the - entire uncompressed data. (The size of the uncompressed data must have - been saved previously by the compressor and transmitted to the decompressor - by some mechanism outside the scope of this compression library.) - Upon exit, destLen is the actual size of the compressed buffer. - This function can be used to decompress a whole file at once if the - input file is mmap'ed. - - uncompress returns Z_OK if success, Z_MEM_ERROR if there was not - enough memory, Z_BUF_ERROR if there was not enough room in the output - buffer, or Z_DATA_ERROR if the input data was corrupted or incomplete. -*/ - - -typedef voidp gzFile; - -ZEXTERN gzFile ZEXPORT gzopen OF((const char *path, const char *mode)); -/* - Opens a gzip (.gz) file for reading or writing. The mode parameter - is as in fopen ("rb" or "wb") but can also include a compression level - ("wb9") or a strategy: 'f' for filtered data as in "wb6f", 'h' for - Huffman only compression as in "wb1h", or 'R' for run-length encoding - as in "wb1R". (See the description of deflateInit2 for more information - about the strategy parameter.) - - gzopen can be used to read a file which is not in gzip format; in this - case gzread will directly read from the file without decompression. - - gzopen returns NULL if the file could not be opened or if there was - insufficient memory to allocate the (de)compression state; errno - can be checked to distinguish the two cases (if errno is zero, the - zlib error is Z_MEM_ERROR). */ - -ZEXTERN gzFile ZEXPORT gzdopen OF((int fd, const char *mode)); -/* - gzdopen() associates a gzFile with the file descriptor fd. File - descriptors are obtained from calls like open, dup, creat, pipe or - fileno (in the file has been previously opened with fopen). - The mode parameter is as in gzopen. - The next call of gzclose on the returned gzFile will also close the - file descriptor fd, just like fclose(fdopen(fd), mode) closes the file - descriptor fd. If you want to keep fd open, use gzdopen(dup(fd), mode). - gzdopen returns NULL if there was insufficient memory to allocate - the (de)compression state. -*/ - -ZEXTERN int ZEXPORT gzsetparams OF((gzFile file, int level, int strategy)); -/* - Dynamically update the compression level or strategy. See the description - of deflateInit2 for the meaning of these parameters. - gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not - opened for writing. -*/ - -ZEXTERN int ZEXPORT gzread OF((gzFile file, voidp buf, unsigned len)); -/* - Reads the given number of uncompressed bytes from the compressed file. - If the input file was not in gzip format, gzread copies the given number - of bytes into the buffer. - gzread returns the number of uncompressed bytes actually read (0 for - end of file, -1 for error). */ - -ZEXTERN int ZEXPORT gzwrite OF((gzFile file, - voidpc buf, unsigned len)); -/* - Writes the given number of uncompressed bytes into the compressed file. - gzwrite returns the number of uncompressed bytes actually written - (0 in case of error). -*/ - -ZEXTERN int ZEXPORTVA gzprintf OF((gzFile file, const char *format, ...)); -/* - Converts, formats, and writes the args to the compressed file under - control of the format string, as in fprintf. gzprintf returns the number of - uncompressed bytes actually written (0 in case of error). The number of - uncompressed bytes written is limited to 4095. The caller should assure that - this limit is not exceeded. If it is exceeded, then gzprintf() will return - return an error (0) with nothing written. In this case, there may also be a - buffer overflow with unpredictable consequences, which is possible only if - zlib was compiled with the insecure functions sprintf() or vsprintf() - because the secure snprintf() or vsnprintf() functions were not available. -*/ - -ZEXTERN int ZEXPORT gzputs OF((gzFile file, const char *s)); -/* - Writes the given null-terminated string to the compressed file, excluding - the terminating null character. - gzputs returns the number of characters written, or -1 in case of error. -*/ - -ZEXTERN char * ZEXPORT gzgets OF((gzFile file, char *buf, int len)); -/* - Reads bytes from the compressed file until len-1 characters are read, or - a newline character is read and transferred to buf, or an end-of-file - condition is encountered. The string is then terminated with a null - character. - gzgets returns buf, or Z_NULL in case of error. -*/ - -ZEXTERN int ZEXPORT gzputc OF((gzFile file, int c)); -/* - Writes c, converted to an unsigned char, into the compressed file. - gzputc returns the value that was written, or -1 in case of error. -*/ - -ZEXTERN int ZEXPORT gzgetc OF((gzFile file)); -/* - Reads one byte from the compressed file. gzgetc returns this byte - or -1 in case of end of file or error. -*/ - -ZEXTERN int ZEXPORT gzungetc OF((int c, gzFile file)); -/* - Push one character back onto the stream to be read again later. - Only one character of push-back is allowed. gzungetc() returns the - character pushed, or -1 on failure. gzungetc() will fail if a - character has been pushed but not read yet, or if c is -1. The pushed - character will be discarded if the stream is repositioned with gzseek() - or gzrewind(). -*/ - -ZEXTERN int ZEXPORT gzflush OF((gzFile file, int flush)); -/* - Flushes all pending output into the compressed file. The parameter - flush is as in the deflate() function. The return value is the zlib - error number (see function gzerror below). gzflush returns Z_OK if - the flush parameter is Z_FINISH and all output could be flushed. - gzflush should be called only when strictly necessary because it can - degrade compression. -*/ - -ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile file, - z_off_t offset, int whence)); -/* - Sets the starting position for the next gzread or gzwrite on the - given compressed file. The offset represents a number of bytes in the - uncompressed data stream. The whence parameter is defined as in lseek(2); - the value SEEK_END is not supported. - If the file is opened for reading, this function is emulated but can be - extremely slow. If the file is opened for writing, only forward seeks are - supported; gzseek then compresses a sequence of zeroes up to the new - starting position. - - gzseek returns the resulting offset location as measured in bytes from - the beginning of the uncompressed stream, or -1 in case of error, in - particular if the file is opened for writing and the new starting position - would be before the current position. -*/ - -ZEXTERN int ZEXPORT gzrewind OF((gzFile file)); -/* - Rewinds the given file. This function is supported only for reading. - - gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET) -*/ - -ZEXTERN z_off_t ZEXPORT gztell OF((gzFile file)); -/* - Returns the starting position for the next gzread or gzwrite on the - given compressed file. This position represents a number of bytes in the - uncompressed data stream. - - gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR) -*/ - -ZEXTERN int ZEXPORT gzeof OF((gzFile file)); -/* - Returns 1 when EOF has previously been detected reading the given - input stream, otherwise zero. -*/ - -ZEXTERN int ZEXPORT gzdirect OF((gzFile file)); -/* - Returns 1 if file is being read directly without decompression, otherwise - zero. -*/ - -ZEXTERN int ZEXPORT gzclose OF((gzFile file)); -/* - Flushes all pending output if necessary, closes the compressed file - and deallocates all the (de)compression state. The return value is the zlib - error number (see function gzerror below). -*/ - -ZEXTERN const char * ZEXPORT gzerror OF((gzFile file, int *errnum)); -/* - Returns the error message for the last error which occurred on the - given compressed file. errnum is set to zlib error number. If an - error occurred in the file system and not in the compression library, - errnum is set to Z_ERRNO and the application may consult errno - to get the exact error code. -*/ - -ZEXTERN void ZEXPORT gzclearerr OF((gzFile file)); -/* - Clears the error and end-of-file flags for file. This is analogous to the - clearerr() function in stdio. This is useful for continuing to read a gzip - file that is being written concurrently. -*/ - - /* checksum functions */ - -/* - These functions are not related to compression but are exported - anyway because they might be useful in applications using the - compression library. -*/ - -ZEXTERN uLong ZEXPORT adler32 OF((uLong adler, const Bytef *buf, uInt len)); -/* - Update a running Adler-32 checksum with the bytes buf[0..len-1] and - return the updated checksum. If buf is NULL, this function returns - the required initial value for the checksum. - An Adler-32 checksum is almost as reliable as a CRC32 but can be computed - much faster. Usage example: - - uLong adler = adler32(0L, Z_NULL, 0); - - while (read_buffer(buffer, length) != EOF) { - adler = adler32(adler, buffer, length); - } - if (adler != original_adler) error(); -*/ - -ZEXTERN uLong ZEXPORT adler32_combine OF((uLong adler1, uLong adler2, - z_off_t len2)); -/* - Combine two Adler-32 checksums into one. For two sequences of bytes, seq1 - and seq2 with lengths len1 and len2, Adler-32 checksums were calculated for - each, adler1 and adler2. adler32_combine() returns the Adler-32 checksum of - seq1 and seq2 concatenated, requiring only adler1, adler2, and len2. -*/ - -ZEXTERN uLong ZEXPORT crc32 OF((uLong crc, const Bytef *buf, uInt len)); -/* - Update a running CRC-32 with the bytes buf[0..len-1] and return the - updated CRC-32. If buf is NULL, this function returns the required initial - value for the for the crc. Pre- and post-conditioning (one's complement) is - performed within this function so it shouldn't be done by the application. - Usage example: - - uLong crc = crc32(0L, Z_NULL, 0); - - while (read_buffer(buffer, length) != EOF) { - crc = crc32(crc, buffer, length); - } - if (crc != original_crc) error(); -*/ - -ZEXTERN uLong ZEXPORT crc32_combine OF((uLong crc1, uLong crc2, z_off_t len2)); - -/* - Combine two CRC-32 check values into one. For two sequences of bytes, - seq1 and seq2 with lengths len1 and len2, CRC-32 check values were - calculated for each, crc1 and crc2. crc32_combine() returns the CRC-32 - check value of seq1 and seq2 concatenated, requiring only crc1, crc2, and - len2. -*/ - - - /* various hacks, don't look :) */ - -/* deflateInit and inflateInit are macros to allow checking the zlib version - * and the compiler's view of z_stream: - */ -ZEXTERN int ZEXPORT deflateInit_ OF((z_streamp strm, int level, - const char *version, int stream_size)); -ZEXTERN int ZEXPORT inflateInit_ OF((z_streamp strm, - const char *version, int stream_size)); -ZEXTERN int ZEXPORT deflateInit2_ OF((z_streamp strm, int level, int method, - int windowBits, int memLevel, - int strategy, const char *version, - int stream_size)); -ZEXTERN int ZEXPORT inflateInit2_ OF((z_streamp strm, int windowBits, - const char *version, int stream_size)); -ZEXTERN int ZEXPORT inflateBackInit_ OF((z_streamp strm, int windowBits, - unsigned char FAR *window, - const char *version, - int stream_size)); - -#define deflateInit(strm, level) \ - deflateInit_((strm), (level), ZLIB_VERSION, sizeof(z_stream)) -#define inflateInit(strm) \ - inflateInit_((strm), ZLIB_VERSION, sizeof(z_stream)) -#define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \ - deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\ - (strategy), ZLIB_VERSION, sizeof(z_stream)) -#define inflateInit2(strm, windowBits) \ - inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream)) -#define inflateBackInit(strm, windowBits, window) \ - inflateBackInit_((strm), (windowBits), (window), \ - ZLIB_VERSION, sizeof(z_stream)) - - -#if !defined(ZUTIL_H) && !defined(NO_DUMMY_DECL) - struct internal_state {int dummy;}; /* hack for buggy compilers */ -#endif - -ZEXTERN const char * ZEXPORT zError OF((int)); -ZEXTERN int ZEXPORT inflateSyncPoint OF((z_streamp z)); -ZEXTERN const uLongf * ZEXPORT get_crc_table OF((void)); - -#ifdef __cplusplus -} -#endif - -#endif /* ZLIB_H */