Dependencies:   mbed

Committer:
robertcook
Date:
Wed Jun 13 18:39:46 2012 +0000
Revision:
0:32a0996dff0f

        

Who changed what in which revision?

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