Perform the handshake and the authentication for each physical stream. More...
#include <XrdClPostMasterInterfaces.hh>
Public Types | |
enum | StreamAction { NoAction = 0x0000, DigestMsg = 0x0001, AbortStream = 0x0002, CloseStream = 0x0004, ResumeStream = 0x0008, HoldStream = 0x0010, RequestClose = 0x0020 } |
Stream actions that may be triggered by incoming control messages. More... | |
Public Member Functions | |
virtual | ~TransportHandler () |
virtual Status | GetHeader (Message *message, int socket)=0 |
virtual Status | GetBody (Message *message, int socket)=0 |
virtual void | InitializeChannel (AnyObject &channelData)=0 |
Initialize channel. | |
virtual void | FinalizeChannel (AnyObject &channelData)=0 |
Finalize channel. | |
virtual Status | HandShake (HandShakeData *handShakeData, AnyObject &channelData)=0 |
HandHake. | |
virtual bool | IsStreamTTLElapsed (time_t inactiveTime, uint16_t streamId, AnyObject &channelData)=0 |
Check if the stream should be disconnected. | |
virtual Status | IsStreamBroken (time_t inactiveTime, uint16_t streamId, AnyObject &channelData)=0 |
virtual PathID | Multiplex (Message *msg, AnyObject &channelData, PathID *hint=0)=0 |
virtual PathID | MultiplexSubStream (Message *msg, uint16_t streamId, AnyObject &channelData, PathID *hint=0)=0 |
virtual uint16_t | StreamNumber (AnyObject &channelData)=0 |
Return a number of streams that should be created. | |
virtual uint16_t | SubStreamNumber (AnyObject &channelData)=0 |
Return a number of substreams per stream that should be created. | |
virtual void | Disconnect (AnyObject &channelData, uint16_t streamId, uint16_t subStreamId)=0 |
The stream has been disconnected, do the cleanups. | |
virtual Status | Query (uint16_t query, AnyObject &result, AnyObject &channelData)=0 |
Query the channel. | |
virtual uint32_t | MessageReceived (Message *msg, uint16_t streamId, uint16_t subStream, AnyObject &channelData)=0 |
Check if the message invokes a stream action. | |
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. |
Perform the handshake and the authentication for each physical stream.
Stream actions that may be triggered by incoming control messages.
virtual XrdCl::TransportHandler::~TransportHandler | ( | ) | [inline, virtual] |
virtual void XrdCl::TransportHandler::Disconnect | ( | AnyObject & | channelData, | |
uint16_t | streamId, | |||
uint16_t | subStreamId | |||
) | [pure virtual] |
The stream has been disconnected, do the cleanups.
virtual void XrdCl::TransportHandler::FinalizeChannel | ( | AnyObject & | channelData | ) | [pure virtual] |
Finalize channel.
Read the message body from the socket, the socket is non-blocking, the method may be called multiple times - see GetHeader for details
message | the message buffer containing the header | |
socket | the socket |
Read a message header from the socket, the socket is non-blocking, so if there is not enough data the function should return errRetry in which case it will be called again when more data arrives, with the data previously read stored in the message buffer
message | the message buffer | |
socket | the socket |
virtual Status XrdCl::TransportHandler::HandShake | ( | HandShakeData * | handShakeData, | |
AnyObject & | channelData | |||
) | [pure virtual] |
HandHake.
virtual void XrdCl::TransportHandler::InitializeChannel | ( | AnyObject & | channelData | ) | [pure virtual] |
Initialize channel.
virtual Status XrdCl::TransportHandler::IsStreamBroken | ( | time_t | inactiveTime, | |
uint16_t | streamId, | |||
AnyObject & | channelData | |||
) | [pure virtual] |
Check the stream is broken - ie. TCP connection got broken and went undetected by the TCP stack
virtual bool XrdCl::TransportHandler::IsStreamTTLElapsed | ( | time_t | inactiveTime, | |
uint16_t | streamId, | |||
AnyObject & | channelData | |||
) | [pure virtual] |
Check if the stream should be disconnected.
virtual uint32_t XrdCl::TransportHandler::MessageReceived | ( | Message * | msg, | |
uint16_t | streamId, | |||
uint16_t | subStream, | |||
AnyObject & | channelData | |||
) | [pure virtual] |
Check if the message invokes a stream action.
virtual void XrdCl::TransportHandler::MessageSent | ( | Message * | msg, | |
uint16_t | streamId, | |||
uint16_t | subStream, | |||
uint32_t | bytesSent, | |||
AnyObject & | channelData | |||
) | [pure virtual] |
Notify the transport about a message having been sent.
virtual PathID XrdCl::TransportHandler::Multiplex | ( | Message * | msg, | |
AnyObject & | channelData, | |||
PathID * | hint = 0 | |||
) | [pure virtual] |
Return the ID for the up stream this message should be sent by and the down stream which the answer should be expected at. Modify the message itself if necessary. If hint is non-zero then the message should be modified such that the answer will be returned via the hinted stream.
virtual PathID XrdCl::TransportHandler::MultiplexSubStream | ( | Message * | msg, | |
uint16_t | streamId, | |||
AnyObject & | channelData, | |||
PathID * | hint = 0 | |||
) | [pure virtual] |
Return the ID for the up substream this message should be sent by and the down substream which the answer should be expected at. Modify the message itself if necessary. If hint is non-zero then the message should be modified such that the answer will be returned via the hinted stream.
virtual Status XrdCl::TransportHandler::Query | ( | uint16_t | query, | |
AnyObject & | result, | |||
AnyObject & | channelData | |||
) | [pure virtual] |
Query the channel.
virtual uint16_t XrdCl::TransportHandler::StreamNumber | ( | AnyObject & | channelData | ) | [pure virtual] |
Return a number of streams that should be created.
virtual uint16_t XrdCl::TransportHandler::SubStreamNumber | ( | AnyObject & | channelData | ) | [pure virtual] |
Return a number of substreams per stream that should be created.