Rik Van Dyck / Mbed 2 deprecated Project_Embedded_C

Project_Embedded_C

Dependencies:   mbed DS1307 Servo TextLCD

NetServices/core/ipaddr.h@0:e1edd52b1ee2, 2014-12-04 (annotated)

Committer:
rikvandyck
Date:
Thu Dec 04 10:44:07 2014 +0000
Revision:
0:e1edd52b1ee2
test

Who changed what in which revision?

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