The EthernetInterface library as found on mbed

Dependencies:   Socket lwip-eth lwip-sys lwip

Fork of EthernetInterface by Jonathon Fletcher

EthernetInterface.h

Committer:
jonathonfletcher
Date:
2012-09-01
Revision:
26:132037eec2ba
Parent:
24:c9bb345dcc65

File content as of revision 26:132037eec2ba:

/* EthernetInterface.h */
/* Copyright (C) 2012 mbed.org, MIT License
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
 * and associated documentation files (the "Software"), to deal in the Software without restriction,
 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or
 * substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef ETHERNETINTERFACE_H_
#define ETHERNETINTERFACE_H_

#if !defined(TARGET_LPC1768)
#error The Ethernet Interface library is supported only on the mbed NXP LPC1768
#endif

#include "rtos.h"
#include "lwip/netif.h"

/** Interface using Ethernet to connect to an IP-based network
*
*/
class EthernetInterface
{
public:

    /*
    * Constructor
    */
    EthernetInterface();

    /** Initialize the interface with DHCP.
    * Initialize the interface and configure it to use DHCP (no connection at this point).
    * \return 0 on success, a negative number on failure
    */
    static int init(); //With DHCP

    /** Initialize the interface with a static IP address.
    * Initialize the interface and configure it with the following static configuration (no connection at this point).
    * \param ip the IP address to use
    * \param mask the IP address mask
    * \param gateway the gateway to use
    * \return 0 on success, a negative number on failure
    */
    static int init(const char* ip, const char* mask, const char* gateway);

    /** Connect
    * Bring the interface up, start DHCP if needed.
    * \param   timeout_ms  timeout in ms (default: (12)s).
    * \return 0 on success, a negative number on failure
    */
    static int connect(unsigned int timeout_ms=12000);

    /** Disconnect
    * Bring the interface down
    * \return 0 on success, a negative number on failure
    */
    static int disconnect();

    static char* getIPAddress();

    static char* getMACAddress();
};

#include "TCPSocketConnection.h"
#include "TCPSocketServer.h"

#include "Endpoint.h"
#include "UDPSocket.h"

#endif /* ETHERNETINTERFACE_H_ */