DwmIpv6Address.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $DwmPath$
//===========================================================================
//  Copyright (c) Daniel W. McRobb 2004-2006, 2016, 2020, 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 _DWMIPV6ADDRESS_HH_
#define _DWMIPV6ADDRESS_HH_
 
extern "C" {
  #include <netinet/in.h>
  #include <bzlib.h>
  #include <zlib.h>
}
 
#include <cstdint>
#include <string>
 
#define XXH_INLINE_ALL
#include <xxhash.h>
 
#include "DwmASIO.hh"
 
namespace Dwm {
 
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class Ipv6Address
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv6Address();
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv6Address(const std::string & addr);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv6Address(const struct in6_addr & addr);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    operator std::string () const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    operator struct in6_addr () const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool operator < (const Ipv6Address & addr) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool operator > (const Ipv6Address & addr) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool operator == (const Ipv6Address & addr) const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline bool operator != (const Ipv6Address & addr) const
    { return (! (*this == addr)); }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv6Address & operator &= (const Ipv6Address & netmask);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Ipv6Address operator & (const Ipv6Address & netmask) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool IsLinkLocal() const;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool IsSiteLocal() const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline const uint8_t *RawPointer() const
    {
      return (const uint8_t *)&_addr;
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline const in6_addr & In6Addr() const
    {
      return _addr;
    }
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    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;
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename ST>
    requires IsSupportedASIOSocket<ST>
    bool ASIO_Read(ST & s, boost::system::error_code & ec)
    {
      using boost::asio::read, boost::asio::buffer;
      return ((read(s, buffer(_addr.s6_addr, 16), ec) == 16) && (! ec));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    template <typename ST>
    requires IsSupportedASIOSocket<ST>
    bool ASIO_Write(ST & s, boost::system::error_code & ec) const
    {
      using boost::asio::write, boost::asio::buffer;
      return ((write(s, buffer(_addr.s6_addr, 16), ec) == 16) && (! ec));
    }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    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
    { return ASIO_Write(s, ec); }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Read(boost::asio::local::stream_protocol::socket & s,
              boost::system::error_code & ec)
    { return ASIO_Read(s, ec); }
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Write(boost::asio::local::stream_protocol::socket & s,
               boost::system::error_code & ec) const
    { return ASIO_Write(s, ec); }
      
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    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
    { return ASIO_Write(s, ec); }
      
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    friend std::ostream & operator << (std::ostream & os, 
                                       const Ipv6Address & addr);
 
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    inline uint64_t Hash() const
    {
      return XXH64(_addr.s6_addr, 16, 0);
    }
    
  private:
    alignas(8) struct in6_addr  _addr;
  };
 
}  // namespace Dwm
 
#endif  // _DWMIPV6ADDRESS_HH_
 
//---------------------------- emacs settings -----------------------------
//  Local Variables:
//  mode: C++
//  tab-width: 2
//  indent-tabs-mode: nil
//  c-basic-offset: 2
//  End:
//-------------------------------------------------------------------------