Doug Anson / mbedConnectorInterfaceWithDM

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbedConnectorInterfaceV3 by Doug Anson

mbed-connector-interface/ConnectorEndpoint.h@13:9edad7677211, 2016-06-08 (annotated)

Committer:
ansond
Date:
Wed Jun 08 22:32:08 2016 +0000
Revision:
13:9edad7677211
Parent:
8:f950fb1b78c0
Child:
15:c11dbe4d354c
updated to latest revision with new DM functions

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/m2mdevice.h"
ansond 1:16f0fb5b8d97 29 #include "mbed-client/m2minterfaceobserver.h"
ansond 1:16f0fb5b8d97 30 #include "mbed-client/m2minterface.h"
ansond 1:16f0fb5b8d97 31 #include "mbed-client/m2mobjectinstance.h"
ansond 1:16f0fb5b8d97 32 #include "mbed-client/m2mresource.h"
ansond 1:16f0fb5b8d97 33
ansond 1:16f0fb5b8d97 34 // Support for Logging/Debug output
ansond 1:16f0fb5b8d97 35 #include "mbed-connector-interface/Logger.h"
ansond 1:16f0fb5b8d97 36
ansond 1:16f0fb5b8d97 37 // Options support
ansond 1:16f0fb5b8d97 38 #include "mbed-connector-interface/Options.h"
ansond 1:16f0fb5b8d97 39
ansond 1:16f0fb5b8d97 40 // Connector namespace
ansond 1:16f0fb5b8d97 41 namespace Connector {
ansond 1:16f0fb5b8d97 42
ansond 1:16f0fb5b8d97 43 /** Endpoint class
ansond 1:16f0fb5b8d97 44 */
ansond 1:16f0fb5b8d97 45 class Endpoint : public M2MInterfaceObserver {
ansond 1:16f0fb5b8d97 46
ansond 1:16f0fb5b8d97 47 public:
ansond 1:16f0fb5b8d97 48 /**
ansond 1:16f0fb5b8d97 49 Default Constructor
ansond 1:16f0fb5b8d97 50 */
ansond 1:16f0fb5b8d97 51 Endpoint(const Logger *logger,const Options *ob);
ansond 1:16f0fb5b8d97 52
ansond 1:16f0fb5b8d97 53 /**
ansond 1:16f0fb5b8d97 54 Copy Constructor
ansond 1:16f0fb5b8d97 55 @param ob input endpoint instance to deep copy
ansond 1:16f0fb5b8d97 56 */
ansond 1:16f0fb5b8d97 57 Endpoint(const Endpoint &ep);
ansond 1:16f0fb5b8d97 58
ansond 1:16f0fb5b8d97 59 /**
ansond 1:16f0fb5b8d97 60 Destructor
ansond 1:16f0fb5b8d97 61 */
ansond 1:16f0fb5b8d97 62 virtual ~Endpoint();
ansond 1:16f0fb5b8d97 63
ansond 1:16f0fb5b8d97 64 /**
ansond 8:f950fb1b78c0 65 Build out the endpoint.
ansond 1:16f0fb5b8d97 66 */
ansond 8:f950fb1b78c0 67 void build_endpoint();
ansond 1:16f0fb5b8d97 68
ansond 1:16f0fb5b8d97 69 /**
ansond 1:16f0fb5b8d97 70 Plumb the lower RF network stack
ansond 13:9edad7677211 71 @param device_manager input optional device manager (DeviceManager type)
ansond 1:16f0fb5b8d97 72 @param canActAsRouterNode input boolean indicating whether this node can act as a router node or not.
ansond 1:16f0fb5b8d97 73 */
ansond 13:9edad7677211 74 static void plumbNetwork(void *device_manager = NULL,bool canActAsRouterNode = false);
ansond 0:1f1f55e73248 75
ansond 1:16f0fb5b8d97 76 /**
ansond 1:16f0fb5b8d97 77 Initialize the endpoint's configuration and begin the endpoint's main even loop
ansond 1:16f0fb5b8d97 78 */
ansond 1:16f0fb5b8d97 79 static void start();
ansond 1:16f0fb5b8d97 80
ansond 8:f950fb1b78c0 81 // register the endpoint
ansond 8:f950fb1b78c0 82 void register_endpoint(M2MSecurity *server_instance, M2MObjectList resources);
ansond 8:f950fb1b78c0 83
ansond 8:f950fb1b78c0 84 // re-register endpoint
ansond 8:f950fb1b78c0 85 void re_register_endpoint();
ansond 8:f950fb1b78c0 86
ansond 8:f950fb1b78c0 87 // de-register endpoint and stop scheduling
ansond 8:f950fb1b78c0 88 void de_register_endpoint(void);
ansond 8:f950fb1b78c0 89
ansond 8:f950fb1b78c0 90 // mbed-client : object registered
ansond 8:f950fb1b78c0 91 virtual void object_registered(M2MSecurity *server_instance, const M2MServer &server);
ansond 1:16f0fb5b8d97 92
ansond 8:f950fb1b78c0 93 // mbed-client : registration updated
ansond 8:f950fb1b78c0 94 virtual void registration_updated(M2MSecurity *server_instance, const M2MServer &server) ;
ansond 1:16f0fb5b8d97 95
ansond 1:16f0fb5b8d97 96 // mbed-client : object unregistered
ansond 8:f950fb1b78c0 97 virtual void object_unregistered(M2MSecurity *server_instance);
ansond 1:16f0fb5b8d97 98
ansond 8:f950fb1b78c0 99 // mbed-client : bootstrap done
ansond 8:f950fb1b78c0 100 virtual void bootstrap_done(M2MSecurity *server_instance);
ansond 1:16f0fb5b8d97 101
ansond 1:16f0fb5b8d97 102 // mbed-client : resource value updated
ansond 8:f950fb1b78c0 103 virtual void value_updated(M2MBase *resource, M2MBase::BaseType type) ;
ansond 1:16f0fb5b8d97 104
ansond 1:16f0fb5b8d97 105 // mbed-client : error handler
ansond 1:16f0fb5b8d97 106 virtual void error(M2MInterface::Error error);
ansond 1:16f0fb5b8d97 107
ansond 1:16f0fb5b8d97 108 // get our Options
ansond 1:16f0fb5b8d97 109 void setOptions(Options *options);
ansond 1:16f0fb5b8d97 110
ansond 1:16f0fb5b8d97 111 // get our Options
ansond 1:16f0fb5b8d97 112 Options *getOptions();
ansond 8:f950fb1b78c0 113
ansond 1:16f0fb5b8d97 114 // get our Server
ansond 1:16f0fb5b8d97 115 M2MSecurity *getServer();
ansond 1:16f0fb5b8d97 116
ansond 1:16f0fb5b8d97 117 // get our Object List
ansond 1:16f0fb5b8d97 118 M2MObjectList getObjectList();
ansond 1:16f0fb5b8d97 119
ansond 1:16f0fb5b8d97 120 // configure to act as router node
ansond 1:16f0fb5b8d97 121 void asRouterNode(bool canActAsRouterNode);
ansond 13:9edad7677211 122
ansond 13:9edad7677211 123 // access the logger
ansond 13:9edad7677211 124 Logger *logger();
ansond 13:9edad7677211 125
ansond 13:9edad7677211 126 // set the device manager
ansond 13:9edad7677211 127 void setDeviceManager(void *device_manager);
ansond 13:9edad7677211 128
ansond 13:9edad7677211 129 // get the device manager
ansond 13:9edad7677211 130 void *getDeviceManager(void);
ansond 13:9edad7677211 131
ansond 13:9edad7677211 132 // underlying network is connected (SET)
ansond 13:9edad7677211 133 void isConnected(bool connected);
ansond 13:9edad7677211 134
ansond 13:9edad7677211 135 // underlying network is connected (GET)
ansond 13:9edad7677211 136 bool isConnected();
ansond 1:16f0fb5b8d97 137
ansond 1:16f0fb5b8d97 138 private:
ansond 1:16f0fb5b8d97 139 Logger *m_logger;
ansond 1:16f0fb5b8d97 140 Options *m_options;
ansond 1:16f0fb5b8d97 141 bool m_canActAsRouterNode;
ansond 13:9edad7677211 142 bool m_connected;
ansond 1:16f0fb5b8d97 143
ansond 1:16f0fb5b8d97 144 // mbed-client support
ansond 1:16f0fb5b8d97 145 M2MInterface *m_interface;
ansond 1:16f0fb5b8d97 146 M2MSecurity *m_server_instance;
ansond 1:16f0fb5b8d97 147 M2MObjectList m_object_list;
ansond 1:16f0fb5b8d97 148 M2MDevice *m_device_object;
ansond 1:16f0fb5b8d97 149
ansond 1:16f0fb5b8d97 150 // mbed-client methods
ansond 1:16f0fb5b8d97 151 void create_interface();
ansond 1:16f0fb5b8d97 152 M2MSecurity *create_server_instance();
ansond 13:9edad7677211 153
ansond 13:9edad7677211 154 // Device Manager
ansond 13:9edad7677211 155 void *m_device_manager;
ansond 1:16f0fb5b8d97 156
ansond 1:16f0fb5b8d97 157 // DynamicResource Lookup
ansond 1:16f0fb5b8d97 158 DynamicResource *lookupDynamicResource(M2MBase *base);
ansond 1:16f0fb5b8d97 159 };
ansond 1:16f0fb5b8d97 160
ansond 1:16f0fb5b8d97 161 } // namespace Connector
ansond 1:16f0fb5b8d97 162
ansond 1:16f0fb5b8d97 163 #endif // __CONNECTOR_ENDPOINT_H__