Azure IoT / iothub_amqp_transport

Microsoft Azure IoTHub client AMQP transport

Dependents:   sht15_remote_monitoring RobotArmDemo iothub_client_sample_amqp iothub_client_sample_amqp ... more

This library implements the AMQP transport for Microsoft Azure IoTHub client. The code is replicated from https://github.com/Azure/azure-iot-sdks

iothubtransport_amqp_common.c@54:830550fef7ea, 2018-06-26 (annotated)

Committer:
AzureIoTClient
Date:
Tue Jun 26 19:13:11 2018 -0700
Revision:
54:830550fef7ea
Parent:
53:e21e1e88460f
Child:
56:8704100b3b54
1.2.6

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