XrdNet.hh

Go to the documentation of this file.

#ifndef __XRDNET_H__
#define __XRDNET_H__
/******************************************************************************/
/*                                                                            */
/*                             X r d N e t . h h                              */
/*                                                                            */
/* (c) 2004 by the Board of Trustees of the Leland Stanford, Jr., University  */
/*   Produced by Andrew Hanushevsky for Stanford University under contract    */
/*              DE-AC02-76-SFO0515 with the Department of Energy              */
/*                                                                            */
/* This file is part of the XRootD software suite.                            */
/*                                                                            */
/* XRootD is free software: you can redistribute it and/or modify it under    */
/* the terms of the GNU Lesser General Public License as published by the     */
/* Free Software Foundation, either version 3 of the License, or (at your     */
/* option) any later version.                                                 */
/*                                                                            */
/* XRootD is distributed in the hope that it will be useful, but WITHOUT      */
/* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or      */
/* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public       */
/* License for more details.                                                  */
/*                                                                            */
/* You should have received a copy of the GNU Lesser General Public License   */
/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file  */
/* COPYING (GPL license).  If not, see <http://www.gnu.org/licenses/>.        */
/*                                                                            */
/* The copyright holder's institutional names and contributor's names may not */
/* be used to endorse or promote products derived from this software without  */
/* specific prior written permission of the institution or contributor.       */
/******************************************************************************/
 
#include <cstdlib>
#include <cstring>
#ifndef WIN32
#include <strings.h>
#include <unistd.h>
#include <netinet/in.h>
#include <sys/socket.h>
#else
#include <Winsock2.h>
#endif
 
#include "XrdNet/XrdNetOpts.hh"
 
class XrdNetAddr;
class XrdNetBufferQ;
class XrdNetPeer;
class XrdNetSecurity;
class XrdSysError;
 
class XrdNet
{
public:
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
int             Accept(XrdNetAddr &myAddr,
                       int opts=0,
                       int timeout=-1);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
int             Accept(XrdNetPeer &myPeer,
                       int opts=0,
                       int timeout=-1);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
int             Bind(      int   port,             // Port number
                     const char *contype="tcp"     // "tcp" or "udp"
                    );
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
int             Bind(      char *path,             // Unix path < |109|
                     const char *contype="stream"  // stream | datagram
                    );
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
int             Connect(XrdNetAddr &myAddr,
                        const char *dest,  // Destination host or ip address
                        int   port=-1,     // Port number
                        int   opts=0,      // Options
                        int   timeout=-1   // Second timeout
                       );
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
int             Connect(XrdNetPeer &myPeer,
                        const char *dest,  // Destination host or ip address
                        int   port=-1,     // Port number
                        int   opts=0,      // Options
                        int   timeout=-1   // Second timeout
                       );
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
int             Port() {return Portnum;}
 
// Relay() creates a UDP socket and optionally decomposes a destination
//         of the form host:port. Upon success it fills in the Peer object
//         and return true (1). Upon failure, it returns false (0).
//
int             Relay(XrdNetPeer &Peer,   // Peer object to be initialized
                      const char *dest,   // Optional destination
                      int         opts=0  // Optional options as above
                     );
 
// Relay() V2 only takes an optional dest and return a non-negative file
//         descriptor upon success or -1 upon failure.
//
int             Relay(const char *dest);  // Optional destination
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
virtual void    Secure(XrdNetSecurity *secp);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
void            setDefaults(int options, int buffsz=0)
                           {netOpts = options; Windowsz = buffsz;}
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
void            setDomain(const char *dname)
                         {if (Domain) free(Domain);
                          Domain = strdup(dname);
                          Domlen = strlen(dname);
                         }
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
void            Trim(char *hname);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
void            unBind();
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
int            WSize();
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
                XrdNet(XrdSysError *erp, XrdNetSecurity *secp=0);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
virtual        ~XrdNet();
 
protected:
 
XrdSysError       *eDest;
XrdNetSecurity    *Police;
char              *Domain;
int                Domlen;
int                iofd;
int                Portnum;
int                PortType;
int                Windowsz;
int                netOpts;
int                BuffSize;
XrdNetBufferQ     *BuffQ;
 
private:
 
int                do_Accept_TCP(XrdNetAddr &myAddr, int opts);
int                do_Accept_TCP(XrdNetPeer &myPeer, int opts);
int                do_Accept_UDP(XrdNetPeer &myPeer, int opts);
};
#endif