hirifumi mikage / EthernetNetIf

EthernetNetIf

Dependents:   XBee_WiFi_EA_LPC4088

core/ipaddr.h@0:62580107d20c, 2014-11-19 (annotated)

Committer:
hmike
Date:
Wed Nov 19 12:00:42 2014 +0000
Revision:
0:62580107d20c
EthernetNetIf

Who changed what in which revision?

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