XrdClPollerBuiltIn.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_BUILT_IN_HH__
#define __XRD_CL_POLLER_BUILT_IN_HH__
 
#include "XrdSys/XrdSysPthread.hh"
#include "XrdCl/XrdClPoller.hh"
#include <map>
#include <vector>
 
 
namespace XrdSys { namespace IOEvents
{
  class Poller;
}; };
 
namespace XrdCl
{
  class AnyObject;
 
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class PollerBuiltIn: public Poller
  {
    public:
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      PollerBuiltIn() : pNbPoller( GetNbPollerInit() ){}
 
      ~PollerBuiltIn() {}
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual bool Initialize();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual bool Finalize();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual bool Start();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual bool Stop();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual bool AddSocket( Socket        *socket,
                              SocketHandler *handler );
 
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual bool RemoveSocket( Socket *socket );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual void ShutdownEvents( Socket *socket );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual bool EnableReadNotification( Socket  *socket,
                                           bool     notify,
                                           time_t   timeout = 60 );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual bool EnableWriteNotification( Socket  *socket,
                                            bool     notify,
                                            time_t   timeout = 60);
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual bool IsRegistered( Socket *socket );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual bool IsRunning() const
      {
        return !pPollerPool.empty();
      }
 
    private:
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XrdSys::IOEvents::Poller* GetNextPoller();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XrdSys::IOEvents::Poller* RegisterAndGetPoller(const Socket *socket);
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void UnregisterFromPoller( const Socket *socket);
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XrdSys::IOEvents::Poller* GetPoller(const Socket *socket);
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      static int GetNbPollerInit();
 
      // associates socket file descriptor to a poller
      typedef std::map<int, XrdSys::IOEvents::Poller *> PollerMap;
 
      typedef std::map<Socket *, void *>              SocketMap;
      typedef std::vector<XrdSys::IOEvents::Poller *> PollerPool;
 
      SocketMap            pSocketMap;
      PollerMap            pPollerMap;
      PollerPool           pPollerPool;
      PollerPool::iterator pNext;
      const int            pNbPoller;
      XrdSysMutex          pMutex;
  };
}
 
#endif // __XRD_CL_POLLER_BUILT_IN_HH__