mbed official / EthernetInterface

mbed IP library over Ethernet

Dependencies:   lwip-eth Socket lwip lwip-sys

Dependents:   denki-yohou_b Network-RTOS NTPClient_HelloWorld temp_FIAP ... more

Legacy Networking Libraries

This is an mbed 2 networking library. For mbed 5, the networking libraries have been revised to better support additional network stacks and thread safety here.

Files at this revision

API Documentation at this revision

Revision 4:9a52c802be61, committed 2012-06-26

Comitter:
donatien
Date:
Tue Jun 26 14:53:52 2012 +0000
Parent:
3:f5776537f27f
Child:
6:c50597f8d7a2
Commit message:
Documentation update

Changed in this revision

EthernetInterface.cpp Show annotated file Show diff for this revision Revisions of this file
EthernetInterface.h Show annotated file Show diff for this revision Revisions of this file 
--- a/EthernetInterface.cpp	Tue Jun 26 14:30:34 2012 +0000
+++ b/EthernetInterface.cpp	Tue Jun 26 14:53:52 2012 +0000
@@ -1,4 +1,4 @@
-/* Ethernetnetwork.cpp */
+/* EthernetInterface.cpp */
 /* Copyright (C) 2012 mbed.org, MIT License
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software

--- a/EthernetInterface.h	Tue Jun 26 14:30:34 2012 +0000
+++ b/EthernetInterface.h	Tue Jun 26 14:53:52 2012 +0000
@@ -28,19 +28,44 @@
 
 #include "lwip/netif.h"
 
-/** Interface using Ethernet to connect to an IP-based network
+ /** Interface using Ethernet to connect to an IP-based network
  *
  */
 class EthernetInterface : public LwIPInterface
 {
 public:
+  /** Instantiate the Ethernet interface.
+  * 
+  */
   EthernetInterface();
 
+  /** Initialize the interface with DHCP.
+  * Initialize the interface and configure it to use DHCP (no connection at this point).
+  * \return 0 on success, a negative number on failure
+  */
   int init(); //With DHCP
 
+  /** Initialize the interface with a static IP address.
+  * Initialize the interface and configure it with the following static configuration (no connection at this point).
+  * \param ip the IP address to use
+  * \param mask the IP address mask
+  * \param gateway the gateway to use
+  * \param dns1 the primary DNS server
+  * \param dns2 the secondary DNS server
+  * \return 0 on success, a negative number on failure
+  */
   int init(const char* ip, const char* mask, const char* gateway, const char* dns1, const char* dns2); //No DHCP
 
+  /** Connect
+  * Bring the interface up, start DHCP if needed.
+  * \return 0 on success, a negative number on failure
+  */
   virtual int connect();
+  
+  /** Disconnect
+  * Bring the interface down
+  * \return 0 on success, a negative number on failure
+  */
   virtual int disconnect();
 
 private: