XrdClSocket.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// Copyright (c) 2011-2012 by European Organization for Nuclear Research (CERN)
// Author: Lukasz Janyst <ljanyst@cern.ch>
//------------------------------------------------------------------------------
// 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 General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with XRootD.  If not, see <http://www.gnu.org/licenses/>.
//------------------------------------------------------------------------------
 
#ifndef __XRD_CL_SOCKET_HH__
#define __XRD_CL_SOCKET_HH__
 
#include <stdint.h>
#include <string>
#include <sys/socket.h>
 
#include "XrdCl/XrdClStatus.hh"
#include "XrdNet/XrdNetAddr.hh"
 
namespace XrdCl
{
  class AnyObject;
 
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class Socket
  {
    public:
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      enum SocketStatus
      {
        Disconnected  = 1,      
        Connected     = 2,      
        Connecting    = 3       
      };
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Socket( int socket = -1, SocketStatus status = Disconnected ):
        pSocket(socket), pStatus( status ), pServerAddr( 0 ),
        pProtocolFamily( AF_INET ),
        pChannelID( 0 )
      {
      };
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual ~Socket()
      {
        Close();
      };
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status Initialize( int family = AF_INET );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status SetFlags( int flags );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status GetFlags( int &flags );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status GetSockOpt( int level, int optname, void *optval,
                         socklen_t *optlen );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status SetSockOpt( int level, int optname, const void *optval,
                         socklen_t optlen );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status Connect( const std::string &host,
                      uint16_t           port,
                      uint16_t           timout = 10 );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status ConnectToAddress( const XrdNetAddr &addr,
                               uint16_t          timout = 10 );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Close();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      SocketStatus GetStatus() const
      {
        return pStatus;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetStatus( SocketStatus status )
      {
        pStatus = status;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status ReadRaw( void *buffer, uint32_t size, int32_t timeout,
                      uint32_t &bytesRead );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status WriteRaw( void *buffer, uint32_t size, int32_t timeout,
                       uint32_t &bytesWritten );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      ssize_t Send( void *buffer, uint32_t size );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      ssize_t WriteV( iovec *iov, int iovcnt );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      int GetFD()
      {
        return pSocket;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      std::string GetSockName() const;
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      std::string GetPeerName() const;
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      std::string GetName() const;
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      const XrdNetAddr &GetServerAddress() const
      {
        return pServerAddr;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetChannelID( AnyObject *channelID )
      {
        pChannelID = channelID;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      const AnyObject* GetChannelID() const
      {
        return pChannelID;
      }
 
    private:
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status Poll( bool readyForReading, bool readyForWriting,
                   int32_t timeout );
 
      int                  pSocket;
      SocketStatus         pStatus;
      XrdNetAddr           pServerAddr;
      mutable std::string  pSockName;     // mutable because it's for caching
      mutable std::string  pPeerName;
      mutable std::string  pName;
      int                  pProtocolFamily;
      AnyObject           *pChannelID;
  };
}
 
#endif // __XRD_CL_SOCKET_HH__