Embed: (wiki syntax)

« Back to documentation index

EthernetNetIf Class Reference

EthernetNetIf Class Reference

Ethernet network interface. More...

#include <EthernetNetIf.h>

Public Member Functions

 EthernetNetIf (const char *hostname=NULL)
 Instantiates the Interface and register it against the stack, DHCP will be used.
 EthernetNetIf (IpAddr ip, IpAddr netmask, IpAddr gateway, IpAddr dns)
 Instantiates the Interface and register it against the stack, DHCP will not be used.
EthernetErr setup (int timeout_ms=15000)
 Brings the interface up.
const char * getHwAddr () const
 Returns an array containing the hardware address.

Detailed Description

Ethernet network interface.

00048 This class provides Ethernet connectivity to the stack 00049

Definition at line 50 of file EthernetNetIf.h.


Constructor & Destructor Documentation

EthernetNetIf ( const char *  hostname = NULL )

Instantiates the Interface and register it against the stack, DHCP will be used.

00055 * An optional hostname can be specified which will be passed to the DHCP server. 00056 * Examples without and with hostname specified: 00057 * 00058 *

00059   * EthernetNetIf eth();
00060   * 

00061 *

00062   * EthernetNetIf eth("mbedSE");
00063   * 

00064

EthernetNetIf ( IpAddr  ip,
IpAddr  netmask,
IpAddr  gateway,
IpAddr  dns 
)

Instantiates the Interface and register it against the stack, DHCP will not be used.

00069 IpAddr is a container class that can be constructed with either 4 bytes or no parameters for a null IP address. 00070


Member Function Documentation

const char* getHwAddr (  ) const

Returns an array containing the hardware address.

EthernetErr setup ( int  timeout_ms = 15000 )

Brings the interface up.

00076 Uses DHCP if necessary 00077

Parameters:
timeout_ms: You can set the timeout parameter in milliseconds, if not it defaults to 15s 00078
Returns:
: ETH_OK on success or ETH_TIMEOUT on timeout 00079