NetServices Stack source

Dependents:   HelloWorld ServoInterfaceBoardExample1 4180_Lab4

Embed: (wiki syntax)

« Back to documentation index

EthernetNetIf Class Reference

EthernetNetIf Class Reference

Ethernet network interface. More...

#include <EthernetNetIf.h>

Inherits LwipNetIf.

Public Member Functions

 EthernetNetIf ()
 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.
IpAddr getIp () const
 Returns the IP of the interface once it's connected.

Detailed Description

Ethernet network interface.

This class provides Ethernet connectivity to the stack

Definition at line 49 of file EthernetNetIf.h.


Constructor & Destructor Documentation

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

Definition at line 40 of file EthernetNetIf.cpp.

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

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.

Definition at line 48 of file EthernetNetIf.cpp.


Member Function Documentation

IpAddr getIp (  ) const [inherited]

Returns the IP of the interface once it's connected.

Definition at line 40 of file netif.cpp.

EthernetErr setup ( int  timeout_ms = 15000 )

Brings the interface up.

Uses DHCP if necessary

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

Definition at line 71 of file EthernetNetIf.cpp.