Committer:
mbed714
Date:
Tue Nov 09 19:32:44 2010 +0000
Revision:
3:0c324737064d
Parent:
0:98aadd37a5c5

        

Who changed what in which revision?

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