Azure IoT / iothub_amqp_transport

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   sht15_remote_monitoring RobotArmDemo iothub_client_sample_amqp iothub_client_sample_amqp ... more

iothubtransport_amqp_common.c@41:71c01aa3df1a, 2017-09-11 (annotated)

Committer:
AzureIoTClient
Date:
Mon Sep 11 09:22:16 2017 -0700
Revision:
41:71c01aa3df1a
Parent:
39:e98d5df6dc74
Child:
42:c2eaa912a28c
1.1.23

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AzureIoTClient 25:63f7d371c030 1 // Copyright (c) Microsoft. All rights reserved.
AzureIoTClient 25:63f7d371c030 2 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
AzureIoTClient 25:63f7d371c030 3
AzureIoTClient 25:63f7d371c030 4 #include <stdlib.h>
AzureIoTClient 25:63f7d371c030 5 #include <stdint.h>
AzureIoTClient 31:adadaef857c1 6 #include <stdbool.h>
AzureIoTClient 25:63f7d371c030 7 #include <time.h>
AzureIoTClient 25:63f7d371c030 8 #include <limits.h>
AzureIoTClient 29:7e8852b14e3b 9 #include "azure_c_shared_utility/optimize_size.h"
AzureIoTClient 25:63f7d371c030 10 #include "azure_c_shared_utility/agenttime.h"
AzureIoTClient 25:63f7d371c030 11 #include "azure_c_shared_utility/gballoc.h"
AzureIoTClient 25:63f7d371c030 12 #include "azure_c_shared_utility/crt_abstractions.h"
AzureIoTClient 30:20a85b733111 13 #include "azure_c_shared_utility/singlylinkedlist.h"
AzureIoTClient 25:63f7d371c030 14 #include "azure_c_shared_utility/doublylinkedlist.h"
AzureIoTClient 25:63f7d371c030 15 #include "azure_c_shared_utility/xlogging.h"
AzureIoTClient 25:63f7d371c030 16 #include "azure_c_shared_utility/platform.h"
AzureIoTClient 25:63f7d371c030 17 #include "azure_c_shared_utility/strings.h"
AzureIoTClient 25:63f7d371c030 18 #include "azure_c_shared_utility/urlencode.h"
AzureIoTClient 25:63f7d371c030 19 #include "azure_c_shared_utility/tlsio.h"
AzureIoTClient 30:20a85b733111 20 #include "azure_c_shared_utility/optionhandler.h"
AzureIoTClient 31:adadaef857c1 21 #include "azure_c_shared_utility/shared_util_options.h"
AzureIoTClient 31:adadaef857c1 22 #include "azure_c_shared_utility/macro_utils.h"
AzureIoTClient 25:63f7d371c030 23
AzureIoTClient 25:63f7d371c030 24 #include "azure_uamqp_c/cbs.h"
AzureIoTClient 30:20a85b733111 25 #include "azure_uamqp_c/session.h"
AzureIoTClient 25:63f7d371c030 26 #include "azure_uamqp_c/message.h"
AzureIoTClient 25:63f7d371c030 27 #include "azure_uamqp_c/messaging.h"
AzureIoTClient 25:63f7d371c030 28
AzureIoTClient 25:63f7d371c030 29 #include "iothub_client_ll.h"
AzureIoTClient 25:63f7d371c030 30 #include "iothub_client_options.h"
AzureIoTClient 25:63f7d371c030 31 #include "iothub_client_private.h"
AzureIoTClient 25:63f7d371c030 32 #ifdef WIP_C2D_METHODS_AMQP /* This feature is WIP, do not use yet */
AzureIoTClient 25:63f7d371c030 33 #include "iothubtransportamqp_methods.h"
AzureIoTClient 25:63f7d371c030 34 #endif
AzureIoTClient 32:babfd49032ff 35 #include "iothub_client_retry_control.h"
AzureIoTClient 25:63f7d371c030 36 #include "iothubtransport_amqp_common.h"
AzureIoTClient 30:20a85b733111 37 #include "iothubtransport_amqp_connection.h"
AzureIoTClient 30:20a85b733111 38 #include "iothubtransport_amqp_device.h"
AzureIoTClient 25:63f7d371c030 39 #include "iothub_client_version.h"
AzureIoTClient 25:63f7d371c030 40
AzureIoTClient 30:20a85b733111 41 #define RESULT_OK 0
AzureIoTClient 30:20a85b733111 42 #define INDEFINITE_TIME ((time_t)(-1))
AzureIoTClient 30:20a85b733111 43 #define DEFAULT_CBS_REQUEST_TIMEOUT_SECS 30
AzureIoTClient 30:20a85b733111 44 #define DEFAULT_DEVICE_STATE_CHANGE_TIMEOUT_SECS 60
AzureIoTClient 30:20a85b733111 45 #define DEFAULT_EVENT_SEND_TIMEOUT_SECS 300
AzureIoTClient 30:20a85b733111 46 #define DEFAULT_SAS_TOKEN_LIFETIME_SECS 3600
AzureIoTClient 30:20a85b733111 47 #define DEFAULT_SAS_TOKEN_REFRESH_TIME_SECS 1800
AzureIoTClient 30:20a85b733111 48 #define MAX_NUMBER_OF_DEVICE_FAILURES 5
AzureIoTClient 37:abd16824f63b 49 #define DEFAULT_C2D_KEEP_ALIVE_FREQ_SECS 240
AzureIoTClient 32:babfd49032ff 50 #define DEFAULT_RETRY_POLICY IOTHUB_CLIENT_RETRY_EXPONENTIAL_BACKOFF_WITH_JITTER
AzureIoTClient 32:babfd49032ff 51 // DEFAULT_MAX_RETRY_TIME_IN_SECS = 0 means infinite retry.
AzureIoTClient 32:babfd49032ff 52 #define DEFAULT_MAX_RETRY_TIME_IN_SECS 0
AzureIoTClient 25:63f7d371c030 53
AzureIoTClient 30:20a85b733111 54 // ---------- Data Definitions ---------- //
AzureIoTClient 25:63f7d371c030 55
AzureIoTClient 30:20a85b733111 56 typedef enum AMQP_TRANSPORT_AUTHENTICATION_MODE_TAG
AzureIoTClient 25:63f7d371c030 57 {
AzureIoTClient 34:51d158b409d2 58 AMQP_TRANSPORT_AUTHENTICATION_MODE_NOT_SET,
AzureIoTClient 34:51d158b409d2 59 AMQP_TRANSPORT_AUTHENTICATION_MODE_CBS,
AzureIoTClient 34:51d158b409d2 60 AMQP_TRANSPORT_AUTHENTICATION_MODE_X509
AzureIoTClient 30:20a85b733111 61 } AMQP_TRANSPORT_AUTHENTICATION_MODE;
AzureIoTClient 39:e98d5df6dc74 62
AzureIoTClient 32:babfd49032ff 63
AzureIoTClient 32:babfd49032ff 64 #define AMQP_TRANSPORT_STATE_STRINGS \
AzureIoTClient 34:51d158b409d2 65 AMQP_TRANSPORT_STATE_NOT_CONNECTED, \
AzureIoTClient 34:51d158b409d2 66 AMQP_TRANSPORT_STATE_CONNECTING, \
AzureIoTClient 34:51d158b409d2 67 AMQP_TRANSPORT_STATE_CONNECTED, \
AzureIoTClient 34:51d158b409d2 68 AMQP_TRANSPORT_STATE_RECONNECTION_REQUIRED, \
AzureIoTClient 34:51d158b409d2 69 AMQP_TRANSPORT_STATE_READY_FOR_RECONNECTION, \
AzureIoTClient 34:51d158b409d2 70 AMQP_TRANSPORT_STATE_RECONNECTING, \
AzureIoTClient 34:51d158b409d2 71 AMQP_TRANSPORT_STATE_BEING_DESTROYED
AzureIoTClient 32:babfd49032ff 72
AzureIoTClient 32:babfd49032ff 73 DEFINE_LOCAL_ENUM(AMQP_TRANSPORT_STATE, AMQP_TRANSPORT_STATE_STRINGS);
AzureIoTClient 32:babfd49032ff 74
AzureIoTClient 30:20a85b733111 75 typedef struct AMQP_TRANSPORT_INSTANCE_TAG
AzureIoTClient 30:20a85b733111 76 {
AzureIoTClient 30:20a85b733111 77 STRING_HANDLE iothub_host_fqdn; // FQDN of the IoT Hub.
AzureIoTClient 30:20a85b733111 78 XIO_HANDLE tls_io; // TSL I/O transport.
AzureIoTClient 30:20a85b733111 79 AMQP_GET_IO_TRANSPORT underlying_io_transport_provider; // Pointer to the function that creates the TLS I/O (internal use only).
AzureIoTClient 34:51d158b409d2 80 AMQP_CONNECTION_HANDLE amqp_connection; // Base amqp connection with service.
AzureIoTClient 34:51d158b409d2 81 AMQP_CONNECTION_STATE amqp_connection_state; // Current state of the amqp_connection.
AzureIoTClient 34:51d158b409d2 82 AMQP_TRANSPORT_AUTHENTICATION_MODE preferred_authentication_mode; // Used to avoid registered devices using different authentication modes.
AzureIoTClient 34:51d158b409d2 83 SINGLYLINKEDLIST_HANDLE registered_devices; // List of devices currently registered in this transport.
AzureIoTClient 30:20a85b733111 84 bool is_trace_on; // Turns logging on and off.
AzureIoTClient 30:20a85b733111 85 OPTIONHANDLER_HANDLE saved_tls_options; // Here are the options from the xio layer if any is saved.
AzureIoTClient 34:51d158b409d2 86 AMQP_TRANSPORT_STATE state; // Current state of the transport.
AzureIoTClient 34:51d158b409d2 87 RETRY_CONTROL_HANDLE connection_retry_control; // Controls when the re-connection attempt should occur.
AzureIoTClient 37:abd16824f63b 88 size_t c2d_keep_alive_freq_secs; // Service to device keep alive frequency
AzureIoTClient 31:adadaef857c1 89
AzureIoTClient 31:adadaef857c1 90 char* http_proxy_hostname;
AzureIoTClient 31:adadaef857c1 91 int http_proxy_port;
AzureIoTClient 31:adadaef857c1 92 char* http_proxy_username;
AzureIoTClient 31:adadaef857c1 93 char* http_proxy_password;
AzureIoTClient 34:51d158b409d2 94
AzureIoTClient 34:51d158b409d2 95 size_t option_sas_token_lifetime_secs; // Device-specific option.
AzureIoTClient 34:51d158b409d2 96 size_t option_sas_token_refresh_time_secs; // Device-specific option.
AzureIoTClient 34:51d158b409d2 97 size_t option_cbs_request_timeout_secs; // Device-specific option.
AzureIoTClient 34:51d158b409d2 98 size_t option_send_event_timeout_secs; // Device-specific option.
AzureIoTClient 34:51d158b409d2 99
AzureIoTClient 34:51d158b409d2 100 // Auth module used to generating handle authorization
AzureIoTClient 34:51d158b409d2 101 IOTHUB_AUTHORIZATION_HANDLE authorization_module; // with either SAS Token, x509 Certs, and Device SAS Token
AzureIoTClient 25:63f7d371c030 102 } AMQP_TRANSPORT_INSTANCE;
AzureIoTClient 25:63f7d371c030 103
AzureIoTClient 30:20a85b733111 104 typedef struct AMQP_TRANSPORT_DEVICE_INSTANCE_TAG
AzureIoTClient 25:63f7d371c030 105 {
AzureIoTClient 30:20a85b733111 106 STRING_HANDLE device_id; // Identity of the device.
AzureIoTClient 34:51d158b409d2 107 DEVICE_HANDLE device_handle; // Logic unit that performs authentication, messaging, etc.
AzureIoTClient 30:20a85b733111 108 IOTHUB_CLIENT_LL_HANDLE iothub_client_handle; // Saved reference to the IoTHub LL Client.
AzureIoTClient 30:20a85b733111 109 AMQP_TRANSPORT_INSTANCE* transport_instance; // Saved reference to the transport the device is registered on.
AzureIoTClient 34:51d158b409d2 110 PDLIST_ENTRY waiting_to_send; // List of events waiting to be sent to the iot hub (i.e., haven't been processed by the transport yet).
AzureIoTClient 34:51d158b409d2 111 DEVICE_STATE device_state; // Current state of the device_handle instance.
AzureIoTClient 34:51d158b409d2 112 size_t number_of_previous_failures; // Number of times the device has failed in sequence; this value is reset to 0 if device succeeds to authenticate, send and/or recv messages.
AzureIoTClient 34:51d158b409d2 113 size_t number_of_send_event_complete_failures; // Number of times on_event_send_complete was called in row with an error.
AzureIoTClient 34:51d158b409d2 114 time_t time_of_last_state_change; // Time the device_handle last changed state; used to track timeouts of device_start_async and device_stop.
AzureIoTClient 34:51d158b409d2 115 unsigned int max_state_change_timeout_secs; // Maximum number of seconds allowed for device_handle to complete start and stop state changes.
AzureIoTClient 25:63f7d371c030 116 #ifdef WIP_C2D_METHODS_AMQP /* This feature is WIP, do not use yet */
AzureIoTClient 25:63f7d371c030 117 // the methods portion
AzureIoTClient 30:20a85b733111 118 IOTHUBTRANSPORT_AMQP_METHODS_HANDLE methods_handle; // Handle to instance of module that deals with device methods for AMQP.
AzureIoTClient 25:63f7d371c030 119 // is subscription for methods needed?
AzureIoTClient 30:20a85b733111 120 bool subscribe_methods_needed; // Indicates if should subscribe for device methods.
AzureIoTClient 25:63f7d371c030 121 // is the transport subscribed for methods?
AzureIoTClient 30:20a85b733111 122 bool subscribed_for_methods; // Indicates if device is subscribed for device methods.
AzureIoTClient 25:63f7d371c030 123 #endif
AzureIoTClient 30:20a85b733111 124 } AMQP_TRANSPORT_DEVICE_INSTANCE;
AzureIoTClient 25:63f7d371c030 125
AzureIoTClient 30:20a85b733111 126 typedef struct MESSAGE_DISPOSITION_CONTEXT_TAG
AzureIoTClient 30:20a85b733111 127 {
AzureIoTClient 34:51d158b409d2 128 AMQP_TRANSPORT_DEVICE_INSTANCE* device_state;
AzureIoTClient 30:20a85b733111 129 char* link_name;
AzureIoTClient 30:20a85b733111 130 delivery_number message_id;
AzureIoTClient 30:20a85b733111 131 } MESSAGE_DISPOSITION_CONTEXT;
AzureIoTClient 25:63f7d371c030 132
AzureIoTClient 39:e98d5df6dc74 133 typedef struct AMQP_TRANSPORT_DEVICE_TWIN_CONTEXT_TAG
AzureIoTClient 39:e98d5df6dc74 134 {
AzureIoTClient 41:71c01aa3df1a 135 uint32_t item_id;
AzureIoTClient 41:71c01aa3df1a 136 IOTHUB_CLIENT_LL_HANDLE client_handle;
AzureIoTClient 39:e98d5df6dc74 137 } AMQP_TRANSPORT_DEVICE_TWIN_CONTEXT;
AzureIoTClient 39:e98d5df6dc74 138
AzureIoTClient 39:e98d5df6dc74 139
AzureIoTClient 30:20a85b733111 140 // ---------- General Helpers ---------- //
AzureIoTClient 25:63f7d371c030 141
AzureIoTClient 31:adadaef857c1 142 static void free_proxy_data(AMQP_TRANSPORT_INSTANCE* amqp_transport_instance)
AzureIoTClient 31:adadaef857c1 143 {
AzureIoTClient 31:adadaef857c1 144 if (amqp_transport_instance->http_proxy_hostname != NULL)
AzureIoTClient 31:adadaef857c1 145 {
AzureIoTClient 31:adadaef857c1 146 free(amqp_transport_instance->http_proxy_hostname);
AzureIoTClient 31:adadaef857c1 147 amqp_transport_instance->http_proxy_hostname = NULL;
AzureIoTClient 31:adadaef857c1 148 }
AzureIoTClient 31:adadaef857c1 149
AzureIoTClient 31:adadaef857c1 150 if (amqp_transport_instance->http_proxy_username != NULL)
AzureIoTClient 31:adadaef857c1 151 {
AzureIoTClient 31:adadaef857c1 152 free(amqp_transport_instance->http_proxy_username);
AzureIoTClient 31:adadaef857c1 153 amqp_transport_instance->http_proxy_username = NULL;
AzureIoTClient 31:adadaef857c1 154 }
AzureIoTClient 31:adadaef857c1 155
AzureIoTClient 31:adadaef857c1 156 if (amqp_transport_instance->http_proxy_password != NULL)
AzureIoTClient 31:adadaef857c1 157 {
AzureIoTClient 31:adadaef857c1 158 free(amqp_transport_instance->http_proxy_password);
AzureIoTClient 31:adadaef857c1 159 amqp_transport_instance->http_proxy_password = NULL;
AzureIoTClient 31:adadaef857c1 160 }
AzureIoTClient 31:adadaef857c1 161 }
AzureIoTClient 31:adadaef857c1 162
AzureIoTClient 30:20a85b733111 163 static STRING_HANDLE get_target_iothub_fqdn(const IOTHUBTRANSPORT_CONFIG* config)
AzureIoTClient 25:63f7d371c030 164 {
AzureIoTClient 34:51d158b409d2 165 STRING_HANDLE fqdn;
AzureIoTClient 30:20a85b733111 166
AzureIoTClient 34:51d158b409d2 167 if (config->upperConfig->protocolGatewayHostName == NULL)
AzureIoTClient 34:51d158b409d2 168 {
AzureIoTClient 34:51d158b409d2 169 if ((fqdn = STRING_construct_sprintf("%s.%s", config->upperConfig->iotHubName, config->upperConfig->iotHubSuffix)) == NULL)
AzureIoTClient 34:51d158b409d2 170 {
AzureIoTClient 34:51d158b409d2 171 LogError("Failed to copy iotHubName and iotHubSuffix (STRING_construct_sprintf failed)");
AzureIoTClient 34:51d158b409d2 172 }
AzureIoTClient 34:51d158b409d2 173 }
AzureIoTClient 34:51d158b409d2 174 else if ((fqdn = STRING_construct(config->upperConfig->protocolGatewayHostName)) == NULL)
AzureIoTClient 34:51d158b409d2 175 {
AzureIoTClient 34:51d158b409d2 176 LogError("Failed to copy protocolGatewayHostName (STRING_construct failed)");
AzureIoTClient 34:51d158b409d2 177 }
AzureIoTClient 30:20a85b733111 178
AzureIoTClient 34:51d158b409d2 179 return fqdn;
AzureIoTClient 25:63f7d371c030 180 }
AzureIoTClient 25:63f7d371c030 181
AzureIoTClient 32:babfd49032ff 182 static void update_state(AMQP_TRANSPORT_INSTANCE* transport_instance, AMQP_TRANSPORT_STATE new_state)
AzureIoTClient 32:babfd49032ff 183 {
AzureIoTClient 34:51d158b409d2 184 transport_instance->state = new_state;
AzureIoTClient 32:babfd49032ff 185 }
AzureIoTClient 32:babfd49032ff 186
AzureIoTClient 32:babfd49032ff 187 static void reset_retry_control(AMQP_TRANSPORT_DEVICE_INSTANCE* registered_device)
AzureIoTClient 32:babfd49032ff 188 {
AzureIoTClient 34:51d158b409d2 189 retry_control_reset(registered_device->transport_instance->connection_retry_control);
AzureIoTClient 32:babfd49032ff 190 }
AzureIoTClient 32:babfd49032ff 191
AzureIoTClient 25:63f7d371c030 192
AzureIoTClient 30:20a85b733111 193 // ---------- Register/Unregister Helpers ---------- //
AzureIoTClient 25:63f7d371c030 194
AzureIoTClient 30:20a85b733111 195 static void internal_destroy_amqp_device_instance(AMQP_TRANSPORT_DEVICE_INSTANCE *trdev_inst)
AzureIoTClient 25:63f7d371c030 196 {
AzureIoTClient 30:20a85b733111 197 #ifdef WIP_C2D_METHODS_AMQP /* This feature is WIP, do not use yet */
AzureIoTClient 34:51d158b409d2 198 if (trdev_inst->methods_handle != NULL)
AzureIoTClient 34:51d158b409d2 199 {
AzureIoTClient 34:51d158b409d2 200 iothubtransportamqp_methods_destroy(trdev_inst->methods_handle);
AzureIoTClient 34:51d158b409d2 201 }
AzureIoTClient 30:20a85b733111 202 #endif
AzureIoTClient 34:51d158b409d2 203 if (trdev_inst->device_handle != NULL)
AzureIoTClient 34:51d158b409d2 204 {
AzureIoTClient 34:51d158b409d2 205 device_destroy(trdev_inst->device_handle);
AzureIoTClient 34:51d158b409d2 206 }
AzureIoTClient 25:63f7d371c030 207
AzureIoTClient 34:51d158b409d2 208 if (trdev_inst->device_id != NULL)
AzureIoTClient 34:51d158b409d2 209 {
AzureIoTClient 34:51d158b409d2 210 STRING_delete(trdev_inst->device_id);
AzureIoTClient 34:51d158b409d2 211 }
AzureIoTClient 25:63f7d371c030 212
AzureIoTClient 34:51d158b409d2 213 free(trdev_inst);
AzureIoTClient 25:63f7d371c030 214 }
AzureIoTClient 25:63f7d371c030 215
AzureIoTClient 41:71c01aa3df1a 216 static DEVICE_AUTH_MODE get_authentication_mode(const IOTHUB_DEVICE_CONFIG* device)
AzureIoTClient 41:71c01aa3df1a 217 {
AzureIoTClient 41:71c01aa3df1a 218 DEVICE_AUTH_MODE result;
AzureIoTClient 41:71c01aa3df1a 219
AzureIoTClient 41:71c01aa3df1a 220 if (device->deviceKey != NULL || device->deviceSasToken != NULL)
AzureIoTClient 41:71c01aa3df1a 221 {
AzureIoTClient 41:71c01aa3df1a 222 result = DEVICE_AUTH_MODE_CBS;
AzureIoTClient 41:71c01aa3df1a 223 }
AzureIoTClient 41:71c01aa3df1a 224 else if (IoTHubClient_Auth_Get_Credential_Type(device->authorization_module) == IOTHUB_CREDENTIAL_TYPE_DEVICE_AUTH)
AzureIoTClient 41:71c01aa3df1a 225 {
AzureIoTClient 41:71c01aa3df1a 226 result = DEVICE_AUTH_MODE_CBS;
AzureIoTClient 41:71c01aa3df1a 227 }
AzureIoTClient 41:71c01aa3df1a 228 else
AzureIoTClient 41:71c01aa3df1a 229 {
AzureIoTClient 41:71c01aa3df1a 230 result = DEVICE_AUTH_MODE_X509;
AzureIoTClient 41:71c01aa3df1a 231 }
AzureIoTClient 41:71c01aa3df1a 232 return result;
AzureIoTClient 41:71c01aa3df1a 233 }
AzureIoTClient 41:71c01aa3df1a 234
AzureIoTClient 30:20a85b733111 235 // @brief
AzureIoTClient 30:20a85b733111 236 // Saves the new state, if it is different than the previous one.
AzureIoTClient 30:20a85b733111 237 static void on_device_state_changed_callback(void* context, DEVICE_STATE previous_state, DEVICE_STATE new_state)
AzureIoTClient 25:63f7d371c030 238 {
AzureIoTClient 34:51d158b409d2 239 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_061: [If `new_state` is the same as `previous_state`, on_device_state_changed_callback shall return]
AzureIoTClient 34:51d158b409d2 240 if (context != NULL && new_state != previous_state)
AzureIoTClient 34:51d158b409d2 241 {
AzureIoTClient 34:51d158b409d2 242 AMQP_TRANSPORT_DEVICE_INSTANCE* registered_device = (AMQP_TRANSPORT_DEVICE_INSTANCE*)context;
AzureIoTClient 34:51d158b409d2 243 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_062: [If `new_state` shall be saved into the `registered_device` instance]
AzureIoTClient 34:51d158b409d2 244 registered_device->device_state = new_state;
AzureIoTClient 34:51d158b409d2 245 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_063: [If `registered_device->time_of_last_state_change` shall be set using get_time()]
AzureIoTClient 34:51d158b409d2 246 registered_device->time_of_last_state_change = get_time(NULL);
AzureIoTClient 31:adadaef857c1 247
AzureIoTClient 34:51d158b409d2 248 if (new_state == DEVICE_STATE_STARTED)
AzureIoTClient 34:51d158b409d2 249 {
AzureIoTClient 34:51d158b409d2 250 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_127: [If `new_state` is DEVICE_STATE_STARTED, retry_control_reset() shall be invoked passing `instance->connection_retry_control`]
AzureIoTClient 34:51d158b409d2 251 reset_retry_control(registered_device);
AzureIoTClient 32:babfd49032ff 252
AzureIoTClient 34:51d158b409d2 253 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_120: [If `new_state` is DEVICE_STATE_STARTED, IoTHubClient_LL_ConnectionStatusCallBack shall be invoked with IOTHUB_CLIENT_CONNECTION_AUTHENTICATED and IOTHUB_CLIENT_CONNECTION_OK]
AzureIoTClient 34:51d158b409d2 254 IoTHubClient_LL_ConnectionStatusCallBack(registered_device->iothub_client_handle, IOTHUB_CLIENT_CONNECTION_AUTHENTICATED, IOTHUB_CLIENT_CONNECTION_OK);
AzureIoTClient 34:51d158b409d2 255 }
AzureIoTClient 34:51d158b409d2 256 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_121: [If `new_state` is DEVICE_STATE_STOPPED, IoTHubClient_LL_ConnectionStatusCallBack shall be invoked with IOTHUB_CLIENT_CONNECTION_UNAUTHENTICATED and IOTHUB_CLIENT_CONNECTION_OK]
AzureIoTClient 34:51d158b409d2 257 else if (new_state == DEVICE_STATE_STOPPED)
AzureIoTClient 34:51d158b409d2 258 {
AzureIoTClient 34:51d158b409d2 259 IoTHubClient_LL_ConnectionStatusCallBack(registered_device->iothub_client_handle, IOTHUB_CLIENT_CONNECTION_UNAUTHENTICATED, IOTHUB_CLIENT_CONNECTION_OK);
AzureIoTClient 34:51d158b409d2 260 }
AzureIoTClient 34:51d158b409d2 261 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_122: [If `new_state` is DEVICE_STATE_ERROR_AUTH, IoTHubClient_LL_ConnectionStatusCallBack shall be invoked with IOTHUB_CLIENT_CONNECTION_UNAUTHENTICATED and IOTHUB_CLIENT_CONNECTION_BAD_CREDENTIAL]
AzureIoTClient 34:51d158b409d2 262 else if (new_state == DEVICE_STATE_ERROR_AUTH)
AzureIoTClient 34:51d158b409d2 263 {
AzureIoTClient 34:51d158b409d2 264 IoTHubClient_LL_ConnectionStatusCallBack(registered_device->iothub_client_handle, IOTHUB_CLIENT_CONNECTION_UNAUTHENTICATED, IOTHUB_CLIENT_CONNECTION_BAD_CREDENTIAL);
AzureIoTClient 34:51d158b409d2 265 }
AzureIoTClient 34:51d158b409d2 266 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_123: [If `new_state` is DEVICE_STATE_ERROR_AUTH_TIMEOUT or DEVICE_STATE_ERROR_MSG, IoTHubClient_LL_ConnectionStatusCallBack shall be invoked with IOTHUB_CLIENT_CONNECTION_UNAUTHENTICATED and IOTHUB_CLIENT_CONNECTION_COMMUNICATION_ERROR]
AzureIoTClient 34:51d158b409d2 267 else if (new_state == DEVICE_STATE_ERROR_AUTH_TIMEOUT || new_state == DEVICE_STATE_ERROR_MSG)
AzureIoTClient 34:51d158b409d2 268 {
AzureIoTClient 34:51d158b409d2 269 IoTHubClient_LL_ConnectionStatusCallBack(registered_device->iothub_client_handle, IOTHUB_CLIENT_CONNECTION_UNAUTHENTICATED, IOTHUB_CLIENT_CONNECTION_COMMUNICATION_ERROR);
AzureIoTClient 34:51d158b409d2 270 }
AzureIoTClient 34:51d158b409d2 271 }
AzureIoTClient 25:63f7d371c030 272 }
AzureIoTClient 25:63f7d371c030 273
AzureIoTClient 30:20a85b733111 274 // @brief Auxiliary function to be used to find a device in the registered_devices list.
AzureIoTClient 30:20a85b733111 275 // @returns true if the device ids match, false otherwise.
AzureIoTClient 30:20a85b733111 276 static bool find_device_by_id_callback(LIST_ITEM_HANDLE list_item, const void* match_context)
AzureIoTClient 25:63f7d371c030 277 {
AzureIoTClient 34:51d158b409d2 278 bool result;
AzureIoTClient 30:20a85b733111 279
AzureIoTClient 34:51d158b409d2 280 if (match_context == NULL)
AzureIoTClient 34:51d158b409d2 281 {
AzureIoTClient 34:51d158b409d2 282 result = false;
AzureIoTClient 34:51d158b409d2 283 }
AzureIoTClient 34:51d158b409d2 284 else
AzureIoTClient 34:51d158b409d2 285 {
AzureIoTClient 34:51d158b409d2 286 AMQP_TRANSPORT_DEVICE_INSTANCE* device_instance = (AMQP_TRANSPORT_DEVICE_INSTANCE*)singlylinkedlist_item_get_value(list_item);
AzureIoTClient 25:63f7d371c030 287
AzureIoTClient 34:51d158b409d2 288 if (device_instance == NULL ||
AzureIoTClient 34:51d158b409d2 289 device_instance->device_id == NULL ||
AzureIoTClient 34:51d158b409d2 290 STRING_c_str(device_instance->device_id) != match_context)
AzureIoTClient 34:51d158b409d2 291 {
AzureIoTClient 34:51d158b409d2 292 result = false;
AzureIoTClient 34:51d158b409d2 293 }
AzureIoTClient 34:51d158b409d2 294 else
AzureIoTClient 34:51d158b409d2 295 {
AzureIoTClient 34:51d158b409d2 296 result = true;
AzureIoTClient 34:51d158b409d2 297 }
AzureIoTClient 34:51d158b409d2 298 }
AzureIoTClient 30:20a85b733111 299
AzureIoTClient 34:51d158b409d2 300 return result;
AzureIoTClient 25:63f7d371c030 301 }
AzureIoTClient 25:63f7d371c030 302
AzureIoTClient 30:20a85b733111 303 // @brief Verifies if a device is already registered within the transport that owns the list of registered devices.
AzureIoTClient 30:20a85b733111 304 // @remarks Returns the correspoding LIST_ITEM_HANDLE in registered_devices, if found.
AzureIoTClient 30:20a85b733111 305 // @returns true if the device is already in the list, false otherwise.
AzureIoTClient 30:20a85b733111 306 static bool is_device_registered_ex(SINGLYLINKEDLIST_HANDLE registered_devices, const char* device_id, LIST_ITEM_HANDLE *list_item)
AzureIoTClient 25:63f7d371c030 307 {
AzureIoTClient 34:51d158b409d2 308 return ((*list_item = singlylinkedlist_find(registered_devices, find_device_by_id_callback, device_id)) != NULL ? 1 : 0);
AzureIoTClient 30:20a85b733111 309 }
AzureIoTClient 25:63f7d371c030 310
AzureIoTClient 30:20a85b733111 311 // @brief Verifies if a device is already registered within the transport that owns the list of registered devices.
AzureIoTClient 30:20a85b733111 312 // @returns true if the device is already in the list, false otherwise.
AzureIoTClient 30:20a85b733111 313 static bool is_device_registered(AMQP_TRANSPORT_DEVICE_INSTANCE* amqp_device_instance)
AzureIoTClient 30:20a85b733111 314 {
AzureIoTClient 34:51d158b409d2 315 LIST_ITEM_HANDLE list_item;
AzureIoTClient 34:51d158b409d2 316 const char* device_id = STRING_c_str(amqp_device_instance->device_id);
AzureIoTClient 34:51d158b409d2 317 return is_device_registered_ex(amqp_device_instance->transport_instance->registered_devices, device_id, &list_item);
AzureIoTClient 25:63f7d371c030 318 }
AzureIoTClient 25:63f7d371c030 319
AzureIoTClient 39:e98d5df6dc74 320 static size_t get_number_of_registered_devices(AMQP_TRANSPORT_INSTANCE* transport)
AzureIoTClient 39:e98d5df6dc74 321 {
AzureIoTClient 41:71c01aa3df1a 322 size_t result = 0;
AzureIoTClient 39:e98d5df6dc74 323
AzureIoTClient 41:71c01aa3df1a 324 LIST_ITEM_HANDLE list_item = singlylinkedlist_get_head_item(transport->registered_devices);
AzureIoTClient 39:e98d5df6dc74 325
AzureIoTClient 41:71c01aa3df1a 326 while (list_item != NULL)
AzureIoTClient 41:71c01aa3df1a 327 {
AzureIoTClient 41:71c01aa3df1a 328 result++;
AzureIoTClient 41:71c01aa3df1a 329 list_item = singlylinkedlist_get_next_item(list_item);
AzureIoTClient 41:71c01aa3df1a 330 }
AzureIoTClient 39:e98d5df6dc74 331
AzureIoTClient 41:71c01aa3df1a 332 return result;
AzureIoTClient 39:e98d5df6dc74 333 }
AzureIoTClient 39:e98d5df6dc74 334
AzureIoTClient 30:20a85b733111 335
AzureIoTClient 30:20a85b733111 336 // ---------- Callbacks ---------- //
AzureIoTClient 30:20a85b733111 337
AzureIoTClient 30:20a85b733111 338 static MESSAGE_CALLBACK_INFO* MESSAGE_CALLBACK_INFO_Create(IOTHUB_MESSAGE_HANDLE message, DEVICE_MESSAGE_DISPOSITION_INFO* disposition_info, AMQP_TRANSPORT_DEVICE_INSTANCE* device_state)
AzureIoTClient 25:63f7d371c030 339 {
AzureIoTClient 34:51d158b409d2 340 MESSAGE_CALLBACK_INFO* result;
AzureIoTClient 25:63f7d371c030 341
AzureIoTClient 34:51d158b409d2 342 if ((result = (MESSAGE_CALLBACK_INFO*)malloc(sizeof(MESSAGE_CALLBACK_INFO))) == NULL)
AzureIoTClient 34:51d158b409d2 343 {
AzureIoTClient 34:51d158b409d2 344 LogError("Failed creating MESSAGE_CALLBACK_INFO (malloc failed)");
AzureIoTClient 34:51d158b409d2 345 }
AzureIoTClient 34:51d158b409d2 346 else
AzureIoTClient 34:51d158b409d2 347 {
AzureIoTClient 34:51d158b409d2 348 memset(result, 0, sizeof(MESSAGE_CALLBACK_INFO));
AzureIoTClient 34:51d158b409d2 349 MESSAGE_DISPOSITION_CONTEXT* tc;
AzureIoTClient 25:63f7d371c030 350
AzureIoTClient 34:51d158b409d2 351 if ((tc = (MESSAGE_DISPOSITION_CONTEXT*)malloc(sizeof(MESSAGE_DISPOSITION_CONTEXT))) == NULL)
AzureIoTClient 34:51d158b409d2 352 {
AzureIoTClient 34:51d158b409d2 353 LogError("Failed creating MESSAGE_DISPOSITION_CONTEXT (malloc failed)");
AzureIoTClient 34:51d158b409d2 354 free(result);
AzureIoTClient 34:51d158b409d2 355 result = NULL;
AzureIoTClient 34:51d158b409d2 356 }
AzureIoTClient 34:51d158b409d2 357 else
AzureIoTClient 34:51d158b409d2 358 {
AzureIoTClient 34:51d158b409d2 359 memset(tc, 0, sizeof(MESSAGE_DISPOSITION_CONTEXT));
AzureIoTClient 34:51d158b409d2 360 if (mallocAndStrcpy_s(&(tc->link_name), disposition_info->source) == 0)
AzureIoTClient 34:51d158b409d2 361 {
AzureIoTClient 34:51d158b409d2 362 tc->device_state = device_state;
AzureIoTClient 34:51d158b409d2 363 tc->message_id = disposition_info->message_id;
AzureIoTClient 25:63f7d371c030 364
AzureIoTClient 34:51d158b409d2 365 result->messageHandle = message;
AzureIoTClient 34:51d158b409d2 366 result->transportContext = tc;
AzureIoTClient 34:51d158b409d2 367 }
AzureIoTClient 34:51d158b409d2 368 else
AzureIoTClient 34:51d158b409d2 369 {
AzureIoTClient 34:51d158b409d2 370 LogError("Failed creating MESSAGE_CALLBACK_INFO (mallocAndStrcyp_s failed)");
AzureIoTClient 34:51d158b409d2 371 free(tc);
AzureIoTClient 34:51d158b409d2 372 free(result);
AzureIoTClient 34:51d158b409d2 373 result = NULL;
AzureIoTClient 34:51d158b409d2 374 }
AzureIoTClient 34:51d158b409d2 375 }
AzureIoTClient 34:51d158b409d2 376 }
AzureIoTClient 25:63f7d371c030 377
AzureIoTClient 34:51d158b409d2 378 return result;
AzureIoTClient 30:20a85b733111 379 }
AzureIoTClient 30:20a85b733111 380
AzureIoTClient 30:20a85b733111 381 static void MESSAGE_CALLBACK_INFO_Destroy(MESSAGE_CALLBACK_INFO* message_callback_info)
AzureIoTClient 30:20a85b733111 382 {
AzureIoTClient 34:51d158b409d2 383 if (message_callback_info->transportContext != NULL)
AzureIoTClient 34:51d158b409d2 384 {
AzureIoTClient 34:51d158b409d2 385 free(message_callback_info->transportContext->link_name);
AzureIoTClient 34:51d158b409d2 386 free(message_callback_info->transportContext);
AzureIoTClient 34:51d158b409d2 387 }
AzureIoTClient 34:51d158b409d2 388 free(message_callback_info);
AzureIoTClient 25:63f7d371c030 389 }
AzureIoTClient 25:63f7d371c030 390
AzureIoTClient 30:20a85b733111 391 static DEVICE_MESSAGE_DISPOSITION_RESULT get_device_disposition_result_from(IOTHUBMESSAGE_DISPOSITION_RESULT iothubclient_disposition_result)
AzureIoTClient 25:63f7d371c030 392 {
AzureIoTClient 34:51d158b409d2 393 DEVICE_MESSAGE_DISPOSITION_RESULT device_disposition_result;
AzureIoTClient 25:63f7d371c030 394
AzureIoTClient 34:51d158b409d2 395 if (iothubclient_disposition_result == IOTHUBMESSAGE_ACCEPTED)
AzureIoTClient 34:51d158b409d2 396 {
AzureIoTClient 34:51d158b409d2 397 device_disposition_result = DEVICE_MESSAGE_DISPOSITION_RESULT_ACCEPTED;
AzureIoTClient 34:51d158b409d2 398 }
AzureIoTClient 34:51d158b409d2 399 else if (iothubclient_disposition_result == IOTHUBMESSAGE_ABANDONED)
AzureIoTClient 34:51d158b409d2 400 {
AzureIoTClient 34:51d158b409d2 401 device_disposition_result = DEVICE_MESSAGE_DISPOSITION_RESULT_RELEASED;
AzureIoTClient 34:51d158b409d2 402 }
AzureIoTClient 34:51d158b409d2 403 else if (iothubclient_disposition_result == IOTHUBMESSAGE_REJECTED)
AzureIoTClient 34:51d158b409d2 404 {
AzureIoTClient 34:51d158b409d2 405 device_disposition_result = DEVICE_MESSAGE_DISPOSITION_RESULT_REJECTED;
AzureIoTClient 34:51d158b409d2 406 }
AzureIoTClient 34:51d158b409d2 407 else
AzureIoTClient 34:51d158b409d2 408 {
AzureIoTClient 34:51d158b409d2 409 LogError("Failed getting corresponding DEVICE_MESSAGE_DISPOSITION_RESULT for IOTHUBMESSAGE_DISPOSITION_RESULT (%d is not supported)", iothubclient_disposition_result);
AzureIoTClient 34:51d158b409d2 410 device_disposition_result = DEVICE_MESSAGE_DISPOSITION_RESULT_RELEASED;
AzureIoTClient 34:51d158b409d2 411 }
AzureIoTClient 25:63f7d371c030 412
AzureIoTClient 34:51d158b409d2 413 return device_disposition_result;
AzureIoTClient 25:63f7d371c030 414 }
AzureIoTClient 25:63f7d371c030 415
AzureIoTClient 30:20a85b733111 416 static DEVICE_MESSAGE_DISPOSITION_RESULT on_message_received(IOTHUB_MESSAGE_HANDLE message, DEVICE_MESSAGE_DISPOSITION_INFO* disposition_info, void* context)
AzureIoTClient 25:63f7d371c030 417 {
AzureIoTClient 34:51d158b409d2 418 AMQP_TRANSPORT_DEVICE_INSTANCE* amqp_device_instance = (AMQP_TRANSPORT_DEVICE_INSTANCE*)context;
AzureIoTClient 34:51d158b409d2 419 DEVICE_MESSAGE_DISPOSITION_RESULT device_disposition_result;
AzureIoTClient 34:51d158b409d2 420 MESSAGE_CALLBACK_INFO* message_data;
AzureIoTClient 25:63f7d371c030 421
AzureIoTClient 34:51d158b409d2 422 if ((message_data = MESSAGE_CALLBACK_INFO_Create(message, disposition_info, amqp_device_instance)) == NULL)
AzureIoTClient 34:51d158b409d2 423 {
AzureIoTClient 34:51d158b409d2 424 LogError("Failed processing message received (failed to assemble callback info)");
AzureIoTClient 34:51d158b409d2 425 device_disposition_result = DEVICE_MESSAGE_DISPOSITION_RESULT_RELEASED;
AzureIoTClient 34:51d158b409d2 426 }
AzureIoTClient 34:51d158b409d2 427 else
AzureIoTClient 34:51d158b409d2 428 {
AzureIoTClient 34:51d158b409d2 429 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_089: [IoTHubClient_LL_MessageCallback() shall be invoked passing the client and the incoming message handles as parameters]
AzureIoTClient 34:51d158b409d2 430 if (IoTHubClient_LL_MessageCallback(amqp_device_instance->iothub_client_handle, message_data) != true)
AzureIoTClient 34:51d158b409d2 431 {
AzureIoTClient 34:51d158b409d2 432 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_090: [If IoTHubClient_LL_MessageCallback() fails, on_message_received_callback shall return DEVICE_MESSAGE_DISPOSITION_RESULT_RELEASED]
AzureIoTClient 34:51d158b409d2 433 LogError("Failed processing message received (IoTHubClient_LL_MessageCallback failed)");
AzureIoTClient 34:51d158b409d2 434 IoTHubMessage_Destroy(message);
AzureIoTClient 34:51d158b409d2 435 MESSAGE_CALLBACK_INFO_Destroy(message_data);
AzureIoTClient 34:51d158b409d2 436 device_disposition_result = DEVICE_MESSAGE_DISPOSITION_RESULT_RELEASED;
AzureIoTClient 34:51d158b409d2 437 }
AzureIoTClient 34:51d158b409d2 438 else
AzureIoTClient 34:51d158b409d2 439 {
AzureIoTClient 34:51d158b409d2 440 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_091: [If IoTHubClient_LL_MessageCallback() succeeds, on_message_received_callback shall return DEVICE_MESSAGE_DISPOSITION_RESULT_NONE]
AzureIoTClient 34:51d158b409d2 441 device_disposition_result = DEVICE_MESSAGE_DISPOSITION_RESULT_NONE;
AzureIoTClient 34:51d158b409d2 442 }
AzureIoTClient 34:51d158b409d2 443 }
AzureIoTClient 30:20a85b733111 444
AzureIoTClient 30:20a85b733111 445 return device_disposition_result;
AzureIoTClient 25:63f7d371c030 446 }
AzureIoTClient 25:63f7d371c030 447
AzureIoTClient 25:63f7d371c030 448 #ifdef WIP_C2D_METHODS_AMQP /* This feature is WIP, do not use yet */
AzureIoTClient 25:63f7d371c030 449 static void on_methods_error(void* context)
AzureIoTClient 25:63f7d371c030 450 {
AzureIoTClient 25:63f7d371c030 451 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_030: [ `on_methods_error` shall do nothing. ]*/
AzureIoTClient 25:63f7d371c030 452 (void)context;
AzureIoTClient 25:63f7d371c030 453 }
AzureIoTClient 25:63f7d371c030 454
AzureIoTClient 29:7e8852b14e3b 455 static void on_methods_unsubscribed(void* context)
AzureIoTClient 29:7e8852b14e3b 456 {
AzureIoTClient 31:adadaef857c1 457 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_METHODS_12_001: [ `on_methods_unsubscribed` calls iothubtransportamqp_methods_unsubscribe. ]*/
AzureIoTClient 30:20a85b733111 458 AMQP_TRANSPORT_DEVICE_INSTANCE* device_state = (AMQP_TRANSPORT_DEVICE_INSTANCE*)context;
AzureIoTClient 31:adadaef857c1 459
AzureIoTClient 34:51d158b409d2 460 iothubtransportamqp_methods_unsubscribe(device_state->methods_handle);
AzureIoTClient 34:51d158b409d2 461 device_state->subscribed_for_methods = false;
AzureIoTClient 29:7e8852b14e3b 462 }
AzureIoTClient 29:7e8852b14e3b 463
AzureIoTClient 25:63f7d371c030 464 static int on_method_request_received(void* context, const char* method_name, const unsigned char* request, size_t request_size, IOTHUBTRANSPORT_AMQP_METHOD_HANDLE method_handle)
AzureIoTClient 25:63f7d371c030 465 {
AzureIoTClient 25:63f7d371c030 466 int result;
AzureIoTClient 30:20a85b733111 467 AMQP_TRANSPORT_DEVICE_INSTANCE* device_state = (AMQP_TRANSPORT_DEVICE_INSTANCE*)context;
AzureIoTClient 25:63f7d371c030 468
AzureIoTClient 26:ee14eed604f6 469 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_017: [ `on_methods_request_received` shall call the `IoTHubClient_LL_DeviceMethodComplete` passing the method name, request buffer and size and the newly created BUFFER handle. ]*/
AzureIoTClient 26:ee14eed604f6 470 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_022: [ The status code shall be the return value of the call to `IoTHubClient_LL_DeviceMethodComplete`. ]*/
AzureIoTClient 26:ee14eed604f6 471 if (IoTHubClient_LL_DeviceMethodComplete(device_state->iothub_client_handle, method_name, request, request_size, (void*)method_handle) != 0)
AzureIoTClient 25:63f7d371c030 472 {
AzureIoTClient 26:ee14eed604f6 473 LogError("Failure: IoTHubClient_LL_DeviceMethodComplete");
AzureIoTClient 29:7e8852b14e3b 474 result = __FAILURE__;
AzureIoTClient 25:63f7d371c030 475 }
AzureIoTClient 25:63f7d371c030 476 else
AzureIoTClient 25:63f7d371c030 477 {
AzureIoTClient 26:ee14eed604f6 478 result = 0;
AzureIoTClient 25:63f7d371c030 479 }
AzureIoTClient 25:63f7d371c030 480 return result;
AzureIoTClient 25:63f7d371c030 481 }
AzureIoTClient 25:63f7d371c030 482
AzureIoTClient 30:20a85b733111 483 static int subscribe_methods(AMQP_TRANSPORT_DEVICE_INSTANCE* deviceState)
AzureIoTClient 25:63f7d371c030 484 {
AzureIoTClient 25:63f7d371c030 485 int result;
AzureIoTClient 25:63f7d371c030 486
AzureIoTClient 29:7e8852b14e3b 487 if (deviceState->subscribed_for_methods)
AzureIoTClient 25:63f7d371c030 488 {
AzureIoTClient 25:63f7d371c030 489 result = 0;
AzureIoTClient 25:63f7d371c030 490 }
AzureIoTClient 25:63f7d371c030 491 else
AzureIoTClient 25:63f7d371c030 492 {
AzureIoTClient 34:51d158b409d2 493 SESSION_HANDLE session_handle;
AzureIoTClient 30:20a85b733111 494
AzureIoTClient 34:51d158b409d2 495 if ((amqp_connection_get_session_handle(deviceState->transport_instance->amqp_connection, &session_handle)) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 496 {
AzureIoTClient 34:51d158b409d2 497 LogError("Device '%s' failed subscribing for methods (failed getting session handle)", STRING_c_str(deviceState->device_id));
AzureIoTClient 34:51d158b409d2 498 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 499 }
AzureIoTClient 25:63f7d371c030 500 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_024: [ If the device authentication status is AUTHENTICATION_STATUS_OK and `IoTHubTransport_AMQP_Common_Subscribe_DeviceMethod` was called to register for methods, `IoTHubTransport_AMQP_Common_DoWork` shall call `iothubtransportamqp_methods_subscribe`. ]*/
AzureIoTClient 25:63f7d371c030 501 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_027: [ The current session handle shall be passed to `iothubtransportamqp_methods_subscribe`. ]*/
AzureIoTClient 30:20a85b733111 502 else if (iothubtransportamqp_methods_subscribe(deviceState->methods_handle, session_handle, on_methods_error, deviceState, on_method_request_received, deviceState, on_methods_unsubscribed, deviceState) != 0)
AzureIoTClient 25:63f7d371c030 503 {
AzureIoTClient 25:63f7d371c030 504 LogError("Cannot subscribe for methods");
AzureIoTClient 29:7e8852b14e3b 505 result = __FAILURE__;
AzureIoTClient 25:63f7d371c030 506 }
AzureIoTClient 25:63f7d371c030 507 else
AzureIoTClient 25:63f7d371c030 508 {
AzureIoTClient 29:7e8852b14e3b 509 deviceState->subscribed_for_methods = true;
AzureIoTClient 25:63f7d371c030 510 result = 0;
AzureIoTClient 25:63f7d371c030 511 }
AzureIoTClient 25:63f7d371c030 512 }
AzureIoTClient 25:63f7d371c030 513
AzureIoTClient 25:63f7d371c030 514 return result;
AzureIoTClient 25:63f7d371c030 515 }
AzureIoTClient 25:63f7d371c030 516 #endif
AzureIoTClient 25:63f7d371c030 517
AzureIoTClient 39:e98d5df6dc74 518 static void on_device_send_twin_update_complete_callback(DEVICE_TWIN_UPDATE_RESULT result, int status_code, void* context)
AzureIoTClient 39:e98d5df6dc74 519 {
AzureIoTClient 41:71c01aa3df1a 520 (void)result;
AzureIoTClient 39:e98d5df6dc74 521
AzureIoTClient 41:71c01aa3df1a 522 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_151: [If `context` is NULL, the callback shall return]
AzureIoTClient 41:71c01aa3df1a 523 if (context == NULL)
AzureIoTClient 41:71c01aa3df1a 524 {
AzureIoTClient 41:71c01aa3df1a 525 LogError("Invalid argument (context is NULL)");
AzureIoTClient 41:71c01aa3df1a 526 }
AzureIoTClient 41:71c01aa3df1a 527 else
AzureIoTClient 41:71c01aa3df1a 528 {
AzureIoTClient 41:71c01aa3df1a 529 AMQP_TRANSPORT_DEVICE_TWIN_CONTEXT* dev_twin_ctx = (AMQP_TRANSPORT_DEVICE_TWIN_CONTEXT*)context;
AzureIoTClient 39:e98d5df6dc74 530
AzureIoTClient 41:71c01aa3df1a 531 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_152: [`IoTHubClient_LL_ReportedStateComplete` shall be invoked passing `status_code` and `context` details]
AzureIoTClient 41:71c01aa3df1a 532 IoTHubClient_LL_ReportedStateComplete(dev_twin_ctx->client_handle, dev_twin_ctx->item_id, status_code);
AzureIoTClient 39:e98d5df6dc74 533
AzureIoTClient 41:71c01aa3df1a 534 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_153: [The memory allocated for `context` shall be released]
AzureIoTClient 41:71c01aa3df1a 535 free(dev_twin_ctx);
AzureIoTClient 41:71c01aa3df1a 536 }
AzureIoTClient 39:e98d5df6dc74 537 }
AzureIoTClient 39:e98d5df6dc74 538
AzureIoTClient 39:e98d5df6dc74 539 static void on_device_twin_update_received_callback(DEVICE_TWIN_UPDATE_TYPE update_type, const unsigned char* message, size_t length, void* context)
AzureIoTClient 39:e98d5df6dc74 540 {
AzureIoTClient 41:71c01aa3df1a 541 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_137: [If `context` is NULL, the callback shall return.]
AzureIoTClient 41:71c01aa3df1a 542 if (context == NULL)
AzureIoTClient 41:71c01aa3df1a 543 {
AzureIoTClient 41:71c01aa3df1a 544 LogError("Invalid argument (context is NULL)");
AzureIoTClient 41:71c01aa3df1a 545 }
AzureIoTClient 41:71c01aa3df1a 546 else
AzureIoTClient 41:71c01aa3df1a 547 {
AzureIoTClient 41:71c01aa3df1a 548 AMQP_TRANSPORT_DEVICE_INSTANCE* registered_device = (AMQP_TRANSPORT_DEVICE_INSTANCE*)context;
AzureIoTClient 39:e98d5df6dc74 549
AzureIoTClient 41:71c01aa3df1a 550 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_138: [If `update_type` is DEVICE_TWIN_UPDATE_TYPE_PARTIAL IoTHubClient_LL_RetrievePropertyComplete shall be invoked passing `context` as handle, `DEVICE_TWIN_UPDATE_PARTIAL`, `payload` and `size`.]
AzureIoTClient 41:71c01aa3df1a 551 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_139: [If `update_type` is DEVICE_TWIN_UPDATE_TYPE_COMPLETE IoTHubClient_LL_RetrievePropertyComplete shall be invoked passing `context` as handle, `DEVICE_TWIN_UPDATE_COMPLETE`, `payload` and `size`.]
AzureIoTClient 41:71c01aa3df1a 552 IoTHubClient_LL_RetrievePropertyComplete(
AzureIoTClient 41:71c01aa3df1a 553 registered_device->iothub_client_handle,
AzureIoTClient 41:71c01aa3df1a 554 (update_type == DEVICE_TWIN_UPDATE_TYPE_COMPLETE ? DEVICE_TWIN_UPDATE_COMPLETE : DEVICE_TWIN_UPDATE_PARTIAL),
AzureIoTClient 41:71c01aa3df1a 555 message, length);
AzureIoTClient 41:71c01aa3df1a 556 }
AzureIoTClient 39:e98d5df6dc74 557 }
AzureIoTClient 39:e98d5df6dc74 558
AzureIoTClient 30:20a85b733111 559
AzureIoTClient 30:20a85b733111 560 // ---------- Underlying TLS I/O Helpers ---------- //
AzureIoTClient 30:20a85b733111 561
AzureIoTClient 30:20a85b733111 562 // @brief
AzureIoTClient 30:20a85b733111 563 // Retrieves the options of the current underlying TLS I/O instance and saves in the transport instance.
AzureIoTClient 30:20a85b733111 564 // @remarks
AzureIoTClient 30:20a85b733111 565 // This is used when the new underlying I/O transport (TLS I/O, or WebSockets, etc) needs to be recreated,
AzureIoTClient 30:20a85b733111 566 // and the options previously set must persist.
AzureIoTClient 30:20a85b733111 567 //
AzureIoTClient 30:20a85b733111 568 // If no TLS I/O instance was created yet, results in failure.
AzureIoTClient 30:20a85b733111 569 // @returns
AzureIoTClient 30:20a85b733111 570 // 0 if succeeds, non-zero otherwise.
AzureIoTClient 30:20a85b733111 571 static int save_underlying_io_transport_options(AMQP_TRANSPORT_INSTANCE* transport_instance)
AzureIoTClient 25:63f7d371c030 572 {
AzureIoTClient 34:51d158b409d2 573 int result;
AzureIoTClient 30:20a85b733111 574
AzureIoTClient 34:51d158b409d2 575 if (transport_instance->tls_io == NULL)
AzureIoTClient 34:51d158b409d2 576 {
AzureIoTClient 34:51d158b409d2 577 LogError("failed saving underlying I/O transport options (tls_io instance is NULL)");
AzureIoTClient 34:51d158b409d2 578 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 579 }
AzureIoTClient 34:51d158b409d2 580 else
AzureIoTClient 34:51d158b409d2 581 {
AzureIoTClient 34:51d158b409d2 582 OPTIONHANDLER_HANDLE fresh_options;
AzureIoTClient 25:63f7d371c030 583
AzureIoTClient 34:51d158b409d2 584 if ((fresh_options = xio_retrieveoptions(transport_instance->tls_io)) == NULL)
AzureIoTClient 34:51d158b409d2 585 {
AzureIoTClient 34:51d158b409d2 586 LogError("failed saving underlying I/O transport options (tls_io instance is NULL)");
AzureIoTClient 34:51d158b409d2 587 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 588 }
AzureIoTClient 34:51d158b409d2 589 else
AzureIoTClient 34:51d158b409d2 590 {
AzureIoTClient 34:51d158b409d2 591 OPTIONHANDLER_HANDLE previous_options = transport_instance->saved_tls_options;
AzureIoTClient 34:51d158b409d2 592 transport_instance->saved_tls_options = fresh_options;
AzureIoTClient 30:20a85b733111 593
AzureIoTClient 34:51d158b409d2 594 if (previous_options != NULL)
AzureIoTClient 34:51d158b409d2 595 {
AzureIoTClient 34:51d158b409d2 596 OptionHandler_Destroy(previous_options);
AzureIoTClient 34:51d158b409d2 597 }
AzureIoTClient 30:20a85b733111 598
AzureIoTClient 34:51d158b409d2 599 result = RESULT_OK;
AzureIoTClient 34:51d158b409d2 600 }
AzureIoTClient 34:51d158b409d2 601 }
AzureIoTClient 30:20a85b733111 602
AzureIoTClient 34:51d158b409d2 603 return result;
AzureIoTClient 30:20a85b733111 604 }
AzureIoTClient 30:20a85b733111 605
AzureIoTClient 30:20a85b733111 606 static void destroy_underlying_io_transport_options(AMQP_TRANSPORT_INSTANCE* transport_instance)
AzureIoTClient 30:20a85b733111 607 {
AzureIoTClient 34:51d158b409d2 608 if (transport_instance->saved_tls_options != NULL)
AzureIoTClient 34:51d158b409d2 609 {
AzureIoTClient 34:51d158b409d2 610 OptionHandler_Destroy(transport_instance->saved_tls_options);
AzureIoTClient 34:51d158b409d2 611 transport_instance->saved_tls_options = NULL;
AzureIoTClient 34:51d158b409d2 612 }
AzureIoTClient 25:63f7d371c030 613 }
AzureIoTClient 25:63f7d371c030 614
AzureIoTClient 30:20a85b733111 615 // @brief
AzureIoTClient 30:20a85b733111 616 // Applies TLS I/O options if previously saved to a new TLS I/O instance.
AzureIoTClient 30:20a85b733111 617 // @returns
AzureIoTClient 30:20a85b733111 618 // 0 if succeeds, non-zero otherwise.
AzureIoTClient 30:20a85b733111 619 static int restore_underlying_io_transport_options(AMQP_TRANSPORT_INSTANCE* transport_instance, XIO_HANDLE xio_handle)
AzureIoTClient 30:20a85b733111 620 {
AzureIoTClient 34:51d158b409d2 621 int result;
AzureIoTClient 30:20a85b733111 622
AzureIoTClient 34:51d158b409d2 623 if (transport_instance->saved_tls_options == NULL)
AzureIoTClient 34:51d158b409d2 624 {
AzureIoTClient 34:51d158b409d2 625 result = RESULT_OK;
AzureIoTClient 34:51d158b409d2 626 }
AzureIoTClient 34:51d158b409d2 627 else
AzureIoTClient 34:51d158b409d2 628 {
AzureIoTClient 34:51d158b409d2 629 if (OptionHandler_FeedOptions(transport_instance->saved_tls_options, xio_handle) != OPTIONHANDLER_OK)
AzureIoTClient 34:51d158b409d2 630 {
AzureIoTClient 34:51d158b409d2 631 LogError("Failed feeding existing options to new TLS instance.");
AzureIoTClient 34:51d158b409d2 632 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 633 }
AzureIoTClient 34:51d158b409d2 634 else
AzureIoTClient 34:51d158b409d2 635 {
AzureIoTClient 34:51d158b409d2 636 result = RESULT_OK;
AzureIoTClient 34:51d158b409d2 637 }
AzureIoTClient 34:51d158b409d2 638 }
AzureIoTClient 30:20a85b733111 639
AzureIoTClient 34:51d158b409d2 640 return result;
AzureIoTClient 30:20a85b733111 641 }
AzureIoTClient 30:20a85b733111 642
AzureIoTClient 30:20a85b733111 643 // @brief Destroys the XIO_HANDLE obtained with underlying_io_transport_provider(), saving its options beforehand.
AzureIoTClient 30:20a85b733111 644 static void destroy_underlying_io_transport(AMQP_TRANSPORT_INSTANCE* transport_instance)
AzureIoTClient 30:20a85b733111 645 {
AzureIoTClient 34:51d158b409d2 646 if (transport_instance->tls_io != NULL)
AzureIoTClient 34:51d158b409d2 647 {
AzureIoTClient 34:51d158b409d2 648 xio_destroy(transport_instance->tls_io);
AzureIoTClient 34:51d158b409d2 649 transport_instance->tls_io = NULL;
AzureIoTClient 34:51d158b409d2 650 }
AzureIoTClient 30:20a85b733111 651 }
AzureIoTClient 30:20a85b733111 652
AzureIoTClient 30:20a85b733111 653 // @brief Invokes underlying_io_transport_provider() and retrieves a new XIO_HANDLE to use for I/O (TLS, or websockets, or w/e is supported).
AzureIoTClient 30:20a85b733111 654 // @param xio_handle: if successfull, set with the new XIO_HANDLE acquired; not changed otherwise.
AzureIoTClient 30:20a85b733111 655 // @returns 0 if successfull, non-zero otherwise.
AzureIoTClient 30:20a85b733111 656 static int get_new_underlying_io_transport(AMQP_TRANSPORT_INSTANCE* transport_instance, XIO_HANDLE *xio_handle)
AzureIoTClient 30:20a85b733111 657 {
AzureIoTClient 34:51d158b409d2 658 int result;
AzureIoTClient 31:adadaef857c1 659 AMQP_TRANSPORT_PROXY_OPTIONS amqp_transport_proxy_options;
AzureIoTClient 30:20a85b733111 660
AzureIoTClient 31:adadaef857c1 661 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_041: [ If the `proxy_data` option has been set, the proxy options shall be filled in the argument `amqp_transport_proxy_options` when calling the function `underlying_io_transport_provider()` to obtain the underlying IO handle. ]*/
AzureIoTClient 31:adadaef857c1 662 amqp_transport_proxy_options.host_address = transport_instance->http_proxy_hostname;
AzureIoTClient 31:adadaef857c1 663 amqp_transport_proxy_options.port = transport_instance->http_proxy_port;
AzureIoTClient 31:adadaef857c1 664 amqp_transport_proxy_options.username = transport_instance->http_proxy_username;
AzureIoTClient 31:adadaef857c1 665 amqp_transport_proxy_options.password = transport_instance->http_proxy_password;
AzureIoTClient 31:adadaef857c1 666
AzureIoTClient 31:adadaef857c1 667 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_042: [ If no `proxy_data` option has been set, NULL shall be passed as the argument `amqp_transport_proxy_options` when calling the function `underlying_io_transport_provider()`. ]*/
AzureIoTClient 31:adadaef857c1 668 if ((*xio_handle = transport_instance->underlying_io_transport_provider(STRING_c_str(transport_instance->iothub_host_fqdn), amqp_transport_proxy_options.host_address == NULL ? NULL : &amqp_transport_proxy_options)) == NULL)
AzureIoTClient 34:51d158b409d2 669 {
AzureIoTClient 34:51d158b409d2 670 LogError("Failed to obtain a TLS I/O transport layer (underlying_io_transport_provider() failed)");
AzureIoTClient 34:51d158b409d2 671 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 672 }
AzureIoTClient 34:51d158b409d2 673 else
AzureIoTClient 34:51d158b409d2 674 {
AzureIoTClient 41:71c01aa3df1a 675 // If this is the DPS x509 ECC certificate
AzureIoTClient 41:71c01aa3df1a 676 if (IoTHubClient_Auth_Get_Credential_Type(transport_instance->authorization_module) == IOTHUB_CREDENTIAL_TYPE_X509_ECC)
AzureIoTClient 41:71c01aa3df1a 677 {
AzureIoTClient 41:71c01aa3df1a 678 // Set the xio_handle
AzureIoTClient 41:71c01aa3df1a 679 if (IoTHubClient_Auth_Set_xio_Certificate(transport_instance->authorization_module, *xio_handle) != 0)
AzureIoTClient 41:71c01aa3df1a 680 {
AzureIoTClient 41:71c01aa3df1a 681 LogError("Unable to create the lower level TLS layer.");
AzureIoTClient 41:71c01aa3df1a 682 result = __FAILURE__;
AzureIoTClient 41:71c01aa3df1a 683 }
AzureIoTClient 41:71c01aa3df1a 684 else
AzureIoTClient 41:71c01aa3df1a 685 {
AzureIoTClient 41:71c01aa3df1a 686 result = 0;
AzureIoTClient 41:71c01aa3df1a 687 }
AzureIoTClient 41:71c01aa3df1a 688 }
AzureIoTClient 41:71c01aa3df1a 689 else
AzureIoTClient 41:71c01aa3df1a 690 {
AzureIoTClient 41:71c01aa3df1a 691 result = 0;
AzureIoTClient 41:71c01aa3df1a 692 }
AzureIoTClient 41:71c01aa3df1a 693
AzureIoTClient 34:51d158b409d2 694 if (restore_underlying_io_transport_options(transport_instance, *xio_handle) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 695 {
AzureIoTClient 34:51d158b409d2 696 /*pessimistically hope TLS will fail, be recreated and options re-given*/
AzureIoTClient 34:51d158b409d2 697 LogError("Failed to apply options previous saved to new underlying I/O transport instance.");
AzureIoTClient 34:51d158b409d2 698 }
AzureIoTClient 30:20a85b733111 699
AzureIoTClient 34:51d158b409d2 700 result = RESULT_OK;
AzureIoTClient 34:51d158b409d2 701 }
AzureIoTClient 30:20a85b733111 702
AzureIoTClient 34:51d158b409d2 703 return result;
AzureIoTClient 30:20a85b733111 704 }
AzureIoTClient 30:20a85b733111 705
AzureIoTClient 30:20a85b733111 706
AzureIoTClient 30:20a85b733111 707 // ---------- AMQP connection establishment/tear-down, connectry retry ---------- //
AzureIoTClient 30:20a85b733111 708
AzureIoTClient 30:20a85b733111 709 static void on_amqp_connection_state_changed(const void* context, AMQP_CONNECTION_STATE previous_state, AMQP_CONNECTION_STATE new_state)
AzureIoTClient 30:20a85b733111 710 {
AzureIoTClient 34:51d158b409d2 711 if (context != NULL && new_state != previous_state)
AzureIoTClient 34:51d158b409d2 712 {
AzureIoTClient 34:51d158b409d2 713 AMQP_TRANSPORT_INSTANCE* transport_instance = (AMQP_TRANSPORT_INSTANCE*)context;
AzureIoTClient 30:20a85b733111 714
AzureIoTClient 34:51d158b409d2 715 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_059: [`new_state` shall be saved in to the transport instance]
AzureIoTClient 34:51d158b409d2 716 transport_instance->amqp_connection_state = new_state;
AzureIoTClient 30:20a85b733111 717
AzureIoTClient 34:51d158b409d2 718 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_060: [If `new_state` is AMQP_CONNECTION_STATE_ERROR, the connection shall be flagged as faulty (so the connection retry logic can be triggered)]
AzureIoTClient 34:51d158b409d2 719 if (new_state == AMQP_CONNECTION_STATE_ERROR)
AzureIoTClient 34:51d158b409d2 720 {
AzureIoTClient 34:51d158b409d2 721 LogError("Transport received an ERROR from the amqp_connection (state changed %s -> %s); it will be flagged for connection retry.", ENUM_TO_STRING(AMQP_CONNECTION_STATE, previous_state), ENUM_TO_STRING(AMQP_CONNECTION_STATE, new_state));
AzureIoTClient 31:adadaef857c1 722
AzureIoTClient 34:51d158b409d2 723 update_state(transport_instance, AMQP_TRANSPORT_STATE_RECONNECTION_REQUIRED);
AzureIoTClient 34:51d158b409d2 724 }
AzureIoTClient 34:51d158b409d2 725 else if (new_state == AMQP_CONNECTION_STATE_OPENED)
AzureIoTClient 34:51d158b409d2 726 {
AzureIoTClient 34:51d158b409d2 727 update_state(transport_instance, AMQP_TRANSPORT_STATE_CONNECTED);
AzureIoTClient 34:51d158b409d2 728 }
AzureIoTClient 34:51d158b409d2 729 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_115: [If the AMQP connection is closed by the service side, the connection retry logic shall be triggered]
AzureIoTClient 34:51d158b409d2 730 else if (new_state == AMQP_CONNECTION_STATE_CLOSED && previous_state == AMQP_CONNECTION_STATE_OPENED && transport_instance->state != AMQP_TRANSPORT_STATE_BEING_DESTROYED)
AzureIoTClient 34:51d158b409d2 731 {
AzureIoTClient 34:51d158b409d2 732 LogError("amqp_connection was closed unexpectedly; connection retry will be triggered.");
AzureIoTClient 30:20a85b733111 733
AzureIoTClient 34:51d158b409d2 734 update_state(transport_instance, AMQP_TRANSPORT_STATE_RECONNECTION_REQUIRED);
AzureIoTClient 34:51d158b409d2 735 }
AzureIoTClient 34:51d158b409d2 736 }
AzureIoTClient 30:20a85b733111 737 }
AzureIoTClient 30:20a85b733111 738
AzureIoTClient 30:20a85b733111 739 static int establish_amqp_connection(AMQP_TRANSPORT_INSTANCE* transport_instance)
AzureIoTClient 25:63f7d371c030 740 {
AzureIoTClient 25:63f7d371c030 741 int result;
AzureIoTClient 25:63f7d371c030 742
AzureIoTClient 34:51d158b409d2 743 if (transport_instance->preferred_authentication_mode == AMQP_TRANSPORT_AUTHENTICATION_MODE_NOT_SET)
AzureIoTClient 34:51d158b409d2 744 {
AzureIoTClient 34:51d158b409d2 745 LogError("Failed establishing connection (transport doesn't have a preferred authentication mode set; unexpected!).");
AzureIoTClient 34:51d158b409d2 746 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 747 }
AzureIoTClient 34:51d158b409d2 748 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_023: [If `instance->tls_io` is NULL, it shall be set invoking instance->underlying_io_transport_provider()]
AzureIoTClient 34:51d158b409d2 749 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_025: [When `instance->tls_io` is created, it shall be set with `instance->saved_tls_options` using OptionHandler_FeedOptions()]
AzureIoTClient 34:51d158b409d2 750 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_111: [If OptionHandler_FeedOptions() fails, it shall be ignored]
AzureIoTClient 34:51d158b409d2 751 else if (transport_instance->tls_io == NULL &&
AzureIoTClient 34:51d158b409d2 752 get_new_underlying_io_transport(transport_instance, &transport_instance->tls_io) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 753 {
AzureIoTClient 34:51d158b409d2 754 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_024: [If instance->underlying_io_transport_provider() fails, IoTHubTransport_AMQP_Common_DoWork shall fail and return]
AzureIoTClient 34:51d158b409d2 755 LogError("Failed establishing connection (failed to obtain a TLS I/O transport layer).");
AzureIoTClient 34:51d158b409d2 756 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 757 }
AzureIoTClient 34:51d158b409d2 758 else
AzureIoTClient 34:51d158b409d2 759 {
AzureIoTClient 34:51d158b409d2 760 AMQP_CONNECTION_CONFIG amqp_connection_config;
AzureIoTClient 34:51d158b409d2 761 amqp_connection_config.iothub_host_fqdn = STRING_c_str(transport_instance->iothub_host_fqdn);
AzureIoTClient 34:51d158b409d2 762 amqp_connection_config.underlying_io_transport = transport_instance->tls_io;
AzureIoTClient 34:51d158b409d2 763 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_029: [`instance->is_trace_on` shall be set into `AMQP_CONNECTION_CONFIG->is_trace_on`]
AzureIoTClient 34:51d158b409d2 764 amqp_connection_config.is_trace_on = transport_instance->is_trace_on;
AzureIoTClient 34:51d158b409d2 765 amqp_connection_config.on_state_changed_callback = on_amqp_connection_state_changed;
AzureIoTClient 34:51d158b409d2 766 amqp_connection_config.on_state_changed_context = transport_instance;
AzureIoTClient 37:abd16824f63b 767 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_12_003: [AMQP connection will be configured using the `c2d_keep_alive_freq_secs` value from SetOption ]
AzureIoTClient 37:abd16824f63b 768 amqp_connection_config.c2d_keep_alive_freq_secs = transport_instance->c2d_keep_alive_freq_secs;
AzureIoTClient 25:63f7d371c030 769
AzureIoTClient 34:51d158b409d2 770 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_027: [If `transport->preferred_authentication_method` is CBS, AMQP_CONNECTION_CONFIG shall be set with `create_sasl_io` = true and `create_cbs_connection` = true]
AzureIoTClient 34:51d158b409d2 771 if (transport_instance->preferred_authentication_mode == AMQP_TRANSPORT_AUTHENTICATION_MODE_CBS)
AzureIoTClient 34:51d158b409d2 772 {
AzureIoTClient 34:51d158b409d2 773 amqp_connection_config.create_sasl_io = true;
AzureIoTClient 34:51d158b409d2 774 amqp_connection_config.create_cbs_connection = true;
AzureIoTClient 34:51d158b409d2 775 }
AzureIoTClient 34:51d158b409d2 776 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_028: [If `transport->preferred_credential_method` is X509, AMQP_CONNECTION_CONFIG shall be set with `create_sasl_io` = false and `create_cbs_connection` = false]
AzureIoTClient 34:51d158b409d2 777 else if (transport_instance->preferred_authentication_mode == AMQP_TRANSPORT_AUTHENTICATION_MODE_X509)
AzureIoTClient 34:51d158b409d2 778 {
AzureIoTClient 34:51d158b409d2 779 amqp_connection_config.create_sasl_io = false;
AzureIoTClient 34:51d158b409d2 780 amqp_connection_config.create_cbs_connection = false;
AzureIoTClient 34:51d158b409d2 781 }
AzureIoTClient 34:51d158b409d2 782 // If new AMQP_TRANSPORT_AUTHENTICATION_MODE values are added, they need to be covered here.
AzureIoTClient 25:63f7d371c030 783
AzureIoTClient 34:51d158b409d2 784 transport_instance->amqp_connection_state = AMQP_CONNECTION_STATE_CLOSED;
AzureIoTClient 30:20a85b733111 785
AzureIoTClient 34:51d158b409d2 786 if (transport_instance->state == AMQP_TRANSPORT_STATE_READY_FOR_RECONNECTION)
AzureIoTClient 34:51d158b409d2 787 {
AzureIoTClient 34:51d158b409d2 788 update_state(transport_instance, AMQP_TRANSPORT_STATE_RECONNECTING);
AzureIoTClient 34:51d158b409d2 789 }
AzureIoTClient 34:51d158b409d2 790 else
AzureIoTClient 34:51d158b409d2 791 {
AzureIoTClient 34:51d158b409d2 792 update_state(transport_instance, AMQP_TRANSPORT_STATE_CONNECTING);
AzureIoTClient 34:51d158b409d2 793 }
AzureIoTClient 32:babfd49032ff 794
AzureIoTClient 34:51d158b409d2 795 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_026: [If `transport->connection` is NULL, it shall be created using amqp_connection_create()]
AzureIoTClient 34:51d158b409d2 796 if ((transport_instance->amqp_connection = amqp_connection_create(&amqp_connection_config)) == NULL)
AzureIoTClient 34:51d158b409d2 797 {
AzureIoTClient 34:51d158b409d2 798 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_030: [If amqp_connection_create() fails, IoTHubTransport_AMQP_Common_DoWork shall fail and return]
AzureIoTClient 34:51d158b409d2 799 LogError("Failed establishing connection (failed to create the amqp_connection instance).");
AzureIoTClient 34:51d158b409d2 800 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 801 }
AzureIoTClient 34:51d158b409d2 802 else
AzureIoTClient 34:51d158b409d2 803 {
AzureIoTClient 34:51d158b409d2 804 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_110: [If amqp_connection_create() succeeds, IoTHubTransport_AMQP_Common_DoWork shall proceed to invoke amqp_connection_do_work]
AzureIoTClient 34:51d158b409d2 805 result = RESULT_OK;
AzureIoTClient 34:51d158b409d2 806 }
AzureIoTClient 34:51d158b409d2 807 }
AzureIoTClient 25:63f7d371c030 808
AzureIoTClient 25:63f7d371c030 809 return result;
AzureIoTClient 25:63f7d371c030 810 }
AzureIoTClient 25:63f7d371c030 811
AzureIoTClient 30:20a85b733111 812 static void prepare_device_for_connection_retry(AMQP_TRANSPORT_DEVICE_INSTANCE* registered_device)
AzureIoTClient 25:63f7d371c030 813 {
AzureIoTClient 30:20a85b733111 814 #ifdef WIP_C2D_METHODS_AMQP /* This feature is WIP, do not use yet */
AzureIoTClient 34:51d158b409d2 815 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_032: [ Each `instance->registered_devices` shall unsubscribe from receiving C2D method requests by calling `iothubtransportamqp_methods_unsubscribe`]
AzureIoTClient 30:20a85b733111 816 iothubtransportamqp_methods_unsubscribe(registered_device->methods_handle);
AzureIoTClient 34:51d158b409d2 817 registered_device->subscribed_for_methods = 0;
AzureIoTClient 30:20a85b733111 818 #endif
AzureIoTClient 25:63f7d371c030 819
AzureIoTClient 34:51d158b409d2 820 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_031: [device_stop() shall be invoked on all `instance->registered_devices` that are not already stopped]
AzureIoTClient 34:51d158b409d2 821 if (registered_device->device_state != DEVICE_STATE_STOPPED)
AzureIoTClient 34:51d158b409d2 822 {
AzureIoTClient 34:51d158b409d2 823 if (device_stop(registered_device->device_handle) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 824 {
AzureIoTClient 34:51d158b409d2 825 LogError("Failed preparing device '%s' for connection retry (device_stop failed)", STRING_c_str(registered_device->device_id));
AzureIoTClient 34:51d158b409d2 826 }
AzureIoTClient 34:51d158b409d2 827 }
AzureIoTClient 25:63f7d371c030 828
AzureIoTClient 34:51d158b409d2 829 registered_device->number_of_previous_failures = 0;
AzureIoTClient 34:51d158b409d2 830 registered_device->number_of_send_event_complete_failures = 0;
AzureIoTClient 25:63f7d371c030 831 }
AzureIoTClient 25:63f7d371c030 832
AzureIoTClient 30:20a85b733111 833 static void prepare_for_connection_retry(AMQP_TRANSPORT_INSTANCE* transport_instance)
AzureIoTClient 25:63f7d371c030 834 {
AzureIoTClient 34:51d158b409d2 835 LogInfo("Preparing transport for re-connection");
AzureIoTClient 32:babfd49032ff 836
AzureIoTClient 34:51d158b409d2 837 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_034: [`instance->tls_io` options shall be saved on `instance->saved_tls_options` using xio_retrieveoptions()]
AzureIoTClient 34:51d158b409d2 838 if (save_underlying_io_transport_options(transport_instance) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 839 {
AzureIoTClient 34:51d158b409d2 840 LogError("Failed saving TLS I/O options while preparing for connection retry; failure will be ignored");
AzureIoTClient 34:51d158b409d2 841 }
AzureIoTClient 25:63f7d371c030 842
AzureIoTClient 34:51d158b409d2 843 LIST_ITEM_HANDLE list_item = singlylinkedlist_get_head_item(transport_instance->registered_devices);
AzureIoTClient 30:20a85b733111 844
AzureIoTClient 34:51d158b409d2 845 while (list_item != NULL)
AzureIoTClient 34:51d158b409d2 846 {
AzureIoTClient 34:51d158b409d2 847 AMQP_TRANSPORT_DEVICE_INSTANCE* registered_device = (AMQP_TRANSPORT_DEVICE_INSTANCE*)singlylinkedlist_item_get_value(list_item);
AzureIoTClient 25:63f7d371c030 848
AzureIoTClient 34:51d158b409d2 849 if (registered_device == NULL)
AzureIoTClient 34:51d158b409d2 850 {
AzureIoTClient 34:51d158b409d2 851 LogError("Failed preparing device for connection retry (singlylinkedlist_item_get_value failed)");
AzureIoTClient 34:51d158b409d2 852 }
AzureIoTClient 34:51d158b409d2 853 else
AzureIoTClient 34:51d158b409d2 854 {
AzureIoTClient 34:51d158b409d2 855 prepare_device_for_connection_retry(registered_device);
AzureIoTClient 34:51d158b409d2 856 }
AzureIoTClient 25:63f7d371c030 857
AzureIoTClient 34:51d158b409d2 858 list_item = singlylinkedlist_get_next_item(list_item);
AzureIoTClient 34:51d158b409d2 859 }
AzureIoTClient 25:63f7d371c030 860
AzureIoTClient 34:51d158b409d2 861 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_033: [`instance->connection` shall be destroyed using amqp_connection_destroy()]
AzureIoTClient 34:51d158b409d2 862 amqp_connection_destroy(transport_instance->amqp_connection);
AzureIoTClient 34:51d158b409d2 863 transport_instance->amqp_connection = NULL;
AzureIoTClient 30:20a85b733111 864 transport_instance->amqp_connection_state = AMQP_CONNECTION_STATE_CLOSED;
AzureIoTClient 25:63f7d371c030 865
AzureIoTClient 34:51d158b409d2 866 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_035: [`instance->tls_io` shall be destroyed using xio_destroy()]
AzureIoTClient 34:51d158b409d2 867 destroy_underlying_io_transport(transport_instance);
AzureIoTClient 32:babfd49032ff 868
AzureIoTClient 34:51d158b409d2 869 update_state(transport_instance, AMQP_TRANSPORT_STATE_READY_FOR_RECONNECTION);
AzureIoTClient 25:63f7d371c030 870 }
AzureIoTClient 25:63f7d371c030 871
AzureIoTClient 30:20a85b733111 872
AzureIoTClient 30:20a85b733111 873 // @brief Verifies if the crendentials used by the device match the requirements and authentication mode currently supported by the transport.
AzureIoTClient 30:20a85b733111 874 // @returns true if credentials are good, false otherwise.
AzureIoTClient 30:20a85b733111 875 static bool is_device_credential_acceptable(const IOTHUB_DEVICE_CONFIG* device_config, AMQP_TRANSPORT_AUTHENTICATION_MODE preferred_authentication_mode)
AzureIoTClient 25:63f7d371c030 876 {
AzureIoTClient 30:20a85b733111 877 bool result;
AzureIoTClient 25:63f7d371c030 878
AzureIoTClient 34:51d158b409d2 879 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_03_003: [IoTHubTransport_AMQP_Common_Register shall return NULL if both deviceKey and deviceSasToken are not NULL.]
AzureIoTClient 34:51d158b409d2 880 if ((device_config->deviceSasToken != NULL) && (device_config->deviceKey != NULL))
AzureIoTClient 34:51d158b409d2 881 {
AzureIoTClient 34:51d158b409d2 882 LogError("Credential of device '%s' is not acceptable (must provide EITHER deviceSasToken OR deviceKey)", device_config->deviceId);
AzureIoTClient 34:51d158b409d2 883 result = false;
AzureIoTClient 34:51d158b409d2 884 }
AzureIoTClient 30:20a85b733111 885 else if (preferred_authentication_mode == AMQP_TRANSPORT_AUTHENTICATION_MODE_NOT_SET)
AzureIoTClient 26:ee14eed604f6 886 {
AzureIoTClient 30:20a85b733111 887 result = true;
AzureIoTClient 30:20a85b733111 888 }
AzureIoTClient 30:20a85b733111 889 else if (preferred_authentication_mode == AMQP_TRANSPORT_AUTHENTICATION_MODE_X509 && (device_config->deviceKey != NULL || device_config->deviceSasToken != NULL))
AzureIoTClient 30:20a85b733111 890 {
AzureIoTClient 34:51d158b409d2 891 LogError("Credential of device '%s' is not acceptable (transport is using X509 certificate authentication, but device config contains deviceKey or sasToken)", device_config->deviceId);
AzureIoTClient 30:20a85b733111 892 result = false;
AzureIoTClient 30:20a85b733111 893 }
AzureIoTClient 30:20a85b733111 894 else if (preferred_authentication_mode != AMQP_TRANSPORT_AUTHENTICATION_MODE_X509 && (device_config->deviceKey == NULL && device_config->deviceSasToken == NULL))
AzureIoTClient 30:20a85b733111 895 {
AzureIoTClient 34:51d158b409d2 896 LogError("Credential of device '%s' is not acceptable (transport is using CBS authentication, but device config does not contain deviceKey nor sasToken)", device_config->deviceId);
AzureIoTClient 30:20a85b733111 897 result = false;
AzureIoTClient 26:ee14eed604f6 898 }
AzureIoTClient 26:ee14eed604f6 899 else
AzureIoTClient 26:ee14eed604f6 900 {
AzureIoTClient 30:20a85b733111 901 result = true;
AzureIoTClient 26:ee14eed604f6 902 }
AzureIoTClient 25:63f7d371c030 903
AzureIoTClient 26:ee14eed604f6 904 return result;
AzureIoTClient 25:63f7d371c030 905 }
AzureIoTClient 25:63f7d371c030 906
AzureIoTClient 25:63f7d371c030 907
AzureIoTClient 30:20a85b733111 908
AzureIoTClient 30:20a85b733111 909 //---------- DoWork Helpers ----------//
AzureIoTClient 30:20a85b733111 910
AzureIoTClient 30:20a85b733111 911 static IOTHUB_MESSAGE_LIST* get_next_event_to_send(AMQP_TRANSPORT_DEVICE_INSTANCE* registered_device)
AzureIoTClient 30:20a85b733111 912 {
AzureIoTClient 34:51d158b409d2 913 IOTHUB_MESSAGE_LIST* message;
AzureIoTClient 30:20a85b733111 914
AzureIoTClient 34:51d158b409d2 915 if (!DList_IsListEmpty(registered_device->waiting_to_send))
AzureIoTClient 34:51d158b409d2 916 {
AzureIoTClient 34:51d158b409d2 917 PDLIST_ENTRY list_entry = registered_device->waiting_to_send->Flink;
AzureIoTClient 34:51d158b409d2 918 message = containingRecord(list_entry, IOTHUB_MESSAGE_LIST, entry);
AzureIoTClient 34:51d158b409d2 919 (void)DList_RemoveEntryList(list_entry);
AzureIoTClient 34:51d158b409d2 920 }
AzureIoTClient 34:51d158b409d2 921 else
AzureIoTClient 34:51d158b409d2 922 {
AzureIoTClient 34:51d158b409d2 923 message = NULL;
AzureIoTClient 34:51d158b409d2 924 }
AzureIoTClient 30:20a85b733111 925
AzureIoTClient 34:51d158b409d2 926 return message;
AzureIoTClient 30:20a85b733111 927 }
AzureIoTClient 30:20a85b733111 928
AzureIoTClient 30:20a85b733111 929 // @brief "Parses" the D2C_EVENT_SEND_RESULT (from iothubtransport_amqp_device module) into a IOTHUB_CLIENT_CONFIRMATION_RESULT.
AzureIoTClient 30:20a85b733111 930 static IOTHUB_CLIENT_CONFIRMATION_RESULT get_iothub_client_confirmation_result_from(D2C_EVENT_SEND_RESULT result)
AzureIoTClient 30:20a85b733111 931 {
AzureIoTClient 34:51d158b409d2 932 IOTHUB_CLIENT_CONFIRMATION_RESULT iothub_send_result;
AzureIoTClient 30:20a85b733111 933
AzureIoTClient 34:51d158b409d2 934 switch (result)
AzureIoTClient 34:51d158b409d2 935 {
AzureIoTClient 34:51d158b409d2 936 case D2C_EVENT_SEND_COMPLETE_RESULT_OK:
AzureIoTClient 34:51d158b409d2 937 iothub_send_result = IOTHUB_CLIENT_CONFIRMATION_OK;
AzureIoTClient 34:51d158b409d2 938 break;
AzureIoTClient 34:51d158b409d2 939 case D2C_EVENT_SEND_COMPLETE_RESULT_ERROR_CANNOT_PARSE:
AzureIoTClient 34:51d158b409d2 940 case D2C_EVENT_SEND_COMPLETE_RESULT_ERROR_FAIL_SENDING:
AzureIoTClient 34:51d158b409d2 941 iothub_send_result = IOTHUB_CLIENT_CONFIRMATION_ERROR;
AzureIoTClient 34:51d158b409d2 942 break;
AzureIoTClient 34:51d158b409d2 943 case D2C_EVENT_SEND_COMPLETE_RESULT_ERROR_TIMEOUT:
AzureIoTClient 34:51d158b409d2 944 iothub_send_result = IOTHUB_CLIENT_CONFIRMATION_MESSAGE_TIMEOUT;
AzureIoTClient 34:51d158b409d2 945 break;
AzureIoTClient 34:51d158b409d2 946 case D2C_EVENT_SEND_COMPLETE_RESULT_DEVICE_DESTROYED:
AzureIoTClient 34:51d158b409d2 947 iothub_send_result = IOTHUB_CLIENT_CONFIRMATION_BECAUSE_DESTROY;
AzureIoTClient 34:51d158b409d2 948 break;
AzureIoTClient 34:51d158b409d2 949 case D2C_EVENT_SEND_COMPLETE_RESULT_ERROR_UNKNOWN:
AzureIoTClient 34:51d158b409d2 950 default:
AzureIoTClient 34:51d158b409d2 951 iothub_send_result = IOTHUB_CLIENT_CONFIRMATION_ERROR;
AzureIoTClient 34:51d158b409d2 952 break;
AzureIoTClient 34:51d158b409d2 953 }
AzureIoTClient 30:20a85b733111 954
AzureIoTClient 34:51d158b409d2 955 return iothub_send_result;
AzureIoTClient 30:20a85b733111 956 }
AzureIoTClient 30:20a85b733111 957
AzureIoTClient 30:20a85b733111 958 // @brief
AzureIoTClient 30:20a85b733111 959 // Callback function for device_send_event_async.
AzureIoTClient 30:20a85b733111 960 static void on_event_send_complete(IOTHUB_MESSAGE_LIST* message, D2C_EVENT_SEND_RESULT result, void* context)
AzureIoTClient 30:20a85b733111 961 {
AzureIoTClient 34:51d158b409d2 962 AMQP_TRANSPORT_DEVICE_INSTANCE* registered_device = (AMQP_TRANSPORT_DEVICE_INSTANCE*)context;
AzureIoTClient 30:20a85b733111 963
AzureIoTClient 34:51d158b409d2 964 if (result != D2C_EVENT_SEND_COMPLETE_RESULT_OK && result != D2C_EVENT_SEND_COMPLETE_RESULT_DEVICE_DESTROYED)
AzureIoTClient 34:51d158b409d2 965 {
AzureIoTClient 34:51d158b409d2 966 registered_device->number_of_send_event_complete_failures++;
AzureIoTClient 34:51d158b409d2 967 }
AzureIoTClient 34:51d158b409d2 968 else
AzureIoTClient 34:51d158b409d2 969 {
AzureIoTClient 34:51d158b409d2 970 registered_device->number_of_send_event_complete_failures = 0;
AzureIoTClient 34:51d158b409d2 971 }
AzureIoTClient 30:20a85b733111 972
AzureIoTClient 34:51d158b409d2 973 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_056: [If `message->callback` is not NULL, it shall invoked with the `iothub_send_result`]
AzureIoTClient 34:51d158b409d2 974 if (message->callback != NULL)
AzureIoTClient 34:51d158b409d2 975 {
AzureIoTClient 34:51d158b409d2 976 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_050: [If result is D2C_EVENT_SEND_COMPLETE_RESULT_OK, `iothub_send_result` shall be set using IOTHUB_CLIENT_CONFIRMATION_OK]
AzureIoTClient 34:51d158b409d2 977 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_051: [If result is D2C_EVENT_SEND_COMPLETE_RESULT_ERROR_CANNOT_PARSE, `iothub_send_result` shall be set using IOTHUB_CLIENT_CONFIRMATION_ERROR]
AzureIoTClient 34:51d158b409d2 978 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_052: [If result is D2C_EVENT_SEND_COMPLETE_RESULT_ERROR_FAIL_SENDING, `iothub_send_result` shall be set using IOTHUB_CLIENT_CONFIRMATION_ERROR]
AzureIoTClient 34:51d158b409d2 979 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_053: [If result is D2C_EVENT_SEND_COMPLETE_RESULT_ERROR_TIMEOUT, `iothub_send_result` shall be set using IOTHUB_CLIENT_CONFIRMATION_MESSAGE_TIMEOUT]
AzureIoTClient 34:51d158b409d2 980 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_054: [If result is D2C_EVENT_SEND_COMPLETE_RESULT_DEVICE_DESTROYED, `iothub_send_result` shall be set using IOTHUB_CLIENT_CONFIRMATION_BECAUSE_DESTROY]
AzureIoTClient 34:51d158b409d2 981 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_055: [If result is D2C_EVENT_SEND_COMPLETE_RESULT_ERROR_UNKNOWN, `iothub_send_result` shall be set using IOTHUB_CLIENT_CONFIRMATION_ERROR]
AzureIoTClient 34:51d158b409d2 982 IOTHUB_CLIENT_CONFIRMATION_RESULT iothub_send_result = get_iothub_client_confirmation_result_from(result);
AzureIoTClient 30:20a85b733111 983
AzureIoTClient 34:51d158b409d2 984 message->callback(iothub_send_result, message->context);
AzureIoTClient 34:51d158b409d2 985 }
AzureIoTClient 30:20a85b733111 986
AzureIoTClient 34:51d158b409d2 987 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_057: [`message->messageHandle` shall be destroyed using IoTHubMessage_Destroy]
AzureIoTClient 34:51d158b409d2 988 IoTHubMessage_Destroy(message->messageHandle);
AzureIoTClient 34:51d158b409d2 989 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_058: [`message` shall be destroyed using free]
AzureIoTClient 34:51d158b409d2 990 free(message);
AzureIoTClient 30:20a85b733111 991 }
AzureIoTClient 30:20a85b733111 992
AzureIoTClient 30:20a85b733111 993 // @brief
AzureIoTClient 30:20a85b733111 994 // Gets events from wait to send list and sends to service in the order they were added.
AzureIoTClient 30:20a85b733111 995 // @returns
AzureIoTClient 30:20a85b733111 996 // 0 if all events could be sent to the next layer successfully, non-zero otherwise.
AzureIoTClient 30:20a85b733111 997 static int send_pending_events(AMQP_TRANSPORT_DEVICE_INSTANCE* device_state)
AzureIoTClient 30:20a85b733111 998 {
AzureIoTClient 34:51d158b409d2 999 int result;
AzureIoTClient 34:51d158b409d2 1000 IOTHUB_MESSAGE_LIST* message;
AzureIoTClient 30:20a85b733111 1001
AzureIoTClient 34:51d158b409d2 1002 result = RESULT_OK;
AzureIoTClient 30:20a85b733111 1003
AzureIoTClient 34:51d158b409d2 1004 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_047: [If the registered device is started, each event on `registered_device->wait_to_send_list` shall be removed from the list and sent using device_send_event_async()]
AzureIoTClient 34:51d158b409d2 1005 while ((message = get_next_event_to_send(device_state)) != NULL)
AzureIoTClient 34:51d158b409d2 1006 {
AzureIoTClient 34:51d158b409d2 1007 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_048: [device_send_event_async() shall be invoked passing `on_event_send_complete`]
AzureIoTClient 34:51d158b409d2 1008 if (device_send_event_async(device_state->device_handle, message, on_event_send_complete, device_state) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 1009 {
AzureIoTClient 34:51d158b409d2 1010 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_049: [If device_send_event_async() fails, `on_event_send_complete` shall be invoked passing EVENT_SEND_COMPLETE_RESULT_ERROR_FAIL_SENDING and return]
AzureIoTClient 34:51d158b409d2 1011 LogError("Device '%s' failed to send message (device_send_event_async failed)", STRING_c_str(device_state->device_id));
AzureIoTClient 34:51d158b409d2 1012 result = __FAILURE__;
AzureIoTClient 30:20a85b733111 1013
AzureIoTClient 34:51d158b409d2 1014 on_event_send_complete(message, D2C_EVENT_SEND_COMPLETE_RESULT_ERROR_FAIL_SENDING, device_state);
AzureIoTClient 34:51d158b409d2 1015 break;
AzureIoTClient 34:51d158b409d2 1016 }
AzureIoTClient 34:51d158b409d2 1017 }
AzureIoTClient 30:20a85b733111 1018
AzureIoTClient 34:51d158b409d2 1019 return result;
AzureIoTClient 30:20a85b733111 1020 }
AzureIoTClient 30:20a85b733111 1021
AzureIoTClient 30:20a85b733111 1022 // @brief
AzureIoTClient 30:20a85b733111 1023 // Auxiliary function for the public DoWork API, performing DoWork activities (authenticate, messaging) for a specific device.
AzureIoTClient 30:20a85b733111 1024 // @requires
AzureIoTClient 30:20a85b733111 1025 // The transport to have a valid instance of AMQP_CONNECTION (from which to obtain SESSION_HANDLE and CBS_HANDLE)
AzureIoTClient 30:20a85b733111 1026 // @returns
AzureIoTClient 30:20a85b733111 1027 // 0 if no errors occur, non-zero otherwise.
AzureIoTClient 30:20a85b733111 1028 static int IoTHubTransport_AMQP_Common_Device_DoWork(AMQP_TRANSPORT_DEVICE_INSTANCE* registered_device)
AzureIoTClient 30:20a85b733111 1029 {
AzureIoTClient 34:51d158b409d2 1030 int result;
AzureIoTClient 30:20a85b733111 1031
AzureIoTClient 34:51d158b409d2 1032 if (registered_device->device_state != DEVICE_STATE_STARTED)
AzureIoTClient 34:51d158b409d2 1033 {
AzureIoTClient 34:51d158b409d2 1034 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_036: [If the device state is DEVICE_STATE_STOPPED, it shall be started]
AzureIoTClient 34:51d158b409d2 1035 if (registered_device->device_state == DEVICE_STATE_STOPPED)
AzureIoTClient 34:51d158b409d2 1036 {
AzureIoTClient 34:51d158b409d2 1037 SESSION_HANDLE session_handle;
AzureIoTClient 34:51d158b409d2 1038 CBS_HANDLE cbs_handle = NULL;
AzureIoTClient 30:20a85b733111 1039
AzureIoTClient 34:51d158b409d2 1040 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_039: [amqp_connection_get_session_handle() shall be invoked on `instance->connection`]
AzureIoTClient 34:51d158b409d2 1041 if (amqp_connection_get_session_handle(registered_device->transport_instance->amqp_connection, &session_handle) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 1042 {
AzureIoTClient 34:51d158b409d2 1043 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_040: [If amqp_connection_get_session_handle() fails, IoTHubTransport_AMQP_Common_DoWork shall fail and return]
AzureIoTClient 34:51d158b409d2 1044 LogError("Failed performing DoWork for device '%s' (failed to get the amqp_connection session_handle)", STRING_c_str(registered_device->device_id));
AzureIoTClient 34:51d158b409d2 1045 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 1046 }
AzureIoTClient 34:51d158b409d2 1047 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_037: [If transport is using CBS authentication, amqp_connection_get_cbs_handle() shall be invoked on `instance->connection`]
AzureIoTClient 34:51d158b409d2 1048 else if (registered_device->transport_instance->preferred_authentication_mode == AMQP_TRANSPORT_AUTHENTICATION_MODE_CBS &&
AzureIoTClient 34:51d158b409d2 1049 amqp_connection_get_cbs_handle(registered_device->transport_instance->amqp_connection, &cbs_handle) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 1050 {
AzureIoTClient 34:51d158b409d2 1051 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_038: [If amqp_connection_get_cbs_handle() fails, IoTHubTransport_AMQP_Common_DoWork shall fail and return]
AzureIoTClient 34:51d158b409d2 1052 LogError("Failed performing DoWork for device '%s' (failed to get the amqp_connection cbs_handle)", STRING_c_str(registered_device->device_id));
AzureIoTClient 34:51d158b409d2 1053 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 1054 }
AzureIoTClient 34:51d158b409d2 1055 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_041: [The device handle shall be started using device_start_async()]
AzureIoTClient 34:51d158b409d2 1056 else if (device_start_async(registered_device->device_handle, session_handle, cbs_handle) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 1057 {
AzureIoTClient 34:51d158b409d2 1058 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_042: [If device_start_async() fails, IoTHubTransport_AMQP_Common_DoWork shall fail and skip to the next registered device]
AzureIoTClient 34:51d158b409d2 1059 LogError("Failed performing DoWork for device '%s' (failed to start device)", STRING_c_str(registered_device->device_id));
AzureIoTClient 34:51d158b409d2 1060 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 1061 }
AzureIoTClient 34:51d158b409d2 1062 else
AzureIoTClient 34:51d158b409d2 1063 {
AzureIoTClient 34:51d158b409d2 1064 result = RESULT_OK;
AzureIoTClient 34:51d158b409d2 1065 }
AzureIoTClient 34:51d158b409d2 1066 }
AzureIoTClient 34:51d158b409d2 1067 else if (registered_device->device_state == DEVICE_STATE_STARTING ||
AzureIoTClient 30:20a85b733111 1068 registered_device->device_state == DEVICE_STATE_STOPPING)
AzureIoTClient 34:51d158b409d2 1069 {
AzureIoTClient 34:51d158b409d2 1070 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_043: [If the device handle is in state DEVICE_STATE_STARTING or DEVICE_STATE_STOPPING, it shall be checked for state change timeout]
AzureIoTClient 34:51d158b409d2 1071 bool is_timed_out;
AzureIoTClient 34:51d158b409d2 1072 if (is_timeout_reached(registered_device->time_of_last_state_change, registered_device->max_state_change_timeout_secs, &is_timed_out) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 1073 {
AzureIoTClient 34:51d158b409d2 1074 LogError("Failed performing DoWork for device '%s' (failed tracking timeout of device %d state)", STRING_c_str(registered_device->device_id), registered_device->device_state);
AzureIoTClient 34:51d158b409d2 1075 registered_device->device_state = DEVICE_STATE_ERROR_AUTH; // if time could not be calculated, the worst must be assumed.
AzureIoTClient 34:51d158b409d2 1076 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 1077 }
AzureIoTClient 34:51d158b409d2 1078 else if (is_timed_out)
AzureIoTClient 34:51d158b409d2 1079 {
AzureIoTClient 34:51d158b409d2 1080 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_044: [If the device times out in state DEVICE_STATE_STARTING or DEVICE_STATE_STOPPING, the registered device shall be marked with failure]
AzureIoTClient 34:51d158b409d2 1081 LogError("Failed performing DoWork for device '%s' (device failed to start or stop within expected timeout)", STRING_c_str(registered_device->device_id));
AzureIoTClient 34:51d158b409d2 1082 registered_device->device_state = DEVICE_STATE_ERROR_AUTH; // this will cause device to be stopped bellow on the next call to this function.
AzureIoTClient 34:51d158b409d2 1083 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 1084 }
AzureIoTClient 34:51d158b409d2 1085 else
AzureIoTClient 34:51d158b409d2 1086 {
AzureIoTClient 34:51d158b409d2 1087 result = RESULT_OK;
AzureIoTClient 34:51d158b409d2 1088 }
AzureIoTClient 34:51d158b409d2 1089 }
AzureIoTClient 34:51d158b409d2 1090 else // i.e., DEVICE_STATE_ERROR_AUTH || DEVICE_STATE_ERROR_AUTH_TIMEOUT || DEVICE_STATE_ERROR_MSG
AzureIoTClient 34:51d158b409d2 1091 {
AzureIoTClient 34:51d158b409d2 1092 LogError("Failed performing DoWork for device '%s' (device reported state %d; number of previous failures: %d)",
AzureIoTClient 34:51d158b409d2 1093 STRING_c_str(registered_device->device_id), registered_device->device_state, registered_device->number_of_previous_failures);
AzureIoTClient 30:20a85b733111 1094
AzureIoTClient 34:51d158b409d2 1095 registered_device->number_of_previous_failures++;
AzureIoTClient 30:20a85b733111 1096
AzureIoTClient 34:51d158b409d2 1097 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_046: [If the device has failed for MAX_NUMBER_OF_DEVICE_FAILURES in a row, it shall trigger a connection retry on the transport]
AzureIoTClient 34:51d158b409d2 1098 if (registered_device->number_of_previous_failures >= MAX_NUMBER_OF_DEVICE_FAILURES)
AzureIoTClient 34:51d158b409d2 1099 {
AzureIoTClient 34:51d158b409d2 1100 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 1101 }
AzureIoTClient 34:51d158b409d2 1102 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_045: [If the registered device has a failure, it shall be stopped using device_stop()]
AzureIoTClient 34:51d158b409d2 1103 else if (device_stop(registered_device->device_handle) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 1104 {
AzureIoTClient 34:51d158b409d2 1105 LogError("Failed to stop reset device '%s' (device_stop failed)", STRING_c_str(registered_device->device_id));
AzureIoTClient 34:51d158b409d2 1106 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 1107 }
AzureIoTClient 34:51d158b409d2 1108 else
AzureIoTClient 34:51d158b409d2 1109 {
AzureIoTClient 34:51d158b409d2 1110 result = RESULT_OK;
AzureIoTClient 34:51d158b409d2 1111 }
AzureIoTClient 34:51d158b409d2 1112 }
AzureIoTClient 34:51d158b409d2 1113 }
AzureIoTClient 30:20a85b733111 1114 #ifdef WIP_C2D_METHODS_AMQP /* This feature is WIP, do not use yet */
AzureIoTClient 34:51d158b409d2 1115 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_031: [ Once the device is authenticated, `iothubtransportamqp_methods_subscribe` shall be invoked (subsequent DoWork calls shall not call it if already subscribed). ]
AzureIoTClient 34:51d158b409d2 1116 else if (registered_device->subscribe_methods_needed &&
AzureIoTClient 34:51d158b409d2 1117 !registered_device->subscribed_for_methods &&
AzureIoTClient 34:51d158b409d2 1118 subscribe_methods(registered_device) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 1119 {
AzureIoTClient 34:51d158b409d2 1120 LogError("Failed performing DoWork for device '%s' (failed registering for device methods)", STRING_c_str(registered_device->device_id));
AzureIoTClient 34:51d158b409d2 1121 registered_device->number_of_previous_failures++;
AzureIoTClient 34:51d158b409d2 1122 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 1123 }
AzureIoTClient 30:20a85b733111 1124 #endif
AzureIoTClient 34:51d158b409d2 1125 else
AzureIoTClient 34:51d158b409d2 1126 {
AzureIoTClient 34:51d158b409d2 1127 if (send_pending_events(registered_device) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 1128 {
AzureIoTClient 34:51d158b409d2 1129 LogError("Failed performing DoWork for device '%s' (failed sending pending events)", STRING_c_str(registered_device->device_id));
AzureIoTClient 34:51d158b409d2 1130 registered_device->number_of_previous_failures++;
AzureIoTClient 34:51d158b409d2 1131 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 1132 }
AzureIoTClient 34:51d158b409d2 1133 else
AzureIoTClient 34:51d158b409d2 1134 {
AzureIoTClient 34:51d158b409d2 1135 registered_device->number_of_previous_failures = 0;
AzureIoTClient 34:51d158b409d2 1136 result = RESULT_OK;
AzureIoTClient 34:51d158b409d2 1137 }
AzureIoTClient 34:51d158b409d2 1138 }
AzureIoTClient 30:20a85b733111 1139
AzureIoTClient 34:51d158b409d2 1140 // No harm in invoking this as API will simply exit if the state is not "started".
AzureIoTClient 34:51d158b409d2 1141 device_do_work(registered_device->device_handle);
AzureIoTClient 30:20a85b733111 1142
AzureIoTClient 34:51d158b409d2 1143 return result;
AzureIoTClient 30:20a85b733111 1144 }
AzureIoTClient 30:20a85b733111 1145
AzureIoTClient 30:20a85b733111 1146
AzureIoTClient 30:20a85b733111 1147 //---------- SetOption-ish Helpers ----------//
AzureIoTClient 30:20a85b733111 1148
AzureIoTClient 30:20a85b733111 1149 // @brief
AzureIoTClient 30:20a85b733111 1150 // Gets all the device-specific options and replicates them into this new registered device.
AzureIoTClient 30:20a85b733111 1151 // @returns
AzureIoTClient 30:20a85b733111 1152 // 0 if the function succeeds, non-zero otherwise.
AzureIoTClient 30:20a85b733111 1153 static int replicate_device_options_to(AMQP_TRANSPORT_DEVICE_INSTANCE* dev_instance, DEVICE_AUTH_MODE auth_mode)
AzureIoTClient 30:20a85b733111 1154 {
AzureIoTClient 34:51d158b409d2 1155 int result;
AzureIoTClient 30:20a85b733111 1156
AzureIoTClient 34:51d158b409d2 1157 if (device_set_option(
AzureIoTClient 34:51d158b409d2 1158 dev_instance->device_handle,
AzureIoTClient 34:51d158b409d2 1159 DEVICE_OPTION_EVENT_SEND_TIMEOUT_SECS,
AzureIoTClient 34:51d158b409d2 1160 &dev_instance->transport_instance->option_send_event_timeout_secs) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 1161 {
AzureIoTClient 34:51d158b409d2 1162 LogError("Failed to apply option DEVICE_OPTION_EVENT_SEND_TIMEOUT_SECS to device '%s' (device_set_option failed)", STRING_c_str(dev_instance->device_id));
AzureIoTClient 34:51d158b409d2 1163 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 1164 }
AzureIoTClient 34:51d158b409d2 1165 else if (auth_mode == DEVICE_AUTH_MODE_CBS)
AzureIoTClient 34:51d158b409d2 1166 {
AzureIoTClient 34:51d158b409d2 1167 if (device_set_option(
AzureIoTClient 34:51d158b409d2 1168 dev_instance->device_handle,
AzureIoTClient 34:51d158b409d2 1169 DEVICE_OPTION_CBS_REQUEST_TIMEOUT_SECS,
AzureIoTClient 34:51d158b409d2 1170 &dev_instance->transport_instance->option_cbs_request_timeout_secs) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 1171 {
AzureIoTClient 34:51d158b409d2 1172 LogError("Failed to apply option DEVICE_OPTION_CBS_REQUEST_TIMEOUT_SECS to device '%s' (device_set_option failed)", STRING_c_str(dev_instance->device_id));
AzureIoTClient 34:51d158b409d2 1173 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 1174 }
AzureIoTClient 34:51d158b409d2 1175 else if (device_set_option(
AzureIoTClient 34:51d158b409d2 1176 dev_instance->device_handle,
AzureIoTClient 34:51d158b409d2 1177 DEVICE_OPTION_SAS_TOKEN_LIFETIME_SECS,
AzureIoTClient 34:51d158b409d2 1178 &dev_instance->transport_instance->option_sas_token_lifetime_secs) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 1179 {
AzureIoTClient 34:51d158b409d2 1180 LogError("Failed to apply option DEVICE_OPTION_SAS_TOKEN_LIFETIME_SECS to device '%s' (device_set_option failed)", STRING_c_str(dev_instance->device_id));
AzureIoTClient 34:51d158b409d2 1181 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 1182 }
AzureIoTClient 34:51d158b409d2 1183 else if (device_set_option(
AzureIoTClient 34:51d158b409d2 1184 dev_instance->device_handle,
AzureIoTClient 34:51d158b409d2 1185 DEVICE_OPTION_SAS_TOKEN_REFRESH_TIME_SECS,
AzureIoTClient 34:51d158b409d2 1186 &dev_instance->transport_instance->option_sas_token_refresh_time_secs) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 1187 {
AzureIoTClient 34:51d158b409d2 1188 LogError("Failed to apply option DEVICE_OPTION_SAS_TOKEN_REFRESH_TIME_SECS to device '%s' (device_set_option failed)", STRING_c_str(dev_instance->device_id));
AzureIoTClient 34:51d158b409d2 1189 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 1190 }
AzureIoTClient 34:51d158b409d2 1191 else
AzureIoTClient 34:51d158b409d2 1192 {
AzureIoTClient 34:51d158b409d2 1193 result = RESULT_OK;
AzureIoTClient 34:51d158b409d2 1194 }
AzureIoTClient 34:51d158b409d2 1195 }
AzureIoTClient 34:51d158b409d2 1196 else
AzureIoTClient 34:51d158b409d2 1197 {
AzureIoTClient 34:51d158b409d2 1198 result = RESULT_OK;
AzureIoTClient 34:51d158b409d2 1199 }
AzureIoTClient 30:20a85b733111 1200
AzureIoTClient 34:51d158b409d2 1201 return result;
AzureIoTClient 30:20a85b733111 1202 }
AzureIoTClient 30:20a85b733111 1203
AzureIoTClient 30:20a85b733111 1204 // @brief
AzureIoTClient 30:20a85b733111 1205 // Translates from the option names supported by iothubtransport_amqp_common to the ones supported by iothubtransport_amqp_device.
AzureIoTClient 30:20a85b733111 1206 static const char* get_device_option_name_from(const char* iothubclient_option_name)
AzureIoTClient 30:20a85b733111 1207 {
AzureIoTClient 34:51d158b409d2 1208 const char* device_option_name;
AzureIoTClient 30:20a85b733111 1209
AzureIoTClient 34:51d158b409d2 1210 if (strcmp(OPTION_SAS_TOKEN_LIFETIME, iothubclient_option_name) == 0)
AzureIoTClient 34:51d158b409d2 1211 {
AzureIoTClient 34:51d158b409d2 1212 device_option_name = DEVICE_OPTION_SAS_TOKEN_LIFETIME_SECS;
AzureIoTClient 34:51d158b409d2 1213 }
AzureIoTClient 34:51d158b409d2 1214 else if (strcmp(OPTION_SAS_TOKEN_REFRESH_TIME, iothubclient_option_name) == 0)
AzureIoTClient 34:51d158b409d2 1215 {
AzureIoTClient 34:51d158b409d2 1216 device_option_name = DEVICE_OPTION_SAS_TOKEN_REFRESH_TIME_SECS;
AzureIoTClient 34:51d158b409d2 1217 }
AzureIoTClient 34:51d158b409d2 1218 else if (strcmp(OPTION_CBS_REQUEST_TIMEOUT, iothubclient_option_name) == 0)
AzureIoTClient 34:51d158b409d2 1219 {
AzureIoTClient 34:51d158b409d2 1220 device_option_name = DEVICE_OPTION_CBS_REQUEST_TIMEOUT_SECS;
AzureIoTClient 34:51d158b409d2 1221 }
AzureIoTClient 34:51d158b409d2 1222 else if (strcmp(OPTION_EVENT_SEND_TIMEOUT_SECS, iothubclient_option_name) == 0)
AzureIoTClient 34:51d158b409d2 1223 {
AzureIoTClient 34:51d158b409d2 1224 device_option_name = DEVICE_OPTION_EVENT_SEND_TIMEOUT_SECS;
AzureIoTClient 34:51d158b409d2 1225 }
AzureIoTClient 34:51d158b409d2 1226 else
AzureIoTClient 34:51d158b409d2 1227 {
AzureIoTClient 34:51d158b409d2 1228 device_option_name = NULL;
AzureIoTClient 34:51d158b409d2 1229 }
AzureIoTClient 30:20a85b733111 1230
AzureIoTClient 34:51d158b409d2 1231 return device_option_name;
AzureIoTClient 30:20a85b733111 1232 }
AzureIoTClient 30:20a85b733111 1233
AzureIoTClient 30:20a85b733111 1234 // @brief
AzureIoTClient 30:20a85b733111 1235 // Auxiliary function invoked by IoTHubTransport_AMQP_Common_SetOption to set an option on every registered device.
AzureIoTClient 30:20a85b733111 1236 // @returns
AzureIoTClient 30:20a85b733111 1237 // 0 if it succeeds, non-zero otherwise.
AzureIoTClient 30:20a85b733111 1238 static int IoTHubTransport_AMQP_Common_Device_SetOption(TRANSPORT_LL_HANDLE handle, const char* option, void* value)
AzureIoTClient 30:20a85b733111 1239 {
AzureIoTClient 34:51d158b409d2 1240 int result;
AzureIoTClient 34:51d158b409d2 1241 const char* device_option;
AzureIoTClient 30:20a85b733111 1242
AzureIoTClient 34:51d158b409d2 1243 if ((device_option = get_device_option_name_from(option)) == NULL)
AzureIoTClient 34:51d158b409d2 1244 {
AzureIoTClient 34:51d158b409d2 1245 LogError("failed setting option '%s' to registered device (could not match name to options supported by device)", option);
AzureIoTClient 34:51d158b409d2 1246 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 1247 }
AzureIoTClient 34:51d158b409d2 1248 else
AzureIoTClient 34:51d158b409d2 1249 {
AzureIoTClient 34:51d158b409d2 1250 AMQP_TRANSPORT_INSTANCE* instance = (AMQP_TRANSPORT_INSTANCE*)handle;
AzureIoTClient 34:51d158b409d2 1251 result = RESULT_OK;
AzureIoTClient 30:20a85b733111 1252
AzureIoTClient 34:51d158b409d2 1253 LIST_ITEM_HANDLE list_item = singlylinkedlist_get_head_item(instance->registered_devices);
AzureIoTClient 30:20a85b733111 1254
AzureIoTClient 34:51d158b409d2 1255 while (list_item != NULL)
AzureIoTClient 34:51d158b409d2 1256 {
AzureIoTClient 34:51d158b409d2 1257 AMQP_TRANSPORT_DEVICE_INSTANCE* registered_device;
AzureIoTClient 30:20a85b733111 1258
AzureIoTClient 34:51d158b409d2 1259 if ((registered_device = (AMQP_TRANSPORT_DEVICE_INSTANCE*)singlylinkedlist_item_get_value(list_item)) == NULL)
AzureIoTClient 34:51d158b409d2 1260 {
AzureIoTClient 34:51d158b409d2 1261 LogError("failed setting option '%s' to registered device (singlylinkedlist_item_get_value failed)", option);
AzureIoTClient 34:51d158b409d2 1262 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 1263 break;
AzureIoTClient 34:51d158b409d2 1264 }
AzureIoTClient 34:51d158b409d2 1265 else if (device_set_option(registered_device->device_handle, device_option, value) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 1266 {
AzureIoTClient 34:51d158b409d2 1267 LogError("failed setting option '%s' to registered device '%s' (device_set_option failed)",
AzureIoTClient 34:51d158b409d2 1268 option, STRING_c_str(registered_device->device_id));
AzureIoTClient 34:51d158b409d2 1269 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 1270 break;
AzureIoTClient 34:51d158b409d2 1271 }
AzureIoTClient 30:20a85b733111 1272
AzureIoTClient 34:51d158b409d2 1273 list_item = singlylinkedlist_get_next_item(list_item);
AzureIoTClient 34:51d158b409d2 1274 }
AzureIoTClient 34:51d158b409d2 1275 }
AzureIoTClient 30:20a85b733111 1276
AzureIoTClient 34:51d158b409d2 1277 return result;
AzureIoTClient 30:20a85b733111 1278 }
AzureIoTClient 30:20a85b733111 1279
AzureIoTClient 30:20a85b733111 1280 static void internal_destroy_instance(AMQP_TRANSPORT_INSTANCE* instance)
AzureIoTClient 30:20a85b733111 1281 {
AzureIoTClient 34:51d158b409d2 1282 if (instance != NULL)
AzureIoTClient 34:51d158b409d2 1283 {
AzureIoTClient 34:51d158b409d2 1284 update_state(instance, AMQP_TRANSPORT_STATE_BEING_DESTROYED);
AzureIoTClient 32:babfd49032ff 1285
AzureIoTClient 34:51d158b409d2 1286 if (instance->registered_devices != NULL)
AzureIoTClient 34:51d158b409d2 1287 {
AzureIoTClient 34:51d158b409d2 1288 LIST_ITEM_HANDLE list_item = singlylinkedlist_get_head_item(instance->registered_devices);
AzureIoTClient 30:20a85b733111 1289
AzureIoTClient 34:51d158b409d2 1290 while (list_item != NULL)
AzureIoTClient 34:51d158b409d2 1291 {
AzureIoTClient 34:51d158b409d2 1292 AMQP_TRANSPORT_DEVICE_INSTANCE* registered_device = (AMQP_TRANSPORT_DEVICE_INSTANCE*)singlylinkedlist_item_get_value(list_item);
AzureIoTClient 34:51d158b409d2 1293 list_item = singlylinkedlist_get_next_item(list_item);
AzureIoTClient 34:51d158b409d2 1294 IoTHubTransport_AMQP_Common_Unregister(registered_device);
AzureIoTClient 34:51d158b409d2 1295 }
AzureIoTClient 30:20a85b733111 1296
AzureIoTClient 34:51d158b409d2 1297 singlylinkedlist_destroy(instance->registered_devices);
AzureIoTClient 34:51d158b409d2 1298 }
AzureIoTClient 30:20a85b733111 1299
AzureIoTClient 34:51d158b409d2 1300 if (instance->amqp_connection != NULL)
AzureIoTClient 34:51d158b409d2 1301 {
AzureIoTClient 34:51d158b409d2 1302 amqp_connection_destroy(instance->amqp_connection);
AzureIoTClient 34:51d158b409d2 1303 }
AzureIoTClient 30:20a85b733111 1304
AzureIoTClient 34:51d158b409d2 1305 destroy_underlying_io_transport(instance);
AzureIoTClient 34:51d158b409d2 1306 destroy_underlying_io_transport_options(instance);
AzureIoTClient 34:51d158b409d2 1307 retry_control_destroy(instance->connection_retry_control);
AzureIoTClient 30:20a85b733111 1308
AzureIoTClient 34:51d158b409d2 1309 STRING_delete(instance->iothub_host_fqdn);
AzureIoTClient 30:20a85b733111 1310
AzureIoTClient 32:babfd49032ff 1311 /* SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_043: [ `IoTHubTransport_AMQP_Common_Destroy` shall free the stored proxy options. ]*/
AzureIoTClient 31:adadaef857c1 1312 free_proxy_data(instance);
AzureIoTClient 31:adadaef857c1 1313
AzureIoTClient 34:51d158b409d2 1314 free(instance);
AzureIoTClient 34:51d158b409d2 1315 }
AzureIoTClient 30:20a85b733111 1316 }
AzureIoTClient 30:20a85b733111 1317
AzureIoTClient 32:babfd49032ff 1318 // ---------- SendMessageDisposition helpers ---------- //
AzureIoTClient 32:babfd49032ff 1319
AzureIoTClient 32:babfd49032ff 1320 static DEVICE_MESSAGE_DISPOSITION_INFO* create_device_message_disposition_info_from(MESSAGE_CALLBACK_INFO* message_data)
AzureIoTClient 32:babfd49032ff 1321 {
AzureIoTClient 34:51d158b409d2 1322 DEVICE_MESSAGE_DISPOSITION_INFO* result;
AzureIoTClient 32:babfd49032ff 1323
AzureIoTClient 34:51d158b409d2 1324 if ((result = (DEVICE_MESSAGE_DISPOSITION_INFO*)malloc(sizeof(DEVICE_MESSAGE_DISPOSITION_INFO))) == NULL)
AzureIoTClient 34:51d158b409d2 1325 {
AzureIoTClient 34:51d158b409d2 1326 LogError("Failed creating DEVICE_MESSAGE_DISPOSITION_INFO (malloc failed)");
AzureIoTClient 34:51d158b409d2 1327 }
AzureIoTClient 34:51d158b409d2 1328 else if (mallocAndStrcpy_s(&result->source, message_data->transportContext->link_name) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 1329 {
AzureIoTClient 34:51d158b409d2 1330 LogError("Failed creating DEVICE_MESSAGE_DISPOSITION_INFO (mallocAndStrcpy_s failed)");
AzureIoTClient 34:51d158b409d2 1331 free(result);
AzureIoTClient 34:51d158b409d2 1332 result = NULL;
AzureIoTClient 34:51d158b409d2 1333 }
AzureIoTClient 34:51d158b409d2 1334 else
AzureIoTClient 34:51d158b409d2 1335 {
AzureIoTClient 34:51d158b409d2 1336 result->message_id = message_data->transportContext->message_id;
AzureIoTClient 34:51d158b409d2 1337 }
AzureIoTClient 32:babfd49032ff 1338
AzureIoTClient 34:51d158b409d2 1339 return result;
AzureIoTClient 32:babfd49032ff 1340 }
AzureIoTClient 32:babfd49032ff 1341
AzureIoTClient 32:babfd49032ff 1342 static void destroy_device_message_disposition_info(DEVICE_MESSAGE_DISPOSITION_INFO* device_message_disposition_info)
AzureIoTClient 32:babfd49032ff 1343 {
AzureIoTClient 34:51d158b409d2 1344 free(device_message_disposition_info->source);
AzureIoTClient 34:51d158b409d2 1345 free(device_message_disposition_info);
AzureIoTClient 32:babfd49032ff 1346 }
AzureIoTClient 32:babfd49032ff 1347
AzureIoTClient 30:20a85b733111 1348
AzureIoTClient 30:20a85b733111 1349 // ---------- API functions ---------- //
AzureIoTClient 25:63f7d371c030 1350
AzureIoTClient 25:63f7d371c030 1351 TRANSPORT_LL_HANDLE IoTHubTransport_AMQP_Common_Create(const IOTHUBTRANSPORT_CONFIG* config, AMQP_GET_IO_TRANSPORT get_io_transport)
AzureIoTClient 25:63f7d371c030 1352 {
AzureIoTClient 34:51d158b409d2 1353 TRANSPORT_LL_HANDLE result;
AzureIoTClient 25:63f7d371c030 1354
AzureIoTClient 34:51d158b409d2 1355 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_001: [If `config` or `config->upperConfig` or `get_io_transport` are NULL then IoTHubTransport_AMQP_Common_Create shall fail and return NULL.]
AzureIoTClient 34:51d158b409d2 1356 if (config == NULL || config->upperConfig == NULL || get_io_transport == NULL)
AzureIoTClient 30:20a85b733111 1357 {
AzureIoTClient 30:20a85b733111 1358 LogError("IoTHub AMQP client transport null configuration parameter (config=%p, get_io_transport=%p).", config, get_io_transport);
AzureIoTClient 34:51d158b409d2 1359 result = NULL;
AzureIoTClient 30:20a85b733111 1360 }
AzureIoTClient 34:51d158b409d2 1361 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_002: [IoTHubTransport_AMQP_Common_Create shall fail and return NULL if `config->upperConfig->protocol` is NULL]
AzureIoTClient 34:51d158b409d2 1362 else if (config->upperConfig->protocol == NULL)
AzureIoTClient 30:20a85b733111 1363 {
AzureIoTClient 30:20a85b733111 1364 LogError("Failed to create the AMQP transport common instance (NULL parameter received: protocol=%p, iotHubName=%p, iotHubSuffix=%p)",
AzureIoTClient 34:51d158b409d2 1365 config->upperConfig->protocol, config->upperConfig->iotHubName, config->upperConfig->iotHubSuffix);
AzureIoTClient 34:51d158b409d2 1366 result = NULL;
AzureIoTClient 34:51d158b409d2 1367 }
AzureIoTClient 34:51d158b409d2 1368 else
AzureIoTClient 34:51d158b409d2 1369 {
AzureIoTClient 34:51d158b409d2 1370 AMQP_TRANSPORT_INSTANCE* instance;
AzureIoTClient 25:63f7d371c030 1371
AzureIoTClient 34:51d158b409d2 1372 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_003: [Memory shall be allocated for the transport's internal state structure (`instance`)]
AzureIoTClient 34:51d158b409d2 1373 if ((instance = (AMQP_TRANSPORT_INSTANCE*)malloc(sizeof(AMQP_TRANSPORT_INSTANCE))) == NULL)
AzureIoTClient 34:51d158b409d2 1374 {
AzureIoTClient 34:51d158b409d2 1375 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_004: [If malloc() fails, IoTHubTransport_AMQP_Common_Create shall fail and return NULL]
AzureIoTClient 34:51d158b409d2 1376 LogError("Could not allocate AMQP transport state (malloc failed)");
AzureIoTClient 34:51d158b409d2 1377 result = NULL;
AzureIoTClient 34:51d158b409d2 1378 }
AzureIoTClient 34:51d158b409d2 1379 else
AzureIoTClient 34:51d158b409d2 1380 {
AzureIoTClient 34:51d158b409d2 1381 memset(instance, 0, sizeof(AMQP_TRANSPORT_INSTANCE));
AzureIoTClient 34:51d158b409d2 1382 instance->amqp_connection_state = AMQP_CONNECTION_STATE_CLOSED;
AzureIoTClient 34:51d158b409d2 1383 instance->preferred_authentication_mode = AMQP_TRANSPORT_AUTHENTICATION_MODE_NOT_SET;
AzureIoTClient 34:51d158b409d2 1384 instance->state = AMQP_TRANSPORT_STATE_NOT_CONNECTED;
AzureIoTClient 34:51d158b409d2 1385 instance->authorization_module = config->auth_module_handle;
AzureIoTClient 25:63f7d371c030 1386
AzureIoTClient 34:51d158b409d2 1387 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_124: [`instance->connection_retry_control` shall be set using retry_control_create(), passing defaults EXPONENTIAL_BACKOFF_WITH_JITTER and 0]
AzureIoTClient 34:51d158b409d2 1388 if ((instance->connection_retry_control = retry_control_create(DEFAULT_RETRY_POLICY, DEFAULT_MAX_RETRY_TIME_IN_SECS)) == NULL)
AzureIoTClient 34:51d158b409d2 1389 {
AzureIoTClient 34:51d158b409d2 1390 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_125: [If retry_control_create() fails, IoTHubTransport_AMQP_Common_Create shall fail and return NULL]
AzureIoTClient 34:51d158b409d2 1391 LogError("Failed to create the connection retry control.");
AzureIoTClient 34:51d158b409d2 1392 result = NULL;
AzureIoTClient 34:51d158b409d2 1393 }
AzureIoTClient 34:51d158b409d2 1394 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_005: [If `config->upperConfig->protocolGatewayHostName` is NULL, `instance->iothub_target_fqdn` shall be set as `config->upperConfig->iotHubName` + "." + `config->upperConfig->iotHubSuffix`]
AzureIoTClient 34:51d158b409d2 1395 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_006: [If `config->upperConfig->protocolGatewayHostName` is not NULL, `instance->iothub_target_fqdn` shall be set with a copy of it]
AzureIoTClient 34:51d158b409d2 1396 else if ((instance->iothub_host_fqdn = get_target_iothub_fqdn(config)) == NULL)
AzureIoTClient 34:51d158b409d2 1397 {
AzureIoTClient 34:51d158b409d2 1398 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_007: [If `instance->iothub_target_fqdn` fails to be set, IoTHubTransport_AMQP_Common_Create shall fail and return NULL]
AzureIoTClient 34:51d158b409d2 1399 LogError("Failed to obtain the iothub target fqdn.");
AzureIoTClient 34:51d158b409d2 1400 result = NULL;
AzureIoTClient 34:51d158b409d2 1401 }
AzureIoTClient 34:51d158b409d2 1402 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_008: [`instance->registered_devices` shall be set using singlylinkedlist_create()]
AzureIoTClient 34:51d158b409d2 1403 else if ((instance->registered_devices = singlylinkedlist_create()) == NULL)
AzureIoTClient 34:51d158b409d2 1404 {
AzureIoTClient 34:51d158b409d2 1405 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_009: [If singlylinkedlist_create() fails, IoTHubTransport_AMQP_Common_Create shall fail and return NULL]
AzureIoTClient 34:51d158b409d2 1406 LogError("Failed to initialize the internal list of registered devices (singlylinkedlist_create failed)");
AzureIoTClient 34:51d158b409d2 1407 result = NULL;
AzureIoTClient 34:51d158b409d2 1408 }
AzureIoTClient 34:51d158b409d2 1409 else
AzureIoTClient 34:51d158b409d2 1410 {
AzureIoTClient 34:51d158b409d2 1411 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_010: [`get_io_transport` shall be saved on `instance->underlying_io_transport_provider`]
AzureIoTClient 34:51d158b409d2 1412 instance->underlying_io_transport_provider = get_io_transport;
AzureIoTClient 34:51d158b409d2 1413 instance->is_trace_on = false;
AzureIoTClient 34:51d158b409d2 1414 instance->option_sas_token_lifetime_secs = DEFAULT_SAS_TOKEN_LIFETIME_SECS;
AzureIoTClient 34:51d158b409d2 1415 instance->option_sas_token_refresh_time_secs = DEFAULT_SAS_TOKEN_REFRESH_TIME_SECS;
AzureIoTClient 34:51d158b409d2 1416 instance->option_cbs_request_timeout_secs = DEFAULT_CBS_REQUEST_TIMEOUT_SECS;
AzureIoTClient 34:51d158b409d2 1417 instance->option_send_event_timeout_secs = DEFAULT_EVENT_SEND_TIMEOUT_SECS;
AzureIoTClient 37:abd16824f63b 1418 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_12_002: [The connection idle timeout parameter default value shall be set to 240000 milliseconds using connection_set_idle_timeout()]
AzureIoTClient 37:abd16824f63b 1419 instance->c2d_keep_alive_freq_secs = DEFAULT_C2D_KEEP_ALIVE_FREQ_SECS;
AzureIoTClient 32:babfd49032ff 1420
AzureIoTClient 34:51d158b409d2 1421 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_012: [If IoTHubTransport_AMQP_Common_Create succeeds it shall return a pointer to `instance`.]
AzureIoTClient 34:51d158b409d2 1422 result = (TRANSPORT_LL_HANDLE)instance;
AzureIoTClient 34:51d158b409d2 1423 }
AzureIoTClient 25:63f7d371c030 1424
AzureIoTClient 34:51d158b409d2 1425 if (result == NULL)
AzureIoTClient 34:51d158b409d2 1426 {
AzureIoTClient 34:51d158b409d2 1427 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_011: [If IoTHubTransport_AMQP_Common_Create fails it shall free any memory it allocated]
AzureIoTClient 34:51d158b409d2 1428 internal_destroy_instance(instance);
AzureIoTClient 34:51d158b409d2 1429 }
AzureIoTClient 34:51d158b409d2 1430 }
AzureIoTClient 34:51d158b409d2 1431 }
AzureIoTClient 25:63f7d371c030 1432
AzureIoTClient 26:ee14eed604f6 1433 return result;
AzureIoTClient 25:63f7d371c030 1434 }
AzureIoTClient 25:63f7d371c030 1435
AzureIoTClient 25:63f7d371c030 1436 IOTHUB_PROCESS_ITEM_RESULT IoTHubTransport_AMQP_Common_ProcessItem(TRANSPORT_LL_HANDLE handle, IOTHUB_IDENTITY_TYPE item_type, IOTHUB_IDENTITY_INFO* iothub_item)
AzureIoTClient 25:63f7d371c030 1437 {
AzureIoTClient 41:71c01aa3df1a 1438 IOTHUB_PROCESS_ITEM_RESULT result;
AzureIoTClient 39:e98d5df6dc74 1439
AzureIoTClient 41:71c01aa3df1a 1440 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_144: [If `handle` or `iothub_item` are NULL, `IoTHubTransport_AMQP_Common_ProcessItem` shall fail and return IOTHUB_PROCESS_ERROR.]
AzureIoTClient 41:71c01aa3df1a 1441 if (handle == NULL || iothub_item == NULL)
AzureIoTClient 41:71c01aa3df1a 1442 {
AzureIoTClient 41:71c01aa3df1a 1443 LogError("Invalid argument (handle=%p, iothub_item=%p)", handle, iothub_item);
AzureIoTClient 41:71c01aa3df1a 1444 result = IOTHUB_PROCESS_ERROR;
AzureIoTClient 41:71c01aa3df1a 1445 }
AzureIoTClient 41:71c01aa3df1a 1446 else
AzureIoTClient 41:71c01aa3df1a 1447 {
AzureIoTClient 41:71c01aa3df1a 1448 if (item_type == IOTHUB_TYPE_DEVICE_TWIN)
AzureIoTClient 41:71c01aa3df1a 1449 {
AzureIoTClient 41:71c01aa3df1a 1450 AMQP_TRANSPORT_DEVICE_TWIN_CONTEXT* dev_twin_ctx;
AzureIoTClient 41:71c01aa3df1a 1451
AzureIoTClient 41:71c01aa3df1a 1452 if ((dev_twin_ctx = (AMQP_TRANSPORT_DEVICE_TWIN_CONTEXT*)malloc(sizeof(AMQP_TRANSPORT_DEVICE_TWIN_CONTEXT))) == NULL)
AzureIoTClient 41:71c01aa3df1a 1453 {
AzureIoTClient 41:71c01aa3df1a 1454 LogError("Failed allocating context for TWIN message");
AzureIoTClient 41:71c01aa3df1a 1455 result = IOTHUB_PROCESS_ERROR;
AzureIoTClient 41:71c01aa3df1a 1456 }
AzureIoTClient 41:71c01aa3df1a 1457 else
AzureIoTClient 41:71c01aa3df1a 1458 {
AzureIoTClient 41:71c01aa3df1a 1459 AMQP_TRANSPORT_DEVICE_INSTANCE* registered_device = (AMQP_TRANSPORT_DEVICE_INSTANCE*)iothub_item->device_twin->device_handle;
AzureIoTClient 39:e98d5df6dc74 1460
AzureIoTClient 41:71c01aa3df1a 1461 dev_twin_ctx->client_handle = iothub_item->device_twin->client_handle;
AzureIoTClient 41:71c01aa3df1a 1462 dev_twin_ctx->item_id = iothub_item->device_twin->item_id;
AzureIoTClient 39:e98d5df6dc74 1463
AzureIoTClient 41:71c01aa3df1a 1464 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_146: [device_send_twin_update_async() shall be invoked passing `iothub_item->device_twin->report_data_handle` and `on_device_send_twin_update_complete_callback`]
AzureIoTClient 41:71c01aa3df1a 1465 if (device_send_twin_update_async(
AzureIoTClient 41:71c01aa3df1a 1466 registered_device->device_handle,
AzureIoTClient 41:71c01aa3df1a 1467 iothub_item->device_twin->report_data_handle,
AzureIoTClient 41:71c01aa3df1a 1468 on_device_send_twin_update_complete_callback, (void*)dev_twin_ctx) != RESULT_OK)
AzureIoTClient 41:71c01aa3df1a 1469 {
AzureIoTClient 41:71c01aa3df1a 1470 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_147: [If device_send_twin_update_async() fails, `IoTHubTransport_AMQP_Common_ProcessItem` shall fail and return IOTHUB_PROCESS_ERROR.]
AzureIoTClient 41:71c01aa3df1a 1471 LogError("Failed sending TWIN update");
AzureIoTClient 41:71c01aa3df1a 1472 free(dev_twin_ctx);
AzureIoTClient 41:71c01aa3df1a 1473 result = IOTHUB_PROCESS_ERROR;
AzureIoTClient 41:71c01aa3df1a 1474 }
AzureIoTClient 41:71c01aa3df1a 1475 else
AzureIoTClient 41:71c01aa3df1a 1476 {
AzureIoTClient 41:71c01aa3df1a 1477 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_150: [If no errors occur, `IoTHubTransport_AMQP_Common_ProcessItem` shall return IOTHUB_PROCESS_OK.]
AzureIoTClient 41:71c01aa3df1a 1478 result = IOTHUB_PROCESS_OK;
AzureIoTClient 41:71c01aa3df1a 1479 }
AzureIoTClient 41:71c01aa3df1a 1480 }
AzureIoTClient 41:71c01aa3df1a 1481 }
AzureIoTClient 41:71c01aa3df1a 1482 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_145: [If `item_type` is not IOTHUB_TYPE_DEVICE_TWIN, `IoTHubTransport_AMQP_Common_ProcessItem` shall fail and return IOTHUB_PROCESS_ERROR.]
AzureIoTClient 41:71c01aa3df1a 1483 else
AzureIoTClient 41:71c01aa3df1a 1484 {
AzureIoTClient 41:71c01aa3df1a 1485 LogError("Item type not supported (%d)", item_type);
AzureIoTClient 41:71c01aa3df1a 1486 result = IOTHUB_PROCESS_ERROR;
AzureIoTClient 41:71c01aa3df1a 1487 }
AzureIoTClient 41:71c01aa3df1a 1488 }
AzureIoTClient 39:e98d5df6dc74 1489
AzureIoTClient 41:71c01aa3df1a 1490 return result;
AzureIoTClient 25:63f7d371c030 1491 }
AzureIoTClient 25:63f7d371c030 1492
AzureIoTClient 25:63f7d371c030 1493 void IoTHubTransport_AMQP_Common_DoWork(TRANSPORT_LL_HANDLE handle, IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle)
AzureIoTClient 25:63f7d371c030 1494 {
AzureIoTClient 30:20a85b733111 1495 (void)iotHubClientHandle; // unused as of now.
AzureIoTClient 30:20a85b733111 1496
AzureIoTClient 34:51d158b409d2 1497 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_016: [If `handle` is NULL, IoTHubTransport_AMQP_Common_DoWork shall return without doing any work]
AzureIoTClient 25:63f7d371c030 1498 if (handle == NULL)
AzureIoTClient 25:63f7d371c030 1499 {
AzureIoTClient 25:63f7d371c030 1500 LogError("IoTHubClient DoWork failed: transport handle parameter is NULL.");
AzureIoTClient 25:63f7d371c030 1501 }
AzureIoTClient 25:63f7d371c030 1502 else
AzureIoTClient 25:63f7d371c030 1503 {
AzureIoTClient 30:20a85b733111 1504 AMQP_TRANSPORT_INSTANCE* transport_instance = (AMQP_TRANSPORT_INSTANCE*)handle;
AzureIoTClient 34:51d158b409d2 1505 LIST_ITEM_HANDLE list_item;
AzureIoTClient 30:20a85b733111 1506
AzureIoTClient 34:51d158b409d2 1507 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_017: [If `instance->state` is `RECONNECTION_REQUIRED`, IoTHubTransport_AMQP_Common_DoWork shall attempt to trigger the connection-retry logic and return]
AzureIoTClient 34:51d158b409d2 1508 if (transport_instance->state == AMQP_TRANSPORT_STATE_RECONNECTION_REQUIRED)
AzureIoTClient 34:51d158b409d2 1509 {
AzureIoTClient 34:51d158b409d2 1510 RETRY_ACTION retry_action;
AzureIoTClient 34:51d158b409d2 1511
AzureIoTClient 34:51d158b409d2 1512 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_126: [The connection retry shall be attempted only if retry_control_should_retry() returns RETRY_ACTION_NOW, or if it fails]
AzureIoTClient 34:51d158b409d2 1513 if (retry_control_should_retry(transport_instance->connection_retry_control, &retry_action) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 1514 {
AzureIoTClient 34:51d158b409d2 1515 LogError("retry_control_should_retry() failed; assuming immediate connection retry for safety.");
AzureIoTClient 34:51d158b409d2 1516 retry_action = RETRY_ACTION_RETRY_NOW;
AzureIoTClient 34:51d158b409d2 1517 }
AzureIoTClient 30:20a85b733111 1518
AzureIoTClient 34:51d158b409d2 1519 if (retry_action == RETRY_ACTION_RETRY_NOW)
AzureIoTClient 34:51d158b409d2 1520 {
AzureIoTClient 34:51d158b409d2 1521 prepare_for_connection_retry(transport_instance);
AzureIoTClient 34:51d158b409d2 1522 }
AzureIoTClient 34:51d158b409d2 1523 }
AzureIoTClient 34:51d158b409d2 1524 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_018: [If there are no devices registered on the transport, IoTHubTransport_AMQP_Common_DoWork shall skip do_work for devices]
AzureIoTClient 34:51d158b409d2 1525 else if ((list_item = singlylinkedlist_get_head_item(transport_instance->registered_devices)) != NULL)
AzureIoTClient 34:51d158b409d2 1526 {
AzureIoTClient 34:51d158b409d2 1527 // We need to check if there are devices, otherwise the amqp_connection won't be able to be created since
AzureIoTClient 34:51d158b409d2 1528 // there is not a preferred authentication mode set yet on the transport.
AzureIoTClient 25:63f7d371c030 1529
AzureIoTClient 34:51d158b409d2 1530 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_019: [If `instance->amqp_connection` is NULL, it shall be established]
AzureIoTClient 37:abd16824f63b 1531 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_12_003: [AMQP connection will be configured using the `c2d_keep_alive_freq_secs` value from SetOption ]
AzureIoTClient 34:51d158b409d2 1532 if (transport_instance->amqp_connection == NULL && establish_amqp_connection(transport_instance) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 1533 {
AzureIoTClient 34:51d158b409d2 1534 LogError("AMQP transport failed to establish connection with service.");
AzureIoTClient 32:babfd49032ff 1535
AzureIoTClient 34:51d158b409d2 1536 update_state(transport_instance, AMQP_TRANSPORT_STATE_RECONNECTION_REQUIRED);
AzureIoTClient 34:51d158b409d2 1537 }
AzureIoTClient 34:51d158b409d2 1538 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_020: [If the amqp_connection is OPENED, the transport shall iterate through each registered device and perform a device-specific do_work on each]
AzureIoTClient 34:51d158b409d2 1539 else if (transport_instance->amqp_connection_state == AMQP_CONNECTION_STATE_OPENED)
AzureIoTClient 34:51d158b409d2 1540 {
AzureIoTClient 34:51d158b409d2 1541 while (list_item != NULL)
AzureIoTClient 34:51d158b409d2 1542 {
AzureIoTClient 34:51d158b409d2 1543 AMQP_TRANSPORT_DEVICE_INSTANCE* registered_device;
AzureIoTClient 30:20a85b733111 1544
AzureIoTClient 34:51d158b409d2 1545 if ((registered_device = (AMQP_TRANSPORT_DEVICE_INSTANCE*)singlylinkedlist_item_get_value(list_item)) == NULL)
AzureIoTClient 34:51d158b409d2 1546 {
AzureIoTClient 34:51d158b409d2 1547 LogError("Transport had an unexpected failure during DoWork (failed to fetch a registered_devices list item value)");
AzureIoTClient 34:51d158b409d2 1548 }
AzureIoTClient 34:51d158b409d2 1549 else if (registered_device->number_of_send_event_complete_failures >= MAX_NUMBER_OF_DEVICE_FAILURES)
AzureIoTClient 34:51d158b409d2 1550 {
AzureIoTClient 34:51d158b409d2 1551 LogError("Device '%s' reported a critical failure (events completed sending with failures); connection retry will be triggered.", STRING_c_str(registered_device->device_id));
AzureIoTClient 30:20a85b733111 1552
AzureIoTClient 34:51d158b409d2 1553 update_state(transport_instance, AMQP_TRANSPORT_STATE_RECONNECTION_REQUIRED);
AzureIoTClient 34:51d158b409d2 1554 }
AzureIoTClient 34:51d158b409d2 1555 else if (IoTHubTransport_AMQP_Common_Device_DoWork(registered_device) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 1556 {
AzureIoTClient 34:51d158b409d2 1557 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_021: [If DoWork fails for the registered device for more than MAX_NUMBER_OF_DEVICE_FAILURES, connection retry shall be triggered]
AzureIoTClient 34:51d158b409d2 1558 if (registered_device->number_of_previous_failures >= MAX_NUMBER_OF_DEVICE_FAILURES)
AzureIoTClient 34:51d158b409d2 1559 {
AzureIoTClient 34:51d158b409d2 1560 LogError("Device '%s' reported a critical failure; connection retry will be triggered.", STRING_c_str(registered_device->device_id));
AzureIoTClient 30:20a85b733111 1561
AzureIoTClient 34:51d158b409d2 1562 update_state(transport_instance, AMQP_TRANSPORT_STATE_RECONNECTION_REQUIRED);
AzureIoTClient 34:51d158b409d2 1563 }
AzureIoTClient 34:51d158b409d2 1564 }
AzureIoTClient 30:20a85b733111 1565
AzureIoTClient 34:51d158b409d2 1566 list_item = singlylinkedlist_get_next_item(list_item);
AzureIoTClient 34:51d158b409d2 1567 }
AzureIoTClient 34:51d158b409d2 1568 }
AzureIoTClient 34:51d158b409d2 1569 }
AzureIoTClient 30:20a85b733111 1570
AzureIoTClient 34:51d158b409d2 1571 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_022: [If `instance->amqp_connection` is not NULL, amqp_connection_do_work shall be invoked]
AzureIoTClient 34:51d158b409d2 1572 if (transport_instance->amqp_connection != NULL)
AzureIoTClient 26:ee14eed604f6 1573 {
AzureIoTClient 34:51d158b409d2 1574 amqp_connection_do_work(transport_instance->amqp_connection);
AzureIoTClient 26:ee14eed604f6 1575 }
AzureIoTClient 25:63f7d371c030 1576 }
AzureIoTClient 25:63f7d371c030 1577 }
AzureIoTClient 25:63f7d371c030 1578
AzureIoTClient 25:63f7d371c030 1579 int IoTHubTransport_AMQP_Common_Subscribe(IOTHUB_DEVICE_HANDLE handle)
AzureIoTClient 25:63f7d371c030 1580 {
AzureIoTClient 25:63f7d371c030 1581 int result;
AzureIoTClient 25:63f7d371c030 1582
AzureIoTClient 34:51d158b409d2 1583 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_084: [If `handle` is NULL, IoTHubTransport_AMQP_Common_Subscribe shall return a non-zero result]
AzureIoTClient 25:63f7d371c030 1584 if (handle == NULL)
AzureIoTClient 25:63f7d371c030 1585 {
AzureIoTClient 25:63f7d371c030 1586 LogError("Invalid handle to IoTHubClient AMQP transport device handle.");
AzureIoTClient 29:7e8852b14e3b 1587 result = __FAILURE__;
AzureIoTClient 25:63f7d371c030 1588 }
AzureIoTClient 25:63f7d371c030 1589 else
AzureIoTClient 25:63f7d371c030 1590 {
AzureIoTClient 30:20a85b733111 1591 AMQP_TRANSPORT_DEVICE_INSTANCE* amqp_device_instance = (AMQP_TRANSPORT_DEVICE_INSTANCE*)handle;
AzureIoTClient 30:20a85b733111 1592
AzureIoTClient 34:51d158b409d2 1593 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_085: [If `amqp_device_instance` is not registered, IoTHubTransport_AMQP_Common_Subscribe shall return a non-zero result]
AzureIoTClient 34:51d158b409d2 1594 if (!is_device_registered(amqp_device_instance))
AzureIoTClient 34:51d158b409d2 1595 {
AzureIoTClient 34:51d158b409d2 1596 LogError("Device '%s' failed subscribing to cloud-to-device messages (device is not registered)", STRING_c_str(amqp_device_instance->device_id));
AzureIoTClient 34:51d158b409d2 1597 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 1598 }
AzureIoTClient 34:51d158b409d2 1599 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_086: [device_subscribe_message() shall be invoked passing `on_message_received_callback`]
AzureIoTClient 34:51d158b409d2 1600 else if (device_subscribe_message(amqp_device_instance->device_handle, on_message_received, amqp_device_instance) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 1601 {
AzureIoTClient 34:51d158b409d2 1602 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_087: [If device_subscribe_message() fails, IoTHubTransport_AMQP_Common_Subscribe shall return a non-zero result]
AzureIoTClient 34:51d158b409d2 1603 LogError("Device '%s' failed subscribing to cloud-to-device messages (device_subscribe_message failed)", STRING_c_str(amqp_device_instance->device_id));
AzureIoTClient 34:51d158b409d2 1604 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 1605 }
AzureIoTClient 34:51d158b409d2 1606 else
AzureIoTClient 34:51d158b409d2 1607 {
AzureIoTClient 34:51d158b409d2 1608 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_088: [If no failures occur, IoTHubTransport_AMQP_Common_Subscribe shall return 0]
AzureIoTClient 34:51d158b409d2 1609 result = RESULT_OK;
AzureIoTClient 34:51d158b409d2 1610 }
AzureIoTClient 25:63f7d371c030 1611 }
AzureIoTClient 25:63f7d371c030 1612
AzureIoTClient 25:63f7d371c030 1613 return result;
AzureIoTClient 25:63f7d371c030 1614 }
AzureIoTClient 25:63f7d371c030 1615
AzureIoTClient 25:63f7d371c030 1616 void IoTHubTransport_AMQP_Common_Unsubscribe(IOTHUB_DEVICE_HANDLE handle)
AzureIoTClient 25:63f7d371c030 1617 {
AzureIoTClient 34:51d158b409d2 1618 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_093: [If `handle` is NULL, IoTHubTransport_AMQP_Common_Subscribe shall return]
AzureIoTClient 25:63f7d371c030 1619 if (handle == NULL)
AzureIoTClient 25:63f7d371c030 1620 {
AzureIoTClient 25:63f7d371c030 1621 LogError("Invalid handle to IoTHubClient AMQP transport device handle.");
AzureIoTClient 25:63f7d371c030 1622 }
AzureIoTClient 25:63f7d371c030 1623 else
AzureIoTClient 25:63f7d371c030 1624 {
AzureIoTClient 30:20a85b733111 1625 AMQP_TRANSPORT_DEVICE_INSTANCE* amqp_device_instance = (AMQP_TRANSPORT_DEVICE_INSTANCE*)handle;
AzureIoTClient 30:20a85b733111 1626
AzureIoTClient 34:51d158b409d2 1627 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_094: [If `amqp_device_instance` is not registered, IoTHubTransport_AMQP_Common_Subscribe shall return]
AzureIoTClient 34:51d158b409d2 1628 if (!is_device_registered(amqp_device_instance))
AzureIoTClient 34:51d158b409d2 1629 {
AzureIoTClient 34:51d158b409d2 1630 LogError("Device '%s' failed unsubscribing to cloud-to-device messages (device is not registered)", STRING_c_str(amqp_device_instance->device_id));
AzureIoTClient 34:51d158b409d2 1631 }
AzureIoTClient 34:51d158b409d2 1632 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_095: [device_unsubscribe_message() shall be invoked passing `amqp_device_instance->device_handle`]
AzureIoTClient 34:51d158b409d2 1633 else if (device_unsubscribe_message(amqp_device_instance->device_handle) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 1634 {
AzureIoTClient 34:51d158b409d2 1635 LogError("Device '%s' failed unsubscribing to cloud-to-device messages (device_unsubscribe_message failed)", STRING_c_str(amqp_device_instance->device_id));
AzureIoTClient 34:51d158b409d2 1636 }
AzureIoTClient 25:63f7d371c030 1637 }
AzureIoTClient 25:63f7d371c030 1638 }
AzureIoTClient 25:63f7d371c030 1639
AzureIoTClient 25:63f7d371c030 1640 int IoTHubTransport_AMQP_Common_Subscribe_DeviceTwin(IOTHUB_DEVICE_HANDLE handle)
AzureIoTClient 25:63f7d371c030 1641 {
AzureIoTClient 41:71c01aa3df1a 1642 int result;
AzureIoTClient 39:e98d5df6dc74 1643
AzureIoTClient 41:71c01aa3df1a 1644 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_131: [If `handle` is NULL, `IoTHubTransport_AMQP_Common_Subscribe_DeviceTwin` shall fail and return non-zero.]
AzureIoTClient 41:71c01aa3df1a 1645 if (handle == NULL)
AzureIoTClient 41:71c01aa3df1a 1646 {
AzureIoTClient 41:71c01aa3df1a 1647 LogError("Invalid argument (handle is NULL");
AzureIoTClient 41:71c01aa3df1a 1648 result = __FAILURE__;
AzureIoTClient 41:71c01aa3df1a 1649 }
AzureIoTClient 41:71c01aa3df1a 1650 else
AzureIoTClient 41:71c01aa3df1a 1651 {
AzureIoTClient 41:71c01aa3df1a 1652 AMQP_TRANSPORT_INSTANCE* transport = (AMQP_TRANSPORT_INSTANCE*)handle;
AzureIoTClient 39:e98d5df6dc74 1653
AzureIoTClient 41:71c01aa3df1a 1654 if (get_number_of_registered_devices(transport) != 1)
AzureIoTClient 41:71c01aa3df1a 1655 {
AzureIoTClient 41:71c01aa3df1a 1656 LogError("Device Twin not supported on device multiplexing scenario");
AzureIoTClient 41:71c01aa3df1a 1657 result = __FAILURE__;
AzureIoTClient 41:71c01aa3df1a 1658 }
AzureIoTClient 41:71c01aa3df1a 1659 else
AzureIoTClient 41:71c01aa3df1a 1660 {
AzureIoTClient 41:71c01aa3df1a 1661 LIST_ITEM_HANDLE list_item = singlylinkedlist_get_head_item(transport->registered_devices);
AzureIoTClient 39:e98d5df6dc74 1662
AzureIoTClient 41:71c01aa3df1a 1663 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_136: [If no errors occur, `IoTHubTransport_AMQP_Common_Subscribe_DeviceTwin` shall return zero.]
AzureIoTClient 41:71c01aa3df1a 1664 result = RESULT_OK;
AzureIoTClient 39:e98d5df6dc74 1665
AzureIoTClient 41:71c01aa3df1a 1666 while (list_item != NULL)
AzureIoTClient 41:71c01aa3df1a 1667 {
AzureIoTClient 41:71c01aa3df1a 1668 AMQP_TRANSPORT_DEVICE_INSTANCE* registered_device;
AzureIoTClient 39:e98d5df6dc74 1669
AzureIoTClient 41:71c01aa3df1a 1670 if ((registered_device = (AMQP_TRANSPORT_DEVICE_INSTANCE*)singlylinkedlist_item_get_value(list_item)) == NULL)
AzureIoTClient 41:71c01aa3df1a 1671 {
AzureIoTClient 41:71c01aa3df1a 1672 LogError("Failed retrieving registered device information");
AzureIoTClient 41:71c01aa3df1a 1673 result = __FAILURE__;
AzureIoTClient 41:71c01aa3df1a 1674 break;
AzureIoTClient 41:71c01aa3df1a 1675 }
AzureIoTClient 41:71c01aa3df1a 1676 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_134: [device_subscribe_for_twin_updates() shall be invoked for the registered device, passing `on_device_twin_update_received_callback`]
AzureIoTClient 41:71c01aa3df1a 1677 else if (device_subscribe_for_twin_updates(registered_device->device_handle, on_device_twin_update_received_callback, (void*)registered_device) != RESULT_OK)
AzureIoTClient 41:71c01aa3df1a 1678 {
AzureIoTClient 41:71c01aa3df1a 1679 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_135: [If device_subscribe_for_twin_updates() fails, `IoTHubTransport_AMQP_Common_Subscribe_DeviceTwin` shall fail and return non-zero.]
AzureIoTClient 41:71c01aa3df1a 1680 LogError("Failed subscribing for device Twin updates");
AzureIoTClient 41:71c01aa3df1a 1681 result = __FAILURE__;
AzureIoTClient 41:71c01aa3df1a 1682 break;
AzureIoTClient 41:71c01aa3df1a 1683 }
AzureIoTClient 39:e98d5df6dc74 1684
AzureIoTClient 41:71c01aa3df1a 1685 list_item = singlylinkedlist_get_next_item(list_item);
AzureIoTClient 41:71c01aa3df1a 1686 }
AzureIoTClient 41:71c01aa3df1a 1687 }
AzureIoTClient 41:71c01aa3df1a 1688 }
AzureIoTClient 39:e98d5df6dc74 1689
AzureIoTClient 41:71c01aa3df1a 1690 return result;
AzureIoTClient 25:63f7d371c030 1691 }
AzureIoTClient 25:63f7d371c030 1692
AzureIoTClient 25:63f7d371c030 1693 void IoTHubTransport_AMQP_Common_Unsubscribe_DeviceTwin(IOTHUB_DEVICE_HANDLE handle)
AzureIoTClient 25:63f7d371c030 1694 {
AzureIoTClient 41:71c01aa3df1a 1695 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_140: [If `handle` is NULL, `IoTHubTransport_AMQP_Common_Unsubscribe_DeviceTwin` shall return.]
AzureIoTClient 41:71c01aa3df1a 1696 if (handle == NULL)
AzureIoTClient 41:71c01aa3df1a 1697 {
AzureIoTClient 41:71c01aa3df1a 1698 LogError("Invalid argument (handle is NULL");
AzureIoTClient 41:71c01aa3df1a 1699 }
AzureIoTClient 41:71c01aa3df1a 1700 else
AzureIoTClient 41:71c01aa3df1a 1701 {
AzureIoTClient 41:71c01aa3df1a 1702 AMQP_TRANSPORT_INSTANCE* transport = (AMQP_TRANSPORT_INSTANCE*)handle;
AzureIoTClient 39:e98d5df6dc74 1703
AzureIoTClient 41:71c01aa3df1a 1704 if (get_number_of_registered_devices(transport) != 1)
AzureIoTClient 41:71c01aa3df1a 1705 {
AzureIoTClient 41:71c01aa3df1a 1706 LogError("Device Twin not supported on device multiplexing scenario");
AzureIoTClient 41:71c01aa3df1a 1707 }
AzureIoTClient 41:71c01aa3df1a 1708 else
AzureIoTClient 41:71c01aa3df1a 1709 {
AzureIoTClient 41:71c01aa3df1a 1710 LIST_ITEM_HANDLE list_item = singlylinkedlist_get_head_item(transport->registered_devices);
AzureIoTClient 39:e98d5df6dc74 1711
AzureIoTClient 41:71c01aa3df1a 1712 while (list_item != NULL)
AzureIoTClient 41:71c01aa3df1a 1713 {
AzureIoTClient 41:71c01aa3df1a 1714 AMQP_TRANSPORT_DEVICE_INSTANCE* registered_device;
AzureIoTClient 39:e98d5df6dc74 1715
AzureIoTClient 41:71c01aa3df1a 1716 if ((registered_device = (AMQP_TRANSPORT_DEVICE_INSTANCE*)singlylinkedlist_item_get_value(list_item)) == NULL)
AzureIoTClient 41:71c01aa3df1a 1717 {
AzureIoTClient 41:71c01aa3df1a 1718 LogError("Failed retrieving registered device information");
AzureIoTClient 41:71c01aa3df1a 1719 break;
AzureIoTClient 41:71c01aa3df1a 1720 }
AzureIoTClient 41:71c01aa3df1a 1721 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_142: [device_unsubscribe_for_twin_updates() shall be invoked for the registered device]
AzureIoTClient 41:71c01aa3df1a 1722 else if (device_unsubscribe_for_twin_updates(registered_device->device_handle) != RESULT_OK)
AzureIoTClient 41:71c01aa3df1a 1723 {
AzureIoTClient 41:71c01aa3df1a 1724 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_143: [If `device_unsubscribe_for_twin_updates` fails, the error shall be ignored]
AzureIoTClient 41:71c01aa3df1a 1725 LogError("Failed unsubscribing for device Twin updates");
AzureIoTClient 41:71c01aa3df1a 1726 break;
AzureIoTClient 41:71c01aa3df1a 1727 }
AzureIoTClient 39:e98d5df6dc74 1728
AzureIoTClient 41:71c01aa3df1a 1729 list_item = singlylinkedlist_get_next_item(list_item);
AzureIoTClient 41:71c01aa3df1a 1730 }
AzureIoTClient 41:71c01aa3df1a 1731 }
AzureIoTClient 41:71c01aa3df1a 1732 }
AzureIoTClient 25:63f7d371c030 1733 }
AzureIoTClient 25:63f7d371c030 1734
AzureIoTClient 25:63f7d371c030 1735 int IoTHubTransport_AMQP_Common_Subscribe_DeviceMethod(IOTHUB_DEVICE_HANDLE handle)
AzureIoTClient 25:63f7d371c030 1736 {
AzureIoTClient 25:63f7d371c030 1737 int result;
AzureIoTClient 25:63f7d371c030 1738
AzureIoTClient 25:63f7d371c030 1739 if (handle == NULL)
AzureIoTClient 25:63f7d371c030 1740 {
AzureIoTClient 25:63f7d371c030 1741 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_004: [ If `handle` is NULL, `IoTHubTransport_AMQP_Common_Subscribe_DeviceMethod` shall fail and return a non-zero value. ] */
AzureIoTClient 25:63f7d371c030 1742 LogError("NULL handle");
AzureIoTClient 29:7e8852b14e3b 1743 result = __FAILURE__;
AzureIoTClient 25:63f7d371c030 1744 }
AzureIoTClient 25:63f7d371c030 1745 else
AzureIoTClient 25:63f7d371c030 1746 {
AzureIoTClient 25:63f7d371c030 1747 #ifdef WIP_C2D_METHODS_AMQP /* This feature is WIP, do not use yet */
AzureIoTClient 30:20a85b733111 1748 AMQP_TRANSPORT_DEVICE_INSTANCE* device_state = (AMQP_TRANSPORT_DEVICE_INSTANCE*)handle;
AzureIoTClient 25:63f7d371c030 1749 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_026: [ `IoTHubTransport_AMQP_Common_Subscribe_DeviceMethod` shall remember that a subscribe is to be performed in the next call to DoWork and on success it shall return 0. ]*/
AzureIoTClient 25:63f7d371c030 1750 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_005: [ If the transport is already subscribed to receive C2D method requests, `IoTHubTransport_AMQP_Common_Subscribe_DeviceMethod` shall perform no additional action and return 0. ]*/
AzureIoTClient 29:7e8852b14e3b 1751 device_state->subscribe_methods_needed = true;
AzureIoTClient 29:7e8852b14e3b 1752 device_state->subscribed_for_methods = false;
AzureIoTClient 25:63f7d371c030 1753 result = 0;
AzureIoTClient 25:63f7d371c030 1754 #else
AzureIoTClient 25:63f7d371c030 1755 LogError("Not implemented");
AzureIoTClient 29:7e8852b14e3b 1756 result = __FAILURE__;
AzureIoTClient 25:63f7d371c030 1757 #endif
AzureIoTClient 25:63f7d371c030 1758 }
AzureIoTClient 25:63f7d371c030 1759
AzureIoTClient 25:63f7d371c030 1760 return result;
AzureIoTClient 25:63f7d371c030 1761 }
AzureIoTClient 25:63f7d371c030 1762
AzureIoTClient 25:63f7d371c030 1763 void IoTHubTransport_AMQP_Common_Unsubscribe_DeviceMethod(IOTHUB_DEVICE_HANDLE handle)
AzureIoTClient 25:63f7d371c030 1764 {
AzureIoTClient 25:63f7d371c030 1765 if (handle == NULL)
AzureIoTClient 25:63f7d371c030 1766 {
AzureIoTClient 25:63f7d371c030 1767 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_006: [ If `handle` is NULL, `IoTHubTransport_AMQP_Common_Unsubscribe_DeviceMethod` shall do nothing. ]*/
AzureIoTClient 25:63f7d371c030 1768 LogError("NULL handle");
AzureIoTClient 25:63f7d371c030 1769 }
AzureIoTClient 25:63f7d371c030 1770 else
AzureIoTClient 25:63f7d371c030 1771 {
AzureIoTClient 25:63f7d371c030 1772 #ifdef WIP_C2D_METHODS_AMQP /* This feature is WIP, do not use yet */
AzureIoTClient 30:20a85b733111 1773 AMQP_TRANSPORT_DEVICE_INSTANCE* device_state = (AMQP_TRANSPORT_DEVICE_INSTANCE*)handle;
AzureIoTClient 25:63f7d371c030 1774
AzureIoTClient 25:63f7d371c030 1775 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_008: [ If the transport is not subscribed to receive C2D method requests then `IoTHubTransport_AMQP_Common_Unsubscribe_DeviceMethod` shall do nothing. ]*/
AzureIoTClient 29:7e8852b14e3b 1776 if (device_state->subscribe_methods_needed)
AzureIoTClient 25:63f7d371c030 1777 {
AzureIoTClient 25:63f7d371c030 1778 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_007: [ `IoTHubTransport_AMQP_Common_Unsubscribe_DeviceMethod` shall unsubscribe from receiving C2D method requests by calling `iothubtransportamqp_methods_unsubscribe`. ]*/
AzureIoTClient 34:51d158b409d2 1779 device_state->subscribed_for_methods = false;
AzureIoTClient 34:51d158b409d2 1780 device_state->subscribe_methods_needed = false;
AzureIoTClient 34:51d158b409d2 1781 iothubtransportamqp_methods_unsubscribe(device_state->methods_handle);
AzureIoTClient 25:63f7d371c030 1782 }
AzureIoTClient 25:63f7d371c030 1783 #else
AzureIoTClient 25:63f7d371c030 1784 LogError("Not implemented");
AzureIoTClient 25:63f7d371c030 1785 #endif
AzureIoTClient 25:63f7d371c030 1786 }
AzureIoTClient 25:63f7d371c030 1787 }
AzureIoTClient 25:63f7d371c030 1788
AzureIoTClient 26:ee14eed604f6 1789 int IoTHubTransport_AMQP_Common_DeviceMethod_Response(IOTHUB_DEVICE_HANDLE handle, METHOD_HANDLE methodId, const unsigned char* response, size_t response_size, int status_response)
AzureIoTClient 26:ee14eed604f6 1790 {
AzureIoTClient 26:ee14eed604f6 1791 (void)response;
AzureIoTClient 26:ee14eed604f6 1792 (void)response_size;
AzureIoTClient 26:ee14eed604f6 1793 (void)status_response;
AzureIoTClient 26:ee14eed604f6 1794 (void)methodId;
AzureIoTClient 26:ee14eed604f6 1795 int result;
AzureIoTClient 30:20a85b733111 1796 AMQP_TRANSPORT_DEVICE_INSTANCE* device_state = (AMQP_TRANSPORT_DEVICE_INSTANCE*)handle;
AzureIoTClient 26:ee14eed604f6 1797 if (device_state != NULL)
AzureIoTClient 26:ee14eed604f6 1798 {
AzureIoTClient 26:ee14eed604f6 1799 #ifdef WIP_C2D_METHODS_AMQP /* This feature is WIP, do not use yet */
AzureIoTClient 26:ee14eed604f6 1800 IOTHUBTRANSPORT_AMQP_METHOD_HANDLE saved_handle = (IOTHUBTRANSPORT_AMQP_METHOD_HANDLE)methodId;
AzureIoTClient 26:ee14eed604f6 1801 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_019: [ `IoTHubTransport_AMQP_Common_DeviceMethod_Response` shall call `iothubtransportamqp_methods_respond` passing to it the `method_handle` argument, the response bytes, response size and the status code. ]*/
AzureIoTClient 26:ee14eed604f6 1802 if (iothubtransportamqp_methods_respond(saved_handle, response, response_size, status_response) != 0)
AzureIoTClient 26:ee14eed604f6 1803 {
AzureIoTClient 26:ee14eed604f6 1804 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_029: [ If `iothubtransportamqp_methods_respond` fails, `on_methods_request_received` shall return a non-zero value. ]*/
AzureIoTClient 26:ee14eed604f6 1805 LogError("iothubtransportamqp_methods_respond failed");
AzureIoTClient 29:7e8852b14e3b 1806 result = __FAILURE__;
AzureIoTClient 26:ee14eed604f6 1807 }
AzureIoTClient 26:ee14eed604f6 1808 else
AzureIoTClient 26:ee14eed604f6 1809 {
AzureIoTClient 26:ee14eed604f6 1810 result = 0;
AzureIoTClient 26:ee14eed604f6 1811 }
AzureIoTClient 26:ee14eed604f6 1812 #else
AzureIoTClient 26:ee14eed604f6 1813 result = 0;
AzureIoTClient 26:ee14eed604f6 1814 LogError("Not implemented");
AzureIoTClient 26:ee14eed604f6 1815 #endif
AzureIoTClient 26:ee14eed604f6 1816 }
AzureIoTClient 26:ee14eed604f6 1817 else
AzureIoTClient 26:ee14eed604f6 1818 {
AzureIoTClient 29:7e8852b14e3b 1819 result = __FAILURE__;
AzureIoTClient 26:ee14eed604f6 1820 }
AzureIoTClient 26:ee14eed604f6 1821 return result;
AzureIoTClient 26:ee14eed604f6 1822 }
AzureIoTClient 26:ee14eed604f6 1823
AzureIoTClient 25:63f7d371c030 1824 IOTHUB_CLIENT_RESULT IoTHubTransport_AMQP_Common_GetSendStatus(IOTHUB_DEVICE_HANDLE handle, IOTHUB_CLIENT_STATUS *iotHubClientStatus)
AzureIoTClient 25:63f7d371c030 1825 {
AzureIoTClient 25:63f7d371c030 1826 IOTHUB_CLIENT_RESULT result;
AzureIoTClient 25:63f7d371c030 1827
AzureIoTClient 34:51d158b409d2 1828 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_096: [If `handle` or `iotHubClientStatus` are NULL, IoTHubTransport_AMQP_Common_GetSendStatus shall return IOTHUB_CLIENT_INVALID_ARG]
AzureIoTClient 34:51d158b409d2 1829 if (handle == NULL || iotHubClientStatus == NULL)
AzureIoTClient 25:63f7d371c030 1830 {
AzureIoTClient 25:63f7d371c030 1831 result = IOTHUB_CLIENT_INVALID_ARG;
AzureIoTClient 30:20a85b733111 1832 LogError("Failed retrieving the device send status (either handle (%p) or iotHubClientStatus (%p) are NULL)", handle, iotHubClientStatus);
AzureIoTClient 25:63f7d371c030 1833 }
AzureIoTClient 25:63f7d371c030 1834 else
AzureIoTClient 25:63f7d371c030 1835 {
AzureIoTClient 30:20a85b733111 1836 AMQP_TRANSPORT_DEVICE_INSTANCE* amqp_device_state = (AMQP_TRANSPORT_DEVICE_INSTANCE*)handle;
AzureIoTClient 25:63f7d371c030 1837
AzureIoTClient 34:51d158b409d2 1838 DEVICE_SEND_STATUS device_send_status;
AzureIoTClient 34:51d158b409d2 1839 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_097: [IoTHubTransport_AMQP_Common_GetSendStatus shall invoke device_get_send_status()]
AzureIoTClient 34:51d158b409d2 1840 if (device_get_send_status(amqp_device_state->device_handle, &device_send_status) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 1841 {
AzureIoTClient 34:51d158b409d2 1842 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_098: [If device_get_send_status() fails, IoTHubTransport_AMQP_Common_GetSendStatus shall return IOTHUB_CLIENT_ERROR]
AzureIoTClient 34:51d158b409d2 1843 LogError("Failed retrieving the device send status (device_get_send_status failed)");
AzureIoTClient 34:51d158b409d2 1844 result = IOTHUB_CLIENT_ERROR;
AzureIoTClient 34:51d158b409d2 1845 }
AzureIoTClient 34:51d158b409d2 1846 else
AzureIoTClient 34:51d158b409d2 1847 {
AzureIoTClient 34:51d158b409d2 1848 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_099: [If device_get_send_status() returns DEVICE_SEND_STATUS_BUSY, IoTHubTransport_AMQP_Common_GetSendStatus shall return IOTHUB_CLIENT_OK and status IOTHUB_CLIENT_SEND_STATUS_BUSY]
AzureIoTClient 34:51d158b409d2 1849 if (device_send_status == DEVICE_SEND_STATUS_BUSY)
AzureIoTClient 34:51d158b409d2 1850 {
AzureIoTClient 34:51d158b409d2 1851 *iotHubClientStatus = IOTHUB_CLIENT_SEND_STATUS_BUSY;
AzureIoTClient 34:51d158b409d2 1852 }
AzureIoTClient 34:51d158b409d2 1853 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_100: [If device_get_send_status() returns DEVICE_SEND_STATUS_IDLE, IoTHubTransport_AMQP_Common_GetSendStatus shall return IOTHUB_CLIENT_OK and status IOTHUB_CLIENT_SEND_STATUS_IDLE]
AzureIoTClient 34:51d158b409d2 1854 else // DEVICE_SEND_STATUS_IDLE
AzureIoTClient 34:51d158b409d2 1855 {
AzureIoTClient 34:51d158b409d2 1856 *iotHubClientStatus = IOTHUB_CLIENT_SEND_STATUS_IDLE;
AzureIoTClient 34:51d158b409d2 1857 }
AzureIoTClient 25:63f7d371c030 1858
AzureIoTClient 34:51d158b409d2 1859 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_109: [If no failures occur, IoTHubTransport_AMQP_Common_GetSendStatus shall return IOTHUB_CLIENT_OK]
AzureIoTClient 34:51d158b409d2 1860 result = IOTHUB_CLIENT_OK;
AzureIoTClient 34:51d158b409d2 1861 }
AzureIoTClient 25:63f7d371c030 1862 }
AzureIoTClient 25:63f7d371c030 1863
AzureIoTClient 25:63f7d371c030 1864 return result;
AzureIoTClient 25:63f7d371c030 1865 }
AzureIoTClient 25:63f7d371c030 1866
AzureIoTClient 25:63f7d371c030 1867 IOTHUB_CLIENT_RESULT IoTHubTransport_AMQP_Common_SetOption(TRANSPORT_LL_HANDLE handle, const char* option, const void* value)
AzureIoTClient 25:63f7d371c030 1868 {
AzureIoTClient 25:63f7d371c030 1869 IOTHUB_CLIENT_RESULT result;
AzureIoTClient 25:63f7d371c030 1870
AzureIoTClient 34:51d158b409d2 1871 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_101: [If `handle`, `option` or `value` are NULL then IoTHubTransport_AMQP_Common_SetOption shall return IOTHUB_CLIENT_INVALID_ARG.]
AzureIoTClient 30:20a85b733111 1872 if ((handle == NULL) || (option == NULL) || (value == NULL))
AzureIoTClient 25:63f7d371c030 1873 {
AzureIoTClient 34:51d158b409d2 1874 LogError("Invalid parameter (NULL) passed to AMQP transport SetOption (handle=%p, options=%p, value=%p)", handle, option, value);
AzureIoTClient 34:51d158b409d2 1875 result = IOTHUB_CLIENT_INVALID_ARG;
AzureIoTClient 25:63f7d371c030 1876 }
AzureIoTClient 25:63f7d371c030 1877 else
AzureIoTClient 25:63f7d371c030 1878 {
AzureIoTClient 30:20a85b733111 1879 AMQP_TRANSPORT_INSTANCE* transport_instance = (AMQP_TRANSPORT_INSTANCE*)handle;
AzureIoTClient 34:51d158b409d2 1880 bool is_device_specific_option;
AzureIoTClient 25:63f7d371c030 1881
AzureIoTClient 34:51d158b409d2 1882 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_102: [If `option` is a device-specific option, it shall be saved and applied to each registered device using device_set_option()]
AzureIoTClient 34:51d158b409d2 1883 if (strcmp(OPTION_SAS_TOKEN_LIFETIME, option) == 0)
AzureIoTClient 34:51d158b409d2 1884 {
AzureIoTClient 34:51d158b409d2 1885 is_device_specific_option = true;
AzureIoTClient 34:51d158b409d2 1886 transport_instance->option_sas_token_lifetime_secs = *(size_t*)value;
AzureIoTClient 34:51d158b409d2 1887 }
AzureIoTClient 34:51d158b409d2 1888 else if (strcmp(OPTION_SAS_TOKEN_REFRESH_TIME, option) == 0)
AzureIoTClient 34:51d158b409d2 1889 {
AzureIoTClient 34:51d158b409d2 1890 is_device_specific_option = true;
AzureIoTClient 34:51d158b409d2 1891 transport_instance->option_sas_token_refresh_time_secs = *(size_t*)value;
AzureIoTClient 34:51d158b409d2 1892 }
AzureIoTClient 34:51d158b409d2 1893 else if (strcmp(OPTION_CBS_REQUEST_TIMEOUT, option) == 0)
AzureIoTClient 34:51d158b409d2 1894 {
AzureIoTClient 34:51d158b409d2 1895 is_device_specific_option = true;
AzureIoTClient 34:51d158b409d2 1896 transport_instance->option_cbs_request_timeout_secs = *(size_t*)value;
AzureIoTClient 34:51d158b409d2 1897 }
AzureIoTClient 34:51d158b409d2 1898 else if (strcmp(OPTION_EVENT_SEND_TIMEOUT_SECS, option) == 0)
AzureIoTClient 34:51d158b409d2 1899 {
AzureIoTClient 34:51d158b409d2 1900 is_device_specific_option = true;
AzureIoTClient 34:51d158b409d2 1901 transport_instance->option_send_event_timeout_secs = *(size_t*)value;
AzureIoTClient 34:51d158b409d2 1902 }
AzureIoTClient 34:51d158b409d2 1903 else
AzureIoTClient 34:51d158b409d2 1904 {
AzureIoTClient 34:51d158b409d2 1905 is_device_specific_option = false;
AzureIoTClient 34:51d158b409d2 1906 }
AzureIoTClient 25:63f7d371c030 1907
AzureIoTClient 34:51d158b409d2 1908 if (is_device_specific_option)
AzureIoTClient 34:51d158b409d2 1909 {
AzureIoTClient 34:51d158b409d2 1910 if (IoTHubTransport_AMQP_Common_Device_SetOption(handle, option, (void*)value) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 1911 {
AzureIoTClient 34:51d158b409d2 1912 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_103: [If device_set_option() fails, IoTHubTransport_AMQP_Common_SetOption shall return IOTHUB_CLIENT_ERROR]
AzureIoTClient 34:51d158b409d2 1913 LogError("transport failed setting option '%s' (failed setting option on one or more registered devices)", option);
AzureIoTClient 34:51d158b409d2 1914 result = IOTHUB_CLIENT_ERROR;
AzureIoTClient 34:51d158b409d2 1915 }
AzureIoTClient 34:51d158b409d2 1916 else
AzureIoTClient 34:51d158b409d2 1917 {
AzureIoTClient 34:51d158b409d2 1918 result = IOTHUB_CLIENT_OK;
AzureIoTClient 34:51d158b409d2 1919 }
AzureIoTClient 34:51d158b409d2 1920 }
AzureIoTClient 38:6435c6e3d55c 1921 else if (strcmp(OPTION_C2D_KEEP_ALIVE_FREQ_SECS, option) == 0)
AzureIoTClient 38:6435c6e3d55c 1922 {
AzureIoTClient 38:6435c6e3d55c 1923 transport_instance->c2d_keep_alive_freq_secs = *(size_t*)value;
AzureIoTClient 38:6435c6e3d55c 1924 result = IOTHUB_CLIENT_OK;
AzureIoTClient 38:6435c6e3d55c 1925 }
AzureIoTClient 34:51d158b409d2 1926 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_104: [If `option` is `logtrace`, `value` shall be saved and applied to `instance->connection` using amqp_connection_set_logging()]
AzureIoTClient 34:51d158b409d2 1927 else if (strcmp(OPTION_LOG_TRACE, option) == 0)
AzureIoTClient 34:51d158b409d2 1928 {
AzureIoTClient 34:51d158b409d2 1929 transport_instance->is_trace_on = *((bool*)value);
AzureIoTClient 25:63f7d371c030 1930
AzureIoTClient 34:51d158b409d2 1931 if (transport_instance->amqp_connection != NULL &&
AzureIoTClient 34:51d158b409d2 1932 amqp_connection_set_logging(transport_instance->amqp_connection, transport_instance->is_trace_on) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 1933 {
AzureIoTClient 34:51d158b409d2 1934 LogError("transport failed setting option '%s' (amqp_connection_set_logging failed)", option);
AzureIoTClient 34:51d158b409d2 1935 result = IOTHUB_CLIENT_ERROR;
AzureIoTClient 34:51d158b409d2 1936 }
AzureIoTClient 34:51d158b409d2 1937 else
AzureIoTClient 34:51d158b409d2 1938 {
AzureIoTClient 34:51d158b409d2 1939 result = IOTHUB_CLIENT_OK;
AzureIoTClient 34:51d158b409d2 1940 }
AzureIoTClient 34:51d158b409d2 1941 }
AzureIoTClient 31:adadaef857c1 1942 else if (strcmp(OPTION_HTTP_PROXY, option) == 0)
AzureIoTClient 31:adadaef857c1 1943 {
AzureIoTClient 31:adadaef857c1 1944 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_032: [ If `option` is `proxy_data`, `value` shall be used as an `HTTP_PROXY_OPTIONS*`. ]*/
AzureIoTClient 31:adadaef857c1 1945 HTTP_PROXY_OPTIONS* proxy_options = (HTTP_PROXY_OPTIONS*)value;
AzureIoTClient 31:adadaef857c1 1946
AzureIoTClient 31:adadaef857c1 1947 if (transport_instance->tls_io != NULL)
AzureIoTClient 31:adadaef857c1 1948 {
AzureIoTClient 31:adadaef857c1 1949 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_038: [ If the underlying IO has already been created, then `IoTHubTransport_AMQP_Common_SetOption` shall fail and return `IOTHUB_CLIENT_ERROR`. ]*/
AzureIoTClient 31:adadaef857c1 1950 LogError("Cannot set proxy option once the underlying IO is created");
AzureIoTClient 31:adadaef857c1 1951 result = IOTHUB_CLIENT_ERROR;
AzureIoTClient 31:adadaef857c1 1952 }
AzureIoTClient 31:adadaef857c1 1953 else if (proxy_options->host_address == NULL)
AzureIoTClient 31:adadaef857c1 1954 {
AzureIoTClient 31:adadaef857c1 1955 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_034: [ If `host_address` is NULL, `IoTHubTransport_AMQP_Common_SetOption` shall fail and return `IOTHUB_CLIENT_INVALID_ARG`. ]*/
AzureIoTClient 31:adadaef857c1 1956 LogError("NULL host_address in proxy options");
AzureIoTClient 31:adadaef857c1 1957 result = IOTHUB_CLIENT_INVALID_ARG;
AzureIoTClient 31:adadaef857c1 1958 }
AzureIoTClient 31:adadaef857c1 1959 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_037: [ If only one of `username` and `password` is NULL, `IoTHubTransport_AMQP_Common_SetOption` shall fail and return `IOTHUB_CLIENT_INVALID_ARG`. ]*/
AzureIoTClient 31:adadaef857c1 1960 else if (((proxy_options->username == NULL) || (proxy_options->password == NULL)) &&
AzureIoTClient 31:adadaef857c1 1961 (proxy_options->username != proxy_options->password))
AzureIoTClient 31:adadaef857c1 1962 {
AzureIoTClient 31:adadaef857c1 1963 LogError("Only one of username and password for proxy settings was NULL");
AzureIoTClient 31:adadaef857c1 1964 result = IOTHUB_CLIENT_INVALID_ARG;
AzureIoTClient 31:adadaef857c1 1965 }
AzureIoTClient 31:adadaef857c1 1966 else
AzureIoTClient 31:adadaef857c1 1967 {
AzureIoTClient 31:adadaef857c1 1968 char* copied_proxy_hostname = NULL;
AzureIoTClient 31:adadaef857c1 1969 char* copied_proxy_username = NULL;
AzureIoTClient 31:adadaef857c1 1970 char* copied_proxy_password = NULL;
AzureIoTClient 31:adadaef857c1 1971
AzureIoTClient 31:adadaef857c1 1972 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_033: [ The fields `host_address`, `port`, `username` and `password` shall be saved for later used (needed when creating the underlying IO to be used by the transport). ]*/
AzureIoTClient 31:adadaef857c1 1973 transport_instance->http_proxy_port = proxy_options->port;
AzureIoTClient 31:adadaef857c1 1974 if (mallocAndStrcpy_s(&copied_proxy_hostname, proxy_options->host_address) != 0)
AzureIoTClient 31:adadaef857c1 1975 {
AzureIoTClient 31:adadaef857c1 1976 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_035: [ If copying `host_address`, `username` or `password` fails, `IoTHubTransport_AMQP_Common_SetOption` shall fail and return `IOTHUB_CLIENT_ERROR`. ]*/
AzureIoTClient 31:adadaef857c1 1977 LogError("Cannot copy HTTP proxy hostname");
AzureIoTClient 31:adadaef857c1 1978 result = IOTHUB_CLIENT_ERROR;
AzureIoTClient 31:adadaef857c1 1979 }
AzureIoTClient 31:adadaef857c1 1980 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_036: [ `username` and `password` shall be allowed to be NULL. ]*/
AzureIoTClient 31:adadaef857c1 1981 else if ((proxy_options->username != NULL) && (mallocAndStrcpy_s(&copied_proxy_username, proxy_options->username) != 0))
AzureIoTClient 31:adadaef857c1 1982 {
AzureIoTClient 31:adadaef857c1 1983 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_035: [ If copying `host_address`, `username` or `password` fails, `IoTHubTransport_AMQP_Common_SetOption` shall fail and return `IOTHUB_CLIENT_ERROR`. ]*/
AzureIoTClient 31:adadaef857c1 1984 free(copied_proxy_hostname);
AzureIoTClient 31:adadaef857c1 1985 LogError("Cannot copy HTTP proxy username");
AzureIoTClient 31:adadaef857c1 1986 result = IOTHUB_CLIENT_ERROR;
AzureIoTClient 31:adadaef857c1 1987 }
AzureIoTClient 31:adadaef857c1 1988 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_036: [ `username` and `password` shall be allowed to be NULL. ]*/
AzureIoTClient 31:adadaef857c1 1989 else if ((proxy_options->password != NULL) && (mallocAndStrcpy_s(&copied_proxy_password, proxy_options->password) != 0))
AzureIoTClient 31:adadaef857c1 1990 {
AzureIoTClient 31:adadaef857c1 1991 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_035: [ If copying `host_address`, `username` or `password` fails, `IoTHubTransport_AMQP_Common_SetOption` shall fail and return `IOTHUB_CLIENT_ERROR`. ]*/
AzureIoTClient 31:adadaef857c1 1992 if (copied_proxy_username != NULL)
AzureIoTClient 31:adadaef857c1 1993 {
AzureIoTClient 31:adadaef857c1 1994 free(copied_proxy_username);
AzureIoTClient 31:adadaef857c1 1995 }
AzureIoTClient 31:adadaef857c1 1996 free(copied_proxy_hostname);
AzureIoTClient 31:adadaef857c1 1997 LogError("Cannot copy HTTP proxy password");
AzureIoTClient 31:adadaef857c1 1998 result = IOTHUB_CLIENT_ERROR;
AzureIoTClient 31:adadaef857c1 1999 }
AzureIoTClient 31:adadaef857c1 2000 else
AzureIoTClient 31:adadaef857c1 2001 {
AzureIoTClient 31:adadaef857c1 2002 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_040: [ When setting the proxy options succeeds any previously saved proxy options shall be freed. ]*/
AzureIoTClient 31:adadaef857c1 2003 free_proxy_data(transport_instance);
AzureIoTClient 31:adadaef857c1 2004
AzureIoTClient 31:adadaef857c1 2005 transport_instance->http_proxy_hostname = copied_proxy_hostname;
AzureIoTClient 31:adadaef857c1 2006 transport_instance->http_proxy_username = copied_proxy_username;
AzureIoTClient 31:adadaef857c1 2007 transport_instance->http_proxy_password = copied_proxy_password;
AzureIoTClient 31:adadaef857c1 2008
AzureIoTClient 31:adadaef857c1 2009 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_039: [ If setting the `proxy_data` option succeeds, `IoTHubTransport_AMQP_Common_SetOption` shall return `IOTHUB_CLIENT_OK` ]*/
AzureIoTClient 31:adadaef857c1 2010 result = IOTHUB_CLIENT_OK;
AzureIoTClient 31:adadaef857c1 2011 }
AzureIoTClient 31:adadaef857c1 2012 }
AzureIoTClient 31:adadaef857c1 2013 }
AzureIoTClient 31:adadaef857c1 2014 else
AzureIoTClient 34:51d158b409d2 2015 {
AzureIoTClient 34:51d158b409d2 2016 result = IOTHUB_CLIENT_OK;
AzureIoTClient 30:20a85b733111 2017
AzureIoTClient 34:51d158b409d2 2018 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_02_007: [ If `option` is `x509certificate` and the transport preferred authentication method is not x509 then IoTHubTransport_AMQP_Common_SetOption shall return IOTHUB_CLIENT_INVALID_ARG. ]
AzureIoTClient 34:51d158b409d2 2019 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_02_008: [ If `option` is `x509privatekey` and the transport preferred authentication method is not x509 then IoTHubTransport_AMQP_Common_SetOption shall return IOTHUB_CLIENT_INVALID_ARG. ]
AzureIoTClient 34:51d158b409d2 2020 if (strcmp(OPTION_X509_CERT, option) == 0 || strcmp(OPTION_X509_PRIVATE_KEY, option) == 0)
AzureIoTClient 34:51d158b409d2 2021 {
AzureIoTClient 34:51d158b409d2 2022 if (transport_instance->preferred_authentication_mode == AMQP_TRANSPORT_AUTHENTICATION_MODE_NOT_SET)
AzureIoTClient 34:51d158b409d2 2023 {
AzureIoTClient 34:51d158b409d2 2024 transport_instance->preferred_authentication_mode = AMQP_TRANSPORT_AUTHENTICATION_MODE_X509;
AzureIoTClient 34:51d158b409d2 2025 }
AzureIoTClient 34:51d158b409d2 2026 else if (transport_instance->preferred_authentication_mode != AMQP_TRANSPORT_AUTHENTICATION_MODE_X509)
AzureIoTClient 34:51d158b409d2 2027 {
AzureIoTClient 34:51d158b409d2 2028 LogError("transport failed setting option '%s' (preferred authentication method is not x509)", option);
AzureIoTClient 34:51d158b409d2 2029 result = IOTHUB_CLIENT_INVALID_ARG;
AzureIoTClient 34:51d158b409d2 2030 }
AzureIoTClient 34:51d158b409d2 2031 else
AzureIoTClient 34:51d158b409d2 2032 {
AzureIoTClient 34:51d158b409d2 2033 IoTHubClient_Auth_Set_x509_Type(transport_instance->authorization_module, true);
AzureIoTClient 34:51d158b409d2 2034 }
AzureIoTClient 34:51d158b409d2 2035 }
AzureIoTClient 25:63f7d371c030 2036
AzureIoTClient 34:51d158b409d2 2037 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_105: [If `option` does not match one of the options handled by this module, it shall be passed to `instance->tls_io` using xio_setoption()]
AzureIoTClient 34:51d158b409d2 2038 if (result != IOTHUB_CLIENT_INVALID_ARG)
AzureIoTClient 34:51d158b409d2 2039 {
AzureIoTClient 34:51d158b409d2 2040 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_106: [If `instance->tls_io` is NULL, it shall be set invoking instance->underlying_io_transport_provider()]
AzureIoTClient 34:51d158b409d2 2041 if (transport_instance->tls_io == NULL &&
AzureIoTClient 34:51d158b409d2 2042 get_new_underlying_io_transport(transport_instance, &transport_instance->tls_io) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 2043 {
AzureIoTClient 34:51d158b409d2 2044 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_107: [If instance->underlying_io_transport_provider() fails, IoTHubTransport_AMQP_Common_SetOption shall fail and return IOTHUB_CLIENT_ERROR]
AzureIoTClient 34:51d158b409d2 2045 LogError("transport failed setting option '%s' (failed to obtain a TLS I/O transport).", option);
AzureIoTClient 34:51d158b409d2 2046 result = IOTHUB_CLIENT_ERROR;
AzureIoTClient 34:51d158b409d2 2047 }
AzureIoTClient 34:51d158b409d2 2048 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_108: [When `instance->tls_io` is created, IoTHubTransport_AMQP_Common_SetOption shall apply `instance->saved_tls_options` with OptionHandler_FeedOptions()]
AzureIoTClient 34:51d158b409d2 2049 else if (xio_setoption(transport_instance->tls_io, option, value) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 2050 {
AzureIoTClient 34:51d158b409d2 2051 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_03_001: [If xio_setoption fails, IoTHubTransport_AMQP_Common_SetOption shall return IOTHUB_CLIENT_ERROR.]
AzureIoTClient 34:51d158b409d2 2052 LogError("transport failed setting option '%s' (xio_setoption failed)", option);
AzureIoTClient 34:51d158b409d2 2053 result = IOTHUB_CLIENT_ERROR;
AzureIoTClient 34:51d158b409d2 2054 }
AzureIoTClient 34:51d158b409d2 2055 else
AzureIoTClient 34:51d158b409d2 2056 {
AzureIoTClient 34:51d158b409d2 2057 if (save_underlying_io_transport_options(transport_instance) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 2058 {
AzureIoTClient 34:51d158b409d2 2059 LogError("IoTHubTransport_AMQP_Common_SetOption failed to save underlying I/O options; failure will be ignored");
AzureIoTClient 34:51d158b409d2 2060 }
AzureIoTClient 25:63f7d371c030 2061
AzureIoTClient 34:51d158b409d2 2062 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_03_001: [If no failures occur, IoTHubTransport_AMQP_Common_SetOption shall return IOTHUB_CLIENT_OK.]
AzureIoTClient 34:51d158b409d2 2063 result = IOTHUB_CLIENT_OK;
AzureIoTClient 34:51d158b409d2 2064 }
AzureIoTClient 34:51d158b409d2 2065 }
AzureIoTClient 34:51d158b409d2 2066 }
AzureIoTClient 34:51d158b409d2 2067 }
AzureIoTClient 25:63f7d371c030 2068
AzureIoTClient 25:63f7d371c030 2069 return result;
AzureIoTClient 25:63f7d371c030 2070 }
AzureIoTClient 25:63f7d371c030 2071
AzureIoTClient 25:63f7d371c030 2072 IOTHUB_DEVICE_HANDLE IoTHubTransport_AMQP_Common_Register(TRANSPORT_LL_HANDLE handle, const IOTHUB_DEVICE_CONFIG* device, IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle, PDLIST_ENTRY waitingToSend)
AzureIoTClient 25:63f7d371c030 2073 {
AzureIoTClient 25:63f7d371c030 2074 #ifdef NO_LOGGING
AzureIoTClient 25:63f7d371c030 2075 UNUSED(iotHubClientHandle);
AzureIoTClient 25:63f7d371c030 2076 #endif
AzureIoTClient 25:63f7d371c030 2077
AzureIoTClient 30:20a85b733111 2078 IOTHUB_DEVICE_HANDLE result;
AzureIoTClient 30:20a85b733111 2079
AzureIoTClient 34:51d158b409d2 2080 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_17_005: [If `handle`, `device`, `iotHubClientHandle` or `waitingToSend` is NULL, IoTHubTransport_AMQP_Common_Register shall return NULL]
AzureIoTClient 34:51d158b409d2 2081 if ((handle == NULL) || (device == NULL) || (waitingToSend == NULL) || (iotHubClientHandle == NULL))
AzureIoTClient 25:63f7d371c030 2082 {
AzureIoTClient 30:20a85b733111 2083 LogError("invalid parameter TRANSPORT_LL_HANDLE handle=%p, const IOTHUB_DEVICE_CONFIG* device=%p, IOTHUB_CLIENT_LL_HANDLE iotHubClientHandle=%p, PDLIST_ENTRY waiting_to_send=%p",
AzureIoTClient 25:63f7d371c030 2084 handle, device, iotHubClientHandle, waitingToSend);
AzureIoTClient 34:51d158b409d2 2085 result = NULL;
AzureIoTClient 25:63f7d371c030 2086 }
AzureIoTClient 34:51d158b409d2 2087 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_03_002: [IoTHubTransport_AMQP_Common_Register shall return NULL if `device->deviceId` is NULL.]
AzureIoTClient 34:51d158b409d2 2088 else if (device->deviceId == NULL)
AzureIoTClient 34:51d158b409d2 2089 {
AzureIoTClient 34:51d158b409d2 2090 LogError("Transport failed to register device (device_id provided is NULL)");
AzureIoTClient 34:51d158b409d2 2091 result = NULL;
AzureIoTClient 34:51d158b409d2 2092 }
AzureIoTClient 26:ee14eed604f6 2093 else
AzureIoTClient 26:ee14eed604f6 2094 {
AzureIoTClient 34:51d158b409d2 2095 LIST_ITEM_HANDLE list_item;
AzureIoTClient 30:20a85b733111 2096 AMQP_TRANSPORT_INSTANCE* transport_instance = (AMQP_TRANSPORT_INSTANCE*)handle;
AzureIoTClient 25:63f7d371c030 2097
AzureIoTClient 34:51d158b409d2 2098 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_064: [If the device is already registered, IoTHubTransport_AMQP_Common_Register shall fail and return NULL.]
AzureIoTClient 34:51d158b409d2 2099 if (is_device_registered_ex(transport_instance->registered_devices, device->deviceId, &list_item))
AzureIoTClient 34:51d158b409d2 2100 {
AzureIoTClient 34:51d158b409d2 2101 LogError("IoTHubTransport_AMQP_Common_Register failed (device '%s' already registered on this transport instance)", device->deviceId);
AzureIoTClient 34:51d158b409d2 2102 result = NULL;
AzureIoTClient 34:51d158b409d2 2103 }
AzureIoTClient 34:51d158b409d2 2104 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_065: [IoTHubTransport_AMQP_Common_Register shall fail and return NULL if the device is not using an authentication mode compatible with the currently used by the transport.]
AzureIoTClient 34:51d158b409d2 2105 else if (!is_device_credential_acceptable(device, transport_instance->preferred_authentication_mode))
AzureIoTClient 26:ee14eed604f6 2106 {
AzureIoTClient 30:20a85b733111 2107 LogError("Transport failed to register device '%s' (device credential was not accepted)", device->deviceId);
AzureIoTClient 34:51d158b409d2 2108 result = NULL;
AzureIoTClient 34:51d158b409d2 2109 }
AzureIoTClient 26:ee14eed604f6 2110 else
AzureIoTClient 26:ee14eed604f6 2111 {
AzureIoTClient 30:20a85b733111 2112 AMQP_TRANSPORT_DEVICE_INSTANCE* amqp_device_instance;
AzureIoTClient 25:63f7d371c030 2113
AzureIoTClient 34:51d158b409d2 2114 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_066: [IoTHubTransport_AMQP_Common_Register shall allocate an instance of AMQP_TRANSPORT_DEVICE_INSTANCE to store the state of the new registered device.]
AzureIoTClient 30:20a85b733111 2115 if ((amqp_device_instance = (AMQP_TRANSPORT_DEVICE_INSTANCE*)malloc(sizeof(AMQP_TRANSPORT_DEVICE_INSTANCE))) == NULL)
AzureIoTClient 26:ee14eed604f6 2116 {
AzureIoTClient 34:51d158b409d2 2117 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_067: [If malloc fails, IoTHubTransport_AMQP_Common_Register shall fail and return NULL.]
AzureIoTClient 34:51d158b409d2 2118 LogError("Transport failed to register device '%s' (failed to create the device state instance; malloc failed)", device->deviceId);
AzureIoTClient 34:51d158b409d2 2119 result = NULL;
AzureIoTClient 34:51d158b409d2 2120 }
AzureIoTClient 26:ee14eed604f6 2121 else
AzureIoTClient 26:ee14eed604f6 2122 {
AzureIoTClient 34:51d158b409d2 2123 memset(amqp_device_instance, 0, sizeof(AMQP_TRANSPORT_DEVICE_INSTANCE));
AzureIoTClient 34:51d158b409d2 2124
AzureIoTClient 34:51d158b409d2 2125 char* local_product_info = NULL;
AzureIoTClient 34:51d158b409d2 2126 void* product_info;
AzureIoTClient 34:51d158b409d2 2127 if ((IoTHubClient_LL_GetOption(iotHubClientHandle, OPTION_PRODUCT_INFO, &product_info) != IOTHUB_CLIENT_OK) || (product_info == NULL))
AzureIoTClient 34:51d158b409d2 2128 {
AzureIoTClient 34:51d158b409d2 2129 mallocAndStrcpy_s(&local_product_info, CLIENT_DEVICE_TYPE_PREFIX CLIENT_DEVICE_BACKSLASH IOTHUB_SDK_VERSION);
AzureIoTClient 34:51d158b409d2 2130 }
AzureIoTClient 34:51d158b409d2 2131 else
AzureIoTClient 34:51d158b409d2 2132 {
AzureIoTClient 34:51d158b409d2 2133 mallocAndStrcpy_s(&local_product_info, STRING_c_str((STRING_HANDLE)product_info));
AzureIoTClient 34:51d158b409d2 2134 }
AzureIoTClient 34:51d158b409d2 2135
AzureIoTClient 34:51d158b409d2 2136 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_068: [IoTHubTransport_AMQP_Common_Register shall save the handle references to the IoTHubClient, transport, waitingToSend list on `amqp_device_instance`.]
AzureIoTClient 34:51d158b409d2 2137 amqp_device_instance->iothub_client_handle = iotHubClientHandle;
AzureIoTClient 30:20a85b733111 2138 amqp_device_instance->transport_instance = transport_instance;
AzureIoTClient 30:20a85b733111 2139 amqp_device_instance->waiting_to_send = waitingToSend;
AzureIoTClient 34:51d158b409d2 2140 amqp_device_instance->device_state = DEVICE_STATE_STOPPED;
AzureIoTClient 34:51d158b409d2 2141 amqp_device_instance->max_state_change_timeout_secs = DEFAULT_DEVICE_STATE_CHANGE_TIMEOUT_SECS;
AzureIoTClient 30:20a85b733111 2142
AzureIoTClient 25:63f7d371c030 2143 #ifdef WIP_C2D_METHODS_AMQP /* This feature is WIP, do not use yet */
AzureIoTClient 30:20a85b733111 2144 amqp_device_instance->subscribe_methods_needed = false;
AzureIoTClient 30:20a85b733111 2145 amqp_device_instance->subscribed_for_methods = false;
AzureIoTClient 25:63f7d371c030 2146 #endif
AzureIoTClient 34:51d158b409d2 2147 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_069: [A copy of `config->deviceId` shall be saved into `device_state->device_id`]
AzureIoTClient 30:20a85b733111 2148 if ((amqp_device_instance->device_id = STRING_construct(device->deviceId)) == NULL)
AzureIoTClient 26:ee14eed604f6 2149 {
AzureIoTClient 34:51d158b409d2 2150 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_070: [If STRING_construct() fails, IoTHubTransport_AMQP_Common_Register shall fail and return NULL]
AzureIoTClient 34:51d158b409d2 2151 LogError("Transport failed to register device '%s' (failed to copy the deviceId)", device->deviceId);
AzureIoTClient 34:51d158b409d2 2152 result = NULL;
AzureIoTClient 34:51d158b409d2 2153 }
AzureIoTClient 26:ee14eed604f6 2154 else
AzureIoTClient 26:ee14eed604f6 2155 {
AzureIoTClient 34:51d158b409d2 2156 DEVICE_CONFIG device_config;
AzureIoTClient 34:51d158b409d2 2157 memset(&device_config, 0, sizeof(DEVICE_CONFIG));
AzureIoTClient 34:51d158b409d2 2158 device_config.iothub_host_fqdn = (char*)STRING_c_str(transport_instance->iothub_host_fqdn);
AzureIoTClient 34:51d158b409d2 2159 device_config.authorization_module = device->authorization_module;
AzureIoTClient 34:51d158b409d2 2160
AzureIoTClient 34:51d158b409d2 2161 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_072: [The configuration for device_create shall be set according to the authentication preferred by IOTHUB_DEVICE_CONFIG]
AzureIoTClient 41:71c01aa3df1a 2162 device_config.authentication_mode = get_authentication_mode(device);
AzureIoTClient 34:51d158b409d2 2163 device_config.on_state_changed_callback = on_device_state_changed_callback;
AzureIoTClient 34:51d158b409d2 2164 device_config.on_state_changed_context = amqp_device_instance;
AzureIoTClient 34:51d158b409d2 2165 device_config.product_info = local_product_info;
AzureIoTClient 30:20a85b733111 2166
AzureIoTClient 34:51d158b409d2 2167 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_071: [`amqp_device_instance->device_handle` shall be set using device_create()]
AzureIoTClient 34:51d158b409d2 2168 if ((amqp_device_instance->device_handle = device_create(&device_config)) == NULL)
AzureIoTClient 34:51d158b409d2 2169 {
AzureIoTClient 34:51d158b409d2 2170 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_073: [If device_create() fails, IoTHubTransport_AMQP_Common_Register shall fail and return NULL]
AzureIoTClient 34:51d158b409d2 2171 LogError("Transport failed to register device '%s' (failed to create the DEVICE_HANDLE instance)", device->deviceId);
AzureIoTClient 34:51d158b409d2 2172 result = NULL;
AzureIoTClient 34:51d158b409d2 2173 }
AzureIoTClient 34:51d158b409d2 2174 else
AzureIoTClient 34:51d158b409d2 2175 {
AzureIoTClient 34:51d158b409d2 2176 bool is_first_device_being_registered = (singlylinkedlist_get_head_item(transport_instance->registered_devices) == NULL);
AzureIoTClient 30:20a85b733111 2177
AzureIoTClient 25:63f7d371c030 2178 #ifdef WIP_C2D_METHODS_AMQP /* This feature is WIP, do not use yet */
AzureIoTClient 34:51d158b409d2 2179 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_010: [ `IoTHubTransport_AMQP_Common_Create` shall create a new iothubtransportamqp_methods instance by calling `iothubtransportamqp_methods_create` while passing to it the the fully qualified domain name and the device Id. ]*/
AzureIoTClient 34:51d158b409d2 2180 amqp_device_instance->methods_handle = iothubtransportamqp_methods_create(STRING_c_str(transport_instance->iothub_host_fqdn), device->deviceId);
AzureIoTClient 34:51d158b409d2 2181 if (amqp_device_instance->methods_handle == NULL)
AzureIoTClient 34:51d158b409d2 2182 {
AzureIoTClient 34:51d158b409d2 2183 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_011: [ If `iothubtransportamqp_methods_create` fails, `IoTHubTransport_AMQP_Common_Create` shall fail and return NULL. ]*/
AzureIoTClient 34:51d158b409d2 2184 LogError("Transport failed to register device '%s' (Cannot create the methods module)", device->deviceId);
AzureIoTClient 34:51d158b409d2 2185 result = NULL;
AzureIoTClient 34:51d158b409d2 2186 }
AzureIoTClient 34:51d158b409d2 2187 else
AzureIoTClient 25:63f7d371c030 2188 #endif
AzureIoTClient 34:51d158b409d2 2189 if (replicate_device_options_to(amqp_device_instance, device_config.authentication_mode) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 2190 {
AzureIoTClient 34:51d158b409d2 2191 LogError("Transport failed to register device '%s' (failed to replicate options)", device->deviceId);
AzureIoTClient 34:51d158b409d2 2192 result = NULL;
AzureIoTClient 34:51d158b409d2 2193 }
AzureIoTClient 34:51d158b409d2 2194 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_074: [IoTHubTransport_AMQP_Common_Register shall add the `amqp_device_instance` to `instance->registered_devices`]
AzureIoTClient 34:51d158b409d2 2195 else if (singlylinkedlist_add(transport_instance->registered_devices, amqp_device_instance) == NULL)
AzureIoTClient 34:51d158b409d2 2196 {
AzureIoTClient 34:51d158b409d2 2197 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_075: [If it fails to add `amqp_device_instance`, IoTHubTransport_AMQP_Common_Register shall fail and return NULL]
AzureIoTClient 34:51d158b409d2 2198 LogError("Transport failed to register device '%s' (singlylinkedlist_add failed)", device->deviceId);
AzureIoTClient 34:51d158b409d2 2199 result = NULL;
AzureIoTClient 34:51d158b409d2 2200 }
AzureIoTClient 34:51d158b409d2 2201 else
AzureIoTClient 34:51d158b409d2 2202 {
AzureIoTClient 34:51d158b409d2 2203 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_076: [If the device is the first being registered on the transport, IoTHubTransport_AMQP_Common_Register shall save its authentication mode as the transport preferred authentication mode]
AzureIoTClient 34:51d158b409d2 2204 if (transport_instance->preferred_authentication_mode == AMQP_TRANSPORT_AUTHENTICATION_MODE_NOT_SET &&
AzureIoTClient 34:51d158b409d2 2205 is_first_device_being_registered)
AzureIoTClient 34:51d158b409d2 2206 {
AzureIoTClient 34:51d158b409d2 2207 if (device_config.authentication_mode == DEVICE_AUTH_MODE_CBS)
AzureIoTClient 34:51d158b409d2 2208 {
AzureIoTClient 34:51d158b409d2 2209 transport_instance->preferred_authentication_mode = AMQP_TRANSPORT_AUTHENTICATION_MODE_CBS;
AzureIoTClient 34:51d158b409d2 2210 }
AzureIoTClient 34:51d158b409d2 2211 else
AzureIoTClient 34:51d158b409d2 2212 {
AzureIoTClient 34:51d158b409d2 2213 transport_instance->preferred_authentication_mode = AMQP_TRANSPORT_AUTHENTICATION_MODE_X509;
AzureIoTClient 34:51d158b409d2 2214 }
AzureIoTClient 34:51d158b409d2 2215 }
AzureIoTClient 25:63f7d371c030 2216
AzureIoTClient 34:51d158b409d2 2217 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_078: [IoTHubTransport_AMQP_Common_Register shall return a handle to `amqp_device_instance` as a IOTHUB_DEVICE_HANDLE]
AzureIoTClient 34:51d158b409d2 2218 result = (IOTHUB_DEVICE_HANDLE)amqp_device_instance;
AzureIoTClient 34:51d158b409d2 2219 }
AzureIoTClient 34:51d158b409d2 2220 }
AzureIoTClient 26:ee14eed604f6 2221 }
AzureIoTClient 25:63f7d371c030 2222
AzureIoTClient 30:20a85b733111 2223 if (result == NULL)
AzureIoTClient 26:ee14eed604f6 2224 {
AzureIoTClient 34:51d158b409d2 2225 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_077: [If IoTHubTransport_AMQP_Common_Register fails, it shall free all memory it allocated]
AzureIoTClient 34:51d158b409d2 2226 internal_destroy_amqp_device_instance(amqp_device_instance);
AzureIoTClient 34:51d158b409d2 2227 }
AzureIoTClient 34:51d158b409d2 2228 free(local_product_info);
AzureIoTClient 26:ee14eed604f6 2229 }
AzureIoTClient 26:ee14eed604f6 2230 }
AzureIoTClient 26:ee14eed604f6 2231 }
AzureIoTClient 25:63f7d371c030 2232
AzureIoTClient 26:ee14eed604f6 2233 return result;
AzureIoTClient 25:63f7d371c030 2234 }
AzureIoTClient 25:63f7d371c030 2235
AzureIoTClient 25:63f7d371c030 2236 void IoTHubTransport_AMQP_Common_Unregister(IOTHUB_DEVICE_HANDLE deviceHandle)
AzureIoTClient 25:63f7d371c030 2237 {
AzureIoTClient 34:51d158b409d2 2238 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_079: [if `deviceHandle` provided is NULL, IoTHubTransport_AMQP_Common_Unregister shall return.]
AzureIoTClient 26:ee14eed604f6 2239 if (deviceHandle == NULL)
AzureIoTClient 26:ee14eed604f6 2240 {
AzureIoTClient 30:20a85b733111 2241 LogError("Failed to unregister device (deviceHandle is NULL).");
AzureIoTClient 26:ee14eed604f6 2242 }
AzureIoTClient 26:ee14eed604f6 2243 else
AzureIoTClient 26:ee14eed604f6 2244 {
AzureIoTClient 30:20a85b733111 2245 AMQP_TRANSPORT_DEVICE_INSTANCE* registered_device = (AMQP_TRANSPORT_DEVICE_INSTANCE*)deviceHandle;
AzureIoTClient 34:51d158b409d2 2246 const char* device_id;
AzureIoTClient 34:51d158b409d2 2247 LIST_ITEM_HANDLE list_item;
AzureIoTClient 25:63f7d371c030 2248
AzureIoTClient 34:51d158b409d2 2249 if ((device_id = STRING_c_str(registered_device->device_id)) == NULL)
AzureIoTClient 34:51d158b409d2 2250 {
AzureIoTClient 34:51d158b409d2 2251 LogError("Failed to unregister device (failed to get device id char ptr)");
AzureIoTClient 34:51d158b409d2 2252 }
AzureIoTClient 34:51d158b409d2 2253 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_080: [if `deviceHandle` has a NULL reference to its transport instance, IoTHubTransport_AMQP_Common_Unregister shall return.]
AzureIoTClient 34:51d158b409d2 2254 else if (registered_device->transport_instance == NULL)
AzureIoTClient 30:20a85b733111 2255 {
AzureIoTClient 34:51d158b409d2 2256 LogError("Failed to unregister device '%s' (deviceHandle does not have a transport state associated to).", device_id);
AzureIoTClient 34:51d158b409d2 2257 }
AzureIoTClient 34:51d158b409d2 2258 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_081: [If the device is not registered with this transport, IoTHubTransport_AMQP_Common_Unregister shall return]
AzureIoTClient 34:51d158b409d2 2259 else if (!is_device_registered_ex(registered_device->transport_instance->registered_devices, device_id, &list_item))
AzureIoTClient 34:51d158b409d2 2260 {
AzureIoTClient 34:51d158b409d2 2261 LogError("Failed to unregister device '%s' (device is not registered within this transport).", device_id);
AzureIoTClient 30:20a85b733111 2262 }
AzureIoTClient 34:51d158b409d2 2263 else
AzureIoTClient 34:51d158b409d2 2264 {
AzureIoTClient 34:51d158b409d2 2265 // Removing it first so the race hazzard is reduced between this function and DoWork. Best would be to use locks.
AzureIoTClient 34:51d158b409d2 2266 if (singlylinkedlist_remove(registered_device->transport_instance->registered_devices, list_item) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 2267 {
AzureIoTClient 34:51d158b409d2 2268 LogError("Failed to unregister device '%s' (singlylinkedlist_remove failed).", device_id);
AzureIoTClient 34:51d158b409d2 2269 }
AzureIoTClient 34:51d158b409d2 2270 else
AzureIoTClient 34:51d158b409d2 2271 {
AzureIoTClient 34:51d158b409d2 2272 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_01_012: [IoTHubTransport_AMQP_Common_Unregister shall destroy the C2D methods handler by calling iothubtransportamqp_methods_destroy]
AzureIoTClient 34:51d158b409d2 2273 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_083: [IoTHubTransport_AMQP_Common_Unregister shall free all the memory allocated for the `device_instance`]
AzureIoTClient 34:51d158b409d2 2274 internal_destroy_amqp_device_instance(registered_device);
AzureIoTClient 34:51d158b409d2 2275 }
AzureIoTClient 34:51d158b409d2 2276 }
AzureIoTClient 26:ee14eed604f6 2277 }
AzureIoTClient 25:63f7d371c030 2278 }
AzureIoTClient 25:63f7d371c030 2279
AzureIoTClient 25:63f7d371c030 2280 void IoTHubTransport_AMQP_Common_Destroy(TRANSPORT_LL_HANDLE handle)
AzureIoTClient 25:63f7d371c030 2281 {
AzureIoTClient 34:51d158b409d2 2282 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_013: [If `handle` is NULL, IoTHubTransport_AMQP_Common_Destroy shall return immediatelly]
AzureIoTClient 34:51d158b409d2 2283 if (handle == NULL)
AzureIoTClient 34:51d158b409d2 2284 {
AzureIoTClient 34:51d158b409d2 2285 LogError("Failed to destroy AMQP transport instance (handle is NULL)");
AzureIoTClient 34:51d158b409d2 2286 }
AzureIoTClient 34:51d158b409d2 2287 else
AzureIoTClient 34:51d158b409d2 2288 {
AzureIoTClient 34:51d158b409d2 2289 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_014: [IoTHubTransport_AMQP_Common_Destroy shall invoke IoTHubTransport_AMQP_Common_Unregister on each of its registered devices.]
AzureIoTClient 34:51d158b409d2 2290 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_015: [All members of `instance` (including tls_io) shall be destroyed and its memory released]
AzureIoTClient 34:51d158b409d2 2291 internal_destroy_instance((AMQP_TRANSPORT_INSTANCE*)handle);
AzureIoTClient 26:ee14eed604f6 2292 }
AzureIoTClient 25:63f7d371c030 2293 }
AzureIoTClient 25:63f7d371c030 2294
AzureIoTClient 25:63f7d371c030 2295 int IoTHubTransport_AMQP_Common_SetRetryPolicy(TRANSPORT_LL_HANDLE handle, IOTHUB_CLIENT_RETRY_POLICY retryPolicy, size_t retryTimeoutLimitInSeconds)
AzureIoTClient 25:63f7d371c030 2296 {
AzureIoTClient 25:63f7d371c030 2297 int result;
AzureIoTClient 32:babfd49032ff 2298
AzureIoTClient 34:51d158b409d2 2299 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_128: [If `handle` is NULL, `IoTHubTransport_AMQP_Common_SetRetryPolicy` shall fail and return non-zero.]
AzureIoTClient 34:51d158b409d2 2300 if (handle == NULL)
AzureIoTClient 34:51d158b409d2 2301 {
AzureIoTClient 34:51d158b409d2 2302 LogError("Cannot set retry policy (transport handle is NULL)");
AzureIoTClient 34:51d158b409d2 2303 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 2304 }
AzureIoTClient 34:51d158b409d2 2305 else
AzureIoTClient 34:51d158b409d2 2306 {
AzureIoTClient 34:51d158b409d2 2307 RETRY_CONTROL_HANDLE new_retry_control;
AzureIoTClient 25:63f7d371c030 2308
AzureIoTClient 34:51d158b409d2 2309 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_129: [`transport_instance->connection_retry_control` shall be set using retry_control_create(), passing `retryPolicy` and `retryTimeoutLimitInSeconds`.]
AzureIoTClient 34:51d158b409d2 2310 if ((new_retry_control = retry_control_create(retryPolicy, (unsigned int)retryTimeoutLimitInSeconds)) == NULL)
AzureIoTClient 34:51d158b409d2 2311 {
AzureIoTClient 34:51d158b409d2 2312 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_130: [If retry_control_create() fails, `IoTHubTransport_AMQP_Common_SetRetryPolicy` shall fail and return non-zero.]
AzureIoTClient 34:51d158b409d2 2313 LogError("Cannot set retry policy (retry_control_create failed)");
AzureIoTClient 34:51d158b409d2 2314 result = __FAILURE__;
AzureIoTClient 34:51d158b409d2 2315 }
AzureIoTClient 34:51d158b409d2 2316 else
AzureIoTClient 34:51d158b409d2 2317 {
AzureIoTClient 34:51d158b409d2 2318 AMQP_TRANSPORT_INSTANCE* transport_instance = (AMQP_TRANSPORT_INSTANCE*)handle;
AzureIoTClient 34:51d158b409d2 2319 RETRY_CONTROL_HANDLE previous_retry_control = transport_instance->connection_retry_control;
AzureIoTClient 25:63f7d371c030 2320
AzureIoTClient 34:51d158b409d2 2321 transport_instance->connection_retry_control = new_retry_control;
AzureIoTClient 32:babfd49032ff 2322
AzureIoTClient 34:51d158b409d2 2323 retry_control_destroy(previous_retry_control);
AzureIoTClient 32:babfd49032ff 2324
AzureIoTClient 34:51d158b409d2 2325 LogInfo("Retry policy set (%d, timeout = %d)", retryPolicy, retryTimeoutLimitInSeconds);
AzureIoTClient 32:babfd49032ff 2326
AzureIoTClient 34:51d158b409d2 2327 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_128: [If no errors occur, `IoTHubTransport_AMQP_Common_SetRetryPolicy` shall return zero.]
AzureIoTClient 34:51d158b409d2 2328 result = RESULT_OK;
AzureIoTClient 34:51d158b409d2 2329 }
AzureIoTClient 34:51d158b409d2 2330 }
AzureIoTClient 32:babfd49032ff 2331
AzureIoTClient 25:63f7d371c030 2332 return result;
AzureIoTClient 25:63f7d371c030 2333 }
AzureIoTClient 25:63f7d371c030 2334
AzureIoTClient 25:63f7d371c030 2335 STRING_HANDLE IoTHubTransport_AMQP_Common_GetHostname(TRANSPORT_LL_HANDLE handle)
AzureIoTClient 25:63f7d371c030 2336 {
AzureIoTClient 25:63f7d371c030 2337 STRING_HANDLE result;
AzureIoTClient 30:20a85b733111 2338
AzureIoTClient 34:51d158b409d2 2339 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_02_001: [If `handle` is NULL, `IoTHubTransport_AMQP_Common_GetHostname` shall return NULL.]
AzureIoTClient 34:51d158b409d2 2340 if (handle == NULL)
AzureIoTClient 25:63f7d371c030 2341 {
AzureIoTClient 34:51d158b409d2 2342 LogError("Cannot provide the target host name (transport handle is NULL).");
AzureIoTClient 30:20a85b733111 2343
AzureIoTClient 34:51d158b409d2 2344 result = NULL;
AzureIoTClient 30:20a85b733111 2345 }
AzureIoTClient 34:51d158b409d2 2346 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_02_002: [IoTHubTransport_AMQP_Common_GetHostname shall return a copy of `instance->iothub_target_fqdn`.]
AzureIoTClient 34:51d158b409d2 2347 else if ((result = STRING_clone(((AMQP_TRANSPORT_INSTANCE*)(handle))->iothub_host_fqdn)) == NULL)
AzureIoTClient 34:51d158b409d2 2348 {
AzureIoTClient 34:51d158b409d2 2349 LogError("Cannot provide the target host name (STRING_clone failed).");
AzureIoTClient 34:51d158b409d2 2350 }
AzureIoTClient 30:20a85b733111 2351
AzureIoTClient 30:20a85b733111 2352 return result;
AzureIoTClient 30:20a85b733111 2353 }
AzureIoTClient 30:20a85b733111 2354
AzureIoTClient 30:20a85b733111 2355 IOTHUB_CLIENT_RESULT IoTHubTransport_AMQP_Common_SendMessageDisposition(MESSAGE_CALLBACK_INFO* message_data, IOTHUBMESSAGE_DISPOSITION_RESULT disposition)
AzureIoTClient 30:20a85b733111 2356 {
AzureIoTClient 30:20a85b733111 2357 IOTHUB_CLIENT_RESULT result;
AzureIoTClient 30:20a85b733111 2358 if (message_data == NULL)
AzureIoTClient 30:20a85b733111 2359 {
AzureIoTClient 30:20a85b733111 2360 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_10_001: [If messageData is NULL, IoTHubTransport_AMQP_Common_SendMessageDisposition shall fail and return IOTHUB_CLIENT_INVALID_ARG.] */
AzureIoTClient 30:20a85b733111 2361 LogError("Failed sending message disposition (message_data is NULL)");
AzureIoTClient 30:20a85b733111 2362 result = IOTHUB_CLIENT_INVALID_ARG;
AzureIoTClient 25:63f7d371c030 2363 }
AzureIoTClient 25:63f7d371c030 2364 else
AzureIoTClient 25:63f7d371c030 2365 {
AzureIoTClient 34:51d158b409d2 2366 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_10_002: [If any of the messageData fields are NULL, IoTHubTransport_AMQP_Common_SendMessageDisposition shall fail and return IOTHUB_CLIENT_INVALID_ARG.] */
AzureIoTClient 30:20a85b733111 2367 if (message_data->messageHandle == NULL || message_data->transportContext == NULL)
AzureIoTClient 30:20a85b733111 2368 {
AzureIoTClient 34:51d158b409d2 2369 LogError("Failed sending message disposition (message_data->messageHandle (%p) or message_data->transportContext (%p) are NULL)", message_data->messageHandle, message_data->transportContext);
AzureIoTClient 30:20a85b733111 2370 result = IOTHUB_CLIENT_INVALID_ARG;
AzureIoTClient 30:20a85b733111 2371 }
AzureIoTClient 34:51d158b409d2 2372 else
AzureIoTClient 34:51d158b409d2 2373 {
AzureIoTClient 34:51d158b409d2 2374 DEVICE_MESSAGE_DISPOSITION_INFO* device_message_disposition_info;
AzureIoTClient 30:20a85b733111 2375
AzureIoTClient 34:51d158b409d2 2376 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_10_004: [IoTHubTransport_AMQP_Common_SendMessageDisposition shall convert the given IOTHUBMESSAGE_DISPOSITION_RESULT to the equivalent AMQP_VALUE and will return the result of calling messagereceiver_send_message_disposition. ] */
AzureIoTClient 34:51d158b409d2 2377 DEVICE_MESSAGE_DISPOSITION_RESULT device_disposition_result = get_device_disposition_result_from(disposition);
AzureIoTClient 30:20a85b733111 2378
AzureIoTClient 34:51d158b409d2 2379 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_112: [A DEVICE_MESSAGE_DISPOSITION_INFO instance shall be created with a copy of the `link_name` and `message_id` contained in `message_data`]
AzureIoTClient 34:51d158b409d2 2380 if ((device_message_disposition_info = create_device_message_disposition_info_from(message_data)) == NULL)
AzureIoTClient 34:51d158b409d2 2381 {
AzureIoTClient 34:51d158b409d2 2382 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_113: [If the DEVICE_MESSAGE_DISPOSITION_INFO fails to be created, `IoTHubTransport_AMQP_Common_SendMessageDisposition()` shall fail and return IOTHUB_CLIENT_ERROR]
AzureIoTClient 34:51d158b409d2 2383 LogError("Device '%s' failed sending message disposition (failed creating DEVICE_MESSAGE_DISPOSITION_RESULT)", STRING_c_str(message_data->transportContext->device_state->device_id));
AzureIoTClient 34:51d158b409d2 2384 result = IOTHUB_CLIENT_ERROR;
AzureIoTClient 34:51d158b409d2 2385 }
AzureIoTClient 34:51d158b409d2 2386 else
AzureIoTClient 34:51d158b409d2 2387 {
AzureIoTClient 34:51d158b409d2 2388 /* Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_10_003: [IoTHubTransport_AMQP_Common_SendMessageDisposition shall fail and return IOTHUB_CLIENT_ERROR if the POST message fails, otherwise return IOTHUB_CLIENT_OK.] */
AzureIoTClient 34:51d158b409d2 2389 if (device_send_message_disposition(message_data->transportContext->device_state->device_handle, device_message_disposition_info, device_disposition_result) != RESULT_OK)
AzureIoTClient 34:51d158b409d2 2390 {
AzureIoTClient 34:51d158b409d2 2391 LogError("Device '%s' failed sending message disposition (device_send_message_disposition failed)", STRING_c_str(message_data->transportContext->device_state->device_id));
AzureIoTClient 34:51d158b409d2 2392 result = IOTHUB_CLIENT_ERROR;
AzureIoTClient 34:51d158b409d2 2393 }
AzureIoTClient 34:51d158b409d2 2394 else
AzureIoTClient 34:51d158b409d2 2395 {
AzureIoTClient 34:51d158b409d2 2396 IoTHubMessage_Destroy(message_data->messageHandle);
AzureIoTClient 34:51d158b409d2 2397 result = IOTHUB_CLIENT_OK;
AzureIoTClient 34:51d158b409d2 2398 }
AzureIoTClient 30:20a85b733111 2399
AzureIoTClient 34:51d158b409d2 2400 // Codes_SRS_IOTHUBTRANSPORT_AMQP_COMMON_09_114: [`IoTHubTransport_AMQP_Common_SendMessageDisposition()` shall destroy the DEVICE_MESSAGE_DISPOSITION_INFO instance]
AzureIoTClient 34:51d158b409d2 2401 destroy_device_message_disposition_info(device_message_disposition_info);
AzureIoTClient 34:51d158b409d2 2402 }
AzureIoTClient 30:20a85b733111 2403 }
AzureIoTClient 34:51d158b409d2 2404
AzureIoTClient 34:51d158b409d2 2405 MESSAGE_CALLBACK_INFO_Destroy(message_data);
AzureIoTClient 25:63f7d371c030 2406 }
AzureIoTClient 30:20a85b733111 2407
AzureIoTClient 25:63f7d371c030 2408 return result;
AzureIoTClient 25:63f7d371c030 2409 }
AzureIoTClient 25:63f7d371c030 2410