25 #ifndef __XRD_CL_POST_MASTER_INTERFACES_HH__
26 #define __XRD_CL_POST_MASTER_INTERFACES_HH__
125 uint32_t &bytesRead )
127 (void)msg; (void)socket; (void)bytesRead;
143 (void)event; (void)streamNum; (void)status;
173 (void)msg; (void)streamNum;
181 virtual bool IsRaw()
const {
return false; }
194 uint32_t &bytesRead )
196 (void)socket; (void)bytesRead;
233 uint16_t stream ) = 0;
277 static const uint16_t
Name = 1;
278 static const uint16_t
Auth = 2;
404 uint16_t subStreamId ) = 0;
432 #endif // __XRD_CL_POST_MASTER_INTERFACES_HH__
Definition: XrdClAnyObject.hh:32
const uint16_t stOK
Everything went OK.
Definition: XrdClStatus.hh:31
Definition: XrdClPostMasterInterfaces.hh:71
virtual bool OnChannelEvent(ChannelEvent event, Status status, uint16_t stream)=0
virtual void FinalizeChannel(AnyObject &channelData)=0
Finalize channel.
Take ownership over the message.
Definition: XrdClPostMasterInterfaces.hh:67
Message filter.
Definition: XrdClPostMasterInterfaces.hh:44
Definition: XrdClPostMasterInterfaces.hh:69
virtual ~IncomingMsgHandler()
Event types that the message handler may receive.
Definition: XrdClPostMasterInterfaces.hh:94
Stream has been broken and won't be recovered.
Definition: XrdClPostMasterInterfaces.hh:87
virtual bool IsRaw() const
Definition: XrdClPostMasterInterfaces.hh:181
virtual Status GetHeader(Message *message, int socket)=0
The message representation used throughout the system.
Definition: XrdClMessage.hh:29
time_t startTime
Timestamp of when the handshake started.
Definition: XrdClPostMasterInterfaces.hh:254
virtual Status WriteMessageBody(int socket, uint32_t &bytesRead)
Definition: XrdClPostMasterInterfaces.hh:193
virtual ~ChannelEventHandler()
Destructor.
Definition: XrdClPostMasterInterfaces.hh:220
StreamAction
Stream actions that may be triggered by incoming control messages.
Definition: XrdClPostMasterInterfaces.hh:291
const URL * url
Destination URL.
Definition: XrdClPostMasterInterfaces.hh:251
virtual PathID Multiplex(Message *msg, AnyObject &channelData, PathID *hint=0)=0
Definition: XrdClPostMasterInterfaces.hh:264
const uint16_t suDone
Definition: XrdClStatus.hh:38
uint16_t subStreamId
Sub-stream id.
Definition: XrdClPostMasterInterfaces.hh:253
std::string clientName
Client name (an IPv6 representation)
Definition: XrdClPostMasterInterfaces.hh:256
static const uint16_t Name
Transport name, returns const char *.
Definition: XrdClPostMasterInterfaces.hh:277
Message * in
Message that has been received.
Definition: XrdClPostMasterInterfaces.hh:250
const void * serverAddr
Server address in the form of sockaddr.
Definition: XrdClPostMasterInterfaces.hh:255
StreamEvent
Events that may have occurred to the stream.
Definition: XrdClPostMasterInterfaces.hh:82
uint16_t up
Definition: XrdClPostMasterInterfaces.hh:267
Procedure execution status.
Definition: XrdClStatus.hh:106
virtual uint16_t Examine(Message *msg)=0
virtual Status IsStreamBroken(time_t inactiveTime, uint16_t streamId, AnyObject &channelData)=0
uint16_t step
Handshake step.
Definition: XrdClPostMasterInterfaces.hh:248
virtual uint16_t StreamNumber(AnyObject &channelData)=0
Return a number of streams that should be created.
virtual Status Query(uint16_t query, AnyObject &result, AnyObject &channelData)=0
Query the channel.
virtual bool Filter(const Message *msg)=0
uint16_t streamId
Stream number.
Definition: XrdClPostMasterInterfaces.hh:252
Data structure that carries the handshake information.
Definition: XrdClPostMasterInterfaces.hh:239
virtual Status GetBody(Message *message, int socket)=0
Definition: XrdClPostMasterInterfaces.hh:294
virtual ~TransportHandler()
Definition: XrdClPostMasterInterfaces.hh:307
virtual Status HandShake(HandShakeData *handShakeData, AnyObject &channelData)=0
HandHake.
Perform the handshake and the authentication for each physical stream.
Definition: XrdClPostMasterInterfaces.hh:284
Stream has been broken and won't be recovered.
Definition: XrdClPostMasterInterfaces.hh:214
The stream is broken.
Definition: XrdClPostMasterInterfaces.hh:213
The declared timeout has occurred.
Definition: XrdClPostMasterInterfaces.hh:86
Definition: XrdClEnv.hh:28
Channel event handler.
Definition: XrdClPostMasterInterfaces.hh:204
The stream has become connected.
Definition: XrdClPostMasterInterfaces.hh:212
The stream is broken.
Definition: XrdClPostMasterInterfaces.hh:85
Message handler.
Definition: XrdClPostMasterInterfaces.hh:59
virtual uint8_t OnStreamEvent(StreamEvent event, uint16_t streamNum, Status status)
Definition: XrdClPostMasterInterfaces.hh:139
virtual uint16_t SubStreamNumber(AnyObject &channelData)=0
Return a number of substreams per stream that should be created.
uint16_t down
Definition: XrdClPostMasterInterfaces.hh:268
virtual bool IsStreamTTLElapsed(time_t inactiveTime, uint16_t streamId, AnyObject &channelData)=0
Check if the stream should be disconnected.
Definition: XrdClPostMasterInterfaces.hh:301
Action
Actions to be taken after a message is processed by the handler.
Definition: XrdClPostMasterInterfaces.hh:65
Definition: XrdClPostMasterInterfaces.hh:296
Definition: XrdClPostMasterInterfaces.hh:275
URL representation.
Definition: XrdClURL.hh:30
No action.
Definition: XrdClPostMasterInterfaces.hh:293
virtual ~MessageFilter()
Definition: XrdClPostMasterInterfaces.hh:47
virtual Status ReadMessageBody(Message *msg, int socket, uint32_t &bytesRead)
Definition: XrdClPostMasterInterfaces.hh:123
virtual void InitializeChannel(AnyObject &channelData)=0
Initialize channel.
virtual void Process(Message *msg)
Definition: XrdClPostMasterInterfaces.hh:110
Ignore the message.
Definition: XrdClPostMasterInterfaces.hh:68
virtual void Disconnect(AnyObject &channelData, uint16_t streamId, uint16_t subStreamId)=0
The stream has been disconnected, do the cleanups.
The stream has become connected.
Definition: XrdClPostMasterInterfaces.hh:84
virtual ~OutgoingMsgHandler()
Definition: XrdClPostMasterInterfaces.hh:154
Definition: XrdClPostMasterInterfaces.hh:74
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.
Message status handler.
Definition: XrdClPostMasterInterfaces.hh:151
PathID(uint16_t u=0, uint16_t d=0)
Definition: XrdClPostMasterInterfaces.hh:266
virtual void OnStatusReady(const Message *message, Status status)=0
The requested action has been performed and the status is available.
virtual void OnReadyToSend(Message *msg, uint16_t streamNum)
Definition: XrdClPostMasterInterfaces.hh:171
ChannelEvent
Events that may have occurred to the channel.
Definition: XrdClPostMasterInterfaces.hh:210
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:299
HandShakeData(const URL *addr, uint16_t stream, uint16_t subStream)
Constructor.
Definition: XrdClPostMasterInterfaces.hh:244
Message * out
Message to be sent out.
Definition: XrdClPostMasterInterfaces.hh:249
Stop sending requests [not yet implemented].
Definition: XrdClPostMasterInterfaces.hh:303
std::string streamName
Name of the stream.
Definition: XrdClPostMasterInterfaces.hh:257
static const uint16_t Auth
Transport name, returns std::string *.
Definition: XrdClPostMasterInterfaces.hh:278
virtual PathID MultiplexSubStream(Message *msg, uint16_t streamId, AnyObject &channelData, PathID *hint=0)=0