XRootD
XrdClStream.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_STREAM_HH__
20 #define __XRD_CL_STREAM_HH__
21 
22 #include "XrdCl/XrdClPoller.hh"
23 #include "XrdCl/XrdClStatus.hh"
24 #include "XrdCl/XrdClURL.hh"
27 #include "XrdCl/XrdClJobManager.hh"
28 #include "XrdCl/XrdClInQueue.hh"
29 #include "XrdCl/XrdClUtils.hh"
30 
31 #include "XrdSys/XrdSysPthread.hh"
32 #include "XrdSys/XrdSysRAtomic.hh"
33 #include "XrdNet/XrdNetAddr.hh"
34 #include "XrdOuc/XrdOucCompiler.hh"
35 #include <list>
36 #include <vector>
37 #include <functional>
38 #include <memory>
39 
40 namespace XrdCl
41 {
42  class Message;
43  class Channel;
44  class TransportHandler;
45  class TaskManager;
46  struct SubStreamData;
47 
48  //----------------------------------------------------------------------------
50  //----------------------------------------------------------------------------
51  class Stream
52  {
53  public:
54  //------------------------------------------------------------------------
56  //------------------------------------------------------------------------
58  {
60  Connected = 1,
61  Connecting = 2,
62  Error = 3
63  };
64 
65  //------------------------------------------------------------------------
67  //------------------------------------------------------------------------
68  Stream( const URL *url, const URL &prefer = URL() );
69 
70  //------------------------------------------------------------------------
72  //------------------------------------------------------------------------
73  ~Stream();
74 
75  //------------------------------------------------------------------------
77  //------------------------------------------------------------------------
79 
80  //------------------------------------------------------------------------
82  //------------------------------------------------------------------------
84  MsgHandler *handler,
85  bool stateful,
86  time_t expires );
87 
88  //------------------------------------------------------------------------
90  //------------------------------------------------------------------------
91  void SetTransport( TransportHandler *transport )
92  {
93  pTransport = transport;
94  }
95 
96  //------------------------------------------------------------------------
98  //------------------------------------------------------------------------
99  void SetPoller( Poller *poller )
100  {
101  pPoller = poller;
102  }
103 
104  //------------------------------------------------------------------------
106  //------------------------------------------------------------------------
107  void SetIncomingQueue( InQueue *incomingQueue )
108  {
109  pIncomingQueue = incomingQueue;
110  }
111 
112  //------------------------------------------------------------------------
114  //------------------------------------------------------------------------
115  void SetChannelData( AnyObject *channelData )
116  {
117  pChannelData = channelData;
118  }
119 
120  //------------------------------------------------------------------------
122  //------------------------------------------------------------------------
123  void SetTaskManager( TaskManager *taskManager )
124  {
125  pTaskManager = taskManager;
126  }
127 
128  //------------------------------------------------------------------------
130  //------------------------------------------------------------------------
131  void SetJobManager( JobManager *jobManager )
132  {
133  pJobManager = jobManager;
134  }
135 
136  //------------------------------------------------------------------------
140  //------------------------------------------------------------------------
141  XRootDStatus EnableLink( PathID &path );
142 
143  //------------------------------------------------------------------------
145  //------------------------------------------------------------------------
146  void Disconnect( bool force = false );
147 
148  //------------------------------------------------------------------------
151  //------------------------------------------------------------------------
152  void Tick( time_t now );
153 
154  //------------------------------------------------------------------------
156  //------------------------------------------------------------------------
157  const URL *GetURL() const
158  {
159  return pUrl;
160  }
161 
162  //------------------------------------------------------------------------
164  //------------------------------------------------------------------------
165  void ForceConnect();
166 
167  //------------------------------------------------------------------------
169  //------------------------------------------------------------------------
170  const std::string &GetName() const
171  {
172  return pStreamName;
173  }
174 
175  //------------------------------------------------------------------------
177  //------------------------------------------------------------------------
178  void DisableIfEmpty( uint16_t subStream );
179 
180  //------------------------------------------------------------------------
182  //------------------------------------------------------------------------
183  void OnIncoming( uint16_t subStream,
184  std::shared_ptr<Message> msg,
185  uint32_t bytesReceived );
186 
187  //------------------------------------------------------------------------
188  // Call when one of the sockets is ready to accept a new message
189  //------------------------------------------------------------------------
190  std::pair<Message *, MsgHandler *>
191  OnReadyToWrite( uint16_t subStream );
192 
193  //------------------------------------------------------------------------
194  // Call when a message is written to the socket
195  //------------------------------------------------------------------------
196  void OnMessageSent( uint16_t subStream,
197  Message *msg,
198  uint32_t bytesSent );
199 
200  //------------------------------------------------------------------------
202  //------------------------------------------------------------------------
203  void OnConnect( uint16_t subStream );
204 
205  //------------------------------------------------------------------------
207  //------------------------------------------------------------------------
208  void OnConnectError( uint16_t subStream, XRootDStatus status );
209 
210  //------------------------------------------------------------------------
212  //------------------------------------------------------------------------
213  void OnError( uint16_t subStream, XRootDStatus status );
214 
215  //------------------------------------------------------------------------
217  //------------------------------------------------------------------------
218  void ForceError( XRootDStatus status, bool hush=false );
219 
220  //------------------------------------------------------------------------
222  //------------------------------------------------------------------------
223  bool OnReadTimeout( uint16_t subStream ) XRD_WARN_UNUSED_RESULT;
224 
225  //------------------------------------------------------------------------
227  //------------------------------------------------------------------------
228  bool OnWriteTimeout( uint16_t subStream ) XRD_WARN_UNUSED_RESULT;
229 
230  //------------------------------------------------------------------------
232  //------------------------------------------------------------------------
233  void RegisterEventHandler( ChannelEventHandler *handler );
234 
235  //------------------------------------------------------------------------
237  //------------------------------------------------------------------------
238  void RemoveEventHandler( ChannelEventHandler *handler );
239 
240  //------------------------------------------------------------------------
249  //------------------------------------------------------------------------
250  MsgHandler*
251  InstallIncHandler( std::shared_ptr<Message> &msg, uint16_t stream );
252 
253  //------------------------------------------------------------------------
257  //------------------------------------------------------------------------
258  uint16_t InspectStatusRsp( uint16_t stream, MsgHandler *&incHandler );
259 
260  //------------------------------------------------------------------------
262  //------------------------------------------------------------------------
263  void SetOnDataConnectHandler( std::shared_ptr<Job> &onConnJob )
264  {
265  XrdSysMutexHelper scopedLock( pMutex );
266  pOnDataConnJob = onConnJob;
267  }
268 
269  //------------------------------------------------------------------------
272  //------------------------------------------------------------------------
273  bool CanCollapse( const URL &url );
274 
275  //------------------------------------------------------------------------
277  //------------------------------------------------------------------------
278  Status Query( uint16_t query, AnyObject &result );
279 
280  private:
281 
282  //------------------------------------------------------------------------
284  //------------------------------------------------------------------------
285  static bool IsPartial( Message &msg );
286 
287  //------------------------------------------------------------------------
289  //------------------------------------------------------------------------
290  inline static bool HasNetAddr( const XrdNetAddr &addr,
291  std::vector<XrdNetAddr> &addresses )
292  {
293  auto itr = addresses.begin();
294  for( ; itr != addresses.end() ; ++itr )
295  {
296  if( itr->Same( &addr ) ) return true;
297  }
298 
299  return false;
300  }
301 
302  //------------------------------------------------------------------------
303  // Job handling the incoming messages
304  //------------------------------------------------------------------------
305  class HandleIncMsgJob: public Job
306  {
307  public:
308  HandleIncMsgJob( MsgHandler *handler ): pHandler( handler ) {};
309  virtual ~HandleIncMsgJob() {};
310  virtual void Run( void* )
311  {
312  pHandler->Process();
313  delete this;
314  }
315  private:
316  MsgHandler *pHandler;
317  };
318 
319  //------------------------------------------------------------------------
321  //------------------------------------------------------------------------
322  void OnFatalError( uint16_t subStream,
323  XRootDStatus status,
324  XrdSysMutexHelper &lock );
325 
326  //------------------------------------------------------------------------
328  //------------------------------------------------------------------------
329  void MonitorDisconnection( XRootDStatus status );
330 
331  //------------------------------------------------------------------------
333  //------------------------------------------------------------------------
334  XRootDStatus RequestClose( Message &resp );
335 
336  typedef std::vector<SubStreamData*> SubStreamList;
337 
338  //------------------------------------------------------------------------
339  // Data members
340  //------------------------------------------------------------------------
341  const URL *pUrl;
342  const URL pPrefer;
343  std::string pStreamName;
344  TransportHandler *pTransport;
345  Poller *pPoller;
346  TaskManager *pTaskManager;
347  JobManager *pJobManager;
348  XrdSysRecMutex pMutex;
349  InQueue *pIncomingQueue;
350  AnyObject *pChannelData;
351  uint32_t pLastStreamError;
352  XRootDStatus pLastFatalError;
353  uint16_t pStreamErrorWindow;
354  uint16_t pConnectionCount;
355  uint16_t pConnectionRetry;
356  time_t pConnectionInitTime;
357  uint16_t pConnectionWindow;
358  SubStreamList pSubStreams;
359  std::vector<XrdNetAddr> pAddresses;
360  Utils::AddressType pAddressType;
361  ChannelHandlerList pChannelEvHandlers;
362  uint64_t pSessionId;
363 
364  //------------------------------------------------------------------------
365  // Monitoring info
366  //------------------------------------------------------------------------
367  timeval pConnectionStarted;
368  timeval pConnectionDone;
369  uint64_t pBytesSent;
370  uint64_t pBytesReceived;
371 
372  //------------------------------------------------------------------------
373  // Data stream on-connect handler
374  //------------------------------------------------------------------------
375  std::shared_ptr<Job> pOnDataConnJob;
376 
377  //------------------------------------------------------------------------
378  // Track last assigned Id across all Streams, to ensure unique sessionId
379  //------------------------------------------------------------------------
380  static RAtomic_uint64_t sSessCntGen;
381  };
382 }
383 
384 #endif // __XRD_CL_STREAM_HH__
#define XRD_WARN_UNUSED_RESULT
A synchronize queue for incoming data.
Definition: XrdClInQueue.hh:37
A synchronized queue.
The message representation used throughout the system.
Definition: XrdClMessage.hh:32
Interface for socket pollers.
Definition: XrdClPoller.hh:87
XRootDStatus Send(Message *msg, MsgHandler *handler, bool stateful, time_t expires)
Queue the message for sending.
Definition: XrdClStream.cc:297
void SetTransport(TransportHandler *transport)
Set the transport.
Definition: XrdClStream.hh:91
StreamStatus
Status of the stream.
Definition: XrdClStream.hh:58
@ Disconnected
Not connected.
Definition: XrdClStream.hh:59
@ Error
Broken.
Definition: XrdClStream.hh:62
@ Connected
Connected.
Definition: XrdClStream.hh:60
@ Connecting
In the process of being connected.
Definition: XrdClStream.hh:61
void SetIncomingQueue(InQueue *incomingQueue)
Set the incoming queue.
Definition: XrdClStream.hh:107
bool OnReadTimeout(uint16_t subStream) XRD_WARN_UNUSED_RESULT
On read timeout.
bool CanCollapse(const URL &url)
void SetPoller(Poller *poller)
Set the poller.
Definition: XrdClStream.hh:99
void ForceConnect()
Force connection.
Definition: XrdClStream.cc:347
void ForceError(XRootDStatus status, bool hush=false)
Force error.
Definition: XrdClStream.cc:913
void SetTaskManager(TaskManager *taskManager)
Set task manager.
Definition: XrdClStream.hh:123
void SetOnDataConnectHandler(std::shared_ptr< Job > &onConnJob)
Set the on-connect handler for data streams.
Definition: XrdClStream.hh:263
void SetJobManager(JobManager *jobManager)
Set job manager.
Definition: XrdClStream.hh:131
Status Query(uint16_t query, AnyObject &result)
Query the stream.
void Disconnect(bool force=false)
Disconnect the stream.
Definition: XrdClStream.cc:363
const std::string & GetName() const
Return stream name.
Definition: XrdClStream.hh:170
XRootDStatus EnableLink(PathID &path)
Definition: XrdClStream.cc:187
Stream(const URL *url, const URL &prefer=URL())
Constructor.
Definition: XrdClStream.cc:96
void OnConnect(uint16_t subStream)
Call back when a message has been reconstructed.
Definition: XrdClStream.cc:610
void Tick(time_t now)
Definition: XrdClStream.cc:377
void OnConnectError(uint16_t subStream, XRootDStatus status)
On connect error.
Definition: XrdClStream.cc:709
~Stream()
Destructor.
Definition: XrdClStream.cc:153
bool OnWriteTimeout(uint16_t subStream) XRD_WARN_UNUSED_RESULT
On write timeout.
void DisableIfEmpty(uint16_t subStream)
Disables respective uplink if empty.
Definition: XrdClStream.cc:568
void RemoveEventHandler(ChannelEventHandler *handler)
Remove a channel event handler.
void OnMessageSent(uint16_t subStream, Message *msg, uint32_t bytesSent)
Definition: XrdClStream.cc:584
MsgHandler * InstallIncHandler(std::shared_ptr< Message > &msg, uint16_t stream)
void OnIncoming(uint16_t subStream, std::shared_ptr< Message > msg, uint32_t bytesReceived)
Call back when a message has been reconstructed.
Definition: XrdClStream.cc:471
void OnError(uint16_t subStream, XRootDStatus status)
On error.
Definition: XrdClStream.cc:809
const URL * GetURL() const
Get the URL.
Definition: XrdClStream.hh:157
uint16_t InspectStatusRsp(uint16_t stream, MsgHandler *&incHandler)
void SetChannelData(AnyObject *channelData)
Set the channel data.
Definition: XrdClStream.hh:115
std::pair< Message *, MsgHandler * > OnReadyToWrite(uint16_t subStream)
Definition: XrdClStream.cc:545
XRootDStatus Initialize()
Initializer.
Definition: XrdClStream.cc:171
void RegisterEventHandler(ChannelEventHandler *handler)
Register channel event handler.
Perform the handshake and the authentication for each physical stream.
URL representation.
Definition: XrdClURL.hh:31
AddressType
Address type.
Definition: XrdClUtils.hh:87
Procedure execution status.
Definition: XrdClStatus.hh:115