IpAddress.h

Go to the documentation of this file.

// Copyright (c) 2008-2025 Optris GmbH & Co. KG

 
#pragma once
 
#include <array>
#include <ostream>
#include <cstdint>
#include <string>
 
#include "otcsdk/Api.h"
#include "otcsdk/Exceptions.h"
 
 
namespace optris 
{
 
class IpAddress
{
public:
  OTC_SDK_API IpAddress() noexcept;

  OTC_SDK_API IpAddress(std::uint32_t address) noexcept;

  OTC_SDK_API IpAddress(const std::string& address);

  OTC_SDK_API IpAddress(std::uint8_t a, std::uint8_t b, std::uint8_t c, std::uint8_t d) noexcept;
 

  OTC_SDK_API void reset();

  OTC_SDK_API void setFromUInt32(std::uint32_t address) noexcept;

  OTC_SDK_API std::uint32_t toUInt32() const noexcept;

  OTC_SDK_API void setFromString(const std::string& address);

  OTC_SDK_API int setFromCidrString(const std::string& address);

  OTC_SDK_API std::string toString() const noexcept;

  OTC_SDK_API std::string toCidrString(int cidr) const noexcept;

  OTC_SDK_API void setByte(int index, std::uint8_t value);

  OTC_SDK_API std::uint8_t getByte(int index) const;

  OTC_SDK_API IpAddress getNetworkPortion(const IpAddress& subnetMask) const noexcept;

  OTC_SDK_API IpAddress getNetworkPortion(int cidr) const;

  OTC_SDK_API IpAddress getHostPortion(const IpAddress& subnetMask) const noexcept;

  OTC_SDK_API IpAddress getHostPortion(int cidr) const;

  OTC_SDK_API IpAddress getBroadcastAddress(const IpAddress& subnetMask) const noexcept;

  OTC_SDK_API IpAddress getBroadcastAddress(int cidr) const;
 

  bool operator==(const IpAddress& rhs) const noexcept;
  bool operator==(std::uint32_t rhs) const noexcept;
  bool operator!=(const IpAddress& rhs) const noexcept;
  bool operator<(const IpAddress& rhs) const noexcept;
 
 
private:
  std::array<std::uint8_t, 4> _bytes;
 

  static std::uint32_t cidrToUInt32(int cidr);
};
 
 
// Utility functions
OTC_SDK_API std::ostream& operator<<(std::ostream& out, const IpAddress& address);
 
 
// Inline implementations
inline bool IpAddress::operator==(const IpAddress& rhs) const noexcept
{
  return _bytes == rhs._bytes;
}
 
inline bool IpAddress::operator==(std::uint32_t rhs) const noexcept
{
  return toUInt32() == rhs;
}
 
inline bool IpAddress::operator!=(const IpAddress& rhs) const noexcept
{
  return !(_bytes == rhs._bytes);
}
 
inline bool IpAddress::operator<(const IpAddress& rhs) const noexcept
{
  return toUInt32() < rhs.toUInt32();
}
 
} // namespace optris