Microsoft Azure IoTHub client libraries
Dependents: sht15_remote_monitoring RobotArmDemo iothub_client_sample_amqp f767zi_mqtt ... more
This library implements the Microsoft Azure IoTHub client library. The code is replicated from https://github.com/Azure/azure-iot-sdks
iothub_client_options.h
- Committer:
- AzureIoTClient
- Date:
- 2018-06-26
- Revision:
- 89:a2ed767a532e
- Parent:
- 87:127f440f845b
- Child:
- 91:bbf806070c5f
File content as of revision 89:a2ed767a532e:
// Copyright (c) Microsoft. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. #ifndef IOTHUB_CLIENT_OPTIONS_H #define IOTHUB_CLIENT_OPTIONS_H #include "azure_c_shared_utility/const_defines.h" #ifdef __cplusplus extern "C" { #endif typedef struct IOTHUB_PROXY_OPTIONS_TAG { const char* host_address; const char* username; const char* password; } IOTHUB_PROXY_OPTIONS; static STATIC_VAR_UNUSED const char* OPTION_LOG_TRACE = "logtrace"; static STATIC_VAR_UNUSED const char* OPTION_X509_CERT = "x509certificate"; static STATIC_VAR_UNUSED const char* OPTION_X509_PRIVATE_KEY = "x509privatekey"; static STATIC_VAR_UNUSED const char* OPTION_KEEP_ALIVE = "keepalive"; static STATIC_VAR_UNUSED const char* OPTION_CONNECTION_TIMEOUT = "connect_timeout"; static STATIC_VAR_UNUSED const char* OPTION_PROXY_HOST = "proxy_address"; static STATIC_VAR_UNUSED const char* OPTION_PROXY_USERNAME = "proxy_username"; static STATIC_VAR_UNUSED const char* OPTION_PROXY_PASSWORD = "proxy_password"; static STATIC_VAR_UNUSED const char* OPTION_SAS_TOKEN_LIFETIME = "sas_token_lifetime"; static STATIC_VAR_UNUSED const char* OPTION_SAS_TOKEN_REFRESH_TIME = "sas_token_refresh_time"; static STATIC_VAR_UNUSED const char* OPTION_CBS_REQUEST_TIMEOUT = "cbs_request_timeout"; static STATIC_VAR_UNUSED const char* OPTION_MIN_POLLING_TIME = "MinimumPollingTime"; static STATIC_VAR_UNUSED const char* OPTION_BATCHING = "Batching"; static STATIC_VAR_UNUSED const char* OPTION_MESSAGE_TIMEOUT = "messageTimeout"; static STATIC_VAR_UNUSED const char* OPTION_BLOB_UPLOAD_TIMEOUT_SECS = "blob_upload_timeout_secs"; static STATIC_VAR_UNUSED const char* OPTION_PRODUCT_INFO = "product_info"; /* * @brief Turns on automatic URL encoding of message properties + system properties. Only valid for use with MQTT Transport */ static STATIC_VAR_UNUSED const char* OPTION_AUTO_URL_ENCODE_DECODE = "auto_url_encode_decode"; /* * @brief Informs the service of what is the maximum period the client will wait for a keep-alive message from the service. * The service must send keep-alives before this timeout is reached, otherwise the client will trigger its re-connection logic. * Setting this option to a low value results in more aggressive/responsive re-connection by the client. * The default value for this option is 240 seconds, and the minimum allowed is usually 5 seconds. * To virtually disable the keep-alives from the service (and consequently the keep-alive timeout control on the client-side), set this option to a high value (e.g., UINT_MAX). */ static STATIC_VAR_UNUSED const char* OPTION_SERVICE_SIDE_KEEP_ALIVE_FREQ_SECS = "svc2cl_keep_alive_timeout_secs"; /* DEPRECATED:: OPTION_C2D_KEEP_ALIVE_FREQ_SECS is DEPRECATED! Use OPTION_SERVICE_SIDE_KEEP_ALIVE_FREQ_SECS, but OPTION_C2D_KEEP_ALIVE_FREQ_SECS legacy variable kept for back-compat. */ static STATIC_VAR_UNUSED const char* OPTION_C2D_KEEP_ALIVE_FREQ_SECS = "c2d_keep_alive_freq_secs"; /* * @brief Ratio to be used for client side pings in AMQP protocol. * The client must use this ratio to send keep-alives before service side remote idle timeout is reached, otherwise the service will disconnect the client. * The default value for this option is 1/2 of the remote idle value sent by the service. * For AMQP remote idle set to 4 minutes, default client ping will be 2 minutes. For AMQP remote idle set to 25 minutes configured via per Hub basis, the default ping will be 12.5 minutes. */ static STATIC_VAR_UNUSED const char* OPTION_REMOTE_IDLE_TIMEOUT_RATIO = "cl2svc_keep_alive_send_ratio"; //diagnostic sampling percentage value, [0-100] static STATIC_VAR_UNUSED const char* OPTION_DIAGNOSTIC_SAMPLING_PERCENTAGE = "diag_sampling_percentage"; #ifdef __cplusplus } #endif #endif /* IOTHUB_CLIENT_OPTIONS_H */