Michiel Berckvens / Mbed 2 deprecated ProjectHTTP

Dependencies:   DS1307 TextLCD mbed

NetServices/if/eth/EthernetNetIf.h@0:f615d151a72c, 2014-12-04 (annotated)

Committer:
Michielber
Date:
Thu Dec 04 10:36:40 2014 +0000
Revision:
0:f615d151a72c
Berckvens Michiel & Basteyns Jonas 4/12/2014

Who changed what in which revision?

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