dunedaq::snbmodules::IPFormat Class Reference

Class that represents an IP address and a port TODO: should be replaced by something better ? More...

#include <ip_format.hpp>

Public Member Functions
	IPFormat (const std::string &ip="0.0.0.0", int port=0)
	Constructor that set the IP address and the port.
	IPFormat (const IPFormat &o)
	Copy constructor.
IPFormat &	operator= (IPFormat const &)=default
	Defualt = operator.
bool	operator== (IPFormat const &o) const
	== operator
bool	operator< (IPFormat const &o) const
	< operator
std::string	get_ip_port () const
	Get the IP address and the port in the format "ip:port".
bool	is_default () const
	Check if the IP address and the port are set to the default values.
void	set_port (int port)
char *	strtok_s (char *s, const char *delim, char **context)
void	set_ip (const std::string &ip)
	Set the IP address, must be called after set_port() if the port is specified in the IP address ex 0.0.0.0:1234.
std::string	get_ip () const
int	get_port () const

Private Attributes
std::string	m_ip = "0.0.0.0"
	IP address.
int	m_port = 0
	Port.

Detailed Description

Class that represents an IP address and a port TODO: should be replaced by something better ?

Definition at line 25 of file ip_format.hpp.

Constructor & Destructor Documentation

IPFormat() [1/2]

dunedaq::snbmodules::IPFormat::IPFormat ( const std::string & ip = "0.0.0.0", int port = 0 )

inlineexplicit

Constructor that set the IP address and the port.

Parameters

ip	IP address
port	Port

Definition at line 33 of file ip_format.hpp.

  {
    set_port(port);
    set_ip(ip);
  }

IPFormat() [2/2]

dunedaq::snbmodules::IPFormat::IPFormat ( const IPFormat & o )

inline

Copy constructor.

Definition at line 40 of file ip_format.hpp.

  {
    set_port(o.m_port);
    set_ip(o.m_ip);
  }

Member Function Documentation

get_ip()

std::string dunedaq::snbmodules::IPFormat::get_ip ( ) const

inline

Definition at line 116 of file ip_format.hpp.

{ return m_ip; }

get_ip_port()

std::string dunedaq::snbmodules::IPFormat::get_ip_port ( ) const

inline

Get the IP address and the port in the format "ip:port".

Returns

The IP address and the port in the format "ip:port"

Definition at line 57 of file ip_format.hpp.

{ return m_ip + ":" + std::to_string(m_port); }

get_port()

int dunedaq::snbmodules::IPFormat::get_port ( ) const

inline

Definition at line 117 of file ip_format.hpp.

{ return m_port; }

is_default()

bool dunedaq::snbmodules::IPFormat::is_default ( ) const

inline

Check if the IP address and the port are set to the default values.

Returns

True if the IP address and the port are set to the default values, false otherwise

Definition at line 61 of file ip_format.hpp.

{ return m_ip == "0.0.0.0" && m_port == 0; }

operator<()

bool dunedaq::snbmodules::IPFormat::operator< ( IPFormat const & o ) const

inline

< operator

Definition at line 53 of file ip_format.hpp.

{ return m_ip.compare(o.m_ip) || (m_ip == o.m_ip && m_port < o.m_port); }

operator=()

IPFormat & dunedaq::snbmodules::IPFormat::operator= ( IPFormat const & )

default

Defualt = operator.

operator==()

bool dunedaq::snbmodules::IPFormat::operator== ( IPFormat const & o ) const

inline

== operator

Definition at line 50 of file ip_format.hpp.

{ return m_ip == o.m_ip && m_port == o.m_port; }

set_ip()

void dunedaq::snbmodules::IPFormat::set_ip ( const std::string & ip )

inline

Set the IP address, must be called after set_port() if the port is specified in the IP address ex 0.0.0.0:1234.

Definition at line 80 of file ip_format.hpp.

  {
    if (ip.empty()) {
      throw std::invalid_argument("IP address cannot be empty");
    }
 
    // Splitting the string IP:PORT or IP
    std::vector<std::string> ip_port_pair;
    char* next_token = nullptr;
 
    char* ip_char = new char[ip.length() + 1];
    strcpy(ip_char, ip.c_str());
 
    char* token = strtok_s(ip_char, ":", &next_token);
    while (token != nullptr) {
      ip_port_pair.emplace_back(std::string(token));
      token = strtok_s(nullptr, ":", &next_token);
    }
 
    delete[] ip_char;
 
    if (ip_port_pair.size() != 1 && ip_port_pair.size() != 2) {
      throw std::invalid_argument("Invalid IP address format (IP:PORT or IP)");
    }
 
    // TODO Aug-14-2022 Leo Joly leo.vincent.andre.joly@cern.ch : Check if the IPv4 address is valid
 
    // set values
    if (ip_port_pair.size() == 2) {
      set_port(std::stoi(ip_port_pair[1]));
    }
 
    m_ip = ip_port_pair[0];
  }

set_port()

void dunedaq::snbmodules::IPFormat::set_port ( int port )

inline

Definition at line 64 of file ip_format.hpp.

  {
 
    if (port < 0 || port > 65535) {
      throw std::invalid_argument("Port must be between 0 and 65535");
    }
 
    m_port = port;
  }

strtok_s()

char * dunedaq::snbmodules::IPFormat::strtok_s ( char * s, const char * delim, char ** context )

inline

Definition at line 75 of file ip_format.hpp.

{ return strtok_r(s, delim, context); }

Member Data Documentation

m_ip

std::string dunedaq::snbmodules::IPFormat::m_ip = "0.0.0.0"

private

IP address.

Definition at line 121 of file ip_format.hpp.

m_port

int dunedaq::snbmodules::IPFormat::m_port = 0

private

Port.

Definition at line 123 of file ip_format.hpp.

---

The documentation for this class was generated from the following file:

• /github/workspace/dunedaq/sourcecode/snbmodules/include/snbmodules/ip_format.hpp