Library for Bert van Dam's book "ARM MICROCONTROLLERS" For all chapters with internet.

Dependencies:   mbed

Committer:
ICTFBI
Date:
Fri Oct 16 14:28:26 2015 +0000
Revision:
0:4edb816d21e1
Pre-update 16-10-15

Who changed what in which revision?

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