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 
29 
30 #include <stdint.h>
31 #include <ctime>
32 
33 #include "XrdCl/XrdClStatus.hh"
34 #include "XrdCl/XrdClAnyObject.hh"
35 #include "XrdCl/XrdClURL.hh"
36 
37 class XrdNetAddr;
38 
39 namespace XrdCl
40 {
41  class Channel;
42  class Message;
43  class URL;
44  class Socket;
45 
46  //----------------------------------------------------------------------------
48  //----------------------------------------------------------------------------
50  {
51  public:
52  virtual ~MessageFilter() {}
53 
54  //------------------------------------------------------------------------
57  //------------------------------------------------------------------------
58  virtual bool Filter( const Message *msg ) = 0;
59 
60  //------------------------------------------------------------------------
64  //------------------------------------------------------------------------
65  virtual uint16_t GetSid() const = 0;
66  };
67 
68  //----------------------------------------------------------------------------
70  //----------------------------------------------------------------------------
72  {
73  public:
74  //------------------------------------------------------------------------
76  //------------------------------------------------------------------------
77  enum Action
78  {
79  Take = 0x0001,
80  Ignore = 0x0002,
81  RemoveHandler = 0x0004,
82  Raw = 0x0008,
84  NoProcess = 0x0010
87  };
90 
91  //------------------------------------------------------------------------
93  //------------------------------------------------------------------------
95  {
96  Ready = 1,
97  Broken = 2,
98  Timeout = 3,
100  };
101 
102  //------------------------------------------------------------------------
104  //------------------------------------------------------------------------
105 
106  virtual ~IncomingMsgHandler() {}
107 
108  //------------------------------------------------------------------------
114  //------------------------------------------------------------------------
115  virtual uint16_t Examine( Message *msg ) = 0;
116 
117  //------------------------------------------------------------------------
121  //------------------------------------------------------------------------
122  virtual uint16_t GetSid() const = 0;
123 
124  //------------------------------------------------------------------------
128  //------------------------------------------------------------------------
129  virtual void Process( Message *msg ) { (void)msg; };
130 
131  //------------------------------------------------------------------------
141  //------------------------------------------------------------------------
143  Socket *socket,
144  uint32_t &bytesRead )
145  {
146  (void)msg; (void)socket; (void)bytesRead;
147  return Status( stOK, suDone );
148  };
149 
150  //------------------------------------------------------------------------
156  //------------------------------------------------------------------------
157  virtual uint8_t OnStreamEvent( StreamEvent event,
158  XRootDStatus status )
159  {
160  (void)event; (void)status;
161  return 0;
162  };
163  };
164 
165  //----------------------------------------------------------------------------
167  //----------------------------------------------------------------------------
169  {
170  public:
171  virtual ~OutgoingMsgHandler() {}
172 
173  //------------------------------------------------------------------------
175  //------------------------------------------------------------------------
176  virtual void OnStatusReady( const Message *message,
177  XRootDStatus status ) = 0;
178 
179  //------------------------------------------------------------------------
186  //------------------------------------------------------------------------
187  virtual void OnReadyToSend( Message *msg )
188  {
189  (void)msg;
190  };
191 
192  //------------------------------------------------------------------------
196  //------------------------------------------------------------------------
197  virtual bool IsRaw() const { return false; }
198 
199  //------------------------------------------------------------------------
208  //------------------------------------------------------------------------
209  virtual Status WriteMessageBody( Socket *socket,
210  uint32_t &bytesWritten )
211  {
212  (void)socket; (void)bytesWritten;
213  return Status();
214  }
215  };
216 
217  //----------------------------------------------------------------------------
219  //----------------------------------------------------------------------------
221  {
222  public:
223  //------------------------------------------------------------------------
225  //------------------------------------------------------------------------
227  {
231  };
232 
233  //------------------------------------------------------------------------
235  //------------------------------------------------------------------------
236  virtual ~ChannelEventHandler() {};
237 
238  //------------------------------------------------------------------------
246  //------------------------------------------------------------------------
247  virtual bool OnChannelEvent( ChannelEvent event,
248  Status status ) = 0;
249  };
250 
251  //----------------------------------------------------------------------------
253  //----------------------------------------------------------------------------
254 
256  {
257  //--------------------------------------------------------------------------
259  //--------------------------------------------------------------------------
260  HandShakeData( const URL *addr, uint16_t subStream ):
261  step(0), out(0), in(0), url(addr), subStreamId( subStream ),
262  startTime( time(0) ), serverAddr(0)
263  {}
264  uint16_t step;
267  const URL *url;
268  uint16_t subStreamId;
269  time_t startTime;
270  const
272  std::string clientName;
273  std::string streamName;
274  };
275 
276  //----------------------------------------------------------------------------
279  //----------------------------------------------------------------------------
280  struct PathID
281  {
282  PathID( uint16_t u = 0, uint16_t d = 0 ): up(u), down(d) {}
283  uint16_t up;
284  uint16_t down;
285  };
286 
287  //----------------------------------------------------------------------------
290  //----------------------------------------------------------------------------
292  {
293  static const uint16_t Name = 1;
294  static const uint16_t Auth = 2;
295  };
296 
297  //----------------------------------------------------------------------------
299  //----------------------------------------------------------------------------
301  {
302  public:
303 
304  //------------------------------------------------------------------------
306  //------------------------------------------------------------------------
308  {
309  NoAction = 0x0000,
310  DigestMsg = 0x0001,
311  AbortStream = 0x0002,
313  CloseStream = 0x0004,
316  ResumeStream = 0x0008,
318  HoldStream = 0x0010,
320  RequestClose = 0x0020
321  };
322 
323 
324  virtual ~TransportHandler() {}
325 
326  //------------------------------------------------------------------------
337  //------------------------------------------------------------------------
338  virtual Status GetHeader( Message *message, Socket *socket ) = 0;
339 
340  //------------------------------------------------------------------------
349  //------------------------------------------------------------------------
350  virtual Status GetBody( Message *message, Socket *socket ) = 0;
351 
352  //------------------------------------------------------------------------
354  //------------------------------------------------------------------------
355  virtual void InitializeChannel( const URL &url,
356  AnyObject &channelData ) = 0;
357 
358  //------------------------------------------------------------------------
360  //------------------------------------------------------------------------
361  virtual void FinalizeChannel( AnyObject &channelData ) = 0;
362 
363  //------------------------------------------------------------------------
365  //------------------------------------------------------------------------
366  virtual Status HandShake( HandShakeData *handShakeData,
367  AnyObject &channelData ) = 0;
368 
369  //------------------------------------------------------------------------
370  // @return true if handshake has been done and stream is connected,
371  // false otherwise
372  //------------------------------------------------------------------------
373  virtual bool HandShakeDone( HandShakeData *handShakeData,
374  AnyObject &channelData ) = 0;
375 
376  //------------------------------------------------------------------------
378  //------------------------------------------------------------------------
379  virtual bool IsStreamTTLElapsed( time_t inactiveTime,
380  AnyObject &channelData ) = 0;
381 
382  //------------------------------------------------------------------------
385  //------------------------------------------------------------------------
386  virtual Status IsStreamBroken( time_t inactiveTime,
387  AnyObject &channelData ) = 0;
388 
389  //------------------------------------------------------------------------
395  //------------------------------------------------------------------------
396  virtual PathID Multiplex( Message *msg,
397  AnyObject &channelData,
398  PathID *hint = 0 ) = 0;
399 
400  //------------------------------------------------------------------------
406  //------------------------------------------------------------------------
407  virtual PathID MultiplexSubStream( Message *msg,
408  AnyObject &channelData,
409  PathID *hint = 0 ) = 0;
410 
411  //------------------------------------------------------------------------
413  //------------------------------------------------------------------------
414  virtual uint16_t SubStreamNumber( AnyObject &channelData ) = 0;
415 
416  //------------------------------------------------------------------------
418  //------------------------------------------------------------------------
419  virtual void Disconnect( AnyObject &channelData,
420  uint16_t subStreamId ) = 0;
421 
422  //------------------------------------------------------------------------
424  //------------------------------------------------------------------------
425  virtual Status Query( uint16_t query,
426  AnyObject &result,
427  AnyObject &channelData ) = 0;
428 
429  //------------------------------------------------------------------------
431  //------------------------------------------------------------------------
432  virtual uint32_t MessageReceived( Message *msg,
433  uint16_t subStream,
434  AnyObject &channelData ) = 0;
435 
436  //------------------------------------------------------------------------
438  //------------------------------------------------------------------------
439  virtual void MessageSent( Message *msg,
440  uint16_t subStream,
441  uint32_t bytesSent,
442  AnyObject &channelData ) = 0;
443 
444  //------------------------------------------------------------------------
446  //------------------------------------------------------------------------
447  virtual void WaitBeforeExit() = 0;
448 
449  //------------------------------------------------------------------------
451  //------------------------------------------------------------------------
452  virtual bool NeedEncryption( HandShakeData *handShakeData,
453  AnyObject &channelData ) = 0;
454 
455  //------------------------------------------------------------------------
457  //------------------------------------------------------------------------
458  virtual Status GetSignature( Message *toSign, Message *&sign,
459  AnyObject &channelData ) = 0;
460  };
461 }
462 
463 #endif // __XRD_CL_POST_MASTER_INTERFACES_HH__
virtual void MessageSent(Message *msg, uint16_t subStream, uint32_t bytesSent, AnyObject &channelData)=0
Notify the transport about a message having been sent.
Definition: XrdClAnyObject.hh:32
const uint16_t stOK
Everything went OK.
Definition: XrdClStatus.hh:31
Definition: XrdClPostMasterInterfaces.hh:83
virtual void FinalizeChannel(AnyObject &channelData)=0
Finalize channel.
Take ownership over the message.
Definition: XrdClPostMasterInterfaces.hh:79
Message filter.
Definition: XrdClPostMasterInterfaces.hh:49
Definition: XrdClPostMasterInterfaces.hh:81
virtual ~IncomingMsgHandler()
Event types that the message handler may receive.
Definition: XrdClPostMasterInterfaces.hh:106
HandShakeData(const URL *addr, uint16_t subStream)
Constructor.
Definition: XrdClPostMasterInterfaces.hh:260
Stream has been broken and won&#39;t be recovered.
Definition: XrdClPostMasterInterfaces.hh:99
virtual Status GetBody(Message *message, Socket *socket)=0
The message representation used throughout the system.
Definition: XrdClMessage.hh:29
const XrdNetAddr * serverAddr
Server address.
Definition: XrdClPostMasterInterfaces.hh:271
time_t startTime
Timestamp of when the handshake started.
Definition: XrdClPostMasterInterfaces.hh:269
virtual ~ChannelEventHandler()
Destructor.
Definition: XrdClPostMasterInterfaces.hh:236
StreamAction
Stream actions that may be triggered by incoming control messages.
Definition: XrdClPostMasterInterfaces.hh:307
const URL * url
Destination URL.
Definition: XrdClPostMasterInterfaces.hh:267
virtual PathID Multiplex(Message *msg, AnyObject &channelData, PathID *hint=0)=0
Definition: XrdClPostMasterInterfaces.hh:280
const uint16_t suDone
Definition: XrdClStatus.hh:38
uint16_t subStreamId
Sub-stream id.
Definition: XrdClPostMasterInterfaces.hh:268
virtual uint32_t MessageReceived(Message *msg, uint16_t subStream, AnyObject &channelData)=0
Check if the message invokes a stream action.
std::string clientName
Client name (an IPv6 representation)
Definition: XrdClPostMasterInterfaces.hh:272
static const uint16_t Name
Transport name, returns const char *.
Definition: XrdClPostMasterInterfaces.hh:293
Message * in
Message that has been received.
Definition: XrdClPostMasterInterfaces.hh:266
StreamEvent
Events that may have occurred to the stream.
Definition: XrdClPostMasterInterfaces.hh:94
virtual bool NeedEncryption(HandShakeData *handShakeData, AnyObject &channelData)=0
uint16_t up
Definition: XrdClPostMasterInterfaces.hh:283
Definition: XrdNetAddr.hh:41
Procedure execution status.
Definition: XrdClStatus.hh:110
virtual uint16_t Examine(Message *msg)=0
virtual uint16_t GetSid() const =0
uint16_t step
Handshake step.
Definition: XrdClPostMasterInterfaces.hh:264
Send a close request.
Definition: XrdClPostMasterInterfaces.hh:320
virtual Status IsStreamBroken(time_t inactiveTime, AnyObject &channelData)=0
virtual Status Query(uint16_t query, AnyObject &result, AnyObject &channelData)=0
Query the channel.
virtual Status GetSignature(Message *toSign, Message *&sign, AnyObject &channelData)=0
Get signature for given message.
virtual bool Filter(const Message *msg)=0
Data structure that carries the handshake information.
Definition: XrdClPostMasterInterfaces.hh:255
virtual void OnReadyToSend(Message *msg)
Definition: XrdClPostMasterInterfaces.hh:187
Definition: XrdClPostMasterInterfaces.hh:310
virtual bool HandShakeDone(HandShakeData *handShakeData, AnyObject &channelData)=0
virtual ~TransportHandler()
Definition: XrdClPostMasterInterfaces.hh:324
virtual Status HandShake(HandShakeData *handShakeData, AnyObject &channelData)=0
HandHake.
Perform the handshake and the authentication for each physical stream.
Definition: XrdClPostMasterInterfaces.hh:300
Stream has been broken and won&#39;t be recovered.
Definition: XrdClPostMasterInterfaces.hh:230
The stream is broken.
Definition: XrdClPostMasterInterfaces.hh:229
The declared timeout has occurred.
Definition: XrdClPostMasterInterfaces.hh:98
Request status.
Definition: XrdClXRootDResponses.hh:214
Definition: XrdClAnyObject.hh:25
Channel event handler.
Definition: XrdClPostMasterInterfaces.hh:220
The stream has become connected.
Definition: XrdClPostMasterInterfaces.hh:228
The stream is broken.
Definition: XrdClPostMasterInterfaces.hh:97
Message handler.
Definition: XrdClPostMasterInterfaces.hh:71
virtual uint16_t SubStreamNumber(AnyObject &channelData)=0
Return a number of substreams per stream that should be created.
virtual Status WriteMessageBody(Socket *socket, uint32_t &bytesWritten)
Definition: XrdClPostMasterInterfaces.hh:209
virtual bool IsStreamTTLElapsed(time_t inactiveTime, AnyObject &channelData)=0
Check if the stream should be disconnected.
virtual Status GetHeader(Message *message, Socket *socket)=0
uint16_t down
Definition: XrdClPostMasterInterfaces.hh:284
virtual uint8_t OnStreamEvent(StreamEvent event, XRootDStatus status)
Definition: XrdClPostMasterInterfaces.hh:157
Definition: XrdClPostMasterInterfaces.hh:317
Action
Actions to be taken after a message is processed by the handler.
Definition: XrdClPostMasterInterfaces.hh:77
Definition: XrdClPostMasterInterfaces.hh:312
Definition: XrdClPostMasterInterfaces.hh:291
URL representation.
Definition: XrdClURL.hh:30
virtual void WaitBeforeExit()=0
Wait before exit.
No action.
Definition: XrdClPostMasterInterfaces.hh:309
virtual bool OnChannelEvent(ChannelEvent event, Status status)=0
virtual Status ReadMessageBody(Message *msg, Socket *socket, uint32_t &bytesRead)
Definition: XrdClPostMasterInterfaces.hh:142
virtual ~MessageFilter()
Definition: XrdClPostMasterInterfaces.hh:52
virtual void Process(Message *msg)
Definition: XrdClPostMasterInterfaces.hh:129
Ignore the message.
Definition: XrdClPostMasterInterfaces.hh:80
The stream has become connected.
Definition: XrdClPostMasterInterfaces.hh:96
virtual ~OutgoingMsgHandler()
Definition: XrdClPostMasterInterfaces.hh:171
virtual uint16_t GetSid() const =0
Definition: XrdClPostMasterInterfaces.hh:86
Message status handler.
Definition: XrdClPostMasterInterfaces.hh:168
virtual void InitializeChannel(const URL &url, AnyObject &channelData)=0
Initialize channel.
PathID(uint16_t u=0, uint16_t d=0)
Definition: XrdClPostMasterInterfaces.hh:282
ChannelEvent
Events that may have occurred to the channel.
Definition: XrdClPostMasterInterfaces.hh:226
virtual bool IsRaw() const
Definition: XrdClPostMasterInterfaces.hh:197
Definition: XrdClPostMasterInterfaces.hh:315
virtual void Disconnect(AnyObject &channelData, uint16_t subStreamId)=0
The stream has been disconnected, do the cleanups.
virtual void OnStatusReady(const Message *message, XRootDStatus status)=0
The requested action has been performed and the status is available.
Message * out
Message to be sent out.
Definition: XrdClPostMasterInterfaces.hh:265
A network socket.
Definition: XrdClSocket.hh:40
virtual PathID MultiplexSubStream(Message *msg, AnyObject &channelData, PathID *hint=0)=0
Stop sending requests [not yet implemented].
Definition: XrdClPostMasterInterfaces.hh:319
std::string streamName
Name of the stream.
Definition: XrdClPostMasterInterfaces.hh:273
static const uint16_t Auth
Transport name, returns std::string *.
Definition: XrdClPostMasterInterfaces.hh:294