ok

Dependencies:   Socket lwip-eth lwip-sys lwip

Fork of EthernetInterface by mbed official

Embed: (wiki syntax)

« Back to documentation index

EthernetInterface Class Reference

EthernetInterface Class Reference

Interface using Ethernet to connect to an IP-based network. More...

#include <EthernetInterface.h>

Static Public Member Functions

static int init ()
 Initialize the interface with DHCP.
static int init (const char *ip, const char *mask, const char *gateway)
 Initialize the interface with a static IP address.
static int connect (unsigned int timeout_ms=12000)
 Connect Bring the interface up, start DHCP if needed.
static int disconnect ()
 Disconnect Bring the interface down.

Detailed Description

Interface using Ethernet to connect to an IP-based network.

Definition at line 33 of file EthernetInterface.h.


Member Function Documentation

int connect ( unsigned int  timeout_ms = 12000 ) [static]

Connect Bring the interface up, start DHCP if needed.

Parameters:
timeout_mstimeout in ms (default: (12)s).
Returns:
0 on success, a negative number on failure

Definition at line 75 of file EthernetInterface.cpp.

int disconnect (  ) [static]

Disconnect Bring the interface down.

Returns:
0 on success, a negative number on failure

Definition at line 90 of file EthernetInterface.cpp.

int init (  ) [static]

Initialize the interface with DHCP.

Initialize the interface and configure it to use DHCP (no connection at this point).

Returns:
0 on success, a negative number on failure

Definition at line 59 of file EthernetInterface.cpp.

int init ( const char *  ip,
const char *  mask,
const char *  gateway 
) [static]

Initialize the interface with a static IP address.

Initialize the interface and configure it with the following static configuration (no connection at this point).

Parameters:
ipthe IP address to use
maskthe IP address mask
gatewaythe gateway to use
Returns:
0 on success, a negative number on failure

Definition at line 65 of file EthernetInterface.cpp.