XRootD
Loading...
Searching...
No Matches
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
23#include <map>
24#include <memory>
25#include <utility>
28
29namespace XrdCl
30{
31 class Message;
32
33 //----------------------------------------------------------------------------
35 //----------------------------------------------------------------------------
36 class InQueue
37 {
38 public:
39 //------------------------------------------------------------------------
48 //------------------------------------------------------------------------
49 void AddMessageHandler( MsgHandler *handler, bool &rmMsg );
50
51 //------------------------------------------------------------------------
58 //------------------------------------------------------------------------
59 void AssignTimeout( MsgHandler *handler );
60
61 //------------------------------------------------------------------------
70 //------------------------------------------------------------------------
71 MsgHandler *GetHandlerForMessage( std::shared_ptr<Message> &msg,
72 time_t &expires,
73 uint16_t &action );
74
75 //------------------------------------------------------------------------
77 //------------------------------------------------------------------------
78 void ReAddMessageHandler( MsgHandler *handler, time_t expires );
79
80 //------------------------------------------------------------------------
82 //------------------------------------------------------------------------
83 void RemoveMessageHandler( MsgHandler *handler );
84
85 //------------------------------------------------------------------------
87 //------------------------------------------------------------------------
89 XRootDStatus status );
90
91 //------------------------------------------------------------------------
93 //------------------------------------------------------------------------
94 void ReportTimeout( time_t now = 0 );
95
96 private:
97
98 //------------------------------------------------------------------------
107 //------------------------------------------------------------------------
108 bool DiscardMessage(Message& msg, uint16_t& sid) const;
109
110 typedef std::pair<MsgHandler *, time_t> HandlerAndExpire;
111 typedef std::map<uint16_t, HandlerAndExpire> HandlerMap;
112 HandlerMap pHandlers;
113 XrdSysRecMutex pMutex;
114 };
115}
116
117#endif // __XRD_CL_IN_QUEUE_HH__
A synchronize queue for incoming data.
void ReportTimeout(time_t now=0)
Timeout handlers.
void RemoveMessageHandler(MsgHandler *handler)
Remove a listener.
void ReAddMessageHandler(MsgHandler *handler, time_t expires)
Re-insert the handler without scanning the cached messages.
void ReportStreamEvent(MsgHandler::StreamEvent event, XRootDStatus status)
Report an event to the handlers.
MsgHandler * GetHandlerForMessage(std::shared_ptr< Message > &msg, time_t &expires, uint16_t &action)
void AssignTimeout(MsgHandler *handler)
void AddMessageHandler(MsgHandler *handler, bool &rmMsg)
The message representation used throughout the system.
StreamEvent
Events that may have occurred to the stream.