Maggie Mei / mbedConnectorInterfaceWithDM

use TCP to connect to mbed connector

Fork of mbedConnectorInterfaceWithDM by Doug Anson

mbed-connector-interface/ConnectorEndpoint.h@1:16f0fb5b8d97, 2016-02-21 (annotated)

Committer:
ansond
Date:
Sun Feb 21 05:06:13 2016 +0000
Revision:
1:16f0fb5b8d97
Parent:
0:1f1f55e73248
Child:
8:f950fb1b78c0
updated with cleaned up Utils

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 1:16f0fb5b8d97 65 Register the endpoint with mbed Device Server
ansond 1:16f0fb5b8d97 66 */
ansond 1:16f0fb5b8d97 67 void register_endpoint();
ansond 1:16f0fb5b8d97 68
ansond 1:16f0fb5b8d97 69 /**
ansond 1:16f0fb5b8d97 70 Plumb the lower RF network stack
ansond 1:16f0fb5b8d97 71 @param canActAsRouterNode input boolean indicating whether this node can act as a router node or not.
ansond 1:16f0fb5b8d97 72 */
ansond 1:16f0fb5b8d97 73 static void plumbNetwork(bool canActAsRouterNode = false);
ansond 0:1f1f55e73248 74
ansond 1:16f0fb5b8d97 75 /**
ansond 1:16f0fb5b8d97 76 Initialize the endpoint's configuration and begin the endpoint's main even loop
ansond 1:16f0fb5b8d97 77 */
ansond 1:16f0fb5b8d97 78 static void start();
ansond 1:16f0fb5b8d97 79
ansond 1:16f0fb5b8d97 80 // mbed-client : bootstrap done
ansond 1:16f0fb5b8d97 81 virtual void bootstrap_done(M2MSecurity *server_object);
ansond 1:16f0fb5b8d97 82
ansond 1:16f0fb5b8d97 83 // mbed-client : object registered
ansond 1:16f0fb5b8d97 84 virtual void object_registered(M2MSecurity *security_object, const M2MServer &server_object);
ansond 1:16f0fb5b8d97 85
ansond 1:16f0fb5b8d97 86 // mbed-client : object unregistered
ansond 1:16f0fb5b8d97 87 virtual void object_unregistered(M2MSecurity *server_object);
ansond 1:16f0fb5b8d97 88
ansond 1:16f0fb5b8d97 89 // mbed-client : registration updated
ansond 1:16f0fb5b8d97 90 virtual void registration_updated(M2MSecurity *security_object, const M2MServer & server_object) ;
ansond 1:16f0fb5b8d97 91
ansond 1:16f0fb5b8d97 92 // mbed-client : resource value updated
ansond 1:16f0fb5b8d97 93 virtual void value_updated(M2MBase *base, M2MBase::BaseType type) ;
ansond 1:16f0fb5b8d97 94
ansond 1:16f0fb5b8d97 95 // mbed-client : error handler
ansond 1:16f0fb5b8d97 96 virtual void error(M2MInterface::Error error);
ansond 1:16f0fb5b8d97 97
ansond 1:16f0fb5b8d97 98 // mbed-client : complete registration of the endpoint
ansond 1:16f0fb5b8d97 99 void complete_endpoint_registration(M2MSecurity *register_object, M2MObjectList object_list);
ansond 1:16f0fb5b8d97 100
ansond 1:16f0fb5b8d97 101 // mbed-client: re-register endpoint
ansond 1:16f0fb5b8d97 102 void re_register_endpoint();
ansond 1:16f0fb5b8d97 103
ansond 1:16f0fb5b8d97 104 // mbed-client: de-register endpoint and stop scheduling
ansond 1:16f0fb5b8d97 105 void closedown_endpoint(void);
ansond 1:16f0fb5b8d97 106
ansond 1:16f0fb5b8d97 107 // get our Options
ansond 1:16f0fb5b8d97 108 void setOptions(Options *options);
ansond 1:16f0fb5b8d97 109
ansond 1:16f0fb5b8d97 110 // get our Options
ansond 1:16f0fb5b8d97 111 Options *getOptions();
ansond 1:16f0fb5b8d97 112
ansond 1:16f0fb5b8d97 113 // get our Server
ansond 1:16f0fb5b8d97 114 M2MSecurity *getServer();
ansond 1:16f0fb5b8d97 115
ansond 1:16f0fb5b8d97 116 // get our Object List
ansond 1:16f0fb5b8d97 117 M2MObjectList getObjectList();
ansond 1:16f0fb5b8d97 118
ansond 1:16f0fb5b8d97 119 // configure to act as router node
ansond 1:16f0fb5b8d97 120 void asRouterNode(bool canActAsRouterNode);
ansond 1:16f0fb5b8d97 121
ansond 1:16f0fb5b8d97 122 private:
ansond 1:16f0fb5b8d97 123 Logger *m_logger;
ansond 1:16f0fb5b8d97 124 Options *m_options;
ansond 1:16f0fb5b8d97 125 bool m_canActAsRouterNode;
ansond 1:16f0fb5b8d97 126
ansond 1:16f0fb5b8d97 127 // mbed-client support
ansond 1:16f0fb5b8d97 128 M2MInterface *m_interface;
ansond 1:16f0fb5b8d97 129 M2MSecurity *m_server_instance;
ansond 1:16f0fb5b8d97 130 M2MObjectList m_object_list;
ansond 1:16f0fb5b8d97 131 M2MDevice *m_device_object;
ansond 1:16f0fb5b8d97 132
ansond 1:16f0fb5b8d97 133 // mbed-client methods
ansond 1:16f0fb5b8d97 134 void create_interface();
ansond 1:16f0fb5b8d97 135 M2MSecurity *create_server_instance();
ansond 1:16f0fb5b8d97 136
ansond 1:16f0fb5b8d97 137 // DynamicResource Lookup
ansond 1:16f0fb5b8d97 138 DynamicResource *lookupDynamicResource(M2MBase *base);
ansond 1:16f0fb5b8d97 139
ansond 1:16f0fb5b8d97 140 // access the logger
ansond 1:16f0fb5b8d97 141 Logger *logger();
ansond 1:16f0fb5b8d97 142 };
ansond 1:16f0fb5b8d97 143
ansond 1:16f0fb5b8d97 144 } // namespace Connector
ansond 1:16f0fb5b8d97 145
ansond 1:16f0fb5b8d97 146 #endif // __CONNECTOR_ENDPOINT_H__
ansond 1:16f0fb5b8d97 147