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@10:3f79b5e67c22, 2016-03-04 (annotated)

Committer:
ansond
Date:
Fri Mar 04 19:16:57 2016 +0000
Revision:
10:3f79b5e67c22
Parent:
9:faa43faea4ca
Child:
17:defb680f8fce
updated to allow for specification of UDP or TCP under CoAP and IPv4 or IPv6 addressing types

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 0:1f1f55e73248 23 #include "mbed-connector-interface/OptionsBuilder.h"
ansond 0:1f1f55e73248 24
ansond 0:1f1f55e73248 25 // external included configuration file for the endpoint...
ansond 0:1f1f55e73248 26 #include "mbed-connector-interface/configuration.h"
ansond 0:1f1f55e73248 27
ansond 0:1f1f55e73248 28 // ResourceObserver support
ansond 0:1f1f55e73248 29 #include "mbed-connector-interface/ThreadedResourceObserver.h"
ansond 0:1f1f55e73248 30 #include "mbed-connector-interface/TickerResourceObserver.h"
ansond 0:1f1f55e73248 31
ansond 0:1f1f55e73248 32 // DEBUG
ansond 0:1f1f55e73248 33 #ifndef NDEBUG
ansond 0:1f1f55e73248 34 #define DEBUG_OUT(...) { printf(__VA_ARGS__); }
ansond 0:1f1f55e73248 35 #else
ansond 0:1f1f55e73248 36 #define DEBUG_OUT(...) /* nothing */
ansond 0:1f1f55e73248 37 #endif
ansond 0:1f1f55e73248 38
ansond 0:1f1f55e73248 39 // Connector namespace
ansond 0:1f1f55e73248 40 namespace Connector {
ansond 0:1f1f55e73248 41
ansond 0:1f1f55e73248 42 // Constructor
ansond 0:1f1f55e73248 43 OptionsBuilder::OptionsBuilder()
ansond 0:1f1f55e73248 44 {
ansond 0:1f1f55e73248 45 this->m_domain = NSP_DOMAIN;
ansond 0:1f1f55e73248 46 this->m_endpoint_type = NSP_ENDPOINT_TYPE;
ansond 0:1f1f55e73248 47 this->m_node_name = NODE_NAME;
ansond 0:1f1f55e73248 48 this->m_reg_update_period = REG_UPDATE_PERIOD_MS;
ansond 0:1f1f55e73248 49 this->m_lifetime = REG_LIFETIME_SEC;
ansond 0:1f1f55e73248 50 this->m_connector_url = string(CONNECTOR_URL);
ansond 0:1f1f55e73248 51 this->m_device_resources.clear();
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 8:f950fb1b78c0 60 this->m_domain = ob.m_domain;
ansond 0:1f1f55e73248 61 this->m_endpoint_type = ob.m_endpoint_type;
ansond 8:f950fb1b78c0 62 this->m_node_name = ob.m_node_name;
ansond 8:f950fb1b78c0 63 this->m_reg_update_period = ob.m_reg_update_period;
ansond 8:f950fb1b78c0 64 this->m_lifetime = ob.m_lifetime;
ansond 8:f950fb1b78c0 65 this->m_connector_url = ob.m_connector_url;
ansond 0:1f1f55e73248 66 this->m_device_resources = ob.m_device_resources;
ansond 0:1f1f55e73248 67 this->m_static_resources = ob.m_static_resources;
ansond 0:1f1f55e73248 68 this->m_dynamic_resources = ob.m_dynamic_resources;
ansond 0:1f1f55e73248 69 this->m_resource_observers = ob.m_resource_observers;
ansond 0:1f1f55e73248 70 }
ansond 0:1f1f55e73248 71
ansond 0:1f1f55e73248 72 // Destructor
ansond 0:1f1f55e73248 73 OptionsBuilder::~OptionsBuilder()
ansond 0:1f1f55e73248 74 {
ansond 0:1f1f55e73248 75 this->m_device_resources.clear();
ansond 0:1f1f55e73248 76 this->m_static_resources.clear();
ansond 0:1f1f55e73248 77 this->m_dynamic_resources.clear();
ansond 0:1f1f55e73248 78 this->m_resource_observers.clear();
ansond 0:1f1f55e73248 79 }
ansond 0:1f1f55e73248 80
ansond 0:1f1f55e73248 81 // set lifetime
ansond 0:1f1f55e73248 82 OptionsBuilder &OptionsBuilder::setLifetime(int lifetime)
ansond 0:1f1f55e73248 83 {
ansond 0:1f1f55e73248 84 this->m_lifetime = lifetime;
ansond 0:1f1f55e73248 85 return *this;
ansond 0:1f1f55e73248 86 }
ansond 0:1f1f55e73248 87
ansond 0:1f1f55e73248 88 // set domain
ansond 0:1f1f55e73248 89 OptionsBuilder &OptionsBuilder::setDomain(const char *domain)
ansond 0:1f1f55e73248 90 {
ansond 0:1f1f55e73248 91 this->m_domain = string(domain);
ansond 0:1f1f55e73248 92 return *this;
ansond 0:1f1f55e73248 93 }
ansond 0:1f1f55e73248 94
ansond 0:1f1f55e73248 95 // set endpoint nodename
ansond 0:1f1f55e73248 96 OptionsBuilder &OptionsBuilder::setEndpointNodename(const char *node_name)
ansond 0:1f1f55e73248 97 {
ansond 0:1f1f55e73248 98 this->m_node_name = string(node_name);
ansond 0:1f1f55e73248 99 return *this;
ansond 0:1f1f55e73248 100 }
ansond 0:1f1f55e73248 101
ansond 0:1f1f55e73248 102 // set lifetime
ansond 0:1f1f55e73248 103 OptionsBuilder &OptionsBuilder::setEndpointType(const char *endpoint_type)
ansond 0:1f1f55e73248 104 {
ansond 0:1f1f55e73248 105 this->m_endpoint_type = string(endpoint_type);
ansond 0:1f1f55e73248 106 return *this;
ansond 0:1f1f55e73248 107 }
ansond 0:1f1f55e73248 108
ansond 0:1f1f55e73248 109 // set mbed registration update period
ansond 0:1f1f55e73248 110 OptionsBuilder &OptionsBuilder::setRegUpdatePeriod(const int reg_update_period)
ansond 0:1f1f55e73248 111 {
ansond 0:1f1f55e73248 112 this->m_reg_update_period = reg_update_period;
ansond 0:1f1f55e73248 113 return *this;
ansond 0:1f1f55e73248 114 }
ansond 0:1f1f55e73248 115
ansond 0:1f1f55e73248 116 // set Connector URL
ansond 0:1f1f55e73248 117 OptionsBuilder &OptionsBuilder::setConnectorURL(const char *connector_url)
ansond 0:1f1f55e73248 118 {
ansond 0:1f1f55e73248 119 if (connector_url != NULL) {
ansond 0:1f1f55e73248 120 this->m_connector_url = string(connector_url);
ansond 0:1f1f55e73248 121 }
ansond 0:1f1f55e73248 122 return *this;
ansond 0:1f1f55e73248 123 }
ansond 0:1f1f55e73248 124
ansond 0:1f1f55e73248 125 // add a device resource
ansond 0:1f1f55e73248 126 OptionsBuilder &OptionsBuilder::addResource(const DeviceResource *resource) {
ansond 0:1f1f55e73248 127 if (resource != NULL) {
ansond 0:1f1f55e73248 128 ((DeviceResource *)resource)->setOptions(this);
ansond 0:1f1f55e73248 129 this->m_device_resources.push_back((DeviceResource *)resource);
ansond 0:1f1f55e73248 130 }
ansond 0:1f1f55e73248 131 return *this;
ansond 0:1f1f55e73248 132 }
ansond 0:1f1f55e73248 133
ansond 0:1f1f55e73248 134 // add static resource
ansond 0:1f1f55e73248 135 OptionsBuilder &OptionsBuilder::addResource(const StaticResource *resource)
ansond 0:1f1f55e73248 136 {
ansond 0:1f1f55e73248 137 if (resource != NULL) {
ansond 0:1f1f55e73248 138 ((StaticResource *)resource)->setOptions(this);
ansond 0:1f1f55e73248 139 this->m_static_resources.push_back((StaticResource *)resource);
ansond 0:1f1f55e73248 140 }
ansond 0:1f1f55e73248 141 return *this;
ansond 0:1f1f55e73248 142 }
ansond 0:1f1f55e73248 143
ansond 0:1f1f55e73248 144 // add dynamic resource
ansond 0:1f1f55e73248 145 OptionsBuilder &OptionsBuilder::addResource(const DynamicResource *resource)
ansond 0:1f1f55e73248 146 {
ansond 0:1f1f55e73248 147 // ensure that the boolean isn't mistaken by the compiler for the obs period...
ansond 0:1f1f55e73248 148 return this->addResource(resource,OBS_PERIOD_MS,!(((DynamicResource *)resource)->implementsObservation()));
ansond 0:1f1f55e73248 149 }
ansond 0:1f1f55e73248 150
ansond 0:1f1f55e73248 151 // add dynamic resource
ansond 0:1f1f55e73248 152 OptionsBuilder &OptionsBuilder::addResource(const DynamicResource *resource,const int sleep_time)
ansond 0:1f1f55e73248 153 {
ansond 0:1f1f55e73248 154 // ensure that the boolean isn't mistaken by the compiler for the obs period...
ansond 0:1f1f55e73248 155 return this->addResource(resource,sleep_time,!(((DynamicResource *)resource)->implementsObservation()));
ansond 0:1f1f55e73248 156 }
ansond 0:1f1f55e73248 157
ansond 0:1f1f55e73248 158 // add dynamic resource
ansond 0:1f1f55e73248 159 OptionsBuilder &OptionsBuilder::addResource(const DynamicResource *resource,const bool use_observer)
ansond 0:1f1f55e73248 160 {
ansond 0:1f1f55e73248 161 // ensure that the boolean isn't mistaken by the compiler for the obs period...
ansond 0:1f1f55e73248 162 return this->addResource(resource,OBS_PERIOD_MS,use_observer);
ansond 0:1f1f55e73248 163 }
ansond 0:1f1f55e73248 164
ansond 0:1f1f55e73248 165 // add dynamic resource
ansond 0:1f1f55e73248 166 OptionsBuilder &OptionsBuilder::addResource(const DynamicResource *resource,const int sleep_time,const bool use_observer)
ansond 0:1f1f55e73248 167 {
ansond 0:1f1f55e73248 168 if (resource != NULL) {
ansond 0:1f1f55e73248 169 this->m_dynamic_resources.push_back((DynamicResource *)resource);
ansond 0:1f1f55e73248 170 ((DynamicResource *)resource)->setOptions(this);
ansond 0:1f1f55e73248 171 if (((DynamicResource *)resource)->isObservable() == true && use_observer == true) {
ansond 0:1f1f55e73248 172 #ifdef CONNECTOR_USING_THREADS
ansond 0:1f1f55e73248 173 ThreadedResourceObserver *observer = new ThreadedResourceObserver((DynamicResource *)resource,(int)sleep_time);
ansond 0:1f1f55e73248 174 #else
ansond 0:1f1f55e73248 175 TickerResourceObserver *observer = new TickerResourceObserver((DynamicResource *)resource,(int)sleep_time);
ansond 0:1f1f55e73248 176 #endif
ansond 0:1f1f55e73248 177 this->m_resource_observers.push_back(observer);
ansond 0:1f1f55e73248 178
ansond 0:1f1f55e73248 179 // immedate observation enablement option
ansond 0:1f1f55e73248 180 if (this->immedateObservationEnabled()) {
ansond 0:1f1f55e73248 181 observer->beginObservation();
ansond 0:1f1f55e73248 182 }
ansond 0:1f1f55e73248 183 }
ansond 0:1f1f55e73248 184 }
ansond 0:1f1f55e73248 185 return *this;
ansond 0:1f1f55e73248 186 }
ansond 0:1f1f55e73248 187
ansond 0:1f1f55e73248 188 // set WiFi SSID
ansond 0:1f1f55e73248 189 OptionsBuilder &OptionsBuilder::setWiFiSSID(char *ssid)
ansond 0:1f1f55e73248 190 {
ansond 0:1f1f55e73248 191 this->m_wifi_ssid = string(ssid);
ansond 0:1f1f55e73248 192 return *this;
ansond 0:1f1f55e73248 193 }
ansond 0:1f1f55e73248 194
ansond 0:1f1f55e73248 195 // set WiFi AuthType
ansond 0:1f1f55e73248 196 OptionsBuilder &OptionsBuilder::setWiFiAuthType(WiFiAuthTypes auth_type)
ansond 0:1f1f55e73248 197 {
ansond 0:1f1f55e73248 198 this->m_wifi_auth_type = auth_type;
ansond 0:1f1f55e73248 199 return *this;
ansond 0:1f1f55e73248 200 }
ansond 0:1f1f55e73248 201
ansond 0:1f1f55e73248 202 // set WiFi AuthKey
ansond 0:1f1f55e73248 203 OptionsBuilder &OptionsBuilder::setWiFiAuthKey(char *auth_key)
ansond 0:1f1f55e73248 204 {
ansond 0:1f1f55e73248 205 this->m_wifi_auth_key = string(auth_key);
ansond 0:1f1f55e73248 206 return *this;
ansond 0:1f1f55e73248 207 }
ansond 0:1f1f55e73248 208
ansond 8:f950fb1b78c0 209 // set 802.15.4 Pre Shared Key
ansond 8:f950fb1b78c0 210 OptionsBuilder &OptionsBuilder::setPreSharedKey(unsigned char psk[16])
ansond 0:1f1f55e73248 211 {
ansond 8:f950fb1b78c0 212 memset(this->m_psk,0,16);
ansond 8:f950fb1b78c0 213 for(int i=0;i<16;++i) {
ansond 8:f950fb1b78c0 214 this->m_psk[i] = psk[i];
ansond 8:f950fb1b78c0 215 }
ansond 0:1f1f55e73248 216 return *this;
ansond 0:1f1f55e73248 217 }
ansond 0:1f1f55e73248 218
ansond 8:f950fb1b78c0 219 // set 802.15.4 Pre Shared Key Identity
ansond 8:f950fb1b78c0 220 OptionsBuilder &OptionsBuilder::setPreSharedKeyIdentity(unsigned char psk_identity[2])
ansond 0:1f1f55e73248 221 {
ansond 8:f950fb1b78c0 222 memset(this->m_psk_identity,0,2);
ansond 8:f950fb1b78c0 223 for(int i=0;i<2;++i) {
ansond 8:f950fb1b78c0 224 this->m_psk_identity[i] = psk_identity[i];
ansond 8:f950fb1b78c0 225 }
ansond 0:1f1f55e73248 226 return *this;
ansond 0:1f1f55e73248 227 }
ansond 0:1f1f55e73248 228
ansond 9:faa43faea4ca 229 // set 802.15.4 Mesh Type
ansond 9:faa43faea4ca 230 OptionsBuilder &OptionsBuilder::setMeshType(MeshTypes mesh_type)
ansond 9:faa43faea4ca 231 {
ansond 9:faa43faea4ca 232 this->m_mesh_type = mesh_type;
ansond 9:faa43faea4ca 233 return *this;
ansond 9:faa43faea4ca 234 }
ansond 9:faa43faea4ca 235
ansond 10:3f79b5e67c22 236 // set the CoAP Connection Type
ansond 10:3f79b5e67c22 237 OptionsBuilder &OptionsBuilder::setCoAPConnectionType(CoAPConnectionTypes coap_connection_type)
ansond 10:3f79b5e67c22 238 {
ansond 10:3f79b5e67c22 239 this->m_coap_connection_type = coap_connection_type;
ansond 10:3f79b5e67c22 240 return *this;
ansond 10:3f79b5e67c22 241 }
ansond 10:3f79b5e67c22 242
ansond 10:3f79b5e67c22 243 // set the IP Address Type
ansond 10:3f79b5e67c22 244 OptionsBuilder &OptionsBuilder::setIPAddressType(IPAddressTypes ip_address_type)
ansond 10:3f79b5e67c22 245 {
ansond 10:3f79b5e67c22 246 this->m_ip_address_type = ip_address_type;
ansond 10:3f79b5e67c22 247 return *this;
ansond 10:3f79b5e67c22 248 }
ansond 10:3f79b5e67c22 249
ansond 0:1f1f55e73248 250 // build out our immutable self
ansond 0:1f1f55e73248 251 Options *OptionsBuilder::build()
ansond 0:1f1f55e73248 252 {
ansond 0:1f1f55e73248 253 return (Options *)this;
ansond 0:1f1f55e73248 254 }
ansond 0:1f1f55e73248 255
ansond 0:1f1f55e73248 256 // Enable/Disable immediate observationing
ansond 0:1f1f55e73248 257 OptionsBuilder &OptionsBuilder::setImmedateObservationEnabled(bool enable) {
ansond 0:1f1f55e73248 258 this->m_enable_immediate_observation = enable;
ansond 0:1f1f55e73248 259 return *this;
ansond 0:1f1f55e73248 260 }
ansond 0:1f1f55e73248 261
ansond 0:1f1f55e73248 262 // Enable/Disable GET-based control of observations
ansond 0:1f1f55e73248 263 OptionsBuilder &OptionsBuilder::setEnableGETObservationControl(bool enable) {
ansond 0:1f1f55e73248 264 this->m_enable_get_obs_control = enable;
ansond 0:1f1f55e73248 265 return *this;
ansond 0:1f1f55e73248 266 }
ansond 0:1f1f55e73248 267
ansond 0:1f1f55e73248 268 // set the server certificate
ansond 0:1f1f55e73248 269 OptionsBuilder &OptionsBuilder::setServerCertificate(uint8_t cert[],int cert_size) {
ansond 0:1f1f55e73248 270 memset(this->m_server_cert,0,MAX_SERVER_CERT_LENGTH);
ansond 0:1f1f55e73248 271 int length = cert_size;
ansond 0:1f1f55e73248 272 if (length > MAX_SERVER_CERT_LENGTH) {
ansond 0:1f1f55e73248 273 length = MAX_SERVER_CERT_LENGTH;
ansond 0:1f1f55e73248 274 DEBUG_OUT("WARNING: Truncated Server Certificate: orig: %d bytes (trunc: %d bytes)\r\n",cert_size,length);
ansond 0:1f1f55e73248 275 }
ansond 0:1f1f55e73248 276 memcpy(this->m_server_cert,cert,length);
ansond 0:1f1f55e73248 277 this->m_server_cert_length = length;
ansond 0:1f1f55e73248 278 return *this;
ansond 0:1f1f55e73248 279 }
ansond 0:1f1f55e73248 280
ansond 0:1f1f55e73248 281 // set the client certificate
ansond 0:1f1f55e73248 282 OptionsBuilder &OptionsBuilder::setClientCertificate(uint8_t cert[],int cert_size) {
ansond 0:1f1f55e73248 283 memset(this->m_client_cert,0,MAX_CLIENT_CERT_LENGTH);
ansond 0:1f1f55e73248 284 int length = cert_size;
ansond 0:1f1f55e73248 285 if (length > MAX_CLIENT_CERT_LENGTH) {
ansond 0:1f1f55e73248 286 length = MAX_CLIENT_CERT_LENGTH;
ansond 0:1f1f55e73248 287 DEBUG_OUT("WARNING: Truncated Client Certificate: orig: %d bytes (trunc: %d bytes)\r\n",cert_size,length);
ansond 0:1f1f55e73248 288 }
ansond 0:1f1f55e73248 289 memcpy(this->m_client_cert,cert,length);
ansond 0:1f1f55e73248 290 this->m_client_cert_length = length;
ansond 0:1f1f55e73248 291 return *this;
ansond 0:1f1f55e73248 292 }
ansond 0:1f1f55e73248 293
ansond 0:1f1f55e73248 294 // set the client key
ansond 0:1f1f55e73248 295 OptionsBuilder &OptionsBuilder::setClientKey(uint8_t key[],int key_size) {
ansond 0:1f1f55e73248 296 memset(this->m_client_key,0,MAX_CLIENT_KEY_LENGTH);
ansond 0:1f1f55e73248 297 int length = key_size;
ansond 0:1f1f55e73248 298 if (length > MAX_CLIENT_KEY_LENGTH) {
ansond 0:1f1f55e73248 299 length = MAX_CLIENT_KEY_LENGTH;
ansond 0:1f1f55e73248 300 DEBUG_OUT("WARNING: Truncated Client Key: orig: %d bytes (trunc: %d bytes)\r\n",key_size,length);
ansond 0:1f1f55e73248 301 }
ansond 0:1f1f55e73248 302 memcpy(this->m_client_key,key,length);
ansond 0:1f1f55e73248 303 this->m_client_key_length = length;
ansond 0:1f1f55e73248 304 return *this;
ansond 0:1f1f55e73248 305 }
ansond 0:1f1f55e73248 306
ansond 0:1f1f55e73248 307 } // namespace Connector