XrdClInQueue.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_IN_QUEUE_HH__
#define __XRD_CL_IN_QUEUE_HH__
 
#include <XrdSys/XrdSysPthread.hh>
#include <map>
#include <utility>
#include "XrdCl/XrdClXRootDResponses.hh"
#include "XrdCl/XrdClPostMasterInterfaces.hh"
 
namespace XrdCl
{
  class Message;
 
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class InQueue
  {
    public:
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool AddMessage( Message *msg );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void AddMessageHandler( MsgHandler *handler, time_t expires, bool &rmMsg );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      MsgHandler *GetHandlerForMessage( Message  *msg,
                                        time_t   &expires,
                                        uint16_t &action );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void ReAddMessageHandler( MsgHandler *handler, time_t expires );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void RemoveMessageHandler( MsgHandler *handler );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void ReportStreamEvent( MsgHandler::StreamEvent event,
                              XRootDStatus                    status );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void ReportTimeout( time_t now = 0 );
 
    private:
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool DiscardMessage(Message* msg, uint16_t& sid) const;
 
      typedef std::pair<MsgHandler *, time_t> HandlerAndExpire;
      typedef std::map<uint16_t, HandlerAndExpire> HandlerMap;
      typedef std::map<uint16_t, Message*> MessageMap;
      MessageMap pMessages;
      HandlerMap pHandlers;
      XrdSysRecMutex pMutex;
  };
}
 
#endif // __XRD_CL_IN_QUEUE_HH__