Diff: api/Endpoint.h

Revision:

2:853f9ecc12df

Parent:

1:cabdd0350707

Child:

5:a929d65eb385

diff -r cabdd0350707 -r 853f9ecc12df api/Endpoint.h
--- a/api/Endpoint.h	Tue Jan 27 22:52:25 2015 +0000
+++ b/api/Endpoint.h	Tue Jan 27 23:41:34 2015 +0000
@@ -3,7 +3,7 @@
  * @brief   mbed CoAP Endpoint base class
  * @author  Doug Anson/Chris Paola
  * @version 1.0
- * @see     
+ * @see
  *
  * Copyright (c) 2014
  *
@@ -19,66 +19,70 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
- 
- #ifndef __ENDPOINT_H__
- #define __ENDPOINT_H__
- 
- // Support for Logging/Debug output
- #include "Logger.h"
-  
- // Options support
- #include "Options.h"
- 
- // Connector namespace
- namespace Connector {
-     
-     class Endpoint {
-        
-        public:
-            /**
-            Default Constructor
-            */
-            Endpoint(const Logger *logger,const Options *ob);
-            
-            /**
-            Copy Constructor
-            @param ob input endpoint instance to deep copy
-            */
-            Endpoint(const Endpoint &ep);
-            
-            /**
-            Destructor
-            */
-            virtual ~Endpoint();
-            
-            /**
-            Plumb the underlying network
-            @param canActAsRouterNode input boolean indicating whether this node can act as a router node or not. 
-            */
-            static void plumbNetwork(bool canActAsRouterNode = false);
-            
-            /**
-            Initialize the endpoint
-            */
-            void initialize();
-            
-            /**
-            Finalize the endpoint's configuration and begin the endpoint's main even loop
-            */
-            static void start();
-        
-        protected:
-             
-        private:
-            Logger         *m_logger;
-            Options        *m_options;
-            
-            // initialize the NSDL network
-            void initNetwork();
-            
-            // access the logger
-            Logger *logger();       
-      };
-  }
- 
- #endif // __ENDPOINT_H__
\ No newline at end of file
+
+#ifndef __ENDPOINT_H__
+#define __ENDPOINT_H__
+
+// Support for Logging/Debug output
+#include "Logger.h"
+
+// Options support
+#include "Options.h"
+
+// Connector namespace
+namespace Connector {
+
+/** Endpoint class
+ */
+class Endpoint
+{
+
+public:
+    /**
+    Default Constructor
+    */
+    Endpoint(const Logger *logger,const Options *ob);
+
+    /**
+    Copy Constructor
+    @param ob input endpoint instance to deep copy
+    */
+    Endpoint(const Endpoint &ep);
+
+    /**
+    Destructor
+    */
+    virtual ~Endpoint();
+
+    /**
+    Plumb the underlying network
+    @param canActAsRouterNode input boolean indicating whether this node can act as a router node or not.
+    */
+    static void plumbNetwork(bool canActAsRouterNode = false);
+
+    /**
+    Initialize the endpoint
+    */
+    void initialize();
+
+    /**
+    Finalize the endpoint's configuration and begin the endpoint's main even loop
+    */
+    static void start();
+
+protected:
+
+private:
+    Logger         *m_logger;
+    Options        *m_options;
+
+    // initialize the NSDL network
+    void initNetwork();
+
+    // access the logger
+    Logger *logger();
+};
+
+} // namespace Connector
+
+#endif // __ENDPOINT_H__