Maxim nexpaq / nexpaq_dev

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Embed: (wiki syntax)

« Back to documentation index

EthernetInterface Class Reference
Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends

EthernetInterface Class Reference

EthernetInterface class Implementation of the NetworkStack for LWIP. More...

#include <EthernetInterface.h>

Inherits EthInterface.

Public Member Functions

virtual int connect ()
 Start the interface.
virtual int disconnect ()
 Stop the interface.
virtual const char * get_ip_address ()
 Get the internally stored IP address.
virtual const char * get_mac_address ()
 Get the internally stored MAC address.

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.

Protected Member Functions

virtual NetworkStack * get_stack ()
 Provide access to the underlying stack.

Friends

class Socket
class UDPSocket
class TCPSocket
class TCPServer
class SocketAddress

Detailed Description

EthernetInterface class Implementation of the NetworkStack for LWIP.

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

Definition at line 31 of file features/net/FEATURE_IPV4/lwip-interface/EthernetInterface.h.

Member Function Documentation

int connect (  ) [virtual]

Start the interface.

Returns:
0 on success, negative on failure

Implements EthInterface.

Definition at line 22 of file features/net/FEATURE_IPV4/lwip-interface/EthernetInterface.cpp.

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 libraries/net/eth/EthernetInterface/EthernetInterface.cpp.

int disconnect (  ) [virtual]

Stop the interface.

Returns:
0 on success, negative on failure

Implements EthInterface.

Definition at line 27 of file features/net/FEATURE_IPV4/lwip-interface/EthernetInterface.cpp.

static int disconnect (  ) [static, virtual]

Disconnect Bring the interface down.

Returns:
0 on success, a negative number on failure

Implements EthInterface.

const char * get_ip_address (  ) [virtual]

Get the internally stored IP address.

Returns:
IP address of the interface or null if not yet connected

Implements NetworkInterface.

Definition at line 33 of file features/net/FEATURE_IPV4/lwip-interface/EthernetInterface.cpp.

const char * get_mac_address (  ) [virtual]

Get the internally stored MAC address.

Returns:
MAC address of the interface

Implements EthInterface.

Definition at line 38 of file features/net/FEATURE_IPV4/lwip-interface/EthernetInterface.cpp.

NetworkStack * get_stack ( void   ) [protected, virtual]

Provide access to the underlying stack.

Returns:
The underlying network stack

Implements NetworkInterface.

Definition at line 43 of file features/net/FEATURE_IPV4/lwip-interface/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 libraries/net/eth/EthernetInterface/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 libraries/net/eth/EthernetInterface/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 libraries/net/eth/EthernetInterface/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 libraries/net/eth/EthernetInterface/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 libraries/net/eth/EthernetInterface/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 libraries/net/eth/EthernetInterface/EthernetInterface.cpp.

Generated on Tue Jul 12 2022 13:06:04 by  doxygen 1.7.2