xrootd
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 <utility>
27 
28 namespace XrdCl
29 {
30  class Message;
31 
32  //----------------------------------------------------------------------------
34  //----------------------------------------------------------------------------
35  class InQueue
36  {
37  public:
38  //------------------------------------------------------------------------
40  //------------------------------------------------------------------------
41  bool AddMessage( Message *msg );
42 
43  //------------------------------------------------------------------------
48  //------------------------------------------------------------------------
49  void AddMessageHandler( IncomingMsgHandler *handler, time_t expires );
50 
51  //------------------------------------------------------------------------
60  //------------------------------------------------------------------------
62  time_t &expires,
63  uint16_t &action );
64 
65  //------------------------------------------------------------------------
67  //------------------------------------------------------------------------
68  void ReAddMessageHandler( IncomingMsgHandler *handler, time_t expires );
69 
70  //------------------------------------------------------------------------
72  //------------------------------------------------------------------------
74 
75  //------------------------------------------------------------------------
77  //------------------------------------------------------------------------
79  XRootDStatus status );
80 
81  //------------------------------------------------------------------------
83  //------------------------------------------------------------------------
84  void ReportTimeout( time_t now = 0 );
85 
86  private:
87 
88  //------------------------------------------------------------------------
97  //------------------------------------------------------------------------
98  bool DiscardMessage(Message* msg, uint16_t& sid) const;
99 
100  typedef std::pair<IncomingMsgHandler *, time_t> HandlerAndExpire;
101  typedef std::map<uint16_t, HandlerAndExpire> HandlerMap;
102  typedef std::map<uint16_t, Message*> MessageMap;
106  };
107 }
108 
109 #endif // __XRD_CL_IN_QUEUE_HH__
Definition: XrdSysPthread.hh:241
The message representation used throughout the system.
Definition: XrdClMessage.hh:29
std::pair< IncomingMsgHandler *, time_t > HandlerAndExpire
Definition: XrdClInQueue.hh:100
StreamEvent
Events that may have occurred to the stream.
Definition: XrdClPostMasterInterfaces.hh:98
void RemoveMessageHandler(IncomingMsgHandler *handler)
Remove a listener.
void ReportTimeout(time_t now=0)
Timeout handlers.
HandlerMap pHandlers
Definition: XrdClInQueue.hh:104
MessageMap pMessages
Definition: XrdClInQueue.hh:103
std::map< uint16_t, Message * > MessageMap
Definition: XrdClInQueue.hh:102
void ReportStreamEvent(IncomingMsgHandler::StreamEvent event, XRootDStatus status)
Report an event to the handlers.
Request status.
Definition: XrdClXRootDResponses.hh:218
Definition: XrdClAnyObject.hh:25
bool DiscardMessage(Message *msg, uint16_t &sid) const
Message handler.
Definition: XrdClPostMasterInterfaces.hh:71
A synchronize queue for incoming data.
Definition: XrdClInQueue.hh:35
void AddMessageHandler(IncomingMsgHandler *handler, time_t expires)
bool AddMessage(Message *msg)
Add a fully reconstructed message to the queue.
void ReAddMessageHandler(IncomingMsgHandler *handler, time_t expires)
Re-insert the handler without scanning the cached messages.
std::map< uint16_t, HandlerAndExpire > HandlerMap
Definition: XrdClInQueue.hh:101
XrdSysRecMutex pMutex
Definition: XrdClInQueue.hh:105
IncomingMsgHandler * GetHandlerForMessage(Message *msg, time_t &expires, uint16_t &action)