XrdNetIF Class Reference

#include <XrdNetIF.hh>

Collaboration diagram for XrdNetIF:

Public Types
enum	ifType {   PublicV4 = 0 ,   PrivateV4 = 1 ,   PublicV6 = 2 ,   PrivateV6 = 3 ,   PrivateIF = 1 ,   ifNum = 4 ,   Public46 = 4 ,   Private46 = 5 ,   Public64 = 6 ,   Private64 = 7 ,   ifMax = 8 ,   ifAny = 8 }
	The enum that is used to index into ifData to get appropriate interface. More...
enum	netType {   netDefault = 0 ,   netSplit ,   netCommon ,   netLocal }

Public Member Functions
	XrdNetIF ()
	Constructor and Destructor.
	~XrdNetIF ()
void	Display (const char *pfx="=====> ")
int	GetDest (char *dest, int dlen, ifType ifT=PublicV6, bool prefn=false)
int	GetName (char *nbuff, int &nport, ifType ifT=PublicV6)
int	GetName (const char *&name, ifType ifT=PublicV6)
int	GetPublicDest (char *dest, size_t dlen)
int	GetPublicName (char *nbuff, int &nport)
bool	HasDest (ifType ifT=PublicV6)
char	Mask ()
int	Port ()
int	Port (int pnum)
bool	SetIF (XrdNetAddrInfo *src, const char *ifList, int port=0, netType nettype=netDefault, const char *xName=0)
bool	SetPublicName (const std::string &name)

Static Public Member Functions
static int	GetIF (char *&ifline, const char **eText=0, bool show=false)
static int	GetIF (char *buff, int blen, const char **eText=0, bool show=false)
static int	GetIF (XrdOucTList **ifList, const char **eText=0)
static ifType	GetIFType (bool conIPv4, bool hasIP64, bool pvtIP)
static bool	InDomain (XrdNetAddrInfo *epaddr)
static char	Mask (ifType ifT)
static const char *	Name (ifType ifT)
static void	PortDefault (int pnum=1094)
static void	Privatize (ifType &x)
static void	Routing (netType nettype)
static bool	SetIFNames (char *ifnames)
static void	SetMsgs (XrdSysError *erp)
static void	SetRPIPA (bool rval)

Static Public Attributes
static const int	haveIPv4 = 1
	ifList == 0 && non-local ipv4 i/f found (or'd)
static const int	haveIPv6 = 2
	ifList == 0 && non-local ipv6 i/f found (or'd)
static const int	haveNoGI = 0
	ifList == 0 && getifaddrs() is not supported
static const int	havePrv4 = 4
	ifList == 0 && private ipv4 i/f found (or'd)
static const int	havePrv6 = 8
	ifList == 0 && private ipv6 i/f found (or'd)
static const int	havePub4 =16
	ifList == 0 && public ipv4 i/f found (or'd)
static const int	havePub6 =32
	ifList == 0 && public ipv6 i/f found (or'd)

Detailed Description

Definition at line 49 of file XrdNetIF.hh.

Member Enumeration Documentation

ifType

enum XrdNetIF::ifType

The enum that is used to index into ifData to get appropriate interface.

Enumerator
PublicV4
PrivateV4
PublicV6
PrivateV6
PrivateIF
ifNum
Public46
Private46
Public64
Private64
ifMax
ifAny

Definition at line 65 of file XrdNetIF.hh.

                   {PublicV4  = 0,  //<! Public  IPv4 network
                    PrivateV4 = 1,  //<! Private IPv4 network
                    PublicV6  = 2,  //<! Public  IPv6 network
                    PrivateV6 = 3,  //<! Private IPv6 network
                    PrivateIF = 1,  //<! Bit to change PublicVx -> PrivateVx
                    ifNum     = 4,  //<! Count of actual interface types
                    Public46  = 4,  //<! Public  v4|6 network (dual stack)
                    Private46 = 5,  //<! Private v4|6 network (dual stack)
                    Public64  = 6,  //<! Public  v6|4 network (dual stack)
                    Private64 = 7,  //<! Private v6|4 network (dual stack)
                    ifMax     = 8,  //<! Total elements in if vector
                    ifAny     = 8}; //<! Used to select any avilable i/f

netType

enum XrdNetIF::netType

Routing() and SetIF() parameter.

netDefault - netSplit for Routing() and Routing() value for SetIF(). netSplit - public and private addresses are routed separately so that substitution of one type of address for another is not allowed. netCommon - clients with private addresses also have public addresses. Source and target addresses should match but a public address may be used in the absence of a private address. netLocal - private addresses are registered and can be used by public clients within this domain. Clients with public addresses can be routed to private addresses.

Enumerator
netDefault
netSplit
netCommon
netLocal

Definition at line 364 of file XrdNetIF.hh.

{netDefault = 0, netSplit, netCommon, netLocal};

Constructor & Destructor Documentation

XrdNetIF()

XrdNetIF::XrdNetIF ( )

inline

Constructor and Destructor.

Definition at line 431 of file XrdNetIF.hh.

: ifBuff(0), ifMask(0), ifAvail(0)  {}

~XrdNetIF()

XrdNetIF::~XrdNetIF ( )

inline

Definition at line 433 of file XrdNetIF.hh.

{if (ifBuff) free(ifBuff);}

Member Function Documentation

Display()

void XrdNetIF::Display

(

const char *

pfx = "=====> "

)

Display the final interface configuration.

Parameters

pfx	The desired message prefix (default is as shown).

Definition at line 142 of file XrdNetIF.cc.

{
   static const char *ifN[] = {"pub4", "prv4", "pub6", "prv6"};
   static const char *ifT[] = {"all4", 0,      "all6", 0};
   static const char *nNM[] = {"local", "split", "common", "local"};
          const char *iHX[hasNum] = {"", "", "", ""};
          const char *ifRType, *hName = "";
   char buff[256];
   bool nameOK = false;
 
// If we have no error routing object, just return
//
   if (!eDest) return;
 
// Get a hostname
//
   for (int i = 0; i < (int)ifNum; i++)
       {if (ifName[i] != &ifNull)
           {hName = ifName[i]->iVal;
            if (ifxDNS[i]) {nameOK = true; break;}
           }
       }
 
// Compute selection mask
//
   for (int i = 0; i < hasNum; i++)
       if (ifMask & sMask[i]) iHX[i] = sName[i];
 
// Print results
//
   sprintf(buff, ": %s %s%s%s%s", nNM[ifRoute], iHX[0],iHX[1],iHX[2],iHX[3]);
   eDest->Say(pfx, "Routing for ", hName, buff);
 
   for (int i = 0; i < (int)ifNum; i++)
       {if (ifName[i] != &ifNull)
           {if (ifT[i] && ifDest[i] == ifDest[i+1]) {ifRType = ifT[i]; i++;}
               else ifRType = ifN[i];
            sprintf(buff, "Route %s: ", ifRType);
            eDest->Say(pfx, buff, (nameOK ? hName : ifName[i]->iVal),
                       " Dest=", ifDest[i]->iVal, portSfx.val);
           }
       }
}

References ifNum.

Referenced by XrdXrootdProtocol::Configure().

Here is the caller graph for this function:

GetDest()

int XrdNetIF::GetDest	(	char *	dest,
		int	dlen,
		ifType	ifT = PublicV6,
		bool	prefn = false )

Get the interface address with a port number.

Parameters

dest	Pointer to the buffer where dest will be placed.
dlen	The length of the buffer.
ifT	Desired ifType (PublicV6 is the default)
prefn	When true, a hostname:port is returned if possible

Returns

The length of the name whose pointer is placed in name. A value of zero indicates that no such interface exists or the buffer was too small.

Definition at line 389 of file XrdNetIF.cc.

{
   ifType  ifX = (ifT >= ifAny ? static_cast<ifType>(ifAvail) : ifT);
   ifData *ifP = (prefn && ifxDNS[ifX] ? ifName[ifX] : ifDest[ifX]);
   int n;
 
// Compute length and make sure we don't overflow
//
   n = ifP->iLen + portSfx.len;
   if (!(ifP->iLen) || n >= dlen) return 0;
 
// Return result with port appended
//
   strcpy(dest, ifP->iVal);
   strcpy(dest +ifP->iLen, portSfx.val);
   return n;
}

References ifAny.

GetIF() [1/3]

int XrdNetIF::GetIF ( char *& ifline, const char ** eText = 0, bool show = false )

static

Obtain an easily transmittable IP routable interfaces to this machine.

Parameters

ifline	Reference to a char * pointer that will get the result.
eText	When not nil, is where to place error message text.
show	When true configured interfaces are also displayed.

Returns

Success: Number of bytes in the returned string ecluding the null. The caller is responsible for unallocating it via free(). Failure: Zero is returned. If eText is supplied, the error message, in persistent storage, is returned. *ifline is set to 0.

Definition at line 589 of file XrdNetIF.cc.

{
   char buff[4096];
   int  n;
 
   if ((n = GetIF(buff, sizeof(buff), eText, show))) ifline = strdup(buff);
      else ifline = 0;
 
// Warn about no interfaces
//
   if (!ifline && show && eDest)
      eDest->Say("Config ", "No usable interfaces; using DNS registered "
                            "address as the interface.");
   return n;
}

References GetIF().

Here is the call graph for this function:

GetIF() [2/3]

int XrdNetIF::GetIF ( char * buff, int blen, const char ** eText = 0, bool show = false )

static

Obtain an easily transmittable IP routable interfaces to this machine.

Parameters

buff	Pointer to buffer to hold result which can be fed to SetIF.
blen	The length of the buffer (4K is really sufficient).
eText	When not nil, is where to place error message text.
show	When true configured interfaces are also displayed.

Returns

Success: Number of bytes placed in buff, excluding the null. Failure: Zero is returned. If eText is supplied, the error message, in persistent storage, is returned.

Definition at line 536 of file XrdNetIF.cc.

{
   XrdOucTList *ifP, *ifN;
   const char *ifName[3] = {ifCfg[0], ifCfg[1], "anon"};
   char *bP = buff;
   int n, bLeft = blen-8;
   bool ifOK[3] = {false, false, false};
 
#ifndef HAVE_GETIFADDRS
// Display warning on how we are getting the interface addresses
//
   if (eDest && show)
      eDest->Say("Config Warning: using DNS registered address as interface!");
#endif
 
// Create the interface list here
//
   *buff = 0;
   if (GetIF(&ifN, eText))
      {while((ifP = ifN))
            {n = ifP->sval[0];
             if (bLeft > n+2)
                {if (bP != buff) {*bP++ = ' '; bLeft--;}
                 strcpy(bP, ifP->text);
                 bP += n; bLeft -= (n+1);
                }
             ifOK[ifP->sval[2]] = true;
             if (show && eDest)
                {const char *kind = (ifP->sval[1] ? " private" : " public ");
                 eDest->Say("Config ", ifName[ifP->sval[2]], kind,
                                    " network interface: ", ifP->text);
                }
             ifN = ifP->next; delete ifP;
            }
      }
 
// Warn about missing interfaces
//
   if (show && eDest)
      {for (n = 0; n < 2; n++)
           {if (!ifOK[n] && ifCfg[n])
                eDest->Say("Config ", ifCfg[n],
                           " interface not found or is not usable.");
           }
      }
 
// Return result
//
   return bP-buff;
}

References GetIF(), XrdOucTList::next, and XrdOucTList::text.

Here is the call graph for this function:

GetIF() [3/3]

int XrdNetIF::GetIF ( XrdOucTList ** ifList, const char ** eText = 0 )

static

Definition at line 429 of file XrdNetIF.cc.

{
   static const int prvIF[] = {havePrv4, havePrv6};
   static const int pubIF[] = {havePub4, havePub6};
 
   char ipBuff[256];
   short ifIdx = 0, sval[4] = {0, 0, 0, 0};
   short iLen;
   int   ifT, haveIF = 0;
 
#ifdef HAVE_GETIFADDRS
 
// Obtain the list of interfaces
//
   XrdNetAddr      netAddr;
   struct ifaddrs *ifBase, *ifP;
   XrdOucTList    *tLP, *tList = 0, *tLast = 0;
   int             n = 0;
   bool            anyIF = (ifCfg[0] == 0 && ifCfg[1] == 0);
 
   if (getifaddrs(&ifBase) < 0)
      {if (eText) *eText = XrdSysE2T(errno);
       if (ifList) *ifList = 0;
       if (eDest) eDest->Emsg("GetIF", errno, "get interface addresses.");
       return 0;
      }
 
// Report only those interfaces that are up and are not loop-back devices and
// have been specified by actual name
//
   ifP = ifBase;
   while(ifP)
        {if ((ifP->ifa_addr != 0)
         &&  (!ifList || anyIF || IsOkName(ifP->ifa_name, ifIdx))
         &&  (ifP->ifa_flags & (IFF_UP))
         &&  (ifP->ifa_flags & (IFF_RUNNING))
         && !(ifP->ifa_flags & (IFF_LOOPBACK))
         &&  ((ifP->ifa_addr->sa_family == AF_INET  &&
              !V4LinkLocal(ifP->ifa_addr))
             ||
              (ifP->ifa_addr->sa_family == AF_INET6 &&
              !(IN6_IS_ADDR_LINKLOCAL(&((sockaddr_in6 *)(ifP->ifa_addr))->sin6_addr)))
             )
            )
            {if (ifP->ifa_addr->sa_family == AF_INET){haveIF |= haveIPv4;ifT=0;}
                else {haveIF |= haveIPv6; ifT = 1;}
             if (ifList)
                {netAddr.Set(ifP->ifa_addr);
                 if ((iLen = netAddr.Format(ipBuff, sizeof(ipBuff),
                             XrdNetAddrInfo::fmtAddr,XrdNetAddrInfo::noPort)))
                    {sval[2] = (anyIF ? 3 : ifIdx);
                     sval[1] = (netAddr.isPrivate() ? 1 : 0);
                     sval[0] = iLen;
                     haveIF |= (sval[1] ? prvIF[ifT] : pubIF[ifT]);
                     tLP = new XrdOucTList(ipBuff, sval);
                     if (tList) tLast->next = tLP;
                        else    tList       = tLP;
                     tLast = tLP;
                     n++;
                    }
                } else {
                 netAddr.Set(ifP->ifa_addr);
                 haveIF |= (netAddr.isPrivate() ? prvIF[ifT] : pubIF[ifT]);
                }
            }
          ifP = ifP->ifa_next;
        }
 
// All done
//
   if (ifBase) freeifaddrs(ifBase);
   if (eText) *eText = 0;
   if (!ifList) return haveIF;
   *ifList = tList;
   return n;
 
#else
 
// If we just need to provide the interface type, indicate we cannot
//
   if (!ifList) return haveNoGI;
 
// For platforms that don't support getifaddrs() use our address
//
   XrdNetAddr netAddr((int)0);
 
// Simply return our formatted address as the interface address
//
   if ((iLen = netAddr.Format(ipBuff, sizeof(ipBuff),
                       XrdNetAddrInfo::fmtAddr,XrdNetAddrInfo::noPort)))
      {if (eText) *eText = 0;
       sval[0] = iLen;
       *ifList = new XrdOucTList(ipBuff, sval);
       return 1;
      }
 
// Something bad happened and it shouldn't have
//
   if (eText) *eText = "unknown error";
   if (eDest) eDest->Emsg("GetIF", "Unable to get interface address; "
                                   "check if IPV6 enabled!");
   return 0;
#endif
}

References XrdNetAddrInfo::fmtAddr, XrdNetAddrInfo::Format(), haveIPv4, haveIPv6, haveNoGI, havePrv4, havePrv6, havePub4, havePub6, XrdNetAddrInfo::isPrivate(), XrdNetAddrInfo::noPort, XrdNetAddr::Set(), and XrdSysE2T().

Referenced by XrdConfig::Configure(), GetIF(), GetIF(), getMyFQN(), XrdNetUtils::NetConfig(), and XrdNetUtils::SetAuto().

Here is the call graph for this function:

Here is the caller graph for this function:

GetIFType()

static ifType XrdNetIF::GetIFType ( bool conIPv4, bool hasIP64, bool pvtIP )

inlinestatic

Get the ifType for client connection.

Parameters

conIPv4	True if connected via IPv4, false means IPv6.
hasIP64	True if the client has an IPv4 and IPv6 address.
pvtIP	True if the ip address is private.

Returns

The ifType correspodning to the passed arguments.

Definition at line 250 of file XrdNetIF.hh.

                       {ifType ifT;
                        if (conIPv4) ifT = (hasIP64 ? Public46 : PublicV4);
                           else      ifT = (hasIP64 ? Public64 : PublicV6);
                        if (pvtIP) Privatize(ifT);
                        return ifT;
                       }

References Privatize(), Public46, Public64, PublicV4, and PublicV6.

Referenced by XrdOfs::fsctl(), and XrdSsiSfs::fsctl().

Here is the call graph for this function:

Here is the caller graph for this function:

GetName() [1/2]

int XrdNetIF::GetName ( char * nbuff, int & nport, ifType ifT = PublicV6 )

inline

Copy the interface name and return port number.

Parameters

nbuff	Reference to buffer where the name will be placed. It must be atleast 256 bytes in length.
nport	Place where the port number will be placed.
ifT	Desired ifType (PublicV6 is the default)

Returns

The length of the name copied into the buffer. A value of zero indicates that no such interface exists.

Definition at line 133 of file XrdNetIF.hh.

                   {if (ifT >= ifAny) ifT = static_cast<ifType>(ifAvail);
                    strcpy(nbuff, ifName[ifT]->iVal); nport = ifPort;
                    return ifName[ifT]->iLen;
                   }

References ifAny, and PublicV6.

GetName() [2/2]

int XrdNetIF::GetName ( const char *& name, ifType ifT = PublicV6 )

inline

Get the interface name without a port number.

Parameters

name	Reference to where a pointer to the name will be placed
ifT	Desired ifType (PublicV6 is the default)

Returns

The length of the name whose pointer is placed in name. A value of zero indicates that no such interface exists.

Definition at line 115 of file XrdNetIF.hh.

                   {if (ifT >= ifAny) ifT = static_cast<ifType>(ifAvail);
                    name = ifName[ifT]->iVal;
                    return ifName[ifT]->iLen;
                   }

References ifAny, and PublicV6.

GetPublicDest()

int XrdNetIF::GetPublicDest	(	char *	dest,
		size_t	dlen )

Get the public interface name with a port number.

Parameters

dest	Pointer to the buffer where dest will be placed.
dlen	The length of the buffer.

Returns

The length of the name whose pointer is placed in name. A value of zero indicates that the buffer was too small.

Definition at line 412 of file XrdNetIF.cc.

{
    auto n = m_PublicName.size() + portSfx.len;
    if (m_PublicName.empty() || n >= dlen) return 0;
 
    strcpy(dest, m_PublicName.c_str());
    strcpy(dest + m_PublicName.size(), portSfx.val);
 
    return n;
}

Referenced by XrdCmsCluster::List().

Here is the caller graph for this function:

GetPublicName()

int XrdNetIF::GetPublicName ( char * nbuff, int & nport )

inline

Get the interface public hostname, not relying on reverse DNS of the IP addresses.

Parameters

nbuff	Reference to buffer where the name will be placed. It must be at least 256 bytes in length.
nport	Place where the port number will be placed.

Returns

The length of the name copied into the buffer. A value of zero indicates that no such interface exists.

Definition at line 150 of file XrdNetIF.hh.

{
    strcpy(nbuff, m_PublicName.c_str());
    nport = ifPort;
    return m_PublicName.size();
}

Referenced by XrdCmsCluster::Select().

Here is the caller graph for this function:

HasDest()

bool XrdNetIF::HasDest ( ifType ifT = PublicV6 )

inline

Determine whether or not an interface exists.

Parameters

ifT	-> Desired ifType (PublicV6 is the default)

Returns

true -> desired dest exists. false -> desired dest does not exist.

Definition at line 267 of file XrdNetIF.hh.

                   {return ifT >= ifAny || ifDest[ifT]->iLen != 0;}

References ifAny, and PublicV6.

Referenced by XrdCmsCluster::List().

Here is the caller graph for this function:

InDomain()

bool XrdNetIF::InDomain ( XrdNetAddrInfo * epaddr )

static

Determine if an endpoint is this domain based on hostname.

Parameters

epaddr

Pointer to the endpoint NetAddrInfo object.

Returns

true The endpoint is in this domain.

false Either the endpoint is not in this domain, is a private address, or is not registered in DNS.

Definition at line 622 of file XrdNetIF.cc.

{
   const char *hnP;
 
// Do not attempt to resolve private addresses as they are always in the domain.
//
   if (epaddr->isPrivate()) return true;
 
// Checkout the domain
//
   if (!myDomain || !(hnP = epaddr->Name(0)) || !(hnP = index(hnP, '.')))
      return false;
 
// Match the domain and returnthe result
//
   return strcmp(myDomain, hnP+1) == 0;
}

References XrdNetAddrInfo::isPrivate(), and XrdNetAddrInfo::Name().

Referenced by XrdSecProtector::New4Server(), XrdXrootdProtocol::Process2(), and XrdSecProtector::ProtResp().

Here is the call graph for this function:

Here is the caller graph for this function:

Mask() [1/2]

char XrdNetIF::Mask ( )

inline

Get the ifType selection mask for this object.

Returns

A single char that represents the selection mask.

Definition at line 288 of file XrdNetIF.hh.

{return ifMask;}

Referenced by XrdCmsCluster::Select().

Here is the caller graph for this function:

Mask() [2/2]

static char XrdNetIF::Mask ( ifType ifT )

inlinestatic

Convert an ifType to its corresponding selection mask.

Parameters

ifT	The ifType to convert.

Returns

A single char that represents the selection mask.

Definition at line 298 of file XrdNetIF.hh.

                {if (ifT >= ifAny) return 0x0f;
                 return ifMaskVec[ifT];
                }

References ifAny.

Name()

static const char * XrdNetIF::Name ( ifType ifT )

inlinestatic

Get the human readable for for an ifType.

Parameters

ifT	The ifType to convert.

Returns

A pointer to the human readable name. The string resides in static storage and is always valid.

Definition at line 312 of file XrdNetIF.hh.

                             {if (ifT >= ifAny) return "any";
                              return ifTName[ifT];
                             }

References ifAny.

Referenced by XrdCmsNode::do_Locate().

Here is the caller graph for this function:

Port() [1/2]

int XrdNetIF::Port ( )

inline

Get the assigned port number

Returns

The port number.

Definition at line 322 of file XrdNetIF.hh.

{return ifPort;}

Referenced by XrdXrootdProtocol::Configure(), XrdCmsCluster::List(), and SetIF().

Here is the caller graph for this function:

Port() [2/2]

int XrdNetIF::Port

(

int

pnum

)

Set the assigned port number. This method is not thread safe!

Parameters

pnum	The port number.

Returns

The previous port number.

Definition at line 657 of file XrdNetIF.cc.

{
   int prevport = ifPort;
 
// Check if anything is really changing
//
   pnum &= 0x0000ffff;
   if (pnum == prevport) return prevport;
 
// Format the port number (can't be more than 5 characters)
//
   portSfx.len = sprintf(portSfx.val, ":%d", pnum);
   ifPort = pnum;
 
// All done
//
   return prevport;
}

PortDefault()

void XrdNetIF::PortDefault ( int pnum = 1094 )

static

Set the default assigned port number.

Parameters

pnum	The port number.

Definition at line 680 of file XrdNetIF.cc.

{dfPort = pnum;}

Privatize()

static void XrdNetIF::Privatize ( ifType & x )

inlinestatic

Make an iofType refer to the private network.

Parameters

x	The iftype variable that will have the private bit set.

Definition at line 330 of file XrdNetIF.hh.

{x = ifType(x | PrivateIF);}

References PrivateIF.

Referenced by XrdCmsNode::do_Locate(), XrdCmsNode::do_Select(), and GetIFType().

Here is the caller graph for this function:

Routing()

void XrdNetIF::Routing ( XrdNetIF::netType nettype )

static

Set default interface network routing.

Parameters

nettype

Network routing (see netType definition).

Definition at line 686 of file XrdNetIF.cc.

{
 
// Set the routing type
//
   netRoutes = (nettype == netDefault ? netLocal : nettype);
 
// Based on the routing we need to set the appropriate selection mask vector
//
        if (netRoutes == netLocal) ifMaskVec = ifMaskLocal;
   else if (netRoutes == netSplit) ifMaskVec = ifMaskSplit;
   else                            ifMaskVec = ifMaskComm;
}

References netDefault, netLocal, and netSplit.

SetIF()

bool XrdNetIF::SetIF	(	XrdNetAddrInfo *	src,
		const char *	ifList,
		int	port = 0,
		netType	nettype = netDefault,
		const char *	xName = 0 )

Set the ifData structure based on the interface string generated by GetIF().

Parameters

src	The network information of host supplying the if string.
ifList	The interface string, it must be null terminated.
port	The port associated with the interfaces; as follows: <0 -> Use previous setting if any. =0 -> use default port (the default). >0 -> Use the number passed.
nettype	Determines how undefined interfaces are resolved. See the netType definition.
xName	the known registered host name should ip address translation fail.

Returns

Success: True. Failure: False and if eText is supplied, the error message, in persistent storage, is returned.

Definition at line 704 of file XrdNetIF.cc.

{
   XrdNetAddrInfo *netIF[4] = {0,0,0,0}; //pub 0:v4, prv 1:v4 pub 2:v6 prv 3:v6
   XrdNetAddr      netAdr[4];
   const char *ifErr = 0, *ifBeg = ifList, *ifEnd, *ifAdr, *ifBad = 0;
   int i, n, ifCnt = 1;
   char abuff[64];
 
// Setup the port number (this sets ifPort)
//
   if (port >= 0) Port((port ? port : dfPort));
 
// Set routing mode for this interface
//
   ifRoute = static_cast<short>(nettype == netDefault ? netRoutes : nettype);
 
// If no list is supplied then fill out based on the source address
//
   if (!ifList || !(*ifList))
      {XrdNetAddrInfo *ifVec[8];
       XrdNetAddr *iP;
       const char *hName = src->Name();
       if (!(src->isRegistered()) && xName) hName = xName;
       ifCnt = 0;
       if (!hName
       ||  XrdNetUtils::GetAddrs(hName,&iP,ifCnt,XrdNetUtils::allIPv64,ifPort)
       || !ifCnt) return SetIF64(GenIF(&src, 1));
       if (ifCnt > 8) ifCnt = 8;
       for (i = 0; i < ifCnt; i++) ifVec[i] = &iP[i];
       bool aOK = GenIF(ifVec, ifCnt, hName);
       delete [] iP;
       return SetIF64(aOK);
      }
 
// Prefrentially use the connect address as the primary interface. This
// avoids using reported interfaces that may have strange routing.
//
   i = (src->isIPType(XrdNetAddrInfo::IPv4) || src->isMapped() ? 0 : 2);
   if (src->isPrivate()) i |= 1;
   netIF[i] = src;
 
// Process the iflist (up to four interfaces)
//
   do {while (*ifBeg && *ifBeg == ' ') ifBeg++;
       if ( !(*ifBeg)) break;
       if (!(ifEnd = index(ifBeg, ' '))) {ifAdr = ifBeg; ifBeg = "";}
          else {n = ifEnd - ifBeg;
                if (n >= (int)sizeof(abuff))
                        {ifAdr = 0; ifBad = ifBeg; ifErr = "invalid";}
                   else {strncpy(abuff, ifBeg, n); abuff[n] = 0; ifAdr = abuff;}
                ifBeg = ifEnd+1;
               }
       if (!ifAdr || (ifErr = netAdr[ifCnt].Set(ifAdr, ifPort)))
          {if (eDest)
              {if (!ifAdr) ifAdr = ifBad;
               eDest->Emsg("SetIF", "Unable to use interface", ifAdr, ifErr);
              }
           continue;
          }
       i = (netAdr[ifCnt].isIPType(XrdNetAddrInfo::IPv4) ||
            netAdr[ifCnt].isMapped() ? 0 : 2);
       if (netAdr[ifCnt].isPrivate()) i |= 1;
       if (!netIF[i]) netIF[i] = &netAdr[ifCnt--];
      } while(ifCnt >= 0);
 
// Set the interface data
//
   return SetIF64(GenIF(netIF, 4));
}

References XrdNetUtils::allIPv64, XrdNetUtils::GetAddrs(), XrdNetAddrInfo::IPv4, XrdNetAddrInfo::isIPType(), XrdNetAddrInfo::isMapped(), XrdNetAddrInfo::isPrivate(), XrdNetAddrInfo::isRegistered(), XrdNetAddrInfo::Name(), netDefault, and Port().

Here is the call graph for this function:

SetIFNames()

bool XrdNetIF::SetIFNames ( char * ifnames )

static

Set the public and private network interface names.

Parameters

ifnames

Pointer to the comma seperated interface names. This string is modified.

Returns

true Names have been set.

false Invalid interface name list.

Definition at line 779 of file XrdNetIF.cc.

{
   char *comma;
 
// Parse the interface names
//
   if ((comma = index(ifnames, ',')))
      {if (comma == ifnames || !(*(comma+1)))
          {if (eDest) eDest->Say("Config","Invalid interface name - ",ifnames);
           return false;
          }
      }
 
// Free old names, if any
//
   if (ifCfg[0]) free(ifCfg[0]);
   if (ifCfg[1]) free(ifCfg[1]);
 
// Copy the new names
//
   if (comma)
      {*comma = 0;
       ifCfg[1] = (strcmp(ifnames, comma+1) ? strdup(comma+1) : 0);
       *comma = ',';
      } else ifCfg[1] = 0;
   ifCfg[0] = strdup(ifnames);
   return true;
}

SetMsgs()

void XrdNetIF::SetMsgs ( XrdSysError * erp )

static

Specify where messages are to be sent.

Parameters

erp	Pointer to the error message object. By default, no error messages are printed. This is not a thread-safe call and the err disposition must be set at initialization time.

Definition at line 886 of file XrdNetIF.cc.

{eDest = erp;}

Referenced by XrdConfig::Configure().

Here is the caller graph for this function:

SetPublicName()

bool XrdNetIF::SetPublicName ( const std::string & name )

inline

Sets the 'public name' to use associated with this interface.

Parameters

name	New public name to utilize.

Returns

True if the name is a valid hostname; false otherwise.

Definition at line 164 of file XrdNetIF.hh.

{
    // TODO: Actually validate this is an acceptable DNS name.
    if (name.size() > 255) return false;
    m_PublicName = name;
    return true;
}

SetRPIPA()

void XrdNetIF::SetRPIPA ( bool rval )

static

Specify wheter or not private IP addresses should be resolved.

Parameters

rval	When true, private IP addresses are resolved. Otherwise, the IP addresses is used as the hostname.

Definition at line 892 of file XrdNetIF.cc.

{rPIPA = rval;}

Member Data Documentation

haveIPv4

const int XrdNetIF::haveIPv4 = 1

static

ifList == 0 && non-local ipv4 i/f found (or'd)

Definition at line 196 of file XrdNetIF.hh.

Referenced by GetIF(), XrdNetUtils::NetConfig(), and XrdNetUtils::SetAuto().

haveIPv6

const int XrdNetIF::haveIPv6 = 2

static

ifList == 0 && non-local ipv6 i/f found (or'd)

Definition at line 198 of file XrdNetIF.hh.

Referenced by GetIF(), XrdNetUtils::NetConfig(), and XrdNetUtils::SetAuto().

haveNoGI

const int XrdNetIF::haveNoGI = 0

static

ifList == 0 && getifaddrs() is not supported

Obtain an easily digestable list of IP routable interfaces to this machine.

Parameters

ifList	Place where the list of interfaces will be placed. If ifList is null, returns configured interface types.
eText	When not nil, is where to place error message text.

Returns

Success: ifList != 0: returns the count of interfaces in the list. *ifList->sval[0] strlen(ifList->text) *ifList->sval[1] when != 0 the address is private. *ifList->text the interface address is standard format. The list of objects belongs to the caller and must be deleted when no longer needed.

ifList == 0: returns types of configured non-local i/f. This is or'd values of the static const ints haveXXXX.

Failure: Zero is returned. If eText is supplied, the error message, in persistent storage, is returned.

Definition at line 194 of file XrdNetIF.hh.

Referenced by GetIF().

havePrv4

const int XrdNetIF::havePrv4 = 4

static

ifList == 0 && private ipv4 i/f found (or'd)

Definition at line 200 of file XrdNetIF.hh.

Referenced by GetIF().

havePrv6

const int XrdNetIF::havePrv6 = 8

static

ifList == 0 && private ipv6 i/f found (or'd)

Definition at line 202 of file XrdNetIF.hh.

Referenced by GetIF().

havePub4

const int XrdNetIF::havePub4 =16

static

ifList == 0 && public ipv4 i/f found (or'd)

Definition at line 204 of file XrdNetIF.hh.

Referenced by GetIF(), and XrdNetUtils::NetConfig().

havePub6

const int XrdNetIF::havePub6 =32

static

ifList == 0 && public ipv6 i/f found (or'd)

Definition at line 206 of file XrdNetIF.hh.

Referenced by GetIF(), and XrdNetUtils::NetConfig().

---

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

• XrdNetIF.hh
• XrdNetIF.cc