#include <XrdNetUtils.hh>

Public Types
enum	AddrOpts { allIPMap = 0 , allIPv64 = 1 , allV4Map = 2 , onlyIPv6 = 3 , onlyIPv4 = 4 , prefIPv6 = 8 , prefAuto = 16 , order46 = 32 , order64 = 64 , onlyUDP =128 }

enum	NetProt { hasNone = 0 , hasIPv4 = 1 , hasIPv6 = 2 , hasIP64 = 3 , hasPub4 = 4 , hasPub6 = 8 }

enum	NetType { qryINET = 0 , qryINIF = 1 }

Public Member Functions
	XrdNetUtils ()
	Constructor.

	~XrdNetUtils ()
	Destructor.

Static Public Member Functions
static int	Decode (XrdNetSockAddr sadr, const char buff, int blen)

static int	Encode (const XrdNetSockAddr sadr, char buff, int blen, int port=-1)

static const char *	GetAddrs (const char hSpec, XrdNetAddr aListP[], int &aListN, AddrOpts opts=allIPMap, int pNum=PortInSpec)

static const char *	GetAddrs (const std::string &hSpec, std::vector< XrdNetAddr > &aVec, int *ordn=0, AddrOpts opts=allIPMap, int pNum=PortInSpec)

static const char *	GetAddrs (std::vector< std::string > &hSVec, std::vector< XrdNetAddr > &aVec, int *ordn=0, AddrOpts opts=allIPMap, unsigned int rotNum=0, bool force=false)

static int	GetSokInfo (int fd, char *theAddr, int theALen, char &theType)

static XrdOucTList *	Hosts (const char hSpec, int hPort=-1, int hWant=8, int sPort=0, const char **eText=0)

static int	IPFormat (const struct sockaddr sAddr, char bP, int bL, int opts=0)

static int	IPFormat (int fd, char *bP, int bL, int opts=0)

static bool	Match (const char hName, const char pattern)

static char *	MyHostName (const char eName="unknown", const char *eText=0)

static NetProt	NetConfig (NetType netquery=qryINET, const char **eText=0)

static bool	Parse (const char hSpec, const char hName, const char hNend, const char hPort, const char *hPend)

static int	Port (int fd, const char **eText=0)

static int	ProtoID (const char *pName)

static int	ServPort (const char sName, bool isUDP=false, const char *eText=0)

static int	SetAuto (AddrOpts aOpts=allIPMap)

static bool	Singleton (const char hSpec, const char *eText=0)

Static Public Attributes
static const int	PortInSpec = (int)0x80000000

static const int	NoPortRaw = (int)0xC0000000

static const int	noPort = 1

static const int	oldFmt = 2

Static Private Member Functions
static void	FillAddr (XrdNetSpace::hpSpec &aBuff, XrdNetAddr aVec, int ordn=0, unsigned int rotNum=0)

static const char *	GetAInfo (XrdNetSpace::hpSpec &aBuff)

static void	GetHints (XrdNetSpace::hpSpec &aBuff, AddrOpts opts)

static const char *	GetHostPort (XrdNetSpace::hpSpec &aBuff, const char *hSpec, int pNum)

static const char *	getMyFQN (const char *&myDom)

static int	setET (const char **errtxt, int rc)

Static Private Attributes
static int	autoFamily

static int	autoHints

Member Enumeration Documentation

◆ AddrOpts

enum XrdNetUtils::AddrOpts

Version 1: Return multiple addresses associated with a host or IP address.

Parameters

hSpec	-> convert specification to addresses. Valid formats: IP.v4: nnn.nnn.nnn.nnn[:<port>] IP.v6: [ipv6_addr][:<port>] IP.xx: name[:port] xx is determined by getaddrinfo()
aListP	place where the pointer to the returned array of XrdNetAddr objects is to be placed. Set to zero if none returned. The caller must delete this array when no longer needed.
aListN	place where the number of elements in aListP are to be returned.
opts	Options on what to return. Choose one of: allIPMap - all IPv6 and mapped IPv4 addrs (default) allIPv64 - all IPv6 and unmapped IPv4 addrs allV4Map - all mapped IPV4 addrs. onlyIPv6 - only IPv6 addrs onlyIPv4 - only unmapped IPv4 addrs prefIPv6 - only IPv6 addrs; if none, mapped IPv4 addrs prefAuto - Returns addresses based on configured non-local interfaces. The returned addresses will be normally useable on this host and may be IPv4, IPv6, mapped IPv4, or a mixture. The above may be or'd with one or more of the following: onlyUDP - only addrs valid for UDP connections else TCP order46 - List IPv4 addresses (mapped or native) first. order64 - List IPv6 addresses first.
pNum	>= 0 uses the value as the port number regardless of what is in hSpec, should it be supplied. However, if is present, it must be a valid port number. < 0 uses the positive value as the port number if the port number has not been specified in hSpec. ** When set to PortInSpec(the default, see below) the port number/name must be specified in hSpec. If it is not, an error is returned. ** When set to NoPortRaw then hSpec does not contain a port number and is a host name, IPv4 address, or an IPv6 address without surrounding brackets.

Returns: Success: 0 with aListN set to the number of elements in aListP. Failure: the error message text describing the error and aListP and aListN is set to zero.

Enumerator
allIPMap
allIPv64
allV4Map
onlyIPv6
onlyIPv4
prefIPv6
prefAuto
order46
order64
onlyUDP

◆ NetProt

enum XrdNetUtils::NetProt

Get the supported network protocols.

Parameters

netqry	An NetType enum specifying the protocol to inspect.
eText	When not nil, is where to place error message text.

Returns: One the the NetProt enums (see below). When hasNone is returned and eText is not nill it will point to a static string that gives the reason. If the reason is a null string, the query was successful but returned no matching protocols.

Enumerator
hasNone	Unable to determine available protocols.
hasIPv4
hasIPv6
hasIP64
hasPub4
hasPub6

◆ NetType

enum XrdNetUtils::NetType

Enumerator
qryINET	Only consider internet protocols via DNS.
qryINIF	Only consider internet protocols via ifconfig.

Constructor & Destructor Documentation

◆ XrdNetUtils()

XrdNetUtils::XrdNetUtils ( )

inline

Constructor.

◆ ~XrdNetUtils()

XrdNetUtils::~XrdNetUtils ( )

inline

Destructor.

Member Function Documentation

◆ Decode()

static int XrdNetUtils::Decode	(	XrdNetSockAddr *	sadr,
		const char *	buff,
		int	blen
	)

static

Decode an "encoded" ipv6/4 address and place it "sockaddr" type structure.

Parameters

sadr	address of the union that will hold the results.
buff	address of buffer that holds the encoding.
blen	length of the string (it need not be null terminated).

Returns: > 0 the port number in host byte order. = 0 the port number was not set. < 0 the encoding was not correct.

◆ Encode()

static int XrdNetUtils::Encode	(	const XrdNetSockAddr *	sadr,
		char *	buff,
		int	blen,
		int	port = `-1`
	)

static

Encode the address and return it in a supplied buffer.

Parameters

sadr	address of the union that holds the IPV4/6 address.
buff	address of buffer to hold the null terminated encoding.
blen	length of the buffer. It6 should be at least 40 bytes.
port	optional port value to use as opposed to the one present in sockaddr sadr. The port must be in host order.

Returns: > 0 the length of the encoding less the null byte. = 0 current address format not supported for encoding. < 0 buffer is too small; abs(retval) bytes needed.

◆ FillAddr()

static void XrdNetUtils::FillAddr	(	XrdNetSpace::hpSpec &	aBuff,
		XrdNetAddr *	aVec,
		int *	ordn = `0`,
		unsigned int	rotNum = `0`
	)

staticprivate

◆ GetAddrs() [1/3]

static const char * XrdNetUtils::GetAddrs	(	const char *	hSpec,
		XrdNetAddr *	aListP[],
		int &	aListN,
		AddrOpts	opts = `allIPMap`,
		int	pNum = `PortInSpec`
	)

static

◆ GetAddrs() [2/3]

static const char * XrdNetUtils::GetAddrs	(	const std::string &	hSpec,
		std::vector< XrdNetAddr > &	aVec,
		int *	ordn = `0`,
		AddrOpts	opts = `allIPMap`,
		int	pNum = `PortInSpec`
	)

static

Version 2: Return multiple addresses associated with a host or IP address.

Parameters

hSpec	Reference to address specification (see version 1).
aVec	Reference to the vector to contain addresses.
ordn	Pointer to where the partition ordinal is to be stored.
opts	Options on what to return (see version 1).
pNum	Port number argument (see version 1).

Returns: Success: 0 is returned. When ordn is not nil, the number of IPv4 entries (for order46) or IPv6 (for order64) entries that appear in the front of the vector. If ordering is not specified, the value is set to the size of the vector. Failure: the error message text describing the error and aVec is cleared (i.e. has no elements).

◆ GetAddrs() [3/3]

static const char * XrdNetUtils::GetAddrs	(	std::vector< std::string > &	hSVec,
		std::vector< XrdNetAddr > &	aVec,
		int *	ordn = `0`,
		AddrOpts	opts = `allIPMap`,
		unsigned int	rotNum = `0`,
		bool	force = `false`
	)

static

Version 3: Return multiple addresses associated with a list of host or IP addresses.

Parameters

hSVec	vector of address specification (see version 1). Note that this version requires hSVec entries to have a port number.
aVec	Reference to the vector to contain addresses.
ordn	Pointer to where the partition ordinal is to be stored.
opts	Options on what to return (see version 1).
rotNum	The rotation factor to order addresses in the result.
force	When true resolution errors are ignored.

Returns: Success: 0 is returned. When ordn is not nil, the number of IPv4 entries (for order46) or IPv6 (for order64) entries that appear in the front of the vector. If ordering is not specified, the value is set to the size of the vector. Failure: the error message text describing the error and aVec is cleared (i.e. has no elements).

◆ GetAInfo()

static const char * XrdNetUtils::GetAInfo ( XrdNetSpace::hpSpec & aBuff )

staticprivate

◆ GetHints()

static void XrdNetUtils::GetHints	(	XrdNetSpace::hpSpec &	aBuff,
		AddrOpts	opts
	)

staticprivate

◆ GetHostPort()

static const char * XrdNetUtils::GetHostPort	(	XrdNetSpace::hpSpec &	aBuff,
		const char *	hSpec,
		int	pNum
	)

staticprivate

◆ getMyFQN()

static const char * XrdNetUtils::getMyFQN ( const char *& myDom )

staticprivate

◆ GetSokInfo()

static int XrdNetUtils::GetSokInfo	(	int	fd,
		char *	theAddr,
		int	theALen,
		char &	theType
	)

static

Obtain connection information from a socket.

Parameters

fd	The file descriptor of the socket whose address is to be converted. The sign of the fd indicates which address: fd > 0 the peer address is used (i.e. getpeername) fd < 0 the local address is used (i.e. getsockname)
theAddr	pointer to a buffer of theAlen bytes where the text version of the IP address is to be returned. The text uses the actual native address format. If theAddr is nil or theAlen is not positive, only the port and address type are returned.
theALen	length of the theAddr buffer.
theType	either the character 4 (IPv4) or 6 (IPv6) is returned. corrresponding to the address family. Note that should be AF_INET6 but the address is mapped, '4' is returned.

Returns: Success: >= 0 corresponding to the port number.; Failure: < 0 corresponding to -errno.

◆ Hosts()

static XrdOucTList * XrdNetUtils::Hosts	(	const char *	hSpec,
		int	hPort = `-1`,
		int	hWant = `8`,
		int *	sPort = `0`,
		const char **	eText = `0`
	)

static

Obtain an easily digestable list of hosts. This is the list of up to eight unique aliases (i.e. with different addresses) assigned to a base hostname.

Parameters

hSpec	the host specification suitable for XrdNetAddr.Set().
hPort	When >= 0 specified the port to use regardless of hSpec. When < 0 the port must be present in hSpec.
hWant	Maximum number of list entries wanted. If hWant is greater that eight it is set eigth.
sPort	If not nil, the *sPort will be set to hPort if and only if the IP address in one of the entries matches the host address. Otherwise, the value is unchanged.
eText	When not nil, is where to place error message text.

Returns: Success: Pointer to a list of XrdOucTList objects where p->val is the port number p->text is the host name. The list of objects belongs to the caller. Failure: A nil pointer is returned. If eText is supplied, the error message, in persistent storage, is returned.

◆ IPFormat() [1/2]

static int XrdNetUtils::IPFormat	(	const struct sockaddr *	sAddr,
		char *	bP,
		int	bL,
		int	opts = `0`
	)

static

◆ IPFormat() [2/2]

static int XrdNetUtils::IPFormat	(	int	fd,
		char *	bP,
		int	bL,
		int	opts = `0`
	)

static

Convert an IP socket address/port (V4 or V6) into the standard V6 RFC ASCII representation: "[address]:port".

Parameters

fd	The file descriptor of the socket whose address is to be converted. The sign of the fd indicates which address: fd > 0 the peer address is used (i.e. getpeername) fd < 0 the local address is used (i.e. getsockname)
bP	points to a buffer large enough to hold the result. A buffer 64 characters long will always be big enough.
bL	the actual size of the buffer.
opts	Formating options: noPort - does not suffix the port number with ":port". oldFmt - use the deprecated format for an IPV4 mapped address: [::d.d.d.d] vs [::ffff:d.d.d.d].

Returns: Success: The length of the formatted address is returned.; Failure: Zero is returned and the buffer state is undefined. Failure occurs when the buffer is too small or the file descriptor does not refer to an open socket.

◆ Match()

static bool XrdNetUtils::Match	(	const char *	hName,
		const char *	pattern
	)

static

Determine if a hostname matches a pattern.

Parameters

hName the name of the host.

pattern the pattern to match against. The pattern may contain one If the pattern contains a single asterisk, then the prefix of hName is compared with the characters before the '*' and the suffix of hName is compared with the character after. If the pattern ends with a plus, the all then pattern is taken as a hostname (less '+') and expanded to all possible hostnames and each one is compared with hName. If the pattern contains both, the asterisk rule is used first. If it contains neither then strict equality is used.

Returns: Success: True, the pattern matches. Failure: False, no match found.

◆ MyHostName()

static char * XrdNetUtils::MyHostName	(	const char *	eName = `"unknown"`,
		const char **	eText = `0`
	)

static

Get the fully qualified name of the current host.

Parameters

eName	The name to be returned when the host name or its true address could not be returned. The pointer may be nil.
eText	When supplied will hold 0 if no errors occurred or error message text, in persistent storage, describing why the error-triggered alternate name was returned. If it contains neither then strict equality is used.

Returns: An strdup() copy of the host name, address , or eName; unless eName is nil, in which case a nil pointer is returned. The caller is responsible for freeing any returned string using free().

◆ NetConfig()

static NetProt XrdNetUtils::NetConfig	(	NetType	netquery = `qryINET`,
		const char **	eText = `0`
	)

static

◆ Parse()

static bool XrdNetUtils::Parse	(	const char *	hSpec,
		const char **	hName,
		const char **	hNend,
		const char **	hPort,
		const char **	hPend
	)

static

Parse an IP or host name specification.

Parameters

hSpec	the name or IP address of the host. As one of the following "[<ipv6>]:<port>", "<ipv4>:<port>", or "<name>:<port>".
hName	place where the starting address of the host is placed.
hNend	place where the ending address+1 is placed. This will point to either ']', ':', or a null byte.
hPort	place where the starting address of the port is placed. If no ":port" was found, this will contain *hNend.
hPend	place where the ending address+1 is placed. If no port If no ":port" was found, this will contain *hNend.

Returns: Success: True. Failure: False, hSpec is not valid. Some output parameters may have been set but shlould be ignored.

◆ Port()

static int XrdNetUtils::Port	(	int	fd,
		const char **	eText = `0`
	)

static

Obtain the numeric port associated with a file descriptor.

Parameters

fd	the file descriptor number.
eText	when not null, the reason for a failure is returned.

Returns: Success: The positive port number. Failure: 0 is returned and if eText is not null, the error message.

◆ ProtoID()

static int XrdNetUtils::ProtoID ( const char * pName )

static

Obtain the protocol identifier.

Parameters

pName the name of the protocol (e.g. "tcp").

Returns: The protocol identifier.

◆ ServPort()

static int XrdNetUtils::ServPort	(	const char *	sName,
		bool	isUDP = `false`,
		const char **	eText = `0`
	)

static

Obtain the numeric port corresponding to a symbolic name.

Parameters

sName	the name of the service or a numeric port number.
isUDP	if true, returns the UDP service port o/w the TCP service
eText	when not null, the reason for a failure is returned.

Returns: Success: The positive port number. Failure: 0 is returned and if eText is not null, the error message.

◆ SetAuto()

static int XrdNetUtils::SetAuto ( AddrOpts aOpts = allIPMap )

static

Set the family and hints to be used in GetAddrs() with prefAuto. This is used within this class and by XrdNetAddr when the IP mode changes. It is meant for internal use only.

Parameters

aOpts Is one of the following from the AddrOpts enum: allIPMap - Use IPv6 and mapped IPv4 addrs (default) onlyIPv4 - Use only IPv4 addresses. prefAuto - Determine proper options based on configuration.

Returns: The getaddrinfo() hints value that should be used.

◆ setET()

static int XrdNetUtils::setET	(	const char **	errtxt,
		int	rc
	)

staticprivate

◆ Singleton()

static bool XrdNetUtils::Singleton	(	const char *	hSpec,
		const char **	eText = `0`
	)

static

Check if whether or not a host name represents more than one unique host.

Parameters

hSpec	the host specification suitable for XrdNetAddr.Set().
eText	When not nil, is where to place error message text.

Returns: True is this is a simple single host. False if the name represensts more than one single host.

Member Data Documentation

◆ autoFamily

int XrdNetUtils::autoFamily

staticprivate

◆ autoHints

int XrdNetUtils::autoHints

staticprivate

◆ noPort

const int XrdNetUtils::noPort = 1

static

Convert an IP address/port (V4 or V6) into the standard V6 RFC ASCII representation: "[address]:port".

Parameters

sAddr	Address to convert. This is either sockaddr_in or sockaddr_in6 cast to struct sockaddr.
bP	points to a buffer large enough to hold the result. A buffer 64 characters long will always be big enough.
bL	the actual size of the buffer.
opts	Formating options: noPort - does not suffix the port number with ":port". oldFmt - use the deprecated format for an IPV4 mapped address: [::d.d.d.d] vs [::ffff:d.d.d.d].

Returns: Success: The length of the formatted address is returned.; Failure: Zero is returned and the buffer state is undefined. Failure occurs when the buffer is too small or the address family (sAddr->sa_family) is neither AF_INET nor AF_INET6.

◆ NoPortRaw

const int XrdNetUtils::NoPortRaw = (int)0xC0000000

static

◆ oldFmt

const int XrdNetUtils::oldFmt = 2

static

◆ PortInSpec

const int XrdNetUtils::PortInSpec = (int)0x80000000

static

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

XrdNetUtils.hh

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Static Private Member Functions

Static Private Attributes

Member Enumeration Documentation

◆ AddrOpts

◆ NetProt

◆ NetType

Constructor & Destructor Documentation

◆ XrdNetUtils()

◆ ~XrdNetUtils()

Member Function Documentation

◆ Decode()

◆ Encode()

◆ FillAddr()

◆ GetAddrs() [1/3]

◆ GetAddrs() [2/3]

◆ GetAddrs() [3/3]

◆ GetAInfo()

◆ GetHints()

◆ GetHostPort()

◆ getMyFQN()

◆ GetSokInfo()

◆ Hosts()

◆ IPFormat() [1/2]

◆ IPFormat() [2/2]

◆ Match()

◆ MyHostName()

◆ NetConfig()

◆ Parse()

◆ Port()

◆ ProtoID()

◆ ServPort()

◆ SetAuto()

◆ setET()

◆ Singleton()

Member Data Documentation

◆ autoFamily

◆ autoHints

◆ noPort

◆ NoPortRaw

◆ oldFmt

◆ PortInSpec