xrootd
XrdClPostMasterInterfaces.hh
Go to the documentation of this file.
1 //------------------------------------------------------------------------------
2 // Copyright (c) 2011-2014 by European Organization for Nuclear Research (CERN)
3 // Author: Lukasz Janyst <ljanyst@cern.ch>
4 //------------------------------------------------------------------------------
5 // This file is part of the XRootD software suite.
6 //
7 // XRootD is free software: you can redistribute it and/or modify
8 // it under the terms of the GNU Lesser General Public License as published by
9 // the Free Software Foundation, either version 3 of the License, or
10 // (at your option) any later version.
11 //
12 // XRootD is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 // GNU General Public License for more details.
16 //
17 // You should have received a copy of the GNU Lesser General Public License
18 // along with XRootD. If not, see <http://www.gnu.org/licenses/>.
19 //
20 // In applying this licence, CERN does not waive the privileges and immunities
21 // granted to it by virtue of its status as an Intergovernmental Organization
22 // or submit itself to any jurisdiction.
23 //------------------------------------------------------------------------------
24 
25 #ifndef __XRD_CL_POST_MASTER_INTERFACES_HH__
26 #define __XRD_CL_POST_MASTER_INTERFACES_HH__
27 
28 #include <stdint.h>
29 #include <ctime>
30 
31 #include "XrdCl/XrdClStatus.hh"
32 #include "XrdCl/XrdClAnyObject.hh"
33 #include "XrdCl/XrdClURL.hh"
34 
35 namespace XrdCl
36 {
37  class Channel;
38  class Message;
39  class URL;
40 
41  //----------------------------------------------------------------------------
43  //----------------------------------------------------------------------------
45  {
46  public:
47  virtual ~MessageFilter() {}
48 
49  //------------------------------------------------------------------------
52  //------------------------------------------------------------------------
53  virtual bool Filter( const Message *msg ) = 0;
54  };
55 
56  //----------------------------------------------------------------------------
58  //----------------------------------------------------------------------------
60  {
61  public:
62  //------------------------------------------------------------------------
64  //------------------------------------------------------------------------
65  enum Action
66  {
67  Take = 0x0001,
68  Ignore = 0x0002,
69  RemoveHandler = 0x0004,
70 
71  Raw = 0x0008,
72 
73 
74  NoProcess = 0x0010
75 
76 
77  };
78 
79  //------------------------------------------------------------------------
81  //------------------------------------------------------------------------
83  {
84  Ready = 1,
85  Broken = 2,
86  Timeout = 3,
88  };
89 
90  //------------------------------------------------------------------------
92  //------------------------------------------------------------------------
93 
94  virtual ~IncomingMsgHandler() {}
95 
96  //------------------------------------------------------------------------
102  //------------------------------------------------------------------------
103  virtual uint16_t Examine( Message *msg ) = 0;
104 
105  //------------------------------------------------------------------------
109  //------------------------------------------------------------------------
110  virtual void Process( Message *msg ) { (void)msg; };
111 
112  //------------------------------------------------------------------------
122  //------------------------------------------------------------------------
124  int socket,
125  uint32_t &bytesRead )
126  {
127  (void)msg; (void)socket; (void)bytesRead;
128  return Status( stOK, suDone );
129  };
130 
131  //------------------------------------------------------------------------
138  //------------------------------------------------------------------------
139  virtual uint8_t OnStreamEvent( StreamEvent event,
140  uint16_t streamNum,
141  Status status )
142  {
143  (void)event; (void)streamNum; (void)status;
144  return 0;
145  };
146  };
147 
148  //----------------------------------------------------------------------------
150  //----------------------------------------------------------------------------
152  {
153  public:
154  virtual ~OutgoingMsgHandler() {}
155 
156  //------------------------------------------------------------------------
158  //------------------------------------------------------------------------
159  virtual void OnStatusReady( const Message *message,
160  Status status ) = 0;
161 
162  //------------------------------------------------------------------------
170  //------------------------------------------------------------------------
171  virtual void OnReadyToSend( Message *msg, uint16_t streamNum )
172  {
173  (void)msg; (void)streamNum;
174  };
175 
176  //------------------------------------------------------------------------
180  //------------------------------------------------------------------------
181  virtual bool IsRaw() const { return false; }
182 
183  //------------------------------------------------------------------------
192  //------------------------------------------------------------------------
193  virtual Status WriteMessageBody( int socket,
194  uint32_t &bytesRead )
195  {
196  (void)socket; (void)bytesRead;
197  return Status();
198  }
199  };
200 
201  //----------------------------------------------------------------------------
203  //----------------------------------------------------------------------------
205  {
206  public:
207  //------------------------------------------------------------------------
209  //------------------------------------------------------------------------
211  {
215  };
216 
217  //------------------------------------------------------------------------
219  //------------------------------------------------------------------------
220  virtual ~ChannelEventHandler() {};
221 
222  //------------------------------------------------------------------------
230  //------------------------------------------------------------------------
231  virtual bool OnChannelEvent( ChannelEvent event,
232  Status status,
233  uint16_t stream ) = 0;
234  };
235 
236  //----------------------------------------------------------------------------
238  //----------------------------------------------------------------------------
240  {
241  //--------------------------------------------------------------------------
243  //--------------------------------------------------------------------------
244  HandShakeData( const URL *addr, uint16_t stream, uint16_t subStream ):
245  step(0), out(0), in(0), url(addr), streamId(stream),
246  subStreamId( subStream ), startTime( time(0) ), serverAddr(0)
247  {}
248  uint16_t step;
251  const URL *url;
252  uint16_t streamId;
253  uint16_t subStreamId;
254  time_t startTime;
255  const void *serverAddr;
256  std::string clientName;
257  std::string streamName;
258  };
259 
260  //----------------------------------------------------------------------------
263  //----------------------------------------------------------------------------
264  struct PathID
265  {
266  PathID( uint16_t u = 0, uint16_t d = 0 ): up(u), down(d) {}
267  uint16_t up;
268  uint16_t down;
269  };
270 
271  //----------------------------------------------------------------------------
274  //----------------------------------------------------------------------------
276  {
277  static const uint16_t Name = 1;
278  static const uint16_t Auth = 2;
279  };
280 
281  //----------------------------------------------------------------------------
283  //----------------------------------------------------------------------------
285  {
286  public:
287 
288  //------------------------------------------------------------------------
290  //------------------------------------------------------------------------
292  {
293  NoAction = 0x0000,
294  DigestMsg = 0x0001,
295 
296  AbortStream = 0x0002,
297 
298 
299  CloseStream = 0x0004,
300 
301  ResumeStream = 0x0008,
302 
303  HoldStream = 0x0010
304  };
305 
306 
307  virtual ~TransportHandler() {}
308 
309  //------------------------------------------------------------------------
320  //------------------------------------------------------------------------
321  virtual Status GetHeader( Message *message, int socket ) = 0;
322 
323  //------------------------------------------------------------------------
332  //------------------------------------------------------------------------
333  virtual Status GetBody( Message *message, int socket ) = 0;
334 
335  //------------------------------------------------------------------------
337  //------------------------------------------------------------------------
338  virtual void InitializeChannel( AnyObject &channelData ) = 0;
339 
340  //------------------------------------------------------------------------
342  //------------------------------------------------------------------------
343  virtual void FinalizeChannel( AnyObject &channelData ) = 0;
344 
345  //------------------------------------------------------------------------
347  //------------------------------------------------------------------------
348  virtual Status HandShake( HandShakeData *handShakeData,
349  AnyObject &channelData ) = 0;
350 
351  //------------------------------------------------------------------------
353  //------------------------------------------------------------------------
354  virtual bool IsStreamTTLElapsed( time_t inactiveTime,
355  uint16_t streamId,
356  AnyObject &channelData ) = 0;
357 
358  //------------------------------------------------------------------------
361  //------------------------------------------------------------------------
362  virtual Status IsStreamBroken( time_t inactiveTime,
363  uint16_t streamId,
364  AnyObject &channelData ) = 0;
365 
366  //------------------------------------------------------------------------
372  //------------------------------------------------------------------------
373  virtual PathID Multiplex( Message *msg,
374  AnyObject &channelData,
375  PathID *hint = 0 ) = 0;
376 
377  //------------------------------------------------------------------------
383  //------------------------------------------------------------------------
384  virtual PathID MultiplexSubStream( Message *msg,
385  uint16_t streamId,
386  AnyObject &channelData,
387  PathID *hint = 0 ) = 0;
388 
389  //------------------------------------------------------------------------
391  //------------------------------------------------------------------------
392  virtual uint16_t StreamNumber( AnyObject &channelData ) = 0;
393 
394  //------------------------------------------------------------------------
396  //------------------------------------------------------------------------
397  virtual uint16_t SubStreamNumber( AnyObject &channelData ) = 0;
398 
399  //------------------------------------------------------------------------
401  //------------------------------------------------------------------------
402  virtual void Disconnect( AnyObject &channelData,
403  uint16_t streamId,
404  uint16_t subStreamId ) = 0;
405 
406  //------------------------------------------------------------------------
408  //------------------------------------------------------------------------
409  virtual Status Query( uint16_t query,
410  AnyObject &result,
411  AnyObject &channelData ) = 0;
412 
413  //------------------------------------------------------------------------
415  //------------------------------------------------------------------------
416  virtual uint32_t MessageReceived( Message *msg,
417  uint16_t streamId,
418  uint16_t subStream,
419  AnyObject &channelData ) = 0;
420 
421  //------------------------------------------------------------------------
423  //------------------------------------------------------------------------
424  virtual void MessageSent( Message *msg,
425  uint16_t streamId,
426  uint16_t subStream,
427  uint32_t bytesSent,
428  AnyObject &channelData ) = 0;
429  };
430 }
431 
432 #endif // __XRD_CL_POST_MASTER_INTERFACES_HH__