XrdClPoller.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_POLLER_HH__
#define __XRD_CL_POLLER_HH__
 
#include <cstdint>
#include <ctime>
#include <string>
 
namespace XrdCl
{
  class Socket;
  class Poller;
 
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class SocketHandler
  {
    public:
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      enum EventType
      {
        ReadyToRead  = 0x01,  
        ReadTimeOut  = 0x02,  
        ReadyToWrite = 0x04,  
        WriteTimeOut = 0x08   
      };
 
      //------------------------------------------------------------------------
      // Destructor
      //------------------------------------------------------------------------
      virtual ~SocketHandler() {}
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual void Initialize( Poller * ) {}
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual void Finalize() {};
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual void Event( uint8_t  type,
                          Socket  *socket ) = 0;
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static std::string EventTypeToString( uint8_t event )
      {
        std::string ev;
        if( event & ReadyToRead )  ev += "ReadyToRead|";
        if( event & ReadTimeOut )  ev += "ReadTimeOut|";
        if( event & ReadyToWrite ) ev += "ReadyToWrite|";
        if( event & WriteTimeOut ) ev += "WriteTimeOut|";
        ev.erase( ev.length()-1, 1) ;
        return ev;
      }
  };
 
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class Poller
  {
    public:
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual ~Poller() {}
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual bool Initialize() = 0;
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual bool Finalize() = 0;
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual bool Start() = 0;
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual bool Stop() = 0;
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual bool AddSocket( Socket        *socket,
                              SocketHandler *handler ) = 0;
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual bool RemoveSocket( Socket *socket ) = 0;
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual void ShutdownEvents( Socket *socket ) = 0;
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual bool EnableReadNotification( Socket  *socket,
                                           bool     notify,
                                           time_t   timeout = 60 ) = 0;
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual bool EnableWriteNotification( Socket  *socket,
                                            bool     notify,
                                            time_t   timeout = 60 ) = 0;
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual bool IsRegistered( Socket *socket )  = 0;
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual bool IsRunning() const = 0;
  };
}
 
#endif // __XRD_CL_POLLER_HH__