XrdClPostMaster.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_POST_MASTER_HH__
#define __XRD_CL_POST_MASTER_HH__
 
#include <cstdint>
#include <map>
#include <vector>
#include <functional>
#include <memory>
 
#include "XrdCl/XrdClStatus.hh"
#include "XrdCl/XrdClURL.hh"
#include "XrdCl/XrdClPostMasterInterfaces.hh"
 
#include "XrdSys/XrdSysPthread.hh"
 
namespace XrdCl
{
  class Poller;
  class TaskManager;
  class Channel;
  class JobManager;
  class Job;
 
  struct PostMasterImpl;
 
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class PostMaster
  {
    public:
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      PostMaster();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      virtual ~PostMaster();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool Initialize();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool Finalize();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool Start();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool Stop();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool Reinitialize();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus Send( const URL    &url,
                         Message      *msg,
                         MsgHandler   *handler,
                         bool          stateful,
                         time_t        expires );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status Redirect( const URL  &url,
                       Message    *msg,
                       MsgHandler *handler);
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status QueryTransport( const URL &url,
                             uint16_t   query,
                             AnyObject &result );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status RegisterEventHandler( const URL           &url,
                                   ChannelEventHandler *handler );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status RemoveEventHandler( const URL           &url,
                                 ChannelEventHandler *handler );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      TaskManager *GetTaskManager();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      JobManager *GetJobManager();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status ForceDisconnect( const URL &url );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status ForceReconnect( const URL &url );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      uint16_t NbConnectedStrm( const URL &url );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetOnDataConnectHandler( const URL            &url,
                                    std::shared_ptr<Job>  onConnJob );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetOnConnectHandler( std::unique_ptr<Job> onConnJob );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetConnectionErrorHandler( std::function<void( const URL&, const XRootDStatus& )> handler );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void NotifyConnectHandler( const URL &url );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void NotifyConnErrHandler( const URL &url, const XRootDStatus &status );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void CollapseRedirect( const URL &oldurl, const URL &newURL );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void DecFileInstCnt( const URL &url );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool IsRunning();
 
    private:
      Channel *GetChannel( const URL &url );
 
      std::unique_ptr<PostMasterImpl> pImpl;
  };
}
 
#endif // __XRD_CL_POST_MASTER_HH__