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@127:b4a661ff6fb9, 2017-09-26 (annotated)

Committer:
ansond
Date:
Tue Sep 26 16:01:31 2017 +0000
Revision:
127:b4a661ff6fb9
Parent:
125:4bf229bf14a3 
minor re-ordering of FCC init

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