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

Embed: (wiki syntax)

« Back to documentation index

EthernetInterface Class Reference
Static Public Member Functions

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=15000)
 Connect Bring the interface up, start DHCP if needed.
static int disconnect ()
 Disconnect Bring the interface down.
static char * getMACAddress ()
 Get the MAC address of your Ethernet interface.
static char * getIPAddress ()
 Get the IP address of your Ethernet interface.
static char * getGateway ()
 Get the Gateway address of your Ethernet interface.
static char * getNetworkMask ()
 Get the Network mask of your Ethernet interface.

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 = 15000 ) [static]

Connect Bring the interface up, start DHCP if needed.

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

Definition at line 107 of file EthernetInterface.cpp.

int disconnect (  ) [static]

Disconnect Bring the interface down.

Returns:
0 on success, a negative number on failure

Definition at line 127 of file EthernetInterface.cpp.

char * getGateway (  ) [static]

Get the Gateway address of your Ethernet interface.

Returns:
a pointer to a string containing the Gateway address

Definition at line 148 of file EthernetInterface.cpp.

char * getIPAddress (  ) [static]

Get the IP address of your Ethernet interface.

Returns:
a pointer to a string containing the IP address

Definition at line 144 of file EthernetInterface.cpp.

char * getMACAddress (  ) [static]

Get the MAC address of your Ethernet interface.

Returns:
a pointer to a string containing the MAC address

Definition at line 140 of file EthernetInterface.cpp.

char * getNetworkMask (  ) [static]

Get the Network mask of your Ethernet interface.

Returns:
a pointer to a string containing the Network mask

Definition at line 152 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 85 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 92 of file EthernetInterface.cpp.

Generated on Tue Jul 12 2022 12:22:09 by  doxygen 1.7.2