DwmIpv4Address.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $DwmPath$
//===========================================================================
//  Copyright (c) Daniel W. McRobb 2004-2006, 2016, 2023, 2024
//  All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions
//  are met:
//
//  1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  3. The names of the authors and copyright holders may not be used to
//    endorse or promote products derived from this software without
//    specific prior written permission.
//
//  IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
//  DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
//  INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
//  EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
//  DAMAGE.
//
//  THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
//  DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
//  UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
//  REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER 
//  IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
//  WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
//  PURPOSE, OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY 
//  PATENT, TRADEMARK OR OTHER RIGHTS.
//===========================================================================
 
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
 
#ifndef _DWMIPV4ADDRESS_HH_
#define _DWMIPV4ADDRESS_HH_
 
extern "C" {
  #include <inttypes.h>
  #include <sys/types.h>
  #include <netinet/in.h>
  #include <bzlib.h>
  #include <zlib.h>
}
 
#include <string>
#include <boost/asio.hpp>
 
namespace Dwm {
 
  using ipv4addr_t = uint32_t;
  
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class Ipv4Address
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4Address();
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline Ipv4Address(ipv4addr_t addr)
        : _addr(addr)
    {}
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv4Address(const std::string & dottedAddr);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline ipv4addr_t Raw() const
    { return(_addr); }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    explicit operator std::string () const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline bool operator < (const Ipv4Address & addr) const
    { return (ntohl(_addr) < ntohl(addr._addr)); }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline bool operator > (const Ipv4Address & addr) const
    { return (ntohl(_addr) > ntohl(addr._addr)); }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline bool operator >= (const Ipv4Address & addr) const
    {
      return ((ntohl(_addr) > ntohl(addr._addr))
              || (_addr == addr._addr));
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline bool operator <= (const Ipv4Address & addr) const
    {
      return ((ntohl(_addr) < ntohl(addr._addr))
              || (_addr == addr._addr));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline bool operator == (const Ipv4Address & addr) const
    { return (_addr == addr._addr); }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline bool operator != (const Ipv4Address & addr) const
    { return (_addr != addr._addr); }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline Ipv4Address & operator &= (const Ipv4Address & mask)
    {
      _addr &= mask._addr;
      return *this;
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline Ipv4Address operator ++ (int)
    {
      Ipv4Address rc(*this);
      uint32_t  a = ntohl(_addr);
      if (a != 0xFFFFFFFF) {
        _addr = htonl(a + 1);
      }
      return rc;
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline Ipv4Address & operator ++ ()
    {
      uint32_t  a = ntohl(_addr);
      if (a != 0xFFFFFFFF) {
        _addr = htonl(a + 1);
      }
      return *this;
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline Ipv4Address operator -- (int)
    {
      Ipv4Address rc(*this);
      uint32_t  a = ntohl(_addr);
      if (a != 0) {
        _addr = htonl(a - 1);
      }
      return rc;
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline Ipv4Address & operator -- ()
    {
      uint32_t  a = ntohl(_addr);
      if (a != 0) {
        _addr = htonl(a - 1);
      }
      return *this;
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline Ipv4Address & operator -= (uint32_t i)
    {
      uint32_t  a = ntohl(_addr);
      if (a >= i) {
        _addr = htonl(a - i);
      }
      else {
        _addr = htonl(0);
      }
      return *this;
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline Ipv4Address & operator += (uint32_t i)
    {
      uint32_t  a = ntohl(_addr);
      if ((uint32_t)(a + i) >= a) {
        _addr = htonl(a + i);
      }
      else {
        _addr = htonl(0xFFFFFFFF);
      }
      return *this;
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline bool BitIsSet(int8_t bit) const
    { return (((ntohl(_addr) >> bit) & 1) != 0); }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline int GetBit(int bit) const
    { return (ntohl(_addr) >> (31 - bit)) & 1; }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    static inline uint8_t MaxKeyBits()
    { return 32; }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint64_t StreamedLength() const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::istream & Read(std::istream & is);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    std::ostream & Write(std::ostream & os) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    ssize_t Read(int fd);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    ssize_t Write(int fd) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    size_t Read(FILE * f);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    size_t Write(FILE * f) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int Read(gzFile gzf);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int Write(gzFile gzf) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int BZRead(BZFILE *bzf);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    int BZWrite(BZFILE *bzf) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Read(boost::asio::ip::tcp::socket & s,
              boost::system::error_code & ec)
    { return ASIO_Read(s, ec); }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Write(boost::asio::ip::tcp::socket & s,
               boost::system::error_code & ec) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Read(boost::asio::local::stream_protocol::socket & s,
              boost::system::error_code & ec);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Write(boost::asio::local::stream_protocol::socket & s,
               boost::system::error_code & ec) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Read(boost::asio::generic::stream_protocol::socket & s,
              boost::system::error_code & ec)
    { return ASIO_Read(s, ec); }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Write(boost::asio::generic::stream_protocol::socket & s,       
               boost::system::error_code & ec) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    friend std::ostream & operator << (std::ostream & os, 
                                       const Ipv4Address & addr);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    friend Ipv4Address operator & (const Ipv4Address & addr,
                                   const Ipv4Address & mask);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    uint32_t IpSum() const;
    
  protected:
    uint32_t  _addr;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename Protocol, typename Executor>
    bool ASIO_Read(boost::asio::basic_stream_socket<Protocol,Executor> & s,
              boost::system::error_code & ec)
    {
      using boost::asio::read, boost::asio::buffer;
      return ((read(s, buffer(&_addr, sizeof(_addr)), ec) == sizeof(_addr))
              && (! ec));
    }
  };
 
}  // namespace Dwm
 
#endif  // _DWMIPV4ADDRESS_HH_
 
//---------------------------- emacs settings -----------------------------
//  Local Variables:
//  mode: C++
//  tab-width: 2
//  indent-tabs-mode: nil
//  c-basic-offset: 2
//  End:
//-------------------------------------------------------------------------