Doug Anson / mbedConnectorInterfaceWithDM

mbed Connector Interface simplification API on top of mbed-client

Fork of mbedConnectorInterfaceV3 by Doug Anson

NOTE:

This repo has been replaced with https://github.com/ARMmbed/mbedConnectorInterface. No further updates will occur with this repo. Please use the github repo instead. Thanks!

source/OptionsBuilder.cpp@72:6b1d37b5420a, 2016-11-04 (annotated)

Committer:
ansond
Date:
Fri Nov 04 16:32:41 2016 +0000
Revision:
72:6b1d37b5420a
Parent:
71:5069a202e892
Child:
79:22b57129590b
updates for new mbed Connector

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ansond 0:1f1f55e73248 1 /**
ansond 0:1f1f55e73248 2 * @file OptionsBuilder.cpp
ansond 0:1f1f55e73248 3 * @brief mbed CoAP OptionsBuilder class implementation
ansond 0:1f1f55e73248 4 * @author Doug Anson/Chris Paola
ansond 0:1f1f55e73248 5 * @version 1.0
ansond 0:1f1f55e73248 6 * @see
ansond 0:1f1f55e73248 7 *
ansond 0:1f1f55e73248 8 * Copyright (c) 2014
ansond 0:1f1f55e73248 9 *
ansond 0:1f1f55e73248 10 * Licensed under the Apache License, Version 2.0 (the "License");
ansond 0:1f1f55e73248 11 * you may not use this file except in compliance with the License.
ansond 0:1f1f55e73248 12 * You may obtain a copy of the License at
ansond 0:1f1f55e73248 13 *
ansond 0:1f1f55e73248 14 * http://www.apache.org/licenses/LICENSE-2.0
ansond 0:1f1f55e73248 15 *
ansond 0:1f1f55e73248 16 * Unless required by applicable law or agreed to in writing, software
ansond 0:1f1f55e73248 17 * distributed under the License is distributed on an "AS IS" BASIS,
ansond 0:1f1f55e73248 18 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ansond 0:1f1f55e73248 19 * See the License for the specific language governing permissions and
ansond 0:1f1f55e73248 20 * limitations under the License.
ansond 0:1f1f55e73248 21 */
ansond 0:1f1f55e73248 22
ansond 33:1d0b855df5a5 23 // Class support
ansond 0:1f1f55e73248 24 #include "mbed-connector-interface/OptionsBuilder.h"
ansond 0:1f1f55e73248 25
ansond 54:dfee8691c83a 26 // ResourceObserver support
ansond 0:1f1f55e73248 27 #include "mbed-connector-interface/ThreadedResourceObserver.h"
ansond 0:1f1f55e73248 28 #include "mbed-connector-interface/TickerResourceObserver.h"
ansond 27:b8aaf7dc7023 29 #include "mbed-connector-interface/MinarResourceObserver.h"
ansond 0:1f1f55e73248 30
ansond 0:1f1f55e73248 31 // Connector namespace
ansond 0:1f1f55e73248 32 namespace Connector {
ansond 0:1f1f55e73248 33
ansond 0:1f1f55e73248 34 // Constructor
ansond 0:1f1f55e73248 35 OptionsBuilder::OptionsBuilder()
ansond 0:1f1f55e73248 36 {
ansond 52:8abdfa69b511 37 this->m_endpoint = NULL;
ansond 54:dfee8691c83a 38 this->m_domain = DEFAULT_DOMAIN;
ansond 54:dfee8691c83a 39 this->m_endpoint_type = DEFAULT_ENDPOINT_TYPE;
ansond 71:5069a202e892 40 #ifdef ENABLE_MBED_CLOUD_SUPPORT
ansond 71:5069a202e892 41 extern char gIdcDevSecurityAccountId[33];
ansond 71:5069a202e892 42 this->m_node_name = (char *)gIdcDevSecurityAccountId;
ansond 72:6b1d37b5420a 43 #else
ansond 27:b8aaf7dc7023 44 this->m_node_name = NODE_NAME;
ansond 71:5069a202e892 45 #endif
ansond 27:b8aaf7dc7023 46 this->m_lifetime = REG_LIFETIME_SEC;
ansond 27:b8aaf7dc7023 47 this->m_connector_url = string(CONNECTOR_URL);
ansond 50:4f04727cbf91 48 this->m_server_cert = NULL;
ansond 49:c603a22495bb 49 this->m_server_cert_length = 0;
ansond 49:c603a22495bb 50 this->m_client_cert = NULL;
ansond 49:c603a22495bb 51 this->m_client_cert_length = 0;
ansond 49:c603a22495bb 52 this->m_client_key = NULL;
ansond 49:c603a22495bb 53 this->m_client_key_length = 0;
ansond 27:b8aaf7dc7023 54 this->m_device_resources_object = NULL;
ansond 27:b8aaf7dc7023 55 this->m_firmware_resources_object = NULL;
ansond 0:1f1f55e73248 56 this->m_static_resources.clear();
ansond 0:1f1f55e73248 57 this->m_dynamic_resources.clear();
ansond 0:1f1f55e73248 58 this->m_resource_observers.clear();
ansond 0:1f1f55e73248 59 }
ansond 0:1f1f55e73248 60
ansond 0:1f1f55e73248 61 // Copy Constructor
ansond 0:1f1f55e73248 62 OptionsBuilder::OptionsBuilder(const OptionsBuilder &ob) : Options(ob)
ansond 0:1f1f55e73248 63 {
ansond 54:dfee8691c83a 64 this->m_endpoint = ob.m_endpoint;
ansond 8:f950fb1b78c0 65 this->m_domain = ob.m_domain;
ansond 0:1f1f55e73248 66 this->m_endpoint_type = ob.m_endpoint_type;
ansond 8:f950fb1b78c0 67 this->m_node_name = ob.m_node_name;
ansond 8:f950fb1b78c0 68 this->m_lifetime = ob.m_lifetime;
ansond 8:f950fb1b78c0 69 this->m_connector_url = ob.m_connector_url;
ansond 50:4f04727cbf91 70 this->m_server_cert = ob.m_server_cert;
ansond 49:c603a22495bb 71 this->m_server_cert_length = ob.m_server_cert_length;
ansond 49:c603a22495bb 72 this->m_client_cert = ob.m_client_cert;
ansond 49:c603a22495bb 73 this->m_client_cert_length = ob.m_client_cert_length;
ansond 49:c603a22495bb 74 this->m_client_key = ob.m_client_key;
ansond 49:c603a22495bb 75 this->m_client_key_length= ob.m_client_key_length;
ansond 27:b8aaf7dc7023 76 this->m_device_resources_object = ob.m_device_resources_object;
ansond 27:b8aaf7dc7023 77 this->m_firmware_resources_object = ob.m_firmware_resources_object;
ansond 0:1f1f55e73248 78 this->m_static_resources = ob.m_static_resources;
ansond 0:1f1f55e73248 79 this->m_dynamic_resources = ob.m_dynamic_resources;
ansond 0:1f1f55e73248 80 this->m_resource_observers = ob.m_resource_observers;
ansond 52:8abdfa69b511 81 this->m_wifi_ssid = ob.m_wifi_ssid;
ansond 52:8abdfa69b511 82 this->m_wifi_auth_key = ob.m_wifi_auth_key;
ansond 52:8abdfa69b511 83 this->m_wifi_auth_type = ob.m_wifi_auth_type;
ansond 52:8abdfa69b511 84 this->m_coap_connection_type = ob.m_coap_connection_type;
ansond 52:8abdfa69b511 85 this->m_ip_address_type = ob.m_ip_address_type;
ansond 52:8abdfa69b511 86 this->m_enable_immediate_observation = ob.m_enable_immediate_observation;
ansond 52:8abdfa69b511 87 this->m_enable_get_obs_control = ob.m_enable_get_obs_control;
ansond 52:8abdfa69b511 88 this->m_endpoint = ob.m_endpoint;
ansond 0:1f1f55e73248 89 }
ansond 0:1f1f55e73248 90
ansond 0:1f1f55e73248 91 // Destructor
ansond 0:1f1f55e73248 92 OptionsBuilder::~OptionsBuilder()
ansond 0:1f1f55e73248 93 {
ansond 38:bb6d2be4d54c 94 this->m_device_resources_object = NULL;
ansond 38:bb6d2be4d54c 95 this->m_firmware_resources_object = NULL;
ansond 0:1f1f55e73248 96 this->m_static_resources.clear();
ansond 0:1f1f55e73248 97 this->m_dynamic_resources.clear();
ansond 0:1f1f55e73248 98 this->m_resource_observers.clear();
ansond 0:1f1f55e73248 99 }
ansond 0:1f1f55e73248 100
ansond 0:1f1f55e73248 101 // set lifetime
ansond 0:1f1f55e73248 102 OptionsBuilder &OptionsBuilder::setLifetime(int lifetime)
ansond 0:1f1f55e73248 103 {
ansond 0:1f1f55e73248 104 this->m_lifetime = lifetime;
ansond 0:1f1f55e73248 105 return *this;
ansond 0:1f1f55e73248 106 }
ansond 0:1f1f55e73248 107
ansond 0:1f1f55e73248 108 // set domain
ansond 0:1f1f55e73248 109 OptionsBuilder &OptionsBuilder::setDomain(const char *domain)
ansond 0:1f1f55e73248 110 {
ansond 0:1f1f55e73248 111 this->m_domain = string(domain);
ansond 0:1f1f55e73248 112 return *this;
ansond 0:1f1f55e73248 113 }
ansond 0:1f1f55e73248 114
ansond 0:1f1f55e73248 115 // set endpoint nodename
ansond 0:1f1f55e73248 116 OptionsBuilder &OptionsBuilder::setEndpointNodename(const char *node_name)
ansond 0:1f1f55e73248 117 {
ansond 0:1f1f55e73248 118 this->m_node_name = string(node_name);
ansond 0:1f1f55e73248 119 return *this;
ansond 0:1f1f55e73248 120 }
ansond 0:1f1f55e73248 121
ansond 0:1f1f55e73248 122 // set lifetime
ansond 0:1f1f55e73248 123 OptionsBuilder &OptionsBuilder::setEndpointType(const char *endpoint_type)
ansond 0:1f1f55e73248 124 {
ansond 0:1f1f55e73248 125 this->m_endpoint_type = string(endpoint_type);
ansond 0:1f1f55e73248 126 return *this;
ansond 0:1f1f55e73248 127 }
ansond 0:1f1f55e73248 128
ansond 0:1f1f55e73248 129 // set Connector URL
ansond 0:1f1f55e73248 130 OptionsBuilder &OptionsBuilder::setConnectorURL(const char *connector_url)
ansond 0:1f1f55e73248 131 {
ansond 0:1f1f55e73248 132 if (connector_url != NULL) {
ansond 0:1f1f55e73248 133 this->m_connector_url = string(connector_url);
ansond 0:1f1f55e73248 134 }
ansond 0:1f1f55e73248 135 return *this;
ansond 0:1f1f55e73248 136 }
ansond 0:1f1f55e73248 137
ansond 27:b8aaf7dc7023 138 // add the device resources object
ansond 27:b8aaf7dc7023 139 OptionsBuilder &OptionsBuilder::setDeviceResourcesObject(const void *device_resources_object)
ansond 27:b8aaf7dc7023 140 {
ansond 27:b8aaf7dc7023 141 if (device_resources_object != NULL) {
ansond 27:b8aaf7dc7023 142 this->m_device_resources_object = (void *)device_resources_object;
ansond 27:b8aaf7dc7023 143 }
ansond 27:b8aaf7dc7023 144 return *this;
ansond 27:b8aaf7dc7023 145 }
ansond 27:b8aaf7dc7023 146
ansond 27:b8aaf7dc7023 147 // add the firmware resources object
ansond 27:b8aaf7dc7023 148 OptionsBuilder &OptionsBuilder::setFirmwareResourcesObject(const void *firmware_resources_object)
ansond 27:b8aaf7dc7023 149 {
ansond 27:b8aaf7dc7023 150 if (firmware_resources_object != NULL) {
ansond 27:b8aaf7dc7023 151 this->m_firmware_resources_object = (void *)firmware_resources_object;
ansond 0:1f1f55e73248 152 }
ansond 0:1f1f55e73248 153 return *this;
ansond 0:1f1f55e73248 154 }
ansond 0:1f1f55e73248 155
ansond 0:1f1f55e73248 156 // add static resource
ansond 0:1f1f55e73248 157 OptionsBuilder &OptionsBuilder::addResource(const StaticResource *resource)
ansond 0:1f1f55e73248 158 {
ansond 0:1f1f55e73248 159 if (resource != NULL) {
ansond 0:1f1f55e73248 160 ((StaticResource *)resource)->setOptions(this);
ansond 0:1f1f55e73248 161 this->m_static_resources.push_back((StaticResource *)resource);
ansond 0:1f1f55e73248 162 }
ansond 0:1f1f55e73248 163 return *this;
ansond 0:1f1f55e73248 164 }
ansond 0:1f1f55e73248 165
ansond 0:1f1f55e73248 166 // add dynamic resource
ansond 0:1f1f55e73248 167 OptionsBuilder &OptionsBuilder::addResource(const DynamicResource *resource)
ansond 0:1f1f55e73248 168 {
ansond 0:1f1f55e73248 169 // ensure that the boolean isn't mistaken by the compiler for the obs period...
ansond 54:dfee8691c83a 170 return this->addResource(resource,DEFAULT_OBS_PERIOD,!(((DynamicResource *)resource)->implementsObservation()));
ansond 0:1f1f55e73248 171 }
ansond 0:1f1f55e73248 172
ansond 0:1f1f55e73248 173 // add dynamic resource
ansond 0:1f1f55e73248 174 OptionsBuilder &OptionsBuilder::addResource(const DynamicResource *resource,const int sleep_time)
ansond 0:1f1f55e73248 175 {
ansond 0:1f1f55e73248 176 // ensure that the boolean isn't mistaken by the compiler for the obs period...
ansond 0:1f1f55e73248 177 return this->addResource(resource,sleep_time,!(((DynamicResource *)resource)->implementsObservation()));
ansond 0:1f1f55e73248 178 }
ansond 0:1f1f55e73248 179
ansond 0:1f1f55e73248 180 // add dynamic resource
ansond 0:1f1f55e73248 181 OptionsBuilder &OptionsBuilder::addResource(const DynamicResource *resource,const bool use_observer)
ansond 0:1f1f55e73248 182 {
ansond 0:1f1f55e73248 183 // ensure that the boolean isn't mistaken by the compiler for the obs period...
ansond 54:dfee8691c83a 184 return this->addResource(resource,DEFAULT_OBS_PERIOD,use_observer);
ansond 0:1f1f55e73248 185 }
ansond 0:1f1f55e73248 186
ansond 0:1f1f55e73248 187 // add dynamic resource
ansond 0:1f1f55e73248 188 OptionsBuilder &OptionsBuilder::addResource(const DynamicResource *resource,const int sleep_time,const bool use_observer)
ansond 0:1f1f55e73248 189 {
ansond 0:1f1f55e73248 190 if (resource != NULL) {
ansond 0:1f1f55e73248 191 this->m_dynamic_resources.push_back((DynamicResource *)resource);
ansond 0:1f1f55e73248 192 ((DynamicResource *)resource)->setOptions(this);
ansond 17:defb680f8fce 193 ((DynamicResource *)resource)->setEndpoint((const void *)this->getEndpoint());
ansond 0:1f1f55e73248 194 if (((DynamicResource *)resource)->isObservable() == true && use_observer == true) {
ansond 34:a10d65907549 195 // Establish the appropriate ResourceObserver
ansond 27:b8aaf7dc7023 196 #if defined (MCI_MINAR_SCHEDULER)
ansond 34:a10d65907549 197 // Minar-based Scheduler ResourceObserver
ansond 27:b8aaf7dc7023 198 MinarResourceObserver *observer = new MinarResourceObserver((DynamicResource *)resource,(int)sleep_time);
ansond 27:b8aaf7dc7023 199 #else
ansond 27:b8aaf7dc7023 200 #ifdef CONNECTOR_USING_THREADS
ansond 34:a10d65907549 201 // mbedOS RTOS Thread ResourceObserver
ansond 0:1f1f55e73248 202 ThreadedResourceObserver *observer = new ThreadedResourceObserver((DynamicResource *)resource,(int)sleep_time);
ansond 34:a10d65907549 203 #endif
ansond 34:a10d65907549 204 #ifdef CONNECTOR_USING_TICKER
ansond 34:a10d65907549 205 // mbed Ticker ResourceObserver
ansond 0:1f1f55e73248 206 TickerResourceObserver *observer = new TickerResourceObserver((DynamicResource *)resource,(int)sleep_time);
ansond 27:b8aaf7dc7023 207 #endif
ansond 0:1f1f55e73248 208 #endif
ansond 34:a10d65907549 209 // If no observer type is set in mbed-connector-interface/configuration.h (EndpointNetwork lib), then "observer" will be unresolved
ansond 0:1f1f55e73248 210 this->m_resource_observers.push_back(observer);
ansond 0:1f1f55e73248 211
ansond 0:1f1f55e73248 212 // immedate observation enablement option
ansond 0:1f1f55e73248 213 if (this->immedateObservationEnabled()) {
ansond 0:1f1f55e73248 214 observer->beginObservation();
ansond 0:1f1f55e73248 215 }
ansond 0:1f1f55e73248 216 }
ansond 0:1f1f55e73248 217 }
ansond 0:1f1f55e73248 218 return *this;
ansond 0:1f1f55e73248 219 }
ansond 0:1f1f55e73248 220
ansond 0:1f1f55e73248 221 // set WiFi SSID
ansond 0:1f1f55e73248 222 OptionsBuilder &OptionsBuilder::setWiFiSSID(char *ssid)
ansond 0:1f1f55e73248 223 {
ansond 0:1f1f55e73248 224 this->m_wifi_ssid = string(ssid);
ansond 0:1f1f55e73248 225 return *this;
ansond 0:1f1f55e73248 226 }
ansond 0:1f1f55e73248 227
ansond 0:1f1f55e73248 228 // set WiFi AuthType
ansond 0:1f1f55e73248 229 OptionsBuilder &OptionsBuilder::setWiFiAuthType(WiFiAuthTypes auth_type)
ansond 0:1f1f55e73248 230 {
ansond 0:1f1f55e73248 231 this->m_wifi_auth_type = auth_type;
ansond 0:1f1f55e73248 232 return *this;
ansond 0:1f1f55e73248 233 }
ansond 0:1f1f55e73248 234
ansond 0:1f1f55e73248 235 // set WiFi AuthKey
ansond 0:1f1f55e73248 236 OptionsBuilder &OptionsBuilder::setWiFiAuthKey(char *auth_key)
ansond 0:1f1f55e73248 237 {
ansond 0:1f1f55e73248 238 this->m_wifi_auth_key = string(auth_key);
ansond 0:1f1f55e73248 239 return *this;
ansond 0:1f1f55e73248 240 }
ansond 0:1f1f55e73248 241
ansond 10:3f79b5e67c22 242 // set the CoAP Connection Type
ansond 10:3f79b5e67c22 243 OptionsBuilder &OptionsBuilder::setCoAPConnectionType(CoAPConnectionTypes coap_connection_type)
ansond 10:3f79b5e67c22 244 {
ansond 10:3f79b5e67c22 245 this->m_coap_connection_type = coap_connection_type;
ansond 10:3f79b5e67c22 246 return *this;
ansond 10:3f79b5e67c22 247 }
ansond 10:3f79b5e67c22 248
ansond 10:3f79b5e67c22 249 // set the IP Address Type
ansond 10:3f79b5e67c22 250 OptionsBuilder &OptionsBuilder::setIPAddressType(IPAddressTypes ip_address_type)
ansond 10:3f79b5e67c22 251 {
ansond 10:3f79b5e67c22 252 this->m_ip_address_type = ip_address_type;
ansond 10:3f79b5e67c22 253 return *this;
ansond 10:3f79b5e67c22 254 }
ansond 10:3f79b5e67c22 255
ansond 0:1f1f55e73248 256 // build out our immutable self
ansond 0:1f1f55e73248 257 Options *OptionsBuilder::build()
ansond 0:1f1f55e73248 258 {
ansond 0:1f1f55e73248 259 return (Options *)this;
ansond 0:1f1f55e73248 260 }
ansond 0:1f1f55e73248 261
ansond 0:1f1f55e73248 262 // Enable/Disable immediate observationing
ansond 0:1f1f55e73248 263 OptionsBuilder &OptionsBuilder::setImmedateObservationEnabled(bool enable) {
ansond 0:1f1f55e73248 264 this->m_enable_immediate_observation = enable;
ansond 0:1f1f55e73248 265 return *this;
ansond 0:1f1f55e73248 266 }
ansond 0:1f1f55e73248 267
ansond 0:1f1f55e73248 268 // Enable/Disable GET-based control of observations
ansond 0:1f1f55e73248 269 OptionsBuilder &OptionsBuilder::setEnableGETObservationControl(bool enable) {
ansond 0:1f1f55e73248 270 this->m_enable_get_obs_control = enable;
ansond 0:1f1f55e73248 271 return *this;
ansond 0:1f1f55e73248 272 }
ansond 0:1f1f55e73248 273
ansond 0:1f1f55e73248 274 // set the server certificate
ansond 49:c603a22495bb 275 OptionsBuilder &OptionsBuilder::setServerCertificate(uint8_t *cert,int cert_size) {
ansond 49:c603a22495bb 276 this->m_server_cert = cert;
ansond 49:c603a22495bb 277 this->m_server_cert_length = cert_size;
ansond 0:1f1f55e73248 278 return *this;
ansond 0:1f1f55e73248 279 }
ansond 0:1f1f55e73248 280
ansond 0:1f1f55e73248 281 // set the client certificate
ansond 49:c603a22495bb 282 OptionsBuilder &OptionsBuilder::setClientCertificate(uint8_t *cert,int cert_size) {
ansond 49:c603a22495bb 283 this->m_client_cert = cert;
ansond 49:c603a22495bb 284 this->m_client_cert_length = cert_size;
ansond 0:1f1f55e73248 285 return *this;
ansond 0:1f1f55e73248 286 }
ansond 0:1f1f55e73248 287
ansond 0:1f1f55e73248 288 // set the client key
ansond 49:c603a22495bb 289 OptionsBuilder &OptionsBuilder::setClientKey(uint8_t *key,int key_size) {
ansond 49:c603a22495bb 290 this->m_client_key = key;
ansond 49:c603a22495bb 291 this->m_client_key_length = key_size;
ansond 0:1f1f55e73248 292 return *this;
ansond 0:1f1f55e73248 293 }
ansond 0:1f1f55e73248 294
ansond 22:68fcdc40b397 295 // set our endpoint
ansond 22:68fcdc40b397 296 void OptionsBuilder::setEndpoint(void *endpoint) {
ansond 22:68fcdc40b397 297 this->m_endpoint = endpoint;
ansond 22:68fcdc40b397 298 }
ansond 22:68fcdc40b397 299
ansond 0:1f1f55e73248 300 } // namespace Connector