XrdNetSocket Class Reference

#include <XrdNetSocket.hh>

Collaboration diagram for XrdNetSocket:

Public Member Functions
	XrdNetSocket (XrdSysError *erobj=0, int SockFileDesc=-1)
	~XrdNetSocket ()
int	Accept (int ms=-1)
void	Close ()
int	Detach ()
int	LastError ()
int	Open (const char *path, int port=-1, int flags=0, int sockbuffsz=0)
const char *	Peername (const struct sockaddr **InetAddr=0, int *InetSize=0)
const char *	SockData (XrdNetSockAddr &InetAddr)
int	SockName (char *buff, int blen)
int	SockNum ()

Static Public Member Functions
static XrdNetSocket *	Create (XrdSysError *Say, const char *path, const char *fn, mode_t mode, int isudp=0)
static int	getWindow (int fd, int &Windowsz, XrdSysError *eDest=0)
static int	setOpts (int fd, int options, XrdSysError *eDest=0)
static int	setWindow (int fd, int Windowsz, XrdSysError *eDest=0)
static char *	socketPath (XrdSysError *Say, char *inbuff, const char *path, const char *fn, mode_t mode)

Detailed Description

Definition at line 47 of file XrdNetSocket.hh.

Constructor & Destructor Documentation

XrdNetSocket()

XrdNetSocket::XrdNetSocket	(	XrdSysError *	erobj = 0,
		int	SockFileDesc = -1 )

Definition at line 88 of file XrdNetSocket.cc.

{
   ErrCode  = 0;
   eroute   = erobj;
   SockFD   = SockFileDesc;
}

Referenced by Create().

Here is the caller graph for this function:

~XrdNetSocket()

XrdNetSocket::~XrdNetSocket ( )

inline

Definition at line 59 of file XrdNetSocket.hh.

{Close();}

References Close().

Here is the call graph for this function:

Member Function Documentation

Accept()

int XrdNetSocket::Accept

(

int

ms = -1

)

Definition at line 99 of file XrdNetSocket.cc.

{
   int retc, ClientSock;
 
   ErrCode = 0;
 
   // Check if a timeout was requested
   //
   if (timeout >= 0)
      {struct pollfd sfd = {SockFD,
                            POLLIN|POLLRDNORM|POLLRDBAND|POLLPRI|POLLHUP, 0};
       do {retc = poll(&sfd, 1, timeout);}
                  while(retc < 0 && (errno == EAGAIN || errno == EINTR));
       if (!sfd.revents) return -1;
      }
 
   do {ClientSock = XrdSysFD_Accept(SockFD, (struct sockaddr *)0, 0);}
      while(ClientSock < 0 && errno == EINTR);
 
   if (ClientSock < 0 && eroute) eroute->Emsg("Accept",errno,"accept connection");
 
   // Return the socket number.
   //
   return ClientSock;
}

References XrdSysError::Emsg().

Referenced by XrdCmsAdmin::Start(), and XrdXrootdAdmin::Start().

Here is the call graph for this function:

Here is the caller graph for this function:

Close()

void XrdNetSocket::Close

(

)

Definition at line 129 of file XrdNetSocket.cc.

{
     // Close any open file descriptor.
     //
     if (SockFD >= 0) {close(SockFD); SockFD=-1;} 
 
     // Reset values and return.
     //
     ErrCode=0;
}

References close.

Referenced by ~XrdNetSocket(), and Open().

Here is the caller graph for this function:

Create()

XrdNetSocket * XrdNetSocket::Create ( XrdSysError * Say, const char * path, const char * fn, mode_t mode, int isudp = 0 )

static

Definition at line 144 of file XrdNetSocket.cc.

{
   XrdNetSocket *ASock;
   int pflags    = (opts & XRDNET_FIFO ? S_IFIFO : S_IFSOCK);
   int sflags    = (opts & XRDNET_UDPSOCKET) | XRDNET_SERVER;
   int rc = 0;
   mode_t myMode = (mode & (S_IRWXU | S_IRWXG));
   const char *eMsg = 0;
   char fnbuff[1024] = {0};
 
// Setup the path
//
   if (!socketPath(Say, fnbuff, path, fn, mode|pflags))
      return (XrdNetSocket *)0;
 
// Connect to the path
//
   ASock = new XrdNetSocket(Say);
#ifndef WIN32
   if (opts & XRDNET_FIFO)
      {if ((ASock->SockFD = mkfifo(fnbuff, mode)) < 0 && errno != EEXIST)
         {eMsg = "create fifo"; rc = errno;}
         else if ((ASock->SockFD = XrdSysFD_Open(fnbuff, O_RDWR, myMode)) < 0)
                 {eMsg = "open fifo"; rc = errno;}
                 else if (opts & XRDNET_NOCLOSEX) XrdSysFD_Yield(ASock->SockFD);
      } else if (ASock->Open(fnbuff, -1, sflags) < 0) 
                {eMsg = "create socket"; rc = ASock->LastError();}
#else
   if (ASock->Open(fnbuff, -1, sflags) < 0)
      {eMsg = "create socket"; rc = ASock->LastError();}
#endif
 
// Return the result
//
   if (eMsg) {Say->Emsg("Create", rc, eMsg, fnbuff);
              delete ASock; ASock = 0;
             }
   return ASock;
}

References XrdNetSocket(), eMsg, LastError(), Open(), opts, Say, socketPath(), XRDNET_FIFO, XRDNET_NOCLOSEX, XRDNET_SERVER, and XRDNET_UDPSOCKET.

Referenced by XrdXrootdProtocol::Configure(), XrdCmsConfig::Configure2(), XrdOfsEvr::Init(), mainConfig(), XrdFrmXfrDaemon::Pong(), XrdBwmLogger::Start(), and XrdOfsEvs::Start().

Here is the call graph for this function:

Here is the caller graph for this function:

Detach()

int XrdNetSocket::Detach

(

)

Definition at line 189 of file XrdNetSocket.cc.

{  int oldFD = SockFD;
   SockFD = -1;
   return oldFD;
}

Referenced by XrdNet::Bind(), XrdNet::Bind(), XrdNet::Connect(), XrdNet::Connect(), XrdOfsEvr::Init(), main(), mainConfig(), XrdCmsAdmin::Notes(), XrdFrmXfrDaemon::Pong(), XrdBwmLogger::Start(), and XrdOfsEvs::Start().

Here is the caller graph for this function:

getWindow()

int XrdNetSocket::getWindow ( int fd, int & Windowsz, XrdSysError * eDest = 0 )

static

Definition at line 199 of file XrdNetSocket.cc.

{
   socklen_t szb = (socklen_t)sizeof(Windowsz);
 
   if (getsockopt(fd, SOL_SOCKET, SO_RCVBUF, (Sokdata_t)&Windowsz, &szb))
      {if (eDest) eDest->Emsg("setWindow", errno, "set socket RCVBUF");
       return -1;
      }
    return 0;
}

References eDest, and Sokdata_t.

Referenced by XrdNet::WSize().

Here is the caller graph for this function:

LastError()

int XrdNetSocket::LastError ( )

inline

Definition at line 107 of file XrdNetSocket.hh.

{return ErrCode;}

Referenced by XrdNet::Bind(), XrdNet::Bind(), Create(), and main().

Here is the caller graph for this function:

Open()

int XrdNetSocket::Open	(	const char *	path,
		int	port = -1,
		int	flags = 0,
		int	sockbuffsz = 0 )

Definition at line 214 of file XrdNetSocket.cc.

{
   const char *epath, *eText, *action = "configure socket";
   char pbuff[128];
   int myEC, backlog, SockProt;
   int SockType = (flags & XRDNET_UDPSOCKET ? SOCK_DGRAM : SOCK_STREAM);
   const int one = 1;
   const SOCKLEN_t szone = (SOCKLEN_t)sizeof(one);
 
// Supply actual port number in error messages
//
   if (inpath) epath = inpath;
      else {sprintf(pbuff, "port %d", port);
            epath = pbuff;
           }
 
// Make sure this object is available for a new socket
//
   if (SockFD >= 0) return Err(Open, EBUSY, "create socket for", epath);
 
// Save the request flags, sometimes we need to check them from the local copy
//
   myEC = ErrCode = 0;
 
// Preset out address information
//
   if ((eText = SockInfo.Set(inpath,(port < 0 ? XrdNetAddr::PortInSpec:port))))
      {ErrCode = EHOSTUNREACH;
       if (eroute)
          {char buff[512];
           snprintf(buff,sizeof(buff),"'%s'; %c%s",epath,tolower(*eText),eText+1);
           eroute->Emsg("Open", "Unable to create socket for", buff);
          }
       return -1;
      }
 
// Allocate a socket descriptor of the right type
//
   SockProt = SockInfo.Protocol();
   if ((SockFD = XrdSysFD_Socket(SockProt, SockType, 0)) < 0)
      return Err(Open, errno, "create socket for", epath);
 
// Based on the type socket, set appropriate options. For server-side Unix
// sockets we must unlink the corresponding Unix path name or bind will fail.
// In some OS's, this creates a problem (e.g., Solaris) since the file inode is
// used to identify the socket and will likely change. This means that connects
// occuring before the bind will hang up to 3 minutes and client needs to retry.
// For non-Unix socketsr be prepared to timeout connects and try again.
//
   if (SockProt == PF_UNIX)
      {setOpts(SockFD, flags | XRDNET_UDPSOCKET, eroute);
       if (flags & XRDNET_SERVER) unlink((const char *)inpath);
      } else {
       setOpts(SockFD, flags, eroute);
       if (setsockopt(SockFD,SOL_SOCKET,SO_REUSEADDR, (Sokdata_t)&one, szone)
       &&  eroute) eroute->Emsg("Open",errno,"set socket REUSEADDR for",epath);
      }
 
// Set the window size or udp buffer size, as needed (ignore errors)
//
   if (windowsz) setWindow(SockFD, windowsz, eroute);
 
// Either do a bind or a connect.
//
   if (flags & XRDNET_SERVER)
      {action = "bind socket to";
       if (bind(SockFD, SockInfo.SockAddr(), SockInfo.SockSize())) myEC = errno;
          else if (SockType == SOCK_STREAM)
                  {action = "listen on stream";
                   if (!(backlog = flags & XRDNET_BKLG))
                      backlog = XRDNETSOCKET_MAXBKLG;
                   if (listen(SockFD, backlog)) myEC = errno;
                  }
       if (SockProt == PF_UNIX) chmod(inpath, S_IRWXU);
      } else {
       int tmo = flags & XRDNET_TOUT;
       action = "connect socket to";
       if (SockType == SOCK_STREAM && tmo)
          myEC = XrdNetConnect::Connect(SockFD, SockInfo.SockAddr(),
                                                SockInfo.SockSize(), tmo);
          else if (connect(SockFD,SockInfo.SockAddr(),SockInfo.SockSize()))
                  myEC = errno;
      }
 
// Check for any errors and return (Close() sets SockFD to -1).
//
   if (myEC)
      {Close(); 
       ErrCode = myEC;
       if (!(flags & XRDNET_NOEMSG) && eroute)
          eroute->Emsg("Open", ErrCode, action, epath);
      }
   return SockFD;
}

References Close(), XrdNetConnect::Connect(), Err, Open(), XrdNetAddr::PortInSpec, setOpts(), setWindow(), SOCKLEN_t, Sokdata_t, unlink, XRDNET_BKLG, XRDNET_NOEMSG, XRDNET_SERVER, XRDNET_TOUT, XRDNET_UDPSOCKET, and XRDNETSOCKET_MAXBKLG.

Referenced by XrdNet::Bind(), XrdNet::Bind(), XrdNet::Connect(), XrdNet::Connect(), Create(), main(), and Open().

Here is the call graph for this function:

Here is the caller graph for this function:

Peername()

const char * XrdNetSocket::Peername	(	const struct sockaddr **	InetAddr = 0,
		int *	InetSize = 0 )

Definition at line 313 of file XrdNetSocket.cc.

{
   const char *errtxt, *PeerName;
 
// Make sure  we have something to look at
//
   if (SockFD < 0) 
      {if (eroute) eroute->Emsg("Peername", 
                                "Unable to obtain peer name; socket not open");
       return (char *)0;
      }
 
// Get the host name on the other side of this socket
//
   if (!(PeerName = SockInfo.Name(0, &errtxt)))
      {if (eroute) 
          eroute->Emsg("Peername", "Unable to obtain peer name; ",errtxt);
       ErrCode = ESRCH;
      }
 
// Return possible address, length and the name
//
     if (InetAddr) *InetAddr = SockInfo.SockAddr();
     if (InetSize) *InetSize = SockInfo.SockSize();
     return PeerName;
}

Referenced by XrdNet::Connect().

Here is the caller graph for this function:

setOpts()

int XrdNetSocket::setOpts ( int fd, int options, XrdSysError * eDest = 0 )

static

Definition at line 345 of file XrdNetSocket.cc.

{
   int rc = 0;
   const int one = 1;
#if defined(__linux__) || defined(__GNU__)
   const int szint = sizeof(int);
#endif
   const SOCKLEN_t szone = (SOCKLEN_t)sizeof(one);
   static int tcpprotid = XrdNetUtils::ProtoID("tcp");
   static struct linger liopts = {1, XRDNETSOCKET_LINGER};
   const SOCKLEN_t szlio = (SOCKLEN_t)sizeof(liopts);
 
   if (opts & XRDNET_NOCLOSEX && !XrdSysFD_Yield(xfd))
      {rc = 1;
       if (eDest) eDest->Emsg("setOpts", errno, "set fd close on exec");
      }
 
   if (opts & XRDNET_UDPSOCKET) return rc;
 
   if (!(opts & XRDNET_NOLINGER)
   &&  setsockopt(xfd,SOL_SOCKET,SO_LINGER,(Sokdata_t)&liopts,szlio))
      {rc = 1;
       if (eDest) eDest->Emsg("setOpts", errno, "set socket LINGER");
      }
 
   if (opts & XRDNET_KEEPALIVE)
      {if (setsockopt(xfd,SOL_SOCKET,SO_KEEPALIVE,(Sokdata_t)&one,szone))
          {rc = 1;
           if (eDest) eDest->Emsg("setOpts", errno, "set socket KEEPALIVE");
          }
#if defined(__linux__) || defined(__GNU__)
           else if (opts & XRDNET_SERVER) // Following are inherited in Linux
      {if (XrdNetSocketCFG::ka_Idle
       &&  setsockopt(xfd,SOL_TCP,TCP_KEEPIDLE,&XrdNetSocketCFG::ka_Idle,szint))
          {rc = 1;
           if (eDest) eDest->Emsg("setOpts", errno, "set socket KEEPIDLE");
          }
       if (XrdNetSocketCFG::ka_Itvl
       &&  setsockopt(xfd,SOL_TCP,TCP_KEEPINTVL,&XrdNetSocketCFG::ka_Itvl,szint))
          {rc = 1;
           if (eDest) eDest->Emsg("setOpts", errno, "set socket KEEPINTVL");
          }
       if (XrdNetSocketCFG::ka_Icnt
       &&  setsockopt(xfd,SOL_TCP,TCP_KEEPCNT,  &XrdNetSocketCFG::ka_Icnt,szint))
          {rc = 1;
           if (eDest) eDest->Emsg("setOpts", errno, "set socket KEEPCNT");
          }
      }
#endif
      }
 
   if (!(opts & XRDNET_DELAY)
   &&  setsockopt(xfd, tcpprotid, TCP_NODELAY, (Sokdata_t)&one,szone))
      {rc = 1;
       if (eDest) eDest->Emsg("setOpts", errno, "set socket NODELAY");
      }
 
   return rc;
}

References eDest, XrdNetSocketCFG::ka_Icnt, XrdNetSocketCFG::ka_Idle, XrdNetSocketCFG::ka_Itvl, opts, XrdNetUtils::ProtoID(), SOCKLEN_t, Sokdata_t, XRDNET_DELAY, XRDNET_KEEPALIVE, XRDNET_NOCLOSEX, XRDNET_NOLINGER, XRDNET_SERVER, XRDNET_UDPSOCKET, and XRDNETSOCKET_LINGER.

Referenced by XrdInet::BindSD(), Open(), XrdCmsAdmin::Relay(), and XrdCmsAdmin::Start().

Here is the call graph for this function:

Here is the caller graph for this function:

setWindow()

int XrdNetSocket::setWindow ( int fd, int Windowsz, XrdSysError * eDest = 0 )

static

Definition at line 409 of file XrdNetSocket.cc.

{
   int rc = 0;
   const SOCKLEN_t szwb  = (SOCKLEN_t)sizeof(Windowsz);
 
   if (setsockopt(xfd, SOL_SOCKET, SO_SNDBUF,
                       (Sokdata_t)&Windowsz, szwb))
      {rc = 1;
       if (eDest) eDest->Emsg("setWindow", errno, "set socket SNDBUF");
      }
 
   if (setsockopt(xfd, SOL_SOCKET, SO_RCVBUF,
                       (Sokdata_t)&Windowsz, szwb))
      {rc = 1;
       if (eDest) eDest->Emsg("setWindow", errno, "set socket RCVBUF");
      }
   return rc;
}

References eDest, SOCKLEN_t, and Sokdata_t.

Referenced by Open().

Here is the caller graph for this function:

SockData()

const char * XrdNetSocket::SockData

(

XrdNetSockAddr &

InetAddr

)

Definition at line 432 of file XrdNetSocket.cc.

{
   const char *errtxt, *Name;
 
// Make sure  we have something to look at
//
   if (SockFD < 0) 
      {if (eroute) eroute->Emsg("SockInfo", 
                                "Unable to obtain socket info; socket not open");
       return (const char *)0;
      }
 
// Return possible address, length and the name
//
   const XrdNetSockAddr *netSA = SockInfo.NetAddr();
   if (!netSA)
      {if (eroute) 
          {eroute->Emsg("SockInfo", "Unable to obtain socker info; "
                                    "not an network socket.");
           ErrCode = EOPNOTSUPP;
           return (const char *)0;
          }
      }
   memcpy(&InetAddr, netSA, sizeof(XrdNetSockAddr));
 
// Get the host name on the other side of this socket
//
   if (!(Name = SockInfo.Name(0, &errtxt)))
      {if (eroute) 
          eroute->Emsg("SockInfo", "Unable to obtain socker info; ",errtxt);
       ErrCode = ESRCH;
       return (const char *)0;
      }
 
// All done
//
   return Name;
}

Referenced by XrdNet::Connect().

Here is the caller graph for this function:

socketPath()

char * XrdNetSocket::socketPath ( XrdSysError * Say, char * inbuff, const char * path, const char * fn, mode_t mode )

static

Definition at line 492 of file XrdNetSocket.cc.

{
   const int srchOK = S_IXUSR | S_IXGRP;
   const int sfMask = (S_IFIFO | S_IFSOCK);
   int rc, i, fnlen = strlen(fnbuff);
   mode_t myMode = (mode & (S_IRWXU | S_IRWXG)) | srchOK;
   struct stat buf;
   char *sp = 0;
 
// Copy the const char path because makePath modifies it
//
   i = strlen(path);
   if (strlcpy(fnbuff, path, 1024) >= 1024 || (i + fnlen + 1) >= 1024)
      {Say->Emsg("createPath", "Socket path", path, "too long");
       return 0;
      }
 
// Check if we should separate the filename from the path
//
   if (!fn)
      {if (fnbuff[i-1] == '/') fnbuff[i-1] = '\0';
       if ((sp = rindex(fnbuff, '/'))) *sp = '\0';
      }
   
// Create the directory if it is not already there
//
   if ((rc = XrdOucUtils::makePath(fnbuff, myMode)))
      {Say->Emsg("createPath", errno, "create path", path);
       return 0;
      }
 
// Construct full filename
//
   if (sp) *sp = '/';
      else {if (path[i-1] != '/') fnbuff[i++] = '/';
            if (fn) strcpy(fnbuff+i, fn);
           }
 
// Check is we have already created it and whether we can access
//
   if (!stat(fnbuff,&buf))
      {if ((buf.st_mode & S_IFMT) != (mode & sfMask))
          {Say->Emsg("createPath","Path",fnbuff,
                     (mode & S_IFSOCK) ? "exists but is not a socket"
                                       : "exists but is not a pipe");
           return 0;
          }
       if (access(fnbuff, W_OK))
          {Say->Emsg("createPath", errno, "access path", fnbuff);
           return 0;
          }
      } else chmod(fnbuff, mode); // This may fail on some platforms
 
// All set now
//
   return fnbuff;
}

References access, XrdOucUtils::makePath(), Say, stat, and strlcpy().

Referenced by Create(), and XrdCmsSupervisor::Init().

Here is the call graph for this function:

Here is the caller graph for this function:

SockName()

int XrdNetSocket::SockName	(	char *	buff,
		int	blen )

Definition at line 475 of file XrdNetSocket.cc.

{
 
// Make sure we have something here
//
   if (SockFD < 0) {*buff = 0; return ENOTSOCK;}
 
// Format the name
//
   if (!SockInfo.Format(buff, blen)) return EINVAL;
   return 0;
}

Referenced by XrdCmsAdmin::Start().

Here is the caller graph for this function:

SockNum()

int XrdNetSocket::SockNum ( )

inline

Definition at line 145 of file XrdNetSocket.hh.

{return SockFD;}

---

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

• XrdNetSocket.hh
• XrdNetSocket.cc