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.
Dependencies: Socket lwip-eth lwip-sys lwip
Fork of EthernetInterface by
EthernetInterface.h
- Committer:
- emilmont
- Date:
- 2012-07-26
- Revision:
- 17:b7a3766f6253
- Parent:
- 15:fd9597f1b81b
- Child:
- 20:0d9ae7845bfe
File content as of revision 17:b7a3766f6253:
/* 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_
#include "rtos.h"
#include "lwip/netif.h"
/** Interface using Ethernet to connect to an IP-based network
*
*/
class EthernetInterface {
public:
/** 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.
* \return 0 on success, a negative number on failure
*/
static int connect();
/** Disconnect
* Bring the interface down
* \return 0 on success, a negative number on failure
*/
static int disconnect();
static char* getIPAddress();
};
#include "TCPSocketConnection.h"
#include "TCPSocketServer.h"
#include "UDPPacket.h"
#include "UDPSocket.h"
#endif /* ETHERNETINTERFACE_H_ */
