Dependents:   SNMPAgent HTTPServer think_speak_a cyassl-client ... more

Committer:
mamezu
Date:
Thu Dec 09 01:33:56 2010 +0000
Revision:
0:0f6c82fcde82

        

Who changed what in which revision?

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