Maggie Mei / mbedConnectorInterfaceWithDM

use TCP to connect to mbed connector

Fork of mbedConnectorInterfaceWithDM by Doug Anson

mbed-connector-interface/ConnectorEndpoint.h@33:1d0b855df5a5, 2016-06-14 (annotated)

Committer:
ansond
Date:
Tue Jun 14 19:29:30 2016 +0000
Revision:
33:1d0b855df5a5
Parent:
27:b8aaf7dc7023
Child:
43:3fb57c4fba34
updated and unified headers

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ansond 1:16f0fb5b8d97 1 /**
ansond 1:16f0fb5b8d97 2 * @file Endpoint.h
ansond 1:16f0fb5b8d97 3 * @brief mbed CoAP Endpoint base class
ansond 1:16f0fb5b8d97 4 * @author Doug Anson/Chris Paola
ansond 1:16f0fb5b8d97 5 * @version 1.0
ansond 1:16f0fb5b8d97 6 * @see
ansond 1:16f0fb5b8d97 7 *
ansond 1:16f0fb5b8d97 8 * Copyright (c) 2014
ansond 1:16f0fb5b8d97 9 *
ansond 1:16f0fb5b8d97 10 * Licensed under the Apache License, Version 2.0 (the "License");
ansond 1:16f0fb5b8d97 11 * you may not use this file except in compliance with the License.
ansond 1:16f0fb5b8d97 12 * You may obtain a copy of the License at
ansond 1:16f0fb5b8d97 13 *
ansond 1:16f0fb5b8d97 14 * http://www.apache.org/licenses/LICENSE-2.0
ansond 1:16f0fb5b8d97 15 *
ansond 1:16f0fb5b8d97 16 * Unless required by applicable law or agreed to in writing, software
ansond 1:16f0fb5b8d97 17 * distributed under the License is distributed on an "AS IS" BASIS,
ansond 1:16f0fb5b8d97 18 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ansond 1:16f0fb5b8d97 19 * See the License for the specific language governing permissions and
ansond 1:16f0fb5b8d97 20 * limitations under the License.
ansond 1:16f0fb5b8d97 21 */
ansond 1:16f0fb5b8d97 22
ansond 1:16f0fb5b8d97 23 #ifndef __CONNECTOR_ENDPOINT_H__
ansond 1:16f0fb5b8d97 24 #define __CONNECTOR_ENDPOINT_H__
ansond 1:16f0fb5b8d97 25
ansond 1:16f0fb5b8d97 26 // mbed-client support
ansond 1:16f0fb5b8d97 27 #include "mbed-client/m2minterfacefactory.h"
ansond 1:16f0fb5b8d97 28 #include "mbed-client/m2minterfaceobserver.h"
ansond 1:16f0fb5b8d97 29 #include "mbed-client/m2minterface.h"
ansond 1:16f0fb5b8d97 30 #include "mbed-client/m2mobjectinstance.h"
ansond 1:16f0fb5b8d97 31 #include "mbed-client/m2mresource.h"
ansond 33:1d0b855df5a5 32 #include "mbed-client/m2mdevice.h"
ansond 33:1d0b855df5a5 33 #include "mbed-client/m2mfirmware.h"
ansond 1:16f0fb5b8d97 34
ansond 1:16f0fb5b8d97 35 // Support for Logging/Debug output
ansond 1:16f0fb5b8d97 36 #include "mbed-connector-interface/Logger.h"
ansond 1:16f0fb5b8d97 37
ansond 1:16f0fb5b8d97 38 // Options support
ansond 1:16f0fb5b8d97 39 #include "mbed-connector-interface/Options.h"
ansond 1:16f0fb5b8d97 40
ansond 27:b8aaf7dc7023 41 // ConnectionStatusInterface support
ansond 27:b8aaf7dc7023 42 #include "mbed-connector-interface/ConnectionStatusInterface.h"
ansond 27:b8aaf7dc7023 43
ansond 27:b8aaf7dc7023 44 // ObjectInstanceManager support
ansond 27:b8aaf7dc7023 45 #include "mbed-connector-interface/ObjectInstanceManager.h"
ansond 27:b8aaf7dc7023 46
ansond 1:16f0fb5b8d97 47 // Connector namespace
ansond 1:16f0fb5b8d97 48 namespace Connector {
ansond 1:16f0fb5b8d97 49
ansond 1:16f0fb5b8d97 50 /** Endpoint class
ansond 1:16f0fb5b8d97 51 */
ansond 1:16f0fb5b8d97 52 class Endpoint : public M2MInterfaceObserver {
ansond 1:16f0fb5b8d97 53
ansond 1:16f0fb5b8d97 54 public:
ansond 1:16f0fb5b8d97 55 /**
ansond 1:16f0fb5b8d97 56 Default Constructor
ansond 1:16f0fb5b8d97 57 */
ansond 1:16f0fb5b8d97 58 Endpoint(const Logger *logger,const Options *ob);
ansond 1:16f0fb5b8d97 59
ansond 1:16f0fb5b8d97 60 /**
ansond 1:16f0fb5b8d97 61 Copy Constructor
ansond 1:16f0fb5b8d97 62 @param ob input endpoint instance to deep copy
ansond 1:16f0fb5b8d97 63 */
ansond 1:16f0fb5b8d97 64 Endpoint(const Endpoint &ep);
ansond 1:16f0fb5b8d97 65
ansond 1:16f0fb5b8d97 66 /**
ansond 1:16f0fb5b8d97 67 Destructor
ansond 1:16f0fb5b8d97 68 */
ansond 1:16f0fb5b8d97 69 virtual ~Endpoint();
ansond 1:16f0fb5b8d97 70
ansond 1:16f0fb5b8d97 71 /**
ansond 8:f950fb1b78c0 72 Build out the endpoint.
ansond 1:16f0fb5b8d97 73 */
ansond 8:f950fb1b78c0 74 void build_endpoint();
ansond 1:16f0fb5b8d97 75
ansond 1:16f0fb5b8d97 76 /**
ansond 1:16f0fb5b8d97 77 Plumb the lower RF network stack
ansond 13:9edad7677211 78 @param device_manager input optional device manager (DeviceManager type)
ansond 1:16f0fb5b8d97 79 @param canActAsRouterNode input boolean indicating whether this node can act as a router node or not.
ansond 1:16f0fb5b8d97 80 */
ansond 13:9edad7677211 81 static void plumbNetwork(void *device_manager = NULL,bool canActAsRouterNode = false);
ansond 0:1f1f55e73248 82
ansond 1:16f0fb5b8d97 83 /**
ansond 1:16f0fb5b8d97 84 Initialize the endpoint's configuration and begin the endpoint's main even loop
ansond 1:16f0fb5b8d97 85 */
ansond 1:16f0fb5b8d97 86 static void start();
ansond 1:16f0fb5b8d97 87
ansond 8:f950fb1b78c0 88 // register the endpoint
ansond 8:f950fb1b78c0 89 void register_endpoint(M2MSecurity *server_instance, M2MObjectList resources);
ansond 8:f950fb1b78c0 90
ansond 8:f950fb1b78c0 91 // re-register endpoint
ansond 8:f950fb1b78c0 92 void re_register_endpoint();
ansond 8:f950fb1b78c0 93
ansond 8:f950fb1b78c0 94 // de-register endpoint and stop scheduling
ansond 8:f950fb1b78c0 95 void de_register_endpoint(void);
ansond 8:f950fb1b78c0 96
ansond 8:f950fb1b78c0 97 // mbed-client : object registered
ansond 8:f950fb1b78c0 98 virtual void object_registered(M2MSecurity *server_instance, const M2MServer &server);
ansond 1:16f0fb5b8d97 99
ansond 8:f950fb1b78c0 100 // mbed-client : registration updated
ansond 8:f950fb1b78c0 101 virtual void registration_updated(M2MSecurity *server_instance, const M2MServer &server) ;
ansond 1:16f0fb5b8d97 102
ansond 1:16f0fb5b8d97 103 // mbed-client : object unregistered
ansond 8:f950fb1b78c0 104 virtual void object_unregistered(M2MSecurity *server_instance);
ansond 1:16f0fb5b8d97 105
ansond 8:f950fb1b78c0 106 // mbed-client : bootstrap done
ansond 8:f950fb1b78c0 107 virtual void bootstrap_done(M2MSecurity *server_instance);
ansond 1:16f0fb5b8d97 108
ansond 1:16f0fb5b8d97 109 // mbed-client : resource value updated
ansond 8:f950fb1b78c0 110 virtual void value_updated(M2MBase *resource, M2MBase::BaseType type) ;
ansond 1:16f0fb5b8d97 111
ansond 1:16f0fb5b8d97 112 // mbed-client : error handler
ansond 1:16f0fb5b8d97 113 virtual void error(M2MInterface::Error error);
ansond 1:16f0fb5b8d97 114
ansond 1:16f0fb5b8d97 115 // get our Options
ansond 1:16f0fb5b8d97 116 void setOptions(Options *options);
ansond 1:16f0fb5b8d97 117
ansond 1:16f0fb5b8d97 118 // get our Options
ansond 1:16f0fb5b8d97 119 Options *getOptions();
ansond 8:f950fb1b78c0 120
ansond 1:16f0fb5b8d97 121 // get our Server
ansond 1:16f0fb5b8d97 122 M2MSecurity *getServer();
ansond 1:16f0fb5b8d97 123
ansond 1:16f0fb5b8d97 124 // get our Object List
ansond 1:16f0fb5b8d97 125 M2MObjectList getObjectList();
ansond 1:16f0fb5b8d97 126
ansond 1:16f0fb5b8d97 127 // configure to act as router node
ansond 1:16f0fb5b8d97 128 void asRouterNode(bool canActAsRouterNode);
ansond 13:9edad7677211 129
ansond 13:9edad7677211 130 // access the logger
ansond 13:9edad7677211 131 Logger *logger();
ansond 13:9edad7677211 132
ansond 13:9edad7677211 133 // set the device manager
ansond 13:9edad7677211 134 void setDeviceManager(void *device_manager);
ansond 13:9edad7677211 135
ansond 13:9edad7677211 136 // get the device manager
ansond 13:9edad7677211 137 void *getDeviceManager(void);
ansond 13:9edad7677211 138
ansond 13:9edad7677211 139 // underlying network is connected (SET)
ansond 13:9edad7677211 140 void isConnected(bool connected);
ansond 13:9edad7677211 141
ansond 13:9edad7677211 142 // underlying network is connected (GET)
ansond 13:9edad7677211 143 bool isConnected();
ansond 15:c11dbe4d354c 144
ansond 15:c11dbe4d354c 145 // Registered with mDC/mDS
ansond 15:c11dbe4d354c 146 bool isRegistered();
ansond 27:b8aaf7dc7023 147
ansond 27:b8aaf7dc7023 148 /**
ansond 27:b8aaf7dc7023 149 Set the ConnectionStatusInterface instance
ansond 27:b8aaf7dc7023 150 @param csi input instance pointer to the ConnectionStatusInterface implementation to be used
ansond 27:b8aaf7dc7023 151 */
ansond 27:b8aaf7dc7023 152 static void setConnectionStatusInterfaceImpl(ConnectionStatusInterface *csi);
ansond 1:16f0fb5b8d97 153
ansond 27:b8aaf7dc7023 154 // Set ObjectInstanceManager
ansond 27:b8aaf7dc7023 155 void setObjectInstanceManager(ObjectInstanceManager *oim);
ansond 27:b8aaf7dc7023 156
ansond 27:b8aaf7dc7023 157 // Get ObjectInstanceManager
ansond 27:b8aaf7dc7023 158 ObjectInstanceManager *getObjectInstanceManager();
ansond 27:b8aaf7dc7023 159
ansond 1:16f0fb5b8d97 160 private:
ansond 1:16f0fb5b8d97 161 Logger *m_logger;
ansond 1:16f0fb5b8d97 162 Options *m_options;
ansond 1:16f0fb5b8d97 163 bool m_canActAsRouterNode;
ansond 13:9edad7677211 164 bool m_connected;
ansond 15:c11dbe4d354c 165 bool m_registered;
ansond 1:16f0fb5b8d97 166
ansond 1:16f0fb5b8d97 167 // mbed-client support
ansond 15:c11dbe4d354c 168 M2MInterface *m_interface;
ansond 15:c11dbe4d354c 169 M2MSecurity *m_server_instance;
ansond 15:c11dbe4d354c 170 M2MObjectList m_object_list;
ansond 15:c11dbe4d354c 171 M2MDevice *m_device_object;
ansond 1:16f0fb5b8d97 172
ansond 1:16f0fb5b8d97 173 // mbed-client methods
ansond 1:16f0fb5b8d97 174 void create_interface();
ansond 1:16f0fb5b8d97 175 M2MSecurity *create_server_instance();
ansond 13:9edad7677211 176
ansond 13:9edad7677211 177 // Device Manager
ansond 33:1d0b855df5a5 178 void *m_device_manager;
ansond 1:16f0fb5b8d97 179
ansond 1:16f0fb5b8d97 180 // DynamicResource Lookup
ansond 1:16f0fb5b8d97 181 DynamicResource *lookupDynamicResource(M2MBase *base);
ansond 27:b8aaf7dc7023 182
ansond 27:b8aaf7dc7023 183 // ConnectionStatusInterface implementation
ansond 27:b8aaf7dc7023 184 ConnectionStatusInterface *m_csi;
ansond 27:b8aaf7dc7023 185
ansond 27:b8aaf7dc7023 186 // ObjectInstanceManager
ansond 27:b8aaf7dc7023 187 ObjectInstanceManager *m_oim;
ansond 1:16f0fb5b8d97 188 };
ansond 1:16f0fb5b8d97 189
ansond 1:16f0fb5b8d97 190 } // namespace Connector
ansond 1:16f0fb5b8d97 191
ansond 1:16f0fb5b8d97 192 #endif // __CONNECTOR_ENDPOINT_H__