Go to the documentation of this file.
25 #ifndef __XRD_CL_POST_MASTER_INTERFACES_HH__
26 #define __XRD_CL_POST_MASTER_INTERFACES_HH__
144 uint32_t &bytesRead )
146 (void)msg; (void)socket; (void)bytesRead;
160 (void)event; (void)status;
197 virtual bool IsRaw()
const {
return false; }
210 uint32_t &bytesWritten )
212 (void)socket; (void)bytesWritten;
293 static const uint16_t
Name = 1;
294 static const uint16_t
Auth = 2;
420 uint16_t subStreamId ) = 0;
463 #endif // __XRD_CL_POST_MASTER_INTERFACES_HH__
@ HoldStream
Stop sending requests [not yet implemented].
Definition: XrdClPostMasterInterfaces.hh:319
A network socket.
Definition: XrdClSocket.hh:41
const uint16_t stOK
Everything went OK.
Definition: XrdClStatus.hh:31
Message status handler.
Definition: XrdClPostMasterInterfaces.hh:169
const XrdNetAddr * serverAddr
Server address.
Definition: XrdClPostMasterInterfaces.hh:271
virtual ~TransportHandler()
Definition: XrdClPostMasterInterfaces.hh:324
Definition: XrdClPostMasterInterfaces.hh:292
@ Broken
The stream is broken.
Definition: XrdClPostMasterInterfaces.hh:97
Message * in
Message that has been received.
Definition: XrdClPostMasterInterfaces.hh:266
Definition: XrdClPostMasterInterfaces.hh:281
virtual void OnReadyToSend(Message *msg)
Definition: XrdClPostMasterInterfaces.hh:187
virtual Status GetBody(Message *message, Socket *socket)=0
virtual ~IncomingMsgHandler()
Event types that the message handler may receive.
Definition: XrdClPostMasterInterfaces.hh:106
virtual uint16_t GetSid() const =0
virtual Status HandShake(HandShakeData *handShakeData, AnyObject &channelData)=0
HandHake.
std::string clientName
Client name (an IPv6 representation)
Definition: XrdClPostMasterInterfaces.hh:272
@ FatalError
Stream has been broken and won't be recovered.
Definition: XrdClPostMasterInterfaces.hh:230
@ NoProcess
Definition: XrdClPostMasterInterfaces.hh:86
virtual void Disconnect(AnyObject &channelData, uint16_t subStreamId)=0
The stream has been disconnected, do the cleanups.
uint16_t subStreamId
Sub-stream id.
Definition: XrdClPostMasterInterfaces.hh:268
virtual void InitializeChannel(const URL &url, AnyObject &channelData)=0
Initialize channel.
@ RequestClose
Send a close request.
Definition: XrdClPostMasterInterfaces.hh:320
uint16_t up
Definition: XrdClPostMasterInterfaces.hh:283
@ Take
Take ownership over the message.
Definition: XrdClPostMasterInterfaces.hh:79
const uint16_t suDone
Definition: XrdClStatus.hh:38
StreamEvent
Events that may have occurred to the stream.
Definition: XrdClPostMasterInterfaces.hh:95
virtual bool IsRaw() const
Definition: XrdClPostMasterInterfaces.hh:197
virtual bool OnChannelEvent(ChannelEvent event, Status status)=0
static const uint16_t Auth
Transport name, returns std::string *.
Definition: XrdClPostMasterInterfaces.hh:294
The message representation used throughout the system.
Definition: XrdClMessage.hh:30
virtual PathID Multiplex(Message *msg, AnyObject &channelData, PathID *hint=0)=0
virtual ~MessageFilter()
Definition: XrdClPostMasterInterfaces.hh:52
const URL * url
Destination URL.
Definition: XrdClPostMasterInterfaces.hh:267
virtual ~ChannelEventHandler()
Destructor.
Definition: XrdClPostMasterInterfaces.hh:236
virtual bool NeedEncryption(HandShakeData *handShakeData, AnyObject &channelData)=0
virtual bool IsStreamTTLElapsed(time_t inactiveTime, AnyObject &channelData)=0
Check if the stream should be disconnected.
Request status.
Definition: XrdClXRootDResponses.hh:215
virtual void OnStatusReady(const Message *message, XRootDStatus status)=0
The requested action has been performed and the status is available.
virtual ~OutgoingMsgHandler()
Definition: XrdClPostMasterInterfaces.hh:171
Data structure that carries the handshake information.
Definition: XrdClPostMasterInterfaces.hh:256
virtual PathID MultiplexSubStream(Message *msg, AnyObject &channelData, PathID *hint=0)=0
virtual Status WriteMessageBody(Socket *socket, uint32_t &bytesWritten)
Definition: XrdClPostMasterInterfaces.hh:209
@ Raw
Definition: XrdClPostMasterInterfaces.hh:83
@ Ready
The stream has become connected.
Definition: XrdClPostMasterInterfaces.hh:96
Message filter.
Definition: XrdClPostMasterInterfaces.hh:50
ChannelEvent
Events that may have occurred to the channel.
Definition: XrdClPostMasterInterfaces.hh:227
Message handler.
Definition: XrdClPostMasterInterfaces.hh:72
@ AbortStream
Definition: XrdClPostMasterInterfaces.hh:312
uint16_t step
Handshake step.
Definition: XrdClPostMasterInterfaces.hh:264
virtual void FinalizeChannel(AnyObject &channelData)=0
Finalize channel.
static const uint16_t Name
Transport name, returns const char *.
Definition: XrdClPostMasterInterfaces.hh:293
@ StreamBroken
The stream is broken.
Definition: XrdClPostMasterInterfaces.hh:229
@ Ignore
Ignore the message.
Definition: XrdClPostMasterInterfaces.hh:80
virtual void MessageSent(Message *msg, uint16_t subStream, uint32_t bytesSent, AnyObject &channelData)=0
Notify the transport about a message having been sent.
virtual uint8_t OnStreamEvent(StreamEvent event, XRootDStatus status)
Definition: XrdClPostMasterInterfaces.hh:157
virtual uint16_t SubStreamNumber(AnyObject &channelData)=0
Return a number of substreams per stream that should be created.
@ ResumeStream
Definition: XrdClPostMasterInterfaces.hh:317
@ DigestMsg
Definition: XrdClPostMasterInterfaces.hh:310
StreamAction
Stream actions that may be triggered by incoming control messages.
Definition: XrdClPostMasterInterfaces.hh:308
virtual Status GetHeader(Message *message, Socket *socket)=0
@ NoAction
No action.
Definition: XrdClPostMasterInterfaces.hh:309
PathID(uint16_t u=0, uint16_t d=0)
Definition: XrdClPostMasterInterfaces.hh:282
Definition: XrdClAnyObject.hh:26
@ FatalError
Stream has been broken and won't be recovered.
Definition: XrdClPostMasterInterfaces.hh:99
virtual uint16_t Examine(Message *msg)=0
virtual Status ReadMessageBody(Message *msg, Socket *socket, uint32_t &bytesRead)
Definition: XrdClPostMasterInterfaces.hh:142
virtual bool Filter(const Message *msg)=0
uint16_t down
Definition: XrdClPostMasterInterfaces.hh:284
Procedure execution status.
Definition: XrdClStatus.hh:111
URL representation.
Definition: XrdClURL.hh:31
@ CloseStream
Definition: XrdClPostMasterInterfaces.hh:315
@ RemoveHandler
Definition: XrdClPostMasterInterfaces.hh:81
Message * out
Message to be sent out.
Definition: XrdClPostMasterInterfaces.hh:265
Action
Actions to be taken after a message is processed by the handler.
Definition: XrdClPostMasterInterfaces.hh:78
virtual uint32_t MessageReceived(Message *msg, uint16_t subStream, AnyObject &channelData)=0
Check if the message invokes a stream action.
virtual uint16_t GetSid() const =0
Channel event handler.
Definition: XrdClPostMasterInterfaces.hh:221
@ Timeout
The declared timeout has occurred.
Definition: XrdClPostMasterInterfaces.hh:98
Perform the handshake and the authentication for each physical stream.
Definition: XrdClPostMasterInterfaces.hh:301
std::string streamName
Name of the stream.
Definition: XrdClPostMasterInterfaces.hh:273
Definition: XrdNetAddr.hh:42
virtual Status IsStreamBroken(time_t inactiveTime, AnyObject &channelData)=0
Definition: XrdClAnyObject.hh:33
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 void Process(Message *msg)
Definition: XrdClPostMasterInterfaces.hh:129
HandShakeData(const URL *addr, uint16_t subStream)
Constructor.
Definition: XrdClPostMasterInterfaces.hh:260
virtual void WaitBeforeExit()=0
Wait before exit.
@ StreamReady
The stream has become connected.
Definition: XrdClPostMasterInterfaces.hh:228
virtual bool HandShakeDone(HandShakeData *handShakeData, AnyObject &channelData)=0
time_t startTime
Timestamp of when the handshake started.
Definition: XrdClPostMasterInterfaces.hh:269