XrdClOutQueue.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_OUT_QUEUE_HH__
#define __XRD_CL_OUT_QUEUE_HH__
 
#include <list>
#include <utility>
#include "XrdCl/XrdClXRootDResponses.hh"
 
namespace XrdCl
{
  class Message;
  class MsgHandler;
 
  //----------------------------------------------------------------------------
  //----------------------------------------------------------------------------
  class OutQueue
  {
    public:
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void PushBack( Message              *msg,
                     MsgHandler   *handler,
                     time_t                expires,
                     bool                  stateful );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void PushFront( Message              *msg,
                      MsgHandler   *handler,
                      time_t                expires,
                      bool                  stateful );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      Message *PopMessage( MsgHandler   *&handler,
                           time_t                &expires,
                           bool                  &stateful );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void PopFront();
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void Report( XRootDStatus status );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      bool IsEmpty() const
      {
        return pMessages.empty();
      }
 
      //------------------------------------------------------------------------
      // Return the size of the queue
      //------------------------------------------------------------------------
      uint64_t GetSize() const
      {
        return pMessages.size();
      }
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      uint64_t GetSizeStateless() const;
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void GrabExpired( OutQueue &queue, time_t exp = 0 );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void GrabStateful( OutQueue &queue );
 
      //------------------------------------------------------------------------
      //------------------------------------------------------------------------
      void GrabItems( OutQueue &queue );
 
      //------------------------------------------------------------------------
      // Helper struct holding all the message data
      //------------------------------------------------------------------------
      struct MsgHelper
      {
        MsgHelper( Message *m = nullptr, MsgHandler *h = nullptr, time_t r = 0, bool s = false ):
          msg( m ), handler( h ), expires( r ), stateful( s ) {}
 
        void Reset()
        {
          msg = 0; handler = 0; expires = 0; stateful = 0;
        }
 
        Message      *msg;
        MsgHandler   *handler;
        time_t        expires;
        bool          stateful;
      };
 
    private:
 
      typedef std::list<MsgHelper> MessageList;
      MessageList pMessages;
  };
}
 
#endif // __XRD_CL_OUT_QUEUE_HH__