Michael Spencer / Mbed 2 deprecated LaOS

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

NetServices/core/ipaddr.h@1:f5ac63519541, 2014-03-05 (annotated)

Committer:
Michael J. Spencer
Date:
Wed Mar 05 06:14:02 2014 -0800
Revision:
1:f5ac63519541
Initial commit.

Who changed what in which revision?

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