Committer:
mbed714
Date:
Sat Sep 18 23:05:49 2010 +0000
Revision:
0:d616ece2d859

        

Who changed what in which revision?

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