Dependencies:   mbed

Committer:
slowness
Date:
Tue Sep 06 18:10:36 2011 +0000
Revision:
0:cd4c47744fa1

        

Who changed what in which revision?

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