Azure IoT / iothub_mqtt_transport

Microsoft Azure IoTHub client MQTT transport

Dependents:   STM32F746_iothub_client_sample_mqtt FXOS8700CQ_To_Azure_IoT f767zi_mqtt FXOS8700CQ_To_Azure_IoT ... more

iothubtransportmqtt.c@20:594780be216d, 2017-03-24 (annotated)

Committer:
AzureIoTClient
Date:
Fri Mar 24 16:35:20 2017 -0700
Revision:
20:594780be216d
Parent:
19:f87dfe76bc70
Child:
28:0cd355c3294e
1.1.10

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Azure.IoT Build 0:5e72a75c31b8 1 // Copyright (c) Microsoft. All rights reserved.
Azure.IoT Build 0:5e72a75c31b8 2 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
Azure.IoT Build 0:5e72a75c31b8 3
Azure.IoT Build 0:5e72a75c31b8 4 #include <stdlib.h>
Azure.IoT Build 0:5e72a75c31b8 5 #include "iothubtransportmqtt.h"
AzureIoTClient 11:31ebaeb51e1e 6 #include "azure_c_shared_utility/xio.h"
Azure.IoT Build 1:f2e563755d91 7 #include "azure_c_shared_utility/tlsio.h"
Azure.IoT Build 1:f2e563755d91 8 #include "azure_c_shared_utility/platform.h"
AzureIoTClient 11:31ebaeb51e1e 9 #include "iothubtransport_mqtt_common.h"
AzureIoTClient 7:7fdd306e6224 10
AzureIoTClient 20:594780be216d 11 static XIO_HANDLE getIoTransportProvider(const char* fully_qualified_name, const MQTT_TRANSPORT_PROXY_OPTIONS* mqtt_transport_proxy_options)
AzureIoTClient 6:16875b609849 12 {
AzureIoTClient 11:31ebaeb51e1e 13 XIO_HANDLE result;
AzureIoTClient 20:594780be216d 14
AzureIoTClient 20:594780be216d 15 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_01_001: [ `getIoTransportProvider` shall obtain the TLS IO interface handle by calling `platform_get_default_tlsio`. ]*/
AzureIoTClient 11:31ebaeb51e1e 16 const IO_INTERFACE_DESCRIPTION* io_interface_description = platform_get_default_tlsio();
AzureIoTClient 20:594780be216d 17 (void)mqtt_transport_proxy_options;
AzureIoTClient 20:594780be216d 18
AzureIoTClient 11:31ebaeb51e1e 19 if (io_interface_description == NULL)
AzureIoTClient 4:e472f5ce3473 20 {
AzureIoTClient 20:594780be216d 21 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_07_013: [ If `platform_get_default_tlsio` returns NULL, `getIoTransportProvider` shall return NULL. ] */
AzureIoTClient 11:31ebaeb51e1e 22 LogError("Failure constructing the provider interface");
AzureIoTClient 4:e472f5ce3473 23 result = NULL;
AzureIoTClient 4:e472f5ce3473 24 }
AzureIoTClient 4:e472f5ce3473 25 else
AzureIoTClient 4:e472f5ce3473 26 {
AzureIoTClient 20:594780be216d 27 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_01_002: [ The TLS IO parameters shall be a `TLSIO_CONFIG` structure filled as below: ]*/
AzureIoTClient 11:31ebaeb51e1e 28 TLSIO_CONFIG tls_io_config;
AzureIoTClient 20:594780be216d 29
AzureIoTClient 20:594780be216d 30 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_01_003: [ - `hostname` shall be set to `fully_qualified_name`. ]*/
AzureIoTClient 20:594780be216d 31 tls_io_config.hostname = fully_qualified_name;
AzureIoTClient 20:594780be216d 32 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_01_004: [ - `port` shall be set to 8883. ]*/
AzureIoTClient 11:31ebaeb51e1e 33 tls_io_config.port = 8883;
AzureIoTClient 20:594780be216d 34 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_01_005: [ - `underlying_io_interface` shall be set to NULL. ]*/
AzureIoTClient 19:f87dfe76bc70 35 tls_io_config.underlying_io_interface = NULL;
AzureIoTClient 20:594780be216d 36 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_01_006: [ - `underlying_io_parameters` shall be set to NULL. ]*/
AzureIoTClient 19:f87dfe76bc70 37 tls_io_config.underlying_io_parameters = NULL;
AzureIoTClient 20:594780be216d 38
AzureIoTClient 20:594780be216d 39 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_07_012: [ `getIoTransportProvider` shall return the `XIO_HANDLE` returned by `xio_create`. ] */
AzureIoTClient 11:31ebaeb51e1e 40 result = xio_create(io_interface_description, &tls_io_config);
AzureIoTClient 2:9db4da50abaa 41 }
AzureIoTClient 4:e472f5ce3473 42 return result;
Azure.IoT Build 0:5e72a75c31b8 43 }
Azure.IoT Build 0:5e72a75c31b8 44
AzureIoTClient 4:e472f5ce3473 45 static TRANSPORT_LL_HANDLE IoTHubTransportMqtt_Create(const IOTHUBTRANSPORT_CONFIG* config)
Azure.IoT Build 0:5e72a75c31b8 46 {
AzureIoTClient 11:31ebaeb51e1e 47 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_07_001: [IoTHubTransportMqtt_Create shall create a TRANSPORT_LL_HANDLE by calling into the IoTHubMqttAbstract_Create function.] */
AzureIoTClient 11:31ebaeb51e1e 48 return IoTHubTransport_MQTT_Common_Create(config, getIoTransportProvider);
Azure.IoT Build 0:5e72a75c31b8 49 }
Azure.IoT Build 0:5e72a75c31b8 50
AzureIoTClient 4:e472f5ce3473 51 static void IoTHubTransportMqtt_Destroy(TRANSPORT_LL_HANDLE handle)
Azure.IoT Build 0:5e72a75c31b8 52 {
AzureIoTClient 11:31ebaeb51e1e 53 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_07_002: [ IoTHubTransportMqtt_Destroy shall destroy the TRANSPORT_LL_HANDLE by calling into the IoTHubMqttAbstract_Destroy function. ] */
AzureIoTClient 11:31ebaeb51e1e 54 IoTHubTransport_MQTT_Common_Destroy(handle);
Azure.IoT Build 0:5e72a75c31b8 55 }
Azure.IoT Build 0:5e72a75c31b8 56
AzureIoTClient 4:e472f5ce3473 57 static int IoTHubTransportMqtt_Subscribe(IOTHUB_DEVICE_HANDLE handle)
Azure.IoT Build 0:5e72a75c31b8 58 {
AzureIoTClient 11:31ebaeb51e1e 59 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_07_005: [ IoTHubTransportMqtt_Subscribe shall subscribe the TRANSPORT_LL_HANDLE by calling into the IoTHubMqttAbstract_Subscribe function. ] */
AzureIoTClient 11:31ebaeb51e1e 60 return IoTHubTransport_MQTT_Common_Subscribe(handle);
Azure.IoT Build 0:5e72a75c31b8 61 }
Azure.IoT Build 0:5e72a75c31b8 62
AzureIoTClient 4:e472f5ce3473 63 static void IoTHubTransportMqtt_Unsubscribe(IOTHUB_DEVICE_HANDLE handle)
Azure.IoT Build 0:5e72a75c31b8 64 {
AzureIoTClient 11:31ebaeb51e1e 65 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_07_006: [ IoTHubTransportMqtt_Unsubscribe shall unsubscribe the TRANSPORT_LL_HANDLE by calling into the IoTHubMqttAbstract_Unsubscribe function. ] */
AzureIoTClient 11:31ebaeb51e1e 66 IoTHubTransport_MQTT_Common_Unsubscribe(handle);
Azure.IoT Build 0:5e72a75c31b8 67 }
Azure.IoT Build 0:5e72a75c31b8 68
AzureIoTClient 14:4dc2b011be33 69 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_07_026: [ IoTHubTransportMqtt_Subscribe_DeviceMethod shall subscribe the TRANSPORT_LL_HANDLE by calling into the IoTHubMqttAbstract_Subscribe_DeviceMethod function. ] */
AzureIoTClient 12:658ca6865de2 70 static int IoTHubTransportMqtt_Subscribe_DeviceMethod(IOTHUB_DEVICE_HANDLE handle)
AzureIoTClient 12:658ca6865de2 71 {
AzureIoTClient 12:658ca6865de2 72 return IoTHubTransport_MQTT_Common_Subscribe_DeviceMethod(handle);
AzureIoTClient 12:658ca6865de2 73 }
AzureIoTClient 12:658ca6865de2 74
AzureIoTClient 14:4dc2b011be33 75 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_07_027: [ IoTHubTransportMqtt_Unsubscribe_DeviceMethod shall call into the IoTHubMqttAbstract_Unsubscribe_DeviceMethod function. ] */
AzureIoTClient 12:658ca6865de2 76 static void IoTHubTransportMqtt_Unsubscribe_DeviceMethod(IOTHUB_DEVICE_HANDLE handle)
AzureIoTClient 12:658ca6865de2 77 {
AzureIoTClient 12:658ca6865de2 78 IoTHubTransport_MQTT_Common_Unsubscribe_DeviceMethod(handle);
AzureIoTClient 12:658ca6865de2 79 }
AzureIoTClient 12:658ca6865de2 80
AzureIoTClient 14:4dc2b011be33 81 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_07_025: [ IoTHubTransportMqtt_Subscribe_DeviceTwin shall call into the IoTHubMqttAbstract_Subscribe_DeviceTwin function. ] */
AzureIoTClient 12:658ca6865de2 82 static int IoTHubTransportMqtt_Subscribe_DeviceTwin(IOTHUB_DEVICE_HANDLE handle)
AzureIoTClient 12:658ca6865de2 83 {
AzureIoTClient 12:658ca6865de2 84 return IoTHubTransport_MQTT_Common_Subscribe_DeviceTwin(handle);
AzureIoTClient 12:658ca6865de2 85 }
AzureIoTClient 12:658ca6865de2 86
AzureIoTClient 14:4dc2b011be33 87 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_07_024: [ IoTHubTransportMqtt_Unsubscribe_DeviceTwin shall shall call into the IoTHubMqttAbstract_Unsubscribe_DeviceTwin function. ] */
AzureIoTClient 12:658ca6865de2 88 static void IoTHubTransportMqtt_Unsubscribe_DeviceTwin(IOTHUB_DEVICE_HANDLE handle)
AzureIoTClient 12:658ca6865de2 89 {
AzureIoTClient 12:658ca6865de2 90 IoTHubTransport_MQTT_Common_Unsubscribe_DeviceTwin(handle);
AzureIoTClient 12:658ca6865de2 91 }
AzureIoTClient 12:658ca6865de2 92
AzureIoTClient 14:4dc2b011be33 93 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_07_023: [ IoTHubTransportMqtt_DeviceMethod_Response shall call into the IoTHubMqttAbstract_DeviceMethod_Response function. ] */
AzureIoTClient 14:4dc2b011be33 94 static int IoTHubTransportMqtt_DeviceMethod_Response(IOTHUB_DEVICE_HANDLE handle, METHOD_HANDLE methodId, const unsigned char* response, size_t response_size, int status_response)
AzureIoTClient 14:4dc2b011be33 95 {
AzureIoTClient 14:4dc2b011be33 96 return IoTHubTransport_MQTT_Common_DeviceMethod_Response(handle, methodId, response, response_size, status_response);
AzureIoTClient 14:4dc2b011be33 97 }
AzureIoTClient 14:4dc2b011be33 98
AzureIoTClient 19:f87dfe76bc70 99 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_10_001: [IoTHubTransportMqtt_SendMessageDisposition shall send the message disposition by calling into the IoTHubMqttAbstract_SendMessageDisposition function.] */
AzureIoTClient 19:f87dfe76bc70 100 static IOTHUB_CLIENT_RESULT IoTHubTransportMqtt_SendMessageDisposition(MESSAGE_CALLBACK_INFO* message_data, IOTHUBMESSAGE_DISPOSITION_RESULT disposition)
AzureIoTClient 19:f87dfe76bc70 101 {
AzureIoTClient 19:f87dfe76bc70 102 return IoTHubTransport_MQTT_Common_SendMessageDisposition(message_data, disposition);
AzureIoTClient 19:f87dfe76bc70 103 }
AzureIoTClient 19:f87dfe76bc70 104
AzureIoTClient 12:658ca6865de2 105 static IOTHUB_PROCESS_ITEM_RESULT IoTHubTransportMqtt_ProcessItem(TRANSPORT_LL_HANDLE handle, IOTHUB_IDENTITY_TYPE item_type, IOTHUB_IDENTITY_INFO* iothub_item)
AzureIoTClient 12:658ca6865de2 106 {
AzureIoTClient 12:658ca6865de2 107 return IoTHubTransport_MQTT_Common_ProcessItem(handle, item_type, iothub_item);
AzureIoTClient 12:658ca6865de2 108 }
AzureIoTClient 12:658ca6865de2 109
AzureIoTClient 12:658ca6865de2 110 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_07_054: [ IoTHubTransportMqtt_DoWork shall subscribe to the Notification and get_state Topics if they are defined. ] */
AzureIoTClient 4:e472f5ce3473 111 static void IoTHubTransportMqtt_DoWork(TRANSPORT_LL_HANDLE handle, IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle)
Azure.IoT Build 0:5e72a75c31b8 112 {
AzureIoTClient 11:31ebaeb51e1e 113 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_07_007: [ IoTHubTransportMqtt_DoWork shall call into the IoTHubMqttAbstract_DoWork function. ] */
AzureIoTClient 11:31ebaeb51e1e 114 IoTHubTransport_MQTT_Common_DoWork(handle, iotHubClientHandle);
Azure.IoT Build 0:5e72a75c31b8 115 }
Azure.IoT Build 0:5e72a75c31b8 116
AzureIoTClient 12:658ca6865de2 117 static int IoTHubTransportMqtt_SetRetryPolicy(TRANSPORT_LL_HANDLE handle, IOTHUB_CLIENT_RETRY_POLICY retryPolicy, size_t retryTimeoutLimitInSeconds)
AzureIoTClient 12:658ca6865de2 118 {
AzureIoTClient 12:658ca6865de2 119 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_25_012: [** IoTHubTransportMqtt_SetRetryPolicy shall call into the IoTHubMqttAbstract_SetRetryPolicy function. ] */
AzureIoTClient 12:658ca6865de2 120 return IoTHubTransport_MQTT_Common_SetRetryPolicy(handle, retryPolicy, retryTimeoutLimitInSeconds);
AzureIoTClient 12:658ca6865de2 121 }
AzureIoTClient 12:658ca6865de2 122
AzureIoTClient 4:e472f5ce3473 123 static IOTHUB_CLIENT_RESULT IoTHubTransportMqtt_GetSendStatus(IOTHUB_DEVICE_HANDLE handle, IOTHUB_CLIENT_STATUS *iotHubClientStatus)
Azure.IoT Build 0:5e72a75c31b8 124 {
AzureIoTClient 11:31ebaeb51e1e 125 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_07_008: [ IoTHubTransportMqtt_GetSendStatus shall get the send status by calling into the IoTHubMqttAbstract_GetSendStatus function. ] */
AzureIoTClient 11:31ebaeb51e1e 126 return IoTHubTransport_MQTT_Common_GetSendStatus(handle, iotHubClientStatus);
Azure.IoT Build 0:5e72a75c31b8 127 }
Azure.IoT Build 0:5e72a75c31b8 128
AzureIoTClient 4:e472f5ce3473 129 static IOTHUB_CLIENT_RESULT IoTHubTransportMqtt_SetOption(TRANSPORT_LL_HANDLE handle, const char* option, const void* value)
Azure.IoT Build 0:5e72a75c31b8 130 {
AzureIoTClient 11:31ebaeb51e1e 131 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_07_009: [ IoTHubTransportMqtt_SetOption shall set the options by calling into the IoTHubMqttAbstract_SetOption function. ] */
AzureIoTClient 11:31ebaeb51e1e 132 return IoTHubTransport_MQTT_Common_SetOption(handle, option, value);
Azure.IoT Build 0:5e72a75c31b8 133 }
Azure.IoT Build 0:5e72a75c31b8 134
AzureIoTClient 4:e472f5ce3473 135 static IOTHUB_DEVICE_HANDLE IoTHubTransportMqtt_Register(TRANSPORT_LL_HANDLE handle, const IOTHUB_DEVICE_CONFIG* device, IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, PDLIST_ENTRY waitingToSend)
Azure.IoT Build 0:5e72a75c31b8 136 {
AzureIoTClient 11:31ebaeb51e1e 137 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_07_003: [ IoTHubTransportMqtt_Register shall register the TRANSPORT_LL_HANDLE by calling into the IoTHubMqttAbstract_Register function. ] */
AzureIoTClient 11:31ebaeb51e1e 138 return IoTHubTransport_MQTT_Common_Register(handle, device, iotHubClientHandle, waitingToSend);
Azure.IoT Build 0:5e72a75c31b8 139 }
Azure.IoT Build 0:5e72a75c31b8 140
AzureIoTClient 4:e472f5ce3473 141 static void IoTHubTransportMqtt_Unregister(IOTHUB_DEVICE_HANDLE deviceHandle)
Azure.IoT Build 0:5e72a75c31b8 142 {
AzureIoTClient 11:31ebaeb51e1e 143 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_07_004: [ IoTHubTransportMqtt_Unregister shall register the TRANSPORT_LL_HANDLE by calling into the IoTHubMqttAbstract_Unregister function. ] */
AzureIoTClient 11:31ebaeb51e1e 144 IoTHubTransport_MQTT_Common_Unregister(deviceHandle);
Azure.IoT Build 0:5e72a75c31b8 145 }
Azure.IoT Build 0:5e72a75c31b8 146
AzureIoTClient 4:e472f5ce3473 147 static STRING_HANDLE IoTHubTransportMqtt_GetHostname(TRANSPORT_LL_HANDLE handle)
AzureIoTClient 4:e472f5ce3473 148 {
AzureIoTClient 11:31ebaeb51e1e 149 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_07_010: [ IoTHubTransportMqtt_GetHostname shall get the hostname by calling into the IoTHubMqttAbstract_GetHostname function. ] */
AzureIoTClient 11:31ebaeb51e1e 150 return IoTHubTransport_MQTT_Common_GetHostname(handle);
AzureIoTClient 4:e472f5ce3473 151 }
AzureIoTClient 4:e472f5ce3473 152
AzureIoTClient 12:658ca6865de2 153 static TRANSPORT_PROVIDER myfunc =
AzureIoTClient 12:658ca6865de2 154 {
AzureIoTClient 19:f87dfe76bc70 155 IoTHubTransportMqtt_SendMessageDisposition, /*pfIotHubTransport_SendMessageDisposition IoTHubTransport_SendMessageDisposition;*/
AzureIoTClient 12:658ca6865de2 156 IoTHubTransportMqtt_Subscribe_DeviceMethod, /*pfIoTHubTransport_Subscribe_DeviceMethod IoTHubTransport_Subscribe_DeviceMethod;*/
AzureIoTClient 12:658ca6865de2 157 IoTHubTransportMqtt_Unsubscribe_DeviceMethod, /*pfIoTHubTransport_Unsubscribe_DeviceMethod IoTHubTransport_Unsubscribe_DeviceMethod;*/
AzureIoTClient 14:4dc2b011be33 158 IoTHubTransportMqtt_DeviceMethod_Response, /*pfIoTHubTransport_DeviceMethod_Response IoTHubTransport_DeviceMethod_Response;*/
AzureIoTClient 12:658ca6865de2 159 IoTHubTransportMqtt_Subscribe_DeviceTwin, /*pfIoTHubTransport_Subscribe_DeviceTwin IoTHubTransport_Subscribe_DeviceTwin;*/
AzureIoTClient 12:658ca6865de2 160 IoTHubTransportMqtt_Unsubscribe_DeviceTwin, /*pfIoTHubTransport_Unsubscribe_DeviceTwin IoTHubTransport_Unsubscribe_DeviceTwin;*/
AzureIoTClient 12:658ca6865de2 161 IoTHubTransportMqtt_ProcessItem, /*pfIoTHubTransport_ProcessItem IoTHubTransport_ProcessItem;*/
AzureIoTClient 12:658ca6865de2 162 IoTHubTransportMqtt_GetHostname, /*pfIoTHubTransport_GetHostname IoTHubTransport_GetHostname;*/
AzureIoTClient 12:658ca6865de2 163 IoTHubTransportMqtt_SetOption, /*pfIoTHubTransport_SetOption IoTHubTransport_SetOption;*/
AzureIoTClient 12:658ca6865de2 164 IoTHubTransportMqtt_Create, /*pfIoTHubTransport_Create IoTHubTransport_Create;*/
AzureIoTClient 12:658ca6865de2 165 IoTHubTransportMqtt_Destroy, /*pfIoTHubTransport_Destroy IoTHubTransport_Destroy;*/
AzureIoTClient 12:658ca6865de2 166 IoTHubTransportMqtt_Register, /*pfIotHubTransport_Register IoTHubTransport_Register;*/
AzureIoTClient 12:658ca6865de2 167 IoTHubTransportMqtt_Unregister, /*pfIotHubTransport_Unregister IoTHubTransport_Unegister;*/
AzureIoTClient 12:658ca6865de2 168 IoTHubTransportMqtt_Subscribe, /*pfIoTHubTransport_Subscribe IoTHubTransport_Subscribe;*/
AzureIoTClient 12:658ca6865de2 169 IoTHubTransportMqtt_Unsubscribe, /*pfIoTHubTransport_Unsubscribe IoTHubTransport_Unsubscribe;*/
AzureIoTClient 12:658ca6865de2 170 IoTHubTransportMqtt_DoWork, /*pfIoTHubTransport_DoWork IoTHubTransport_DoWork;*/
AzureIoTClient 12:658ca6865de2 171 IoTHubTransportMqtt_SetRetryPolicy, /*pfIoTHubTransport_DoWork IoTHubTransport_SetRetryPolicy;*/
AzureIoTClient 12:658ca6865de2 172 IoTHubTransportMqtt_GetSendStatus /*pfIoTHubTransport_GetSendStatus IoTHubTransport_GetSendStatus;*/
Azure.IoT Build 0:5e72a75c31b8 173 };
Azure.IoT Build 0:5e72a75c31b8 174
AzureIoTClient 12:658ca6865de2 175 /* Codes_SRS_IOTHUB_MQTT_TRANSPORT_07_022: [This function shall return a pointer to a structure of type TRANSPORT_PROVIDER */
AzureIoTClient 12:658ca6865de2 176 extern const TRANSPORT_PROVIDER* MQTT_Protocol(void)
Azure.IoT Build 0:5e72a75c31b8 177 {
AzureIoTClient 4:e472f5ce3473 178 return &myfunc;
Azure.IoT Build 0:5e72a75c31b8 179 }