XrdCl::Channel Class Reference

A communication channel between the client and the server. More...

#include <XrdClChannel.hh>

Collaboration diagram for XrdCl::Channel:

Public Member Functions
	Channel (const URL &url, Poller *poller, TransportHandler *transport, TaskManager *taskManager, JobManager *jobManager)
	~Channel ()
	Destructor. More...
const URL &	GetURL () const
	Get the URL. More...
XRootDStatus	Send (Message *msg, bool stateful, time_t expires)
XRootDStatus	Send (Message *msg, OutgoingMsgHandler *handler, bool stateful, time_t expires)
Status	Receive (Message *&msg, MessageFilter *filter, time_t expires)
Status	Receive (IncomingMsgHandler *handler, time_t expires)
Status	QueryTransport (uint16_t query, AnyObject &result)
void	RegisterEventHandler (ChannelEventHandler *handler)
	Register channel event handler. More...
void	RemoveEventHandler (ChannelEventHandler *handler)
	Remove a channel event handler. More...
void	Tick (time_t now)
	Handle a time event. More...
Status	ForceDisconnect ()
	Force disconnect of all streams. More...
uint16_t	NbConnectedStrm ()
	Get the number of connected data streams. More...
void	SetOnDataConnectHandler (std::shared_ptr< Job > &onConnJob)
	Set the on-connect handler for data streams. More...

Private Attributes
URL	pUrl
Poller *	pPoller
TransportHandler *	pTransport
TaskManager *	pTaskManager
Stream *	pStream
XrdSysMutex	pMutex
AnyObject	pChannelData
InQueue	pIncoming
TickGeneratorTask *	pTickGenerator
JobManager *	pJobManager

Detailed Description

A communication channel between the client and the server.

Constructor & Destructor Documentation

Channel()

XrdCl::Channel::Channel	(	const URL &	url,
		Poller *	poller,
		TransportHandler *	transport,
		TaskManager *	taskManager,
		JobManager *	jobManager
	)

Constructor

Parameters

url	address of the server to connect to
poller	poller object to be used for non-blocking IO
transport	protocol specific transport handler
taskManager	async task handler to be used by the channel
jobManager	worker thread handler to be used by the channel

~Channel()

XrdCl::Channel::~Channel

(

)

Destructor.

Member Function Documentation

ForceDisconnect()

Status XrdCl::Channel::ForceDisconnect

(

)

Force disconnect of all streams.

GetURL()

const URL& XrdCl::Channel::GetURL ( ) const

inline

Get the URL.

References pUrl.

NbConnectedStrm()

uint16_t XrdCl::Channel::NbConnectedStrm

(

)

Get the number of connected data streams.

QueryTransport()

Status XrdCl::Channel::QueryTransport	(	uint16_t	query,
		AnyObject &	result
	)

Query the transport handler

Parameters

query	the query as defined in the TransportQuery struct or others that may be recognized by the protocol transport
result	the result of the query

Returns

status of the query

Receive() [1/2]

Status XrdCl::Channel::Receive	(	IncomingMsgHandler *	handler,
		time_t	expires
	)

Listen to incoming messages, the listener is notified when a new message arrives and when the timeout passes

Parameters

handler	handler to be notified about new messages
expires	expiration timestamp

Returns

success when the handler has been registered correctly

Receive() [2/2]

Status XrdCl::Channel::Receive	(	Message *&	msg,
		MessageFilter *	filter,
		time_t	expires
	)

Synchronously receive a message - blocks until a message matching a filter is found in the incoming queue or the timeout passes

Parameters

msg	reference to a message pointer, the pointer will point to the received message
filter	filter object defining what to look for
expires	expiration timestamp

Returns

success when the message has been received successfully, failure otherwise

RegisterEventHandler()

void XrdCl::Channel::RegisterEventHandler

(

ChannelEventHandler *

handler

)

Register channel event handler.

RemoveEventHandler()

void XrdCl::Channel::RemoveEventHandler

(

ChannelEventHandler *

handler

)

Remove a channel event handler.

Send() [1/2]

XRootDStatus XrdCl::Channel::Send	(	Message *	msg,
		bool	stateful,
		time_t	expires
	)

Send a message synchronously - synchronously means that it will block until the message is written to a socket

Parameters

msg	message to be sent
expires	expiration timestamp after which a failure should be reported if sending was unsuccessful
stateful	physical stream disconnection causes an error

Returns

success if the message has been pushed through the wire, failure otherwise

Send() [2/2]

XRootDStatus XrdCl::Channel::Send	(	Message *	msg,
		OutgoingMsgHandler *	handler,
		bool	stateful,
		time_t	expires
	)

Send the message asynchronously - the message is inserted into the send queue and a listener is called when the message is successfully pushed through the wire or when the timeout elapses

Parameters

msg	message to be sent @apram stateful physical stream disconnection causes an error
expires	unix timestamp after which a failure is reported to the listener
handler	handler to be notified about the status
redirector	virtual redirector to be used

Returns

success if the message was successfully inserted into the send queues, failure otherwise

SetOnDataConnectHandler()

void XrdCl::Channel::SetOnDataConnectHandler

(

std::shared_ptr< Job > &

onConnJob

)

Set the on-connect handler for data streams.

Tick()

void XrdCl::Channel::Tick

(

time_t

now

)

Handle a time event.

Member Data Documentation

pChannelData

AnyObject XrdCl::Channel::pChannelData

private

pIncoming

InQueue XrdCl::Channel::pIncoming

private

pJobManager

JobManager* XrdCl::Channel::pJobManager

private

pMutex

XrdSysMutex XrdCl::Channel::pMutex

private

pPoller

Poller* XrdCl::Channel::pPoller

private

pStream

Stream* XrdCl::Channel::pStream

private

pTaskManager

TaskManager* XrdCl::Channel::pTaskManager

private

pTickGenerator

TickGeneratorTask* XrdCl::Channel::pTickGenerator

private

pTransport

TransportHandler* XrdCl::Channel::pTransport

private

pUrl

URL XrdCl::Channel::pUrl

private

Referenced by GetURL().

---

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

• XrdClChannel.hh