Used in Live Traffic Update Nokia LCD Display Project

Fork of NetServices by Segundo Equipo

Committer:
rrajan8
Date:
Wed Mar 06 19:07:23 2013 +0000
Revision:
8:92b57208ab99
Parent:
4:966a0265edfc
Child:
7:4e2468d7d5cb
This project utilizes mbed's networking features to display live traffic updates on the Nokia LCD using the MapQuest API's Traffic Web Service.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
segundo 0:ac1725ba162c 1
segundo 0:ac1725ba162c 2 /*
segundo 0:ac1725ba162c 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
segundo 0:ac1725ba162c 4
segundo 0:ac1725ba162c 5 Permission is hereby granted, free of charge, to any person obtaining a copy
segundo 0:ac1725ba162c 6 of this software and associated documentation files (the "Software"), to deal
segundo 0:ac1725ba162c 7 in the Software without restriction, including without limitation the rights
segundo 0:ac1725ba162c 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
segundo 0:ac1725ba162c 9 copies of the Software, and to permit persons to whom the Software is
segundo 0:ac1725ba162c 10 furnished to do so, subject to the following conditions:
segundo 0:ac1725ba162c 11
segundo 0:ac1725ba162c 12 The above copyright notice and this permission notice shall be included in
segundo 0:ac1725ba162c 13 all copies or substantial portions of the Software.
segundo 0:ac1725ba162c 14
segundo 0:ac1725ba162c 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
segundo 0:ac1725ba162c 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
segundo 0:ac1725ba162c 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
segundo 0:ac1725ba162c 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
segundo 0:ac1725ba162c 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
segundo 0:ac1725ba162c 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
segundo 0:ac1725ba162c 21 THE SOFTWARE.
segundo 0:ac1725ba162c 22 */
segundo 0:ac1725ba162c 23
segundo 0:ac1725ba162c 24 /** \file
segundo 0:ac1725ba162c 25 Ethernet network interface header file
segundo 0:ac1725ba162c 26 */
segundo 0:ac1725ba162c 27
segundo 0:ac1725ba162c 28 #ifndef ETHERNETNETIF_H
segundo 0:ac1725ba162c 29 #define ETHERNETNETIF_H
segundo 0:ac1725ba162c 30
segundo 0:ac1725ba162c 31 struct netif;
segundo 0:ac1725ba162c 32
segundo 0:ac1725ba162c 33 #include "mbed.h"
segundo 0:ac1725ba162c 34
segundo 0:ac1725ba162c 35 #include "if/lwip/LwipNetIf.h"
segundo 4:966a0265edfc 36 #include "lwip/dhcp.h"
segundo 0:ac1725ba162c 37
segundo 0:ac1725ba162c 38 ///Ethernet network interface return codes
segundo 0:ac1725ba162c 39 enum EthernetErr
segundo 0:ac1725ba162c 40 {
segundo 0:ac1725ba162c 41 __ETH_MIN = -0xFFFF,
segundo 0:ac1725ba162c 42 ETH_TIMEOUT, ///<Timeout during setup
segundo 0:ac1725ba162c 43 ETH_OK = 0 ///<Success
segundo 0:ac1725ba162c 44 };
segundo 0:ac1725ba162c 45
segundo 0:ac1725ba162c 46 ///Ethernet network interface
segundo 0:ac1725ba162c 47 /**
segundo 0:ac1725ba162c 48 This class provides Ethernet connectivity to the stack
segundo 0:ac1725ba162c 49 */
segundo 0:ac1725ba162c 50 class EthernetNetIf : public LwipNetIf
segundo 0:ac1725ba162c 51 {
segundo 0:ac1725ba162c 52 public:
segundo 0:ac1725ba162c 53 ///Instantiates the Interface and register it against the stack, DHCP will be used
segundo 0:ac1725ba162c 54 /**
segundo 0:ac1725ba162c 55 * An optional hostname can be specified which will be passed to the DHCP server.
segundo 0:ac1725ba162c 56 * Examples without and with hostname specified:
segundo 0:ac1725ba162c 57 *
segundo 0:ac1725ba162c 58 * @code
segundo 0:ac1725ba162c 59 * EthernetNetIf eth();
segundo 0:ac1725ba162c 60 * @endcode
segundo 0:ac1725ba162c 61 * @code
segundo 0:ac1725ba162c 62 * EthernetNetIf eth("mbedSE");
segundo 0:ac1725ba162c 63 * @endcode
segundo 0:ac1725ba162c 64 */
segundo 0:ac1725ba162c 65 EthernetNetIf(const char* hostname = NULL); //W/ DHCP
segundo 0:ac1725ba162c 66
segundo 0:ac1725ba162c 67 ///Instantiates the Interface and register it against the stack, DHCP will not be used
segundo 0:ac1725ba162c 68 /**
segundo 0:ac1725ba162c 69 IpAddr is a container class that can be constructed with either 4 bytes or no parameters for a null IP address.
segundo 0:ac1725ba162c 70 */
segundo 0:ac1725ba162c 71 EthernetNetIf(IpAddr ip, IpAddr netmask, IpAddr gateway, IpAddr dns); //W/o DHCP
segundo 0:ac1725ba162c 72 virtual ~EthernetNetIf();
segundo 0:ac1725ba162c 73
segundo 0:ac1725ba162c 74 ///Brings the interface up
segundo 0:ac1725ba162c 75 /**
segundo 0:ac1725ba162c 76 Uses DHCP if necessary
segundo 0:ac1725ba162c 77 @param timeout_ms : You can set the timeout parameter in milliseconds, if not it defaults to 15s
segundo 0:ac1725ba162c 78 @return : ETH_OK on success or ETH_TIMEOUT on timeout
segundo 0:ac1725ba162c 79 */
segundo 0:ac1725ba162c 80 EthernetErr setup(int timeout_ms = 15000);
segundo 0:ac1725ba162c 81
segundo 0:ac1725ba162c 82 virtual void poll();
segundo 3:5a6792c147c0 83
segundo 3:5a6792c147c0 84 ///Returns an array containing the hardware address
segundo 3:5a6792c147c0 85 const char* getHwAddr() const;
segundo 3:5a6792c147c0 86
segundo 0:ac1725ba162c 87 private:
segundo 0:ac1725ba162c 88 Timer m_ethArpTimer;
segundo 0:ac1725ba162c 89 Timer m_dhcpCoarseTimer;
segundo 0:ac1725ba162c 90 Timer m_dhcpFineTimer;
segundo 0:ac1725ba162c 91 Timer m_igmpTimer;
segundo 0:ac1725ba162c 92
segundo 0:ac1725ba162c 93 bool m_useDhcp;
segundo 0:ac1725ba162c 94
segundo 0:ac1725ba162c 95 netif* m_pNetIf;
segundo 0:ac1725ba162c 96
segundo 0:ac1725ba162c 97 IpAddr m_netmask;
segundo 0:ac1725ba162c 98 IpAddr m_gateway;
segundo 0:ac1725ba162c 99
segundo 0:ac1725ba162c 100 const char* m_hostname;
segundo 4:966a0265edfc 101 dhcp* m_pDhcp;
segundo 4:966a0265edfc 102 bool m_setup;
segundo 0:ac1725ba162c 103 };
segundo 0:ac1725ba162c 104
segundo 0:ac1725ba162c 105 #endif
segundo 0:ac1725ba162c 106