Diff: if/eth/EthernetNetIf.h

Revision:

5:dd63a1e02b1b

Parent:

2:a4f97773c90f

Child:

6:b7dd7cde8ad2

--- a/if/eth/EthernetNetIf.h	Fri Jul 09 14:46:47 2010 +0000
+++ b/if/eth/EthernetNetIf.h	Tue Jul 27 15:59:42 2010 +0000
@@ -34,17 +34,33 @@
 enum EthernetErr
 {
   __ETH_MIN = -0xFFFF,
-  ETH_TIMEOUT, //Timeout during setup
+  ETH_TIMEOUT, ///Timeout during setup
   ETH_OK = 0
 };
 
+///Ethernet network interface
+/**
+This class provides Ethernet connectivity to the stack
+*/
 class EthernetNetIf : public LwipNetIf
 {
 public:
+  ///Instantiates the Interface and register it against the stack, DHCP will be used
   EthernetNetIf(); //W/ DHCP
+
+  ///Instantiates the Interface and register it against the stack, DHCP will not be used
+  /**
+  IpAddr is a container class that can be constructed with either 4 bytes or no parameters for a null IP address.
+  */
   EthernetNetIf(IpAddr ip, IpAddr netmask, IpAddr gateway, IpAddr dns); //W/o DHCP
   virtual ~EthernetNetIf();
   
+  ///Brings the interface up
+  /**
+  Uses DHCP if necessary
+  @param timeout_ms : You can set the timeout parameter in milliseconds, if not it defaults to 15s
+  @return : ETH_OK on success or ETH_TIMEOUT on timeout
+  */
   EthernetErr setup(int timeout_ms = 15000);
 
   virtual void poll();
@@ -53,6 +69,7 @@
   Timer m_ethArpTimer;
   Timer m_dhcpCoarseTimer;
   Timer m_dhcpFineTimer;
+  Timer m_igmpTimer;
     
   bool m_useDhcp;