Wrapper for (un)resolved network addresses; there's no reason to transform a numeric IP to a string and then back again to pass it to functions. More...

#include <address.h>

Public Member Functions
	NetworkAddress (struct sockaddr_storage &address, int address_length)
	Create a network address based on a resolved IP and port.

	NetworkAddress (const sockaddr *address, int address_length)
	Create a network address based on a resolved IP and port.

	NetworkAddress (std::string_view hostname="", uint16_t port=0, int family=AF_UNSPEC)
	Create a network address based on a unresolved host and port.

const std::string &	GetHostname ()
	Get the hostname; in case it wasn't given the IPv4 dotted representation is given.

std::string	GetAddressAsString (bool with_family=true)
	Get the address as a string, e.g.

const sockaddr_storage *	GetAddress ()
	Get the address in its internal representation.

int	GetAddressLength ()
	Get the (valid) length of the address.

uint16_t	GetPort () const
	Get the port.

void	SetPort (uint16_t port)
	Set the port.

bool	IsResolved () const
	Check whether the IP address has been resolved already.

bool	IsFamily (int family)
	Checks of this address is of the given family.

bool	IsInNetmask (std::string_view netmask)
	Checks whether this IP address is contained by the given netmask.

int	CompareTo (NetworkAddress &address)
	Compare the address of this class with the address of another.

bool	operator== (NetworkAddress &address)
	Compare the address of this class with the address of another.

bool	operator== (NetworkAddress &address) const
	Compare the address of this class with the address of another.

auto	operator<=> (NetworkAddress &address)
	Compare the address of this class with the address of another.

void	Listen (int socktype, SocketList *sockets)
	Make the given socket listen.

Static Public Member Functions
static std::string_view	SocketTypeAsString (int socktype)
	Convert the socket type into a string.

static std::string_view	AddressFamilyAsString (int family)
	Convert the address family into a string.

static NetworkAddress	GetPeerAddress (SOCKET sock)
	Get the peer address of a socket as NetworkAddress.

static NetworkAddress	GetSockAddress (SOCKET sock)
	Get the local address of a socket as NetworkAddress.

static const std::string	GetPeerName (SOCKET sock)
	Get the peer name of a socket in string format.

Private Types
typedef SOCKET(*	LoopProc) (addrinfo *runp)
	Helper function to resolve something to a socket.

Private Member Functions
SOCKET	Resolve (int family, int socktype, int flags, SocketList *sockets, LoopProc func)
	Resolve this address into a socket.

Private Attributes
std::string	hostname {}
	The hostname.

int	address_length {}
	The length of the resolved address.

sockaddr_storage	address {}
	The resolved address.

bool	resolved = false
	Whether the address has been (tried to be) resolved.

Detailed Description

Wrapper for (un)resolved network addresses; there's no reason to transform a numeric IP to a string and then back again to pass it to functions.

It furthermore allows easier delaying of the hostname lookup.

Definition at line 28 of file address.h.

Member Typedef Documentation

◆ LoopProc

typedef SOCKET(* NetworkAddress::LoopProc) (addrinfo *runp)

private

Helper function to resolve something to a socket.

Parameters

runp	information about the socket to try not

Returns: the opened socket or INVALID_SOCKET

Definition at line 40 of file address.h.

Constructor & Destructor Documentation

◆ NetworkAddress() [1/3]

NetworkAddress::NetworkAddress	(	struct sockaddr_storage &	address,
		int	address_length
	)

inline

Create a network address based on a resolved IP and port.

Parameters

address	The IP address with port.
address_length	The length of the address.

Definition at line 49 of file address.h.

◆ NetworkAddress() [2/3]

NetworkAddress::NetworkAddress	(	const sockaddr *	address,
		int	address_length
	)

inline

Create a network address based on a resolved IP and port.

Parameters

address	The IP address with port.
address_length	The length of the address.

Definition at line 61 of file address.h.

References address, and address_length.

◆ NetworkAddress() [3/3]

NetworkAddress::NetworkAddress	(	std::string_view	hostname = `""`,
		uint16_t	port = `0`,
		int	family = `AF_UNSPEC`
	)

inline

Create a network address based on a unresolved host and port.

Parameters

hostname	the unresolved hostname
port	the port
family	the address family

Definition at line 74 of file address.h.

References address, hostname, and SetPort().

Member Function Documentation

◆ AddressFamilyAsString()

std::string_view NetworkAddress::AddressFamilyAsString ( int family )

static

Convert the address family into a string.

Parameters

family the family to convert

Returns: the string representation

Note: only works for AF_INET, AF_INET6 and AF_UNSPEC

Definition at line 382 of file address.cpp.

Referenced by TCPConnecter::Connect(), ListenLoopProc(), and Resolve().

◆ CompareTo()

int NetworkAddress::CompareTo ( NetworkAddress & address )

inline

Compare the address of this class with the address of another.

Parameters

address the other address.

Returns: < 0 if address is less, 0 if equal and > 0 if address is more

Definition at line 122 of file address.h.

References address, GetAddressLength(), and GetPort().

Referenced by operator<=>(), operator==(), and operator==().

◆ GetAddress()

const sockaddr_storage * NetworkAddress::GetAddress ( )

Get the address in its internal representation.

Returns: the address

Definition at line 114 of file address.cpp.

References address, IsResolved(), Resolve(), resolved, and ResolveLoopProc().

Referenced by TCPConnecter::Connect(), GetAddressAsString(), GetAddressLength(), IsInNetmask(), and NetworkUDPSocketHandler::SendPacket().

◆ GetAddressAsString()

std::string NetworkAddress::GetAddressAsString ( bool with_family = true )

Get the address as a string, e.g.

127.0.0.1:12345.

Parameters

with_family whether to add the family (e.g. IPvX).

Returns: the address

Definition at line 95 of file address.cpp.

References GetAddress(), GetAddressFormatString(), GetHostname(), and GetPort().

Referenced by TCPConnecter::Connect(), GetPeerName(), NetworkUDPSocketHandler::HandleUDPPacket(), ListenLoopProc(), TCPConnecter::OnResolved(), ClientNetworkUDPSocketHandler::Receive_SERVER_RESPONSE(), NetworkUDPSocketHandler::ReceiveInvalidPacket(), NetworkUDPSocketHandler::ReceivePackets(), and NetworkUDPSocketHandler::SendPacket().

◆ GetAddressLength()

int NetworkAddress::GetAddressLength ( )

inline

Get the (valid) length of the address.

Returns: the length

Definition at line 95 of file address.h.

References address_length, GetAddress(), and IsResolved().

Referenced by CompareTo(), IsInNetmask(), and NetworkUDPSocketHandler::SendPacket().

◆ GetHostname()

const std::string & NetworkAddress::GetHostname ( )

Get the hostname; in case it wasn't given the IPv4 dotted representation is given.

Returns: the hostname

Definition at line 24 of file address.cpp.

References address, address_length, hostname, and NETWORK_HOSTNAME_LENGTH.

Referenced by TCPListenHandler< Tsocket, Tfull_packet, Tban_packet >::AcceptClient(), ClientNetworkCoordinatorSocketHandler::ConnectSuccess(), GetAddressAsString(), ServerNetworkGameSocketHandler::GetClientIP(), ServerNetworkUDPSocketHandler::Receive_CLIENT_FIND_SERVER(), and TCPConnecter::Resolve().

◆ GetPeerAddress()

NetworkAddress NetworkAddress::GetPeerAddress ( SOCKET sock )

static

Get the peer address of a socket as NetworkAddress.

Parameters

sock	The socket to get the peer address of.

Returns: The NetworkAddress of the peer address.

Definition at line 397 of file address.cpp.

References Debug, and NetworkError::GetLast().

Referenced by GetPeerName(), NetworkDirectConnecter::OnConnect(), and NetworkReuseStunConnecter::OnConnect().

◆ GetPeerName()

const std::string NetworkAddress::GetPeerName ( SOCKET sock )

static

Get the peer name of a socket in string format.

Parameters

sock	The socket to get the peer name of.

Returns: The string representation of the peer name.

Definition at line 429 of file address.cpp.

References GetAddressAsString(), and GetPeerAddress().

Referenced by TCPConnecter::CheckActivity().

◆ GetPort()

uint16_t NetworkAddress::GetPort ( ) const

Get the port.

Returns: the port.

Definition at line 39 of file address.cpp.

References address.

Referenced by CompareTo(), TCPConnecter::Connect(), GetAddressAsString(), TCPConnecter::Resolve(), and Resolve().

◆ GetSockAddress()

NetworkAddress NetworkAddress::GetSockAddress ( SOCKET sock )

static

Get the local address of a socket as NetworkAddress.

Parameters

sock	The socket to get the local address of.

Returns: The NetworkAddress of the local address.

Definition at line 413 of file address.cpp.

References Debug, and NetworkError::GetLast().

Referenced by NetworkStunConnecter::OnConnect().

◆ IsFamily()

bool NetworkAddress::IsFamily ( int family )

Checks of this address is of the given family.

Parameters

family the family to check against

Returns: true if it is of the given family

Definition at line 133 of file address.cpp.

References address, IsResolved(), Resolve(), and ResolveLoopProc().

Referenced by NetworkUDPSocketHandler::SendPacket().

◆ IsInNetmask()

bool NetworkAddress::IsInNetmask ( std::string_view netmask )

Checks whether this IP address is contained by the given netmask.

Parameters

netmask the netmask in CIDR notation to test against.

Note: netmask without /n assumes all bits need to match.

Returns: true if this IP is within the netmask.

Definition at line 147 of file address.cpp.

References address, GetAddress(), GetAddressLength(), IsResolved(), and StringConsumer::SKIP_ONE_SEPARATOR.

◆ IsResolved()

bool NetworkAddress::IsResolved ( ) const

inline

Check whether the IP address has been resolved already.

Returns: true iff the port has been resolved

Definition at line 109 of file address.h.

References resolved.

Referenced by GetAddress(), GetAddressLength(), IsFamily(), and IsInNetmask().

◆ Listen()

void NetworkAddress::Listen	(	int	socktype,
		SocketList *	sockets
	)

Make the given socket listen.

Parameters

socktype	the type of socket (TCP, UDP, etc)
sockets	the list of sockets to add the sockets to

Definition at line 345 of file address.cpp.

References address, address_length, ListenLoopProc(), and Resolve().

◆ operator<=>()

auto NetworkAddress::operator<=> ( NetworkAddress & address )

inline

Compare the address of this class with the address of another.

Parameters

address the other address.

Definition at line 155 of file address.h.

References CompareTo().

◆ operator==() [1/2]

bool NetworkAddress::operator== ( NetworkAddress & address )

inline

Compare the address of this class with the address of another.

Parameters

address the other address.

Returns: true if both match.

Definition at line 136 of file address.h.

References CompareTo().

◆ operator==() [2/2]

bool NetworkAddress::operator== ( NetworkAddress & address ) const

inline

Compare the address of this class with the address of another.

Parameters

address the other address.

Returns: true if both match.

Definition at line 146 of file address.h.

References address, and CompareTo().

◆ Resolve()

SOCKET NetworkAddress::Resolve	(	int	family,
		int	socktype,
		int	flags,
		SocketList *	sockets,
		LoopProc	func
	)

private

Resolve this address into a socket.

Parameters

family	the type of 'protocol' (IPv4, IPv6)
socktype	the type of socket (TCP, UDP, etc)
flags	the flags to send to getaddrinfo
sockets	the list of sockets to add the sockets to
func	the inner working while looping over the address info

Returns: the resolved socket or INVALID_SOCKET.

Definition at line 202 of file address.cpp.

References address, address_length, AddressFamilyAsString(), Debug, FS2OTTD(), GetPort(), hostname, ResolveLoopProc(), and SocketTypeAsString().

Referenced by GetAddress(), IsFamily(), and Listen().

◆ SetPort()

void NetworkAddress::SetPort ( uint16_t port )

Set the port.

Parameters

port	set the port number.

Definition at line 58 of file address.cpp.

References address.

Referenced by NetworkAddress().

◆ SocketTypeAsString()

std::string_view NetworkAddress::SocketTypeAsString ( int socktype )

static

Convert the socket type into a string.

Parameters

socktype the socket type to convert

Returns: the string representation

Note: only works for SOCK_STREAM and SOCK_DGRAM

Definition at line 367 of file address.cpp.

Referenced by TCPConnecter::Connect(), ListenLoopProc(), and Resolve().

Field Documentation

◆ address

sockaddr_storage NetworkAddress::address {}

private

The resolved address.

Definition at line 32 of file address.h.

Referenced by CompareTo(), GetAddress(), GetHostname(), GetPort(), IsFamily(), IsInNetmask(), Listen(), NetworkAddress(), NetworkAddress(), operator==(), Resolve(), and SetPort().

◆ address_length

int NetworkAddress::address_length {}

private

The length of the resolved address.

Definition at line 31 of file address.h.

Referenced by GetAddressLength(), GetHostname(), Listen(), NetworkAddress(), and Resolve().

◆ hostname

std::string NetworkAddress::hostname {}

private

The hostname.

Definition at line 30 of file address.h.

Referenced by GetHostname(), NetworkAddress(), and Resolve().

◆ resolved

bool NetworkAddress::resolved = false

private

Whether the address has been (tried to be) resolved.

Definition at line 33 of file address.h.

Referenced by GetAddress(), and IsResolved().

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

src/network/core/address.h
src/network/core/address.cpp

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ LoopProc

Constructor & Destructor Documentation

◆ NetworkAddress() [1/3]

◆ NetworkAddress() [2/3]

◆ NetworkAddress() [3/3]

Member Function Documentation

◆ AddressFamilyAsString()

◆ CompareTo()

◆ GetAddress()

◆ GetAddressAsString()

◆ GetAddressLength()

◆ GetHostname()

◆ GetPeerAddress()

◆ GetPeerName()

◆ GetPort()

◆ GetSockAddress()

◆ IsFamily()

◆ IsInNetmask()

◆ IsResolved()

◆ Listen()

◆ operator<=>()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ Resolve()

◆ SetPort()

◆ SocketTypeAsString()

Field Documentation

◆ address

◆ address_length

◆ hostname

◆ resolved