Diff: EthernetInterface.h

Branch:

api-changes

Revision:

21:35ed15069189

Parent:

18:dd05ebdd2546

Child:

26:9774a2edad71

--- a/EthernetInterface.h	Fri Dec 25 19:51:33 2015 +0000
+++ b/EthernetInterface.h	Thu Feb 18 03:11:58 2016 -0600
@@ -14,29 +14,29 @@
  * limitations under the License.
  */
 
-#ifndef ETHERNETINTERFACE_H
-#define ETHERNETINTERFACE_H
+#ifndef ETHERNET_INTERFACE_H
+#define ETHERNET_INTERFACE_H
 
 #include "NetworkInterface.h"
 
-///* wifi_security_t enum for encryption types
-// */
-//typedef enum wifi_security_t {
-//    WI_NONE = 0,    /*!< No security for connection */
-//    WI_WEP,         /*!< WEP  encryption */
-//    WI_WPA,         /*!< WPA  encryption */
-//    WI_WPA2,        /*!< WPA2 encryption */
-//} wifi_security_t;
 
-/** EthernetInterface class.
-    This is a common interface to handle how ethernet connects to a router
+/** EthernetInterface class
+ *  Common interface that is shared between ethernet hardware
  */
 class EthernetInterface : public NetworkInterface
 {
 public:
 
-    // make sure to import the base symbol that needs an implementation for classes that have ap and phrase in the constructor
-    using NetworkInterface::connect;
+    /** Start the interface
+     *  @param timeout_ms Time in milliseconds to wait for a connection
+     *  @return 0 on success
+     */
+    virtual int32_t connect(uint32_t timeout_ms = 15000) = 0;
+
+    /** Stop the interface
+     *  @return 0 on success
+     */
+    virtual int32_t disconnect() = 0;
 };
 
 #endif