XRootD transport handler. More...

#include <XrdClXRootDTransport.hh>

Inheritance diagram for XrdCl::XRootDTransport:

Collaboration diagram for XrdCl::XRootDTransport:

Public Member Functions
	XRootDTransport ()
	Constructor. More...

	~XRootDTransport ()
	Destructor. More...

virtual Status	GetHeader (Message *message, int socket)

virtual Status	GetBody (Message *message, int socket)

virtual void	InitializeChannel (AnyObject &channelData)
	Initialize channel. More...

virtual void	InitializeChannel (const URL &url, AnyObject &channelData)

virtual void	FinalizeChannel (AnyObject &channelData)
	Finalize channel. More...

virtual Status	HandShake (HandShakeData *handShakeData, AnyObject &channelData)
	HandShake. More...

virtual bool	IsStreamTTLElapsed (time_t time, uint16_t streamId, AnyObject &channelData)
	Check if the stream should be disconnected. More...

virtual Status	IsStreamBroken (time_t inactiveTime, uint16_t streamId, AnyObject &channelData)

virtual PathID	Multiplex (Message msg, AnyObject &channelData, PathID hint=0)

virtual PathID	MultiplexSubStream (Message msg, uint16_t streamId, AnyObject &channelData, PathID hint=0)

virtual uint16_t	StreamNumber (AnyObject &channelData)
	Return a number of streams that should be created. More...

virtual uint16_t	SubStreamNumber (AnyObject &channelData)
	Return a number of substreams per stream that should be created. More...

virtual bool	NeedControlConnection ()

virtual void	Disconnect (AnyObject &channelData, uint16_t streamId, uint16_t subStreamId)
	The stream has been disconnected, do the cleanups. More...

virtual Status	Query (uint16_t query, AnyObject &result, AnyObject &channelData)
	Query the channel. More...

virtual uint32_t	MessageReceived (Message *msg, uint16_t streamId, uint16_t subStream, AnyObject &channelData)
	Check if the message invokes a stream action. More...

virtual void	MessageSent (Message *msg, uint16_t streamId, uint16_t subStream, uint32_t bytesSent, AnyObject &channelData)
	Notify the transport about a message having been sent. More...

virtual Status	GetSignature (Message toSign, Message &sign, AnyObject &channelData)
	Get signature for given message. More...

Status	GetSignature (Message toSign, Message &sign, XRootDChannelInfo *info)
	Get signature for given message. More...

Status	ClassifyErrno (int error)
	Classify errno while reading/writing. More...

Public Member Functions inherited from XrdCl::TransportHandler
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. More...

virtual void	FinalizeChannel (AnyObject &channelData)=0
	Finalize channel. More...

virtual Status	HandShake (HandShakeData *handShakeData, AnyObject &channelData)=0
	HandHake. More...

virtual bool	IsStreamTTLElapsed (time_t inactiveTime, uint16_t streamId, AnyObject &channelData)=0
	Check if the stream should be disconnected. More...

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. More...

virtual uint16_t	SubStreamNumber (AnyObject &channelData)=0
	Return a number of substreams per stream that should be created. More...

virtual void	Disconnect (AnyObject &channelData, uint16_t streamId, uint16_t subStreamId)=0
	The stream has been disconnected, do the cleanups. More...

virtual Status	Query (uint16_t query, AnyObject &result, AnyObject &channelData)=0
	Query the channel. More...

virtual uint32_t	MessageReceived (Message *msg, uint16_t streamId, uint16_t subStream, AnyObject &channelData)=0
	Check if the message invokes a stream action. More...

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. More...

Static Public Member Functions
static Status	MarshallRequest (Message *msg)
	Marshal the outgoing message. More...

static Status	UnMarshallRequest (Message *msg)

static Status	UnMarshallBody (Message *msg, uint16_t reqType)
	Unmarshall the body of the incoming message. More...

static void	UnMarshallHeader (Message *msg)
	Unmarshall the header incoming message. More...

static void	LogErrorResponse (const Message &msg)
	Log server error response. More...

static uint16_t	NbConnectedStrm (AnyObject &channelData)
	Number of currently connected data streams. More...

static void	SetDescription (Message *msg)
	Get the description of a message. More...

Private Member Functions
Status	HandShakeMain (HandShakeData *handShakeData, AnyObject &channelData)

Status	HandShakeParallel (HandShakeData *handShakeData, AnyObject &channelData)

Message *	GenerateInitialHS (HandShakeData hsData, XRootDChannelInfo info)

Message *	GenerateInitialHSProtocol (HandShakeData hsData, XRootDChannelInfo info)

Status	ProcessServerHS (HandShakeData hsData, XRootDChannelInfo info)

Status	ProcessProtocolResp (HandShakeData hsData, XRootDChannelInfo info)

Message *	GenerateBind (HandShakeData hsData, XRootDChannelInfo info)

Status	ProcessBindResp (HandShakeData hsData, XRootDChannelInfo info)

Message *	GenerateLogIn (HandShakeData hsData, XRootDChannelInfo info)

Status	ProcessLogInResp (HandShakeData hsData, XRootDChannelInfo info)

Status	DoAuthentication (HandShakeData hsData, XRootDChannelInfo info)

Status	GetCredentials (XrdSecCredentials &credentials, HandShakeData hsData, XRootDChannelInfo *info)

Status	CleanUpAuthentication (XRootDChannelInfo *info)

Status	CleanUpProtection (XRootDChannelInfo *info)

XrdSecGetProt_t	GetAuthHandler ()

Message *	GenerateEndSession (HandShakeData hsData, XRootDChannelInfo info)

Status	ProcessEndSessionResp (HandShakeData hsData, XRootDChannelInfo info)

Static Private Member Functions
static std::string	ServerFlagsToStr (uint32_t flags)

static std::string	FileHandleToStr (const unsigned char handle[4])

Private Attributes
PluginUnloadHandler *	pSecUnloadHandler

Friends
struct	PluginUnloadHandler

Additional Inherited Members
Public Types inherited from XrdCl::TransportHandler
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...

Detailed Description

XRootD transport handler.

Constructor & Destructor Documentation

◆ XRootDTransport()

XrdCl::XRootDTransport::XRootDTransport ( )

Constructor.

◆ ~XRootDTransport()

XrdCl::XRootDTransport::~XRootDTransport ( )

Destructor.

Member Function Documentation

◆ ClassifyErrno()

Status XrdCl::XRootDTransport::ClassifyErrno ( int error )

Classify errno while reading/writing.

◆ CleanUpAuthentication()

Status XrdCl::XRootDTransport::CleanUpAuthentication ( XRootDChannelInfo * info )

private

◆ CleanUpProtection()

Status XrdCl::XRootDTransport::CleanUpProtection ( XRootDChannelInfo * info )

private

◆ Disconnect()

virtual void XrdCl::XRootDTransport::Disconnect	(	AnyObject &	channelData,
		uint16_t	streamId,
		uint16_t	subStreamId
	)

virtual

The stream has been disconnected, do the cleanups.

Implements XrdCl::TransportHandler.

◆ DoAuthentication()

Status XrdCl::XRootDTransport::DoAuthentication	(	HandShakeData *	hsData,
		XRootDChannelInfo *	info
	)

private

◆ FileHandleToStr()

static std::string XrdCl::XRootDTransport::FileHandleToStr ( const unsigned char handle[4] )

staticprivate

◆ FinalizeChannel()

virtual void XrdCl::XRootDTransport::FinalizeChannel ( AnyObject & channelData )

virtual

Finalize channel.

Implements XrdCl::TransportHandler.

◆ GenerateBind()

Message * XrdCl::XRootDTransport::GenerateBind	(	HandShakeData *	hsData,
		XRootDChannelInfo *	info
	)

private

◆ GenerateEndSession()

Message * XrdCl::XRootDTransport::GenerateEndSession	(	HandShakeData *	hsData,
		XRootDChannelInfo *	info
	)

private

◆ GenerateInitialHS()

Message * XrdCl::XRootDTransport::GenerateInitialHS	(	HandShakeData *	hsData,
		XRootDChannelInfo *	info
	)

private

◆ GenerateInitialHSProtocol()

Message * XrdCl::XRootDTransport::GenerateInitialHSProtocol	(	HandShakeData *	hsData,
		XRootDChannelInfo *	info
	)

private

◆ GenerateLogIn()

Message * XrdCl::XRootDTransport::GenerateLogIn	(	HandShakeData *	hsData,
		XRootDChannelInfo *	info
	)

private

◆ GetAuthHandler()

XrdSecGetProt_t XrdCl::XRootDTransport::GetAuthHandler ( )

private

◆ GetBody()

virtual Status XrdCl::XRootDTransport::GetBody	(	Message *	message,
		int	socket
	)

virtual

Read the message body from the socket, the socket is non-blocking, the method may be called multiple times - see GetHeader for details

Parameters

message	the message buffer containing the header
socket	the socket

Returns: stOK & suDone if the whole message has been processed stOK & suRetry if more data is needed stError on failure

Implements XrdCl::TransportHandler.

◆ GetCredentials()

Status XrdCl::XRootDTransport::GetCredentials	(	XrdSecCredentials *&	credentials,
		HandShakeData *	hsData,
		XRootDChannelInfo *	info
	)

private

◆ GetHeader()

virtual Status XrdCl::XRootDTransport::GetHeader	(	Message *	message,
		int	socket
	)

virtual

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

Parameters

message	the message buffer
socket	the socket

Returns: stOK & suDone if the whole message has been processed stOK & suRetry if more data is needed stError on failure

Implements XrdCl::TransportHandler.

◆ GetSignature() [1/2]

virtual Status XrdCl::XRootDTransport::GetSignature	(	Message *	toSign,
		Message *&	sign,
		AnyObject &	channelData
	)

virtual

Get signature for given message.

◆ GetSignature() [2/2]

Status XrdCl::XRootDTransport::GetSignature	(	Message *	toSign,
		Message *&	sign,
		XRootDChannelInfo *	info
	)

Get signature for given message.

◆ HandShake()

virtual Status XrdCl::XRootDTransport::HandShake	(	HandShakeData *	handShakeData,
		AnyObject &	channelData
	)

virtual

HandShake.

Implements XrdCl::TransportHandler.

◆ HandShakeMain()

Status XrdCl::XRootDTransport::HandShakeMain	(	HandShakeData *	handShakeData,
		AnyObject &	channelData
	)

private

◆ HandShakeParallel()

Status XrdCl::XRootDTransport::HandShakeParallel	(	HandShakeData *	handShakeData,
		AnyObject &	channelData
	)

private

◆ InitializeChannel() [1/2]

virtual void XrdCl::XRootDTransport::InitializeChannel ( AnyObject & channelData )

virtual

Initialize channel.

Implements XrdCl::TransportHandler.

◆ InitializeChannel() [2/2]

virtual void XrdCl::XRootDTransport::InitializeChannel	(	const URL &	url,
		AnyObject &	channelData
	)

virtual

◆ IsStreamBroken()

virtual Status XrdCl::XRootDTransport::IsStreamBroken	(	time_t	inactiveTime,
		uint16_t	streamId,
		AnyObject &	channelData
	)

virtual

Check the stream is broken - ie. TCP connection got broken and went undetected by the TCP stack

Implements XrdCl::TransportHandler.

◆ IsStreamTTLElapsed()

virtual bool XrdCl::XRootDTransport::IsStreamTTLElapsed	(	time_t	time,
		uint16_t	streamId,
		AnyObject &	channelData
	)

virtual

Check if the stream should be disconnected.

Implements XrdCl::TransportHandler.

◆ LogErrorResponse()

static void XrdCl::XRootDTransport::LogErrorResponse ( const Message & msg )

static

Log server error response.

◆ MarshallRequest()

static Status XrdCl::XRootDTransport::MarshallRequest ( Message * msg )

static

Marshal the outgoing message.

◆ MessageReceived()

virtual uint32_t XrdCl::XRootDTransport::MessageReceived	(	Message *	msg,
		uint16_t	streamId,
		uint16_t	subStream,
		AnyObject &	channelData
	)

virtual

Check if the message invokes a stream action.

Implements XrdCl::TransportHandler.

◆ MessageSent()

virtual void XrdCl::XRootDTransport::MessageSent	(	Message *	msg,
		uint16_t	streamId,
		uint16_t	subStream,
		uint32_t	bytesSent,
		AnyObject &	channelData
	)

virtual

Notify the transport about a message having been sent.

Implements XrdCl::TransportHandler.

◆ Multiplex()

virtual PathID XrdCl::XRootDTransport::Multiplex	(	Message *	msg,
		AnyObject &	channelData,
		PathID *	hint = `0`
	)

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.

Implements XrdCl::TransportHandler.

◆ MultiplexSubStream()

virtual PathID XrdCl::XRootDTransport::MultiplexSubStream	(	Message *	msg,
		uint16_t	streamId,
		AnyObject &	channelData,
		PathID *	hint = `0`
	)

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.

Implements XrdCl::TransportHandler.

◆ NbConnectedStrm()

static uint16_t XrdCl::XRootDTransport::NbConnectedStrm ( AnyObject & channelData )

static

Number of currently connected data streams.

◆ NeedControlConnection()

virtual bool XrdCl::XRootDTransport::NeedControlConnection ( )

inlinevirtual

Return the information whether a control connection needs to be valid before establishing other connections

◆ ProcessBindResp()

Status XrdCl::XRootDTransport::ProcessBindResp	(	HandShakeData *	hsData,
		XRootDChannelInfo *	info
	)

private

◆ ProcessEndSessionResp()

Status XrdCl::XRootDTransport::ProcessEndSessionResp	(	HandShakeData *	hsData,
		XRootDChannelInfo *	info
	)

private

◆ ProcessLogInResp()

Status XrdCl::XRootDTransport::ProcessLogInResp	(	HandShakeData *	hsData,
		XRootDChannelInfo *	info
	)

private

◆ ProcessProtocolResp()

Status XrdCl::XRootDTransport::ProcessProtocolResp	(	HandShakeData *	hsData,
		XRootDChannelInfo *	info
	)

private

◆ ProcessServerHS()

Status XrdCl::XRootDTransport::ProcessServerHS	(	HandShakeData *	hsData,
		XRootDChannelInfo *	info
	)

private

◆ Query()

virtual Status XrdCl::XRootDTransport::Query	(	uint16_t	query,
		AnyObject &	result,
		AnyObject &	channelData
	)

virtual

Query the channel.

Implements XrdCl::TransportHandler.

◆ ServerFlagsToStr()

static std::string XrdCl::XRootDTransport::ServerFlagsToStr ( uint32_t flags )

staticprivate

◆ SetDescription()

static void XrdCl::XRootDTransport::SetDescription ( Message * msg )

static

Get the description of a message.

◆ StreamNumber()

virtual uint16_t XrdCl::XRootDTransport::StreamNumber ( AnyObject & channelData )

virtual

Return a number of streams that should be created.

Implements XrdCl::TransportHandler.

◆ SubStreamNumber()

virtual uint16_t XrdCl::XRootDTransport::SubStreamNumber ( AnyObject & channelData )

virtual

Return a number of substreams per stream that should be created.

Implements XrdCl::TransportHandler.

◆ UnMarshallBody()

static Status XrdCl::XRootDTransport::UnMarshallBody	(	Message *	msg,
		uint16_t	reqType
	)

static

Unmarshall the body of the incoming message.

◆ UnMarshallHeader()

static void XrdCl::XRootDTransport::UnMarshallHeader ( Message * msg )

static

Unmarshall the header incoming message.

◆ UnMarshallRequest()

static Status XrdCl::XRootDTransport::UnMarshallRequest ( Message * msg )

static

Unmarshall the request - sometimes the requests need to be rewritten, so we need to unmarshall them

Friends And Related Function Documentation

◆ PluginUnloadHandler

friend struct PluginUnloadHandler

friend

Member Data Documentation

◆ pSecUnloadHandler

PluginUnloadHandler* XrdCl::XRootDTransport::pSecUnloadHandler

private

The documentation for this class was generated from the following file:

XrdClXRootDTransport.hh

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XRootDTransport()

◆ ~XRootDTransport()

Member Function Documentation

◆ ClassifyErrno()

◆ CleanUpAuthentication()

◆ CleanUpProtection()

◆ Disconnect()

◆ DoAuthentication()

◆ FileHandleToStr()

◆ FinalizeChannel()

◆ GenerateBind()

◆ GenerateEndSession()

◆ GenerateInitialHS()

◆ GenerateInitialHSProtocol()

◆ GenerateLogIn()

◆ GetAuthHandler()

◆ GetBody()

◆ GetCredentials()

◆ GetHeader()

◆ GetSignature() [1/2]

◆ GetSignature() [2/2]

◆ HandShake()

◆ HandShakeMain()

◆ HandShakeParallel()

◆ InitializeChannel() [1/2]

◆ InitializeChannel() [2/2]

◆ IsStreamBroken()

◆ IsStreamTTLElapsed()

◆ LogErrorResponse()

◆ MarshallRequest()

◆ MessageReceived()

◆ MessageSent()

◆ Multiplex()

◆ MultiplexSubStream()

◆ NbConnectedStrm()

◆ NeedControlConnection()

◆ ProcessBindResp()

◆ ProcessEndSessionResp()

◆ ProcessLogInResp()

◆ ProcessProtocolResp()

◆ ProcessServerHS()

◆ Query()

◆ ServerFlagsToStr()

◆ SetDescription()

◆ StreamNumber()

◆ SubStreamNumber()

◆ UnMarshallBody()

◆ UnMarshallHeader()

◆ UnMarshallRequest()

Friends And Related Function Documentation

◆ PluginUnloadHandler

Member Data Documentation

◆ pSecUnloadHandler