xrootd
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
XrdClInQueue.hh
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 // Copyright (c) 2011-2012 by European Organization for Nuclear Research (CERN)
3 // Author: Lukasz Janyst <ljanyst@cern.ch>
4 //------------------------------------------------------------------------------
5 // XRootD is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU Lesser General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // XRootD is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public License
16 // along with XRootD. If not, see <http://www.gnu.org/licenses/>.
17 //------------------------------------------------------------------------------
18 
19 #ifndef __XRD_CL_IN_QUEUE_HH__
20 #define __XRD_CL_IN_QUEUE_HH__
21 
22 #include <XrdSys/XrdSysPthread.hh>
23 #include <map>
24 #include <memory>
25 #include <utility>
28 
29 namespace XrdCl
30 {
31  class Message;
32 
33  //----------------------------------------------------------------------------
35  //----------------------------------------------------------------------------
36  class InQueue
37  {
38  public:
39  //------------------------------------------------------------------------
41  //------------------------------------------------------------------------
42  bool AddMessage( std::shared_ptr<Message> msg );
43 
44  //------------------------------------------------------------------------
51  //------------------------------------------------------------------------
52  void AddMessageHandler( MsgHandler *handler, time_t expires, bool &rmMsg );
53 
54  //------------------------------------------------------------------------
63  //------------------------------------------------------------------------
64  MsgHandler *GetHandlerForMessage( std::shared_ptr<Message> &msg,
65  time_t &expires,
66  uint16_t &action );
67 
68  //------------------------------------------------------------------------
70  //------------------------------------------------------------------------
71  void ReAddMessageHandler( MsgHandler *handler, time_t expires );
72 
73  //------------------------------------------------------------------------
75  //------------------------------------------------------------------------
76  void RemoveMessageHandler( MsgHandler *handler );
77 
78  //------------------------------------------------------------------------
80  //------------------------------------------------------------------------
82  XRootDStatus status );
83 
84  //------------------------------------------------------------------------
86  //------------------------------------------------------------------------
87  void ReportTimeout( time_t now = 0 );
88 
89  private:
90 
91  //------------------------------------------------------------------------
100  //------------------------------------------------------------------------
101  bool DiscardMessage(Message& msg, uint16_t& sid) const;
102 
103  typedef std::pair<MsgHandler *, time_t> HandlerAndExpire;
104  typedef std::map<uint16_t, HandlerAndExpire> HandlerMap;
105  typedef std::map<uint16_t, std::shared_ptr<Message>> MessageMap;
109  };
110 }
111 
112 #endif // __XRD_CL_IN_QUEUE_HH__
Definition: XrdSysPthread.hh:241
The message representation used throughout the system.
Definition: XrdClMessage.hh:29
bool DiscardMessage(Message &msg, uint16_t &sid) const
void AddMessageHandler(MsgHandler *handler, time_t expires, bool &rmMsg)
std::pair< MsgHandler *, time_t > HandlerAndExpire
Definition: XrdClInQueue.hh:103
Message handler.
Definition: XrdClPostMasterInterfaces.hh:50
void ReportStreamEvent(MsgHandler::StreamEvent event, XRootDStatus status)
Report an event to the handlers.
StreamEvent
Events that may have occurred to the stream.
Definition: XrdClPostMasterInterfaces.hh:78
void ReportTimeout(time_t now=0)
Timeout handlers.
HandlerMap pHandlers
Definition: XrdClInQueue.hh:107
MessageMap pMessages
Definition: XrdClInQueue.hh:106
bool AddMessage(std::shared_ptr< Message > msg)
Add a fully reconstructed message to the queue.
Request status.
Definition: XrdClXRootDResponses.hh:218
A synchronize queue for incoming data.
Definition: XrdClInQueue.hh:36
MsgHandler * GetHandlerForMessage(std::shared_ptr< Message > &msg, time_t &expires, uint16_t &action)
void RemoveMessageHandler(MsgHandler *handler)
Remove a listener.
std::map< uint16_t, HandlerAndExpire > HandlerMap
Definition: XrdClInQueue.hh:104
std::map< uint16_t, std::shared_ptr< Message > > MessageMap
Definition: XrdClInQueue.hh:105
XrdSysRecMutex pMutex
Definition: XrdClInQueue.hh:108
void ReAddMessageHandler(MsgHandler *handler, time_t expires)
Re-insert the handler without scanning the cached messages.