a

Fork of EthernetNetIf by Donatien Garnier

LPC1768/core/ipaddr.h

Committer:
anze777
Date:
2016-11-27
Revision:
6:13a3e24ed1a3
Parent:
5:bc7df6da7589

File content as of revision 6:13a3e24ed1a3:


/*
Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/

#ifndef IPADDR_H
#define IPADDR_H

#include "netCfg.h"
#if NET_LWIP_STACK
typedef struct ip_addr ip_addr_t;
#endif

#include "stdint.h"

///IP Address container
/**
This class is a container for an IPv4 address.
*/
class IpAddr //Basically a C++ frontend to ip_addr_t
{
public:
  #if NET_LWIP_STACK
  IpAddr(ip_addr_t* pIp);
  #endif
  
  ///Initializes IP address with provided values
  IpAddr(uint8_t ip0, uint8_t ip1, uint8_t ip2, uint8_t ip3);
  
  ///Initializes IP address with null values 
  IpAddr();

  #if NET_LWIP_STACK
  ip_addr_t getStruct() const;
  #endif
  
  ///Returns IP address byte #
  uint8_t operator[](unsigned int i) const;
  
  ///Compares too addresses
  /**
  @return true if the two addresses are equal
  */
  bool isEq(const IpAddr& b) const;
  
  ///Compares too addresses
  /**
  @return true if the two addresses are equal
  */
  bool operator==(const IpAddr& b) const;
 
  ///Compares too addresses
  /**
  @return true if the two addresses are different
  */ 
  bool operator!=(const IpAddr& b) const;
  
  ///Checks whether the address is null
  /**
  @return true if the address is null
  */
  bool isNull() const;
  
  ///Checks whether the address is a broadcast address
  /**
  @return true if the address is a broadcast address
  */
  bool isBroadcast() const;

  ///Checks whether the address is a multicast address
  /**
  @return true if the address is a multicast address
  */
  bool isMulticast() const;
  
private:
  uint8_t m_ip[4];
};

#endif