joey shelton / LED_Demo

Dependencies:   MAX44000 PWM_Tone_Library nexpaq_mdk

Fork of LED_Demo by Maxim nexpaq

Embed: (wiki syntax)

« Back to documentation index

MeshInterface Class Reference

MeshInterface Class Reference

MeshInterface class. More...

#include <MeshInterface.h>

Inherits NetworkInterface.

Inherited by MeshInterfaceNanostack.

Public Member Functions

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

Protected Member Functions

virtual NetworkStackget_stack ()=0
 Provide access to the NetworkStack object.

Friends

class Socket
class UDPSocket
class TCPSocket
class TCPServer
class SocketAddress

Detailed Description

MeshInterface class.

Common interface that is shared between mesh hardware

Definition at line 27 of file MeshInterface.h.


Member Function Documentation

virtual int connect (  ) [pure virtual]

Start the interface.

Returns:
0 on success, negative on failure
virtual int disconnect (  ) [pure virtual]

Stop the interface.

Returns:
0 on success, negative on failure
virtual const char* get_ip_address (  ) [pure virtual, inherited]

Get the local IP address.

Returns:
Null-terminated representation of the local IP address or null if not yet connected

Implemented in EthernetInterface.

virtual const char* get_mac_address (  ) [pure virtual]

Get the local MAC address.

Returns:
Null-terminated representation of the local MAC address
virtual NetworkStack* get_stack (  ) [protected, pure virtual, inherited]

Provide access to the NetworkStack object.

Returns:
The underlying NetworkStack object

Implemented in EthernetInterface.