XrdClChannel.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_CHANNEL_HH__
#define __XRD_CL_POST_CHANNEL_HH__
 
#include <cstdint>
#include <vector>
#include <ctime>
#include <functional>
 
#include "XrdCl/XrdClStatus.hh"
#include "XrdCl/XrdClURL.hh"
#include "XrdCl/XrdClPoller.hh"
#include "XrdCl/XrdClInQueue.hh"
#include "XrdCl/XrdClPostMasterInterfaces.hh"
#include "XrdCl/XrdClAnyObject.hh"
#include "XrdCl/XrdClTaskManager.hh"
 
#include "XrdSys/XrdSysPthread.hh"
 
namespace XrdCl
{
  class Stream;
  class JobManager;
  class VirtualRedirector;
  class TickGeneratorTask;
  class Job;
 
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class Channel
  {
    public:
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Channel( const URL        &url,
               Poller           *poller,
               TransportHandler *transport,
               TaskManager      *taskManager,
               JobManager       *jobManager,
               const URL        &prefurl = URL() );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      ~Channel();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      const URL &GetURL() const
      {
        return pUrl;
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      XRootDStatus Send( Message              *msg,
                         MsgHandler           *handler,
                         bool                  stateful,
                         time_t                expires );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status QueryTransport( uint16_t query, AnyObject &result );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void RegisterEventHandler( ChannelEventHandler *handler );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void RemoveEventHandler( ChannelEventHandler *handler );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Tick( time_t now );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status ForceDisconnect();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status ForceDisconnect( bool hush );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status ForceDisconnect( std::shared_ptr<Channel> self,
                              const uint64_t sess );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Status ForceReconnect();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      uint16_t NbConnectedStrm();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetOnDataConnectHandler( std::shared_ptr<Job> &onConnJob );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool CanCollapse( const URL &url );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void DecFileInstCnt();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void SetSelf( std::shared_ptr<Channel> &self );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Finalize();
 
    private:
 
      URL                    pUrl;
      Poller                *pPoller;
      TransportHandler      *pTransport;
      TaskManager           *pTaskManager;
      std::unique_ptr<Stream> pStream;
      XrdSysMutex            pMutex;
      AnyObject              pChannelData;
      InQueue                pIncoming;
      TickGeneratorTask     *pTickGenerator;
      JobManager            *pJobManager;
      std::weak_ptr<Channel> pSelf;
  };
}
 
#endif // __XRD_CL_POST_CHANNEL_HH__