Go to the documentation of this file.
25 #ifndef __XRD_CL_POST_MASTER_INTERFACES_HH__
26 #define __XRD_CL_POST_MASTER_INTERFACES_HH__
62 virtual uint16_t
GetSid()
const = 0;
119 virtual uint16_t
GetSid()
const = 0;
141 uint32_t &bytesRead )
143 (void)msg; (void)socket; (void)bytesRead;
159 (void)event; (void)streamNum; (void)status;
189 (void)msg; (void)streamNum;
197 virtual bool IsRaw()
const {
return false; }
210 uint32_t &bytesRead )
212 (void)socket; (void)bytesRead;
249 uint16_t stream ) = 0;
295 static const uint16_t
Name = 1;
296 static const uint16_t
Auth = 2;
423 uint16_t subStreamId ) = 0;
451 #endif // __XRD_CL_POST_MASTER_INTERFACES_HH__
@ HoldStream
Stop sending requests [not yet implemented].
Definition: XrdClPostMasterInterfaces.hh:321
const uint16_t stOK
Everything went OK.
Definition: XrdClStatus.hh:31
Message status handler.
Definition: XrdClPostMasterInterfaces.hh:167
const XrdNetAddr * serverAddr
Server address.
Definition: XrdClPostMasterInterfaces.hh:273
virtual ~TransportHandler()
Definition: XrdClPostMasterInterfaces.hh:326
Definition: XrdClPostMasterInterfaces.hh:293
@ Broken
The stream is broken.
Definition: XrdClPostMasterInterfaces.hh:94
virtual void OnReadyToSend(Message *msg, uint16_t streamNum)
Definition: XrdClPostMasterInterfaces.hh:187
Message * in
Message that has been received.
Definition: XrdClPostMasterInterfaces.hh:267
virtual uint32_t MessageReceived(Message *msg, uint16_t streamId, uint16_t subStream, AnyObject &channelData)=0
Check if the message invokes a stream action.
Definition: XrdClPostMasterInterfaces.hh:282
virtual ~IncomingMsgHandler()
Event types that the message handler may receive.
Definition: XrdClPostMasterInterfaces.hh:103
virtual uint16_t GetSid() const =0
virtual Status HandShake(HandShakeData *handShakeData, AnyObject &channelData)=0
HandHake.
virtual void Disconnect(AnyObject &channelData, uint16_t streamId, uint16_t subStreamId)=0
The stream has been disconnected, do the cleanups.
std::string clientName
Client name (an IPv6 representation)
Definition: XrdClPostMasterInterfaces.hh:274
virtual uint16_t StreamNumber(AnyObject &channelData)=0
Return a number of streams that should be created.
@ FatalError
Stream has been broken and won't be recovered.
Definition: XrdClPostMasterInterfaces.hh:230
@ NoProcess
Definition: XrdClPostMasterInterfaces.hh:83
uint16_t subStreamId
Sub-stream id.
Definition: XrdClPostMasterInterfaces.hh:270
@ RequestClose
Send a close request.
Definition: XrdClPostMasterInterfaces.hh:322
uint16_t up
Definition: XrdClPostMasterInterfaces.hh:285
@ Take
Take ownership over the message.
Definition: XrdClPostMasterInterfaces.hh:76
const uint16_t suDone
Definition: XrdClStatus.hh:38
StreamEvent
Events that may have occurred to the stream.
Definition: XrdClPostMasterInterfaces.hh:91
virtual bool IsRaw() const
Definition: XrdClPostMasterInterfaces.hh:197
static const uint16_t Auth
Transport name, returns std::string *.
Definition: XrdClPostMasterInterfaces.hh:296
The message representation used throughout the system.
Definition: XrdClMessage.hh:29
uint16_t streamId
Stream number.
Definition: XrdClPostMasterInterfaces.hh:269
virtual PathID Multiplex(Message *msg, AnyObject &channelData, PathID *hint=0)=0
virtual ~MessageFilter()
Definition: XrdClPostMasterInterfaces.hh:49
const URL * url
Destination URL.
Definition: XrdClPostMasterInterfaces.hh:268
virtual ~ChannelEventHandler()
Destructor.
Definition: XrdClPostMasterInterfaces.hh:236
virtual Status WriteMessageBody(int socket, uint32_t &bytesRead)
Definition: XrdClPostMasterInterfaces.hh:209
virtual bool IsStreamTTLElapsed(time_t inactiveTime, uint16_t streamId, AnyObject &channelData)=0
Check if the stream should be disconnected.
virtual ~OutgoingMsgHandler()
Definition: XrdClPostMasterInterfaces.hh:170
Data structure that carries the handshake information.
Definition: XrdClPostMasterInterfaces.hh:256
virtual PathID MultiplexSubStream(Message *msg, uint16_t streamId, AnyObject &channelData, PathID *hint=0)=0
@ Raw
Definition: XrdClPostMasterInterfaces.hh:80
@ Ready
The stream has become connected.
Definition: XrdClPostMasterInterfaces.hh:93
Message filter.
Definition: XrdClPostMasterInterfaces.hh:46
ChannelEvent
Events that may have occurred to the channel.
Definition: XrdClPostMasterInterfaces.hh:226
Message handler.
Definition: XrdClPostMasterInterfaces.hh:68
@ AbortStream
Definition: XrdClPostMasterInterfaces.hh:314
uint16_t step
Handshake step.
Definition: XrdClPostMasterInterfaces.hh:265
virtual void FinalizeChannel(AnyObject &channelData)=0
Finalize channel.
static const uint16_t Name
Transport name, returns const char *.
Definition: XrdClPostMasterInterfaces.hh:295
@ StreamBroken
The stream is broken.
Definition: XrdClPostMasterInterfaces.hh:229
@ Ignore
Ignore the message.
Definition: XrdClPostMasterInterfaces.hh:77
virtual Status IsStreamBroken(time_t inactiveTime, uint16_t streamId, AnyObject &channelData)=0
virtual void OnStatusReady(const Message *message, Status status)=0
The requested action has been performed and the status is available.
virtual uint8_t OnStreamEvent(StreamEvent event, uint16_t streamNum, Status status)
Definition: XrdClPostMasterInterfaces.hh:155
virtual uint16_t SubStreamNumber(AnyObject &channelData)=0
Return a number of substreams per stream that should be created.
@ ResumeStream
Definition: XrdClPostMasterInterfaces.hh:319
@ DigestMsg
Definition: XrdClPostMasterInterfaces.hh:312
StreamAction
Stream actions that may be triggered by incoming control messages.
Definition: XrdClPostMasterInterfaces.hh:309
@ NoAction
No action.
Definition: XrdClPostMasterInterfaces.hh:311
PathID(uint16_t u=0, uint16_t d=0)
Definition: XrdClPostMasterInterfaces.hh:284
virtual Status ReadMessageBody(Message *msg, int socket, uint32_t &bytesRead)
Definition: XrdClPostMasterInterfaces.hh:139
Definition: XrdClAnyObject.hh:25
virtual bool OnChannelEvent(ChannelEvent event, Status status, uint16_t stream)=0
@ FatalError
Stream has been broken and won't be recovered.
Definition: XrdClPostMasterInterfaces.hh:96
virtual uint16_t Examine(Message *msg)=0
virtual Status GetHeader(Message *message, int socket)=0
virtual Status GetBody(Message *message, int socket)=0
virtual bool Filter(const Message *msg)=0
uint16_t down
Definition: XrdClPostMasterInterfaces.hh:286
Procedure execution status.
Definition: XrdClStatus.hh:109
URL representation.
Definition: XrdClURL.hh:30
virtual void MessageSent(Message *msg, uint16_t streamId, uint16_t subStream, uint32_t bytesSent, AnyObject &channelData)=0
Notify the transport about a message having been sent.
@ CloseStream
Definition: XrdClPostMasterInterfaces.hh:317
@ RemoveHandler
Definition: XrdClPostMasterInterfaces.hh:78
Message * out
Message to be sent out.
Definition: XrdClPostMasterInterfaces.hh:266
Action
Actions to be taken after a message is processed by the handler.
Definition: XrdClPostMasterInterfaces.hh:74
virtual uint16_t GetSid() const =0
Channel event handler.
Definition: XrdClPostMasterInterfaces.hh:220
@ Timeout
The declared timeout has occurred.
Definition: XrdClPostMasterInterfaces.hh:95
Perform the handshake and the authentication for each physical stream.
Definition: XrdClPostMasterInterfaces.hh:302
std::string streamName
Name of the stream.
Definition: XrdClPostMasterInterfaces.hh:275
Definition: XrdNetAddr.hh:41
Definition: XrdClAnyObject.hh:32
virtual Status Query(uint16_t query, AnyObject &result, AnyObject &channelData)=0
Query the channel.
virtual void Process(Message *msg)
Definition: XrdClPostMasterInterfaces.hh:126
@ StreamReady
The stream has become connected.
Definition: XrdClPostMasterInterfaces.hh:228
virtual void InitializeChannel(AnyObject &channelData)=0
Initialize channel.
HandShakeData(const URL *addr, uint16_t stream, uint16_t subStream)
Constructor.
Definition: XrdClPostMasterInterfaces.hh:261
time_t startTime
Timestamp of when the handshake started.
Definition: XrdClPostMasterInterfaces.hh:271