Pranav Sawant / EthernetNetIf

12Oct2012MbedLab

Dependents:   Lab3_VoiceMeter

Fork of EthernetNetIf by Donatien Garnier

LPC2368/core/ipaddr.h@6:22ce63eddd2b, 2012-10-12 (annotated)

Committer:
psawant9
Date:
Fri Oct 12 16:02:00 2012 +0000
Revision:
6:22ce63eddd2b
Parent:
5:bc7df6da7589 
Done

Who changed what in which revision?

UserRevisionLine numberNew contents of line
psawant9 6:22ce63eddd2b 1
psawant9 6:22ce63eddd2b 2 /*
psawant9 6:22ce63eddd2b 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
psawant9 6:22ce63eddd2b 4
psawant9 6:22ce63eddd2b 5 Permission is hereby granted, free of charge, to any person obtaining a copy
psawant9 6:22ce63eddd2b 6 of this software and associated documentation files (the "Software"), to deal
psawant9 6:22ce63eddd2b 7 in the Software without restriction, including without limitation the rights
psawant9 6:22ce63eddd2b 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
psawant9 6:22ce63eddd2b 9 copies of the Software, and to permit persons to whom the Software is
psawant9 6:22ce63eddd2b 10 furnished to do so, subject to the following conditions:
psawant9 6:22ce63eddd2b 11
psawant9 6:22ce63eddd2b 12 The above copyright notice and this permission notice shall be included in
psawant9 6:22ce63eddd2b 13 all copies or substantial portions of the Software.
psawant9 6:22ce63eddd2b 14
psawant9 6:22ce63eddd2b 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
psawant9 6:22ce63eddd2b 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
psawant9 6:22ce63eddd2b 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
psawant9 6:22ce63eddd2b 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
psawant9 6:22ce63eddd2b 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
psawant9 6:22ce63eddd2b 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
psawant9 6:22ce63eddd2b 21 THE SOFTWARE.
psawant9 6:22ce63eddd2b 22 */
psawant9 6:22ce63eddd2b 23
psawant9 6:22ce63eddd2b 24 #ifndef IPADDR_H
psawant9 6:22ce63eddd2b 25 #define IPADDR_H
psawant9 6:22ce63eddd2b 26
psawant9 6:22ce63eddd2b 27 #include "netCfg.h"
psawant9 6:22ce63eddd2b 28 #if NET_LWIP_STACK
psawant9 6:22ce63eddd2b 29 typedef struct ip_addr ip_addr_t;
psawant9 6:22ce63eddd2b 30 #endif
psawant9 6:22ce63eddd2b 31
psawant9 6:22ce63eddd2b 32 #include "stdint.h"
psawant9 6:22ce63eddd2b 33
psawant9 6:22ce63eddd2b 34 ///IP Address container
psawant9 6:22ce63eddd2b 35 /**
psawant9 6:22ce63eddd2b 36 This class is a container for an IPv4 address.
psawant9 6:22ce63eddd2b 37 */
psawant9 6:22ce63eddd2b 38 class IpAddr //Basically a C++ frontend to ip_addr_t
psawant9 6:22ce63eddd2b 39 {
psawant9 6:22ce63eddd2b 40 public:
psawant9 6:22ce63eddd2b 41 #if NET_LWIP_STACK
psawant9 6:22ce63eddd2b 42 IpAddr(ip_addr_t* pIp);
psawant9 6:22ce63eddd2b 43 #endif
psawant9 6:22ce63eddd2b 44
psawant9 6:22ce63eddd2b 45 ///Initializes IP address with provided values
psawant9 6:22ce63eddd2b 46 IpAddr(uint8_t ip0, uint8_t ip1, uint8_t ip2, uint8_t ip3);
psawant9 6:22ce63eddd2b 47
psawant9 6:22ce63eddd2b 48 ///Initializes IP address with null values
psawant9 6:22ce63eddd2b 49 IpAddr();
psawant9 6:22ce63eddd2b 50
psawant9 6:22ce63eddd2b 51 #if NET_LWIP_STACK
psawant9 6:22ce63eddd2b 52 ip_addr_t getStruct() const;
psawant9 6:22ce63eddd2b 53 #endif
psawant9 6:22ce63eddd2b 54
psawant9 6:22ce63eddd2b 55 ///Returns IP address byte #
psawant9 6:22ce63eddd2b 56 uint8_t operator[](unsigned int i) const;
psawant9 6:22ce63eddd2b 57
psawant9 6:22ce63eddd2b 58 ///Compares too addresses
psawant9 6:22ce63eddd2b 59 /**
psawant9 6:22ce63eddd2b 60 @return true if the two addresses are equal
psawant9 6:22ce63eddd2b 61 */
psawant9 6:22ce63eddd2b 62 bool isEq(const IpAddr& b) const;
psawant9 6:22ce63eddd2b 63
psawant9 6:22ce63eddd2b 64 ///Compares too addresses
psawant9 6:22ce63eddd2b 65 /**
psawant9 6:22ce63eddd2b 66 @return true if the two addresses are equal
psawant9 6:22ce63eddd2b 67 */
psawant9 6:22ce63eddd2b 68 bool operator==(const IpAddr& b) const;
psawant9 6:22ce63eddd2b 69
psawant9 6:22ce63eddd2b 70 ///Compares too addresses
psawant9 6:22ce63eddd2b 71 /**
psawant9 6:22ce63eddd2b 72 @return true if the two addresses are different
psawant9 6:22ce63eddd2b 73 */
psawant9 6:22ce63eddd2b 74 bool operator!=(const IpAddr& b) const;
psawant9 6:22ce63eddd2b 75
psawant9 6:22ce63eddd2b 76 ///Checks whether the address is null
psawant9 6:22ce63eddd2b 77 /**
psawant9 6:22ce63eddd2b 78 @return true if the address is null
psawant9 6:22ce63eddd2b 79 */
psawant9 6:22ce63eddd2b 80 bool isNull() const;
psawant9 6:22ce63eddd2b 81
psawant9 6:22ce63eddd2b 82 ///Checks whether the address is a broadcast address
psawant9 6:22ce63eddd2b 83 /**
psawant9 6:22ce63eddd2b 84 @return true if the address is a broadcast address
psawant9 6:22ce63eddd2b 85 */
psawant9 6:22ce63eddd2b 86 bool isBroadcast() const;
psawant9 6:22ce63eddd2b 87
psawant9 6:22ce63eddd2b 88 ///Checks whether the address is a multicast address
psawant9 6:22ce63eddd2b 89 /**
psawant9 6:22ce63eddd2b 90 @return true if the address is a multicast address
psawant9 6:22ce63eddd2b 91 */
psawant9 6:22ce63eddd2b 92 bool isMulticast() const;
psawant9 6:22ce63eddd2b 93
psawant9 6:22ce63eddd2b 94 private:
psawant9 6:22ce63eddd2b 95 uint8_t m_ip[4];
psawant9 6:22ce63eddd2b 96 };
psawant9 6:22ce63eddd2b 97
psawant9 6:22ce63eddd2b 98 #endif