Donatien Garnier
NetServices Stack source
Dependents: HelloWorld ServoInterfaceBoardExample1 4180_Lab4
if/net/ipaddr.h@8:93fa3cfc0219, 2010-07-28 (annotated)
- Committer:
- donatien
- Date:
- Wed Jul 28 12:45:32 2010 +0000
- Revision:
- 8:93fa3cfc0219
- Parent:
- 5:dd63a1e02b1b
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| donatien | 0:632c9925f013 | 1 | |
| donatien | 0:632c9925f013 | 2 | /* |
| donatien | 0:632c9925f013 | 3 | Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com) |
| donatien | 0:632c9925f013 | 4 | |
| donatien | 0:632c9925f013 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy |
| donatien | 0:632c9925f013 | 6 | of this software and associated documentation files (the "Software"), to deal |
| donatien | 0:632c9925f013 | 7 | in the Software without restriction, including without limitation the rights |
| donatien | 0:632c9925f013 | 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| donatien | 0:632c9925f013 | 9 | copies of the Software, and to permit persons to whom the Software is |
| donatien | 0:632c9925f013 | 10 | furnished to do so, subject to the following conditions: |
| donatien | 0:632c9925f013 | 11 | |
| donatien | 0:632c9925f013 | 12 | The above copyright notice and this permission notice shall be included in |
| donatien | 0:632c9925f013 | 13 | all copies or substantial portions of the Software. |
| donatien | 0:632c9925f013 | 14 | |
| donatien | 0:632c9925f013 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| donatien | 0:632c9925f013 | 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| donatien | 0:632c9925f013 | 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| donatien | 0:632c9925f013 | 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| donatien | 0:632c9925f013 | 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| donatien | 0:632c9925f013 | 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| donatien | 0:632c9925f013 | 21 | THE SOFTWARE. |
| donatien | 0:632c9925f013 | 22 | */ |
| donatien | 0:632c9925f013 | 23 | |
| donatien | 0:632c9925f013 | 24 | #ifndef IPADDR_H |
| donatien | 0:632c9925f013 | 25 | #define IPADDR_H |
| donatien | 0:632c9925f013 | 26 | |
| donatien | 0:632c9925f013 | 27 | #include "mbed.h" |
| donatien | 0:632c9925f013 | 28 | |
| donatien | 0:632c9925f013 | 29 | #include "netCfg.h" |
| donatien | 0:632c9925f013 | 30 | #if NET_LWIP_STACK |
| donatien | 0:632c9925f013 | 31 | #include "lwip/ip_addr.h" |
| donatien | 5:dd63a1e02b1b | 32 | |
| donatien | 5:dd63a1e02b1b | 33 | #ifdef __LWIP_DEBUG |
| donatien | 5:dd63a1e02b1b | 34 | #undef __LWIP_DEBUG |
| donatien | 0:632c9925f013 | 35 | #endif |
| donatien | 5:dd63a1e02b1b | 36 | #endif |
| donatien | 5:dd63a1e02b1b | 37 | |
| donatien | 0:632c9925f013 | 38 | class IpAddr; |
| donatien | 0:632c9925f013 | 39 | |
| donatien | 8:93fa3cfc0219 | 40 | ///IP Address container |
| donatien | 8:93fa3cfc0219 | 41 | /** |
| donatien | 8:93fa3cfc0219 | 42 | This class is a container for an IPv4 address. |
| donatien | 8:93fa3cfc0219 | 43 | */ |
| donatien | 0:632c9925f013 | 44 | class IpAddr //Basically a C++ frontend to ip_addr_t |
| donatien | 0:632c9925f013 | 45 | { |
| donatien | 0:632c9925f013 | 46 | public: |
| donatien | 0:632c9925f013 | 47 | #if NET_LWIP_STACK |
| donatien | 0:632c9925f013 | 48 | IpAddr(ip_addr_t* pIp) |
| donatien | 0:632c9925f013 | 49 | { |
| donatien | 0:632c9925f013 | 50 | *((uint32_t*)m_ip) = pIp->addr; |
| donatien | 0:632c9925f013 | 51 | } |
| donatien | 0:632c9925f013 | 52 | #endif |
| donatien | 0:632c9925f013 | 53 | |
| donatien | 8:93fa3cfc0219 | 54 | ///Initializes IP address with provided values |
| donatien | 0:632c9925f013 | 55 | IpAddr(uint8_t ip0, uint8_t ip1, uint8_t ip2, uint8_t ip3) |
| donatien | 0:632c9925f013 | 56 | { |
| donatien | 0:632c9925f013 | 57 | //We are in LE |
| donatien | 0:632c9925f013 | 58 | m_ip[0] = ip0; |
| donatien | 0:632c9925f013 | 59 | m_ip[1] = ip1; |
| donatien | 0:632c9925f013 | 60 | m_ip[2] = ip2; |
| donatien | 0:632c9925f013 | 61 | m_ip[3] = ip3; |
| donatien | 0:632c9925f013 | 62 | } |
| donatien | 0:632c9925f013 | 63 | |
| donatien | 8:93fa3cfc0219 | 64 | ///Initializes IP address with null values |
| donatien | 0:632c9925f013 | 65 | IpAddr() |
| donatien | 0:632c9925f013 | 66 | { |
| donatien | 0:632c9925f013 | 67 | m_ip[0] = 0; |
| donatien | 0:632c9925f013 | 68 | m_ip[1] = 0; |
| donatien | 0:632c9925f013 | 69 | m_ip[2] = 0; |
| donatien | 0:632c9925f013 | 70 | m_ip[3] = 0; |
| donatien | 0:632c9925f013 | 71 | } |
| donatien | 0:632c9925f013 | 72 | |
| donatien | 5:dd63a1e02b1b | 73 | |
| donatien | 0:632c9925f013 | 74 | #if NET_LWIP_STACK |
| donatien | 0:632c9925f013 | 75 | ip_addr_t getStruct() const |
| donatien | 0:632c9925f013 | 76 | { |
| donatien | 0:632c9925f013 | 77 | ip_addr_t ip_struct; |
| donatien | 0:632c9925f013 | 78 | ip_struct.addr = *((uint32_t*)m_ip); |
| donatien | 0:632c9925f013 | 79 | return ip_struct; |
| donatien | 0:632c9925f013 | 80 | } |
| donatien | 0:632c9925f013 | 81 | #endif |
| donatien | 0:632c9925f013 | 82 | |
| donatien | 8:93fa3cfc0219 | 83 | ///Returns IP address byte # |
| donatien | 0:632c9925f013 | 84 | uint8_t operator[](unsigned int i) const |
| donatien | 0:632c9925f013 | 85 | { |
| donatien | 0:632c9925f013 | 86 | uint8_t null = 0; |
| donatien | 0:632c9925f013 | 87 | if( i > 3 ) |
| donatien | 0:632c9925f013 | 88 | return null; |
| donatien | 0:632c9925f013 | 89 | return m_ip[i]; |
| donatien | 0:632c9925f013 | 90 | } |
| donatien | 0:632c9925f013 | 91 | |
| donatien | 8:93fa3cfc0219 | 92 | ///Compares too addresses |
| donatien | 8:93fa3cfc0219 | 93 | /* |
| donatien | 8:93fa3cfc0219 | 94 | @return true if the two addresses are equal |
| donatien | 8:93fa3cfc0219 | 95 | */ |
| donatien | 0:632c9925f013 | 96 | bool isEq(const IpAddr& b) const |
| donatien | 0:632c9925f013 | 97 | { |
| donatien | 0:632c9925f013 | 98 | return (*((uint32_t*)m_ip) == *((uint32_t*)(b.m_ip))); |
| donatien | 0:632c9925f013 | 99 | } |
| donatien | 0:632c9925f013 | 100 | |
| donatien | 8:93fa3cfc0219 | 101 | ///Compares too addresses |
| donatien | 8:93fa3cfc0219 | 102 | /* |
| donatien | 8:93fa3cfc0219 | 103 | @return true if the two addresses are equal |
| donatien | 8:93fa3cfc0219 | 104 | */ |
| donatien | 0:632c9925f013 | 105 | bool operator==(const IpAddr& b) const |
| donatien | 0:632c9925f013 | 106 | { |
| donatien | 0:632c9925f013 | 107 | return isEq(b); |
| donatien | 0:632c9925f013 | 108 | } |
| donatien | 8:93fa3cfc0219 | 109 | |
| donatien | 8:93fa3cfc0219 | 110 | ///Compares too addresses |
| donatien | 8:93fa3cfc0219 | 111 | /* |
| donatien | 8:93fa3cfc0219 | 112 | @return true if the two addresses are different |
| donatien | 8:93fa3cfc0219 | 113 | */ |
| donatien | 0:632c9925f013 | 114 | bool operator!=(const IpAddr& b) const |
| donatien | 0:632c9925f013 | 115 | { |
| donatien | 0:632c9925f013 | 116 | return !(operator==(b)); |
| donatien | 0:632c9925f013 | 117 | } |
| donatien | 0:632c9925f013 | 118 | |
| donatien | 8:93fa3cfc0219 | 119 | ///Checks whether the address is null |
| donatien | 8:93fa3cfc0219 | 120 | /* |
| donatien | 8:93fa3cfc0219 | 121 | @return true if the address is null |
| donatien | 8:93fa3cfc0219 | 122 | */ |
| donatien | 0:632c9925f013 | 123 | bool isNull() const |
| donatien | 0:632c9925f013 | 124 | { |
| donatien | 0:632c9925f013 | 125 | return (*((uint32_t*)m_ip) == 0); |
| donatien | 0:632c9925f013 | 126 | } |
| donatien | 0:632c9925f013 | 127 | |
| donatien | 8:93fa3cfc0219 | 128 | ///Checks whether the address is a broadcast address |
| donatien | 8:93fa3cfc0219 | 129 | /* |
| donatien | 8:93fa3cfc0219 | 130 | @return true if the address is a broadcast address |
| donatien | 8:93fa3cfc0219 | 131 | */ |
| donatien | 5:dd63a1e02b1b | 132 | bool isBroadcast() const |
| donatien | 5:dd63a1e02b1b | 133 | { |
| donatien | 5:dd63a1e02b1b | 134 | return (*((uint32_t*)m_ip) == 0xFFFFFFFF); |
| donatien | 5:dd63a1e02b1b | 135 | } |
| donatien | 8:93fa3cfc0219 | 136 | |
| donatien | 8:93fa3cfc0219 | 137 | ///Checks whether the address is a multicast address |
| donatien | 8:93fa3cfc0219 | 138 | /* |
| donatien | 8:93fa3cfc0219 | 139 | @return true if the address is a multicast address |
| donatien | 8:93fa3cfc0219 | 140 | */ |
| donatien | 5:dd63a1e02b1b | 141 | bool isMulticast() const |
| donatien | 5:dd63a1e02b1b | 142 | { |
| donatien | 5:dd63a1e02b1b | 143 | return ((m_ip[0] & 0xF0) == 0xE0); |
| donatien | 5:dd63a1e02b1b | 144 | } |
| donatien | 5:dd63a1e02b1b | 145 | |
| donatien | 0:632c9925f013 | 146 | private: |
| donatien | 0:632c9925f013 | 147 | uint8_t m_ip[4]; |
| donatien | 0:632c9925f013 | 148 | }; |
| donatien | 0:632c9925f013 | 149 | |
| donatien | 0:632c9925f013 | 150 | #endif |