#include <XrdClChannel.hh>

Collaboration diagram for XrdCl::Channel:

Public Member Functions
	Channel (const URL &url, Poller poller, TransportHandler transport, TaskManager taskManager, JobManager jobManager, const URL &prefurl=URL())

	~Channel ()
	Destructor. More...

bool	CanCollapse (const URL &url)

void	DecFileInstCnt ()
	Decrement file object instance count bound to this channel. More...

void	Finalize ()

Status	ForceDisconnect ()
	Force disconnect of all streams. More...

Status	ForceDisconnect (bool hush)
	Force disconnect of all streams. More...

Status	ForceDisconnect (std::shared_ptr< Channel > self, const uint64_t sess)

Status	ForceReconnect ()
	Force reconnect. More...

const URL &	GetURL () const
	Get the URL. More...

uint16_t	NbConnectedStrm ()
	Get the number of connected data streams. More...

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

XRootDStatus	Send (Message msg, MsgHandler handler, bool stateful, time_t expires)

void	SetOnDataConnectHandler (std::shared_ptr< Job > &onConnJob)
	Set the on-connect handler for data streams. More...

void	SetSelf (std::shared_ptr< Channel > &self)
	Gives us access to the shared pointer that the postmaster holds for us. More...

void	Tick (time_t now)
	Handle a time event. More...

Detailed Description

A communication channel between the client and the server

Notes on ownership. The Channel is owned via shared_ptr usually held by at least PostMaster. Channels replaced during a RedirectCollapse may no longer be held by PostMaster. Channel has a weak_ptr to its shared_ptr (pSelf). Channel owns a Stream, which also holds a weak_ptr for its owning Channel. The Stream owns a number of AsyncSocketHandler (one for each substream). After Connect() the SocketHandler will hold a shared_ptr for Channel until the SocketHandler is Closed. Thus lifetime of Channel ends when PostMaster gives up holding the Channel and all AsyncSocketHandler Close connections. PostMaster also maintains a set of non-owning Channel* for live Channel objects, for PostMaster::Finalize() to use to issue Finalize() on any live Channels.

Definition at line 61 of file XrdClChannel.hh.

Constructor & Destructor Documentation

◆ Channel()

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

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

Definition at line 84 of file XrdClChannel.cc.

                                                :
     pUrl( url.GetHostId() ),
     pPoller( poller ),
     pTransport( transport ),
     pTaskManager( taskManager ),
     pTickGenerator( 0 ),
     pJobManager( jobManager )
   {
     Env *env = DefaultEnv::GetEnv();
     Log *log = DefaultEnv::GetLog();
  
     int  timeoutResolution = DefaultTimeoutResolution;
     env->GetInt( "TimeoutResolution", timeoutResolution );
  
     pTransport->InitializeChannel( url, pChannelData );
     log->Debug( PostMasterMsg, "Creating new channel to: %s",
                                 url.GetChannelId().c_str() );
  
     pUrl.SetParams( url.GetParams() );
     pUrl.SetProtocol( url.GetProtocol() );
  
     //--------------------------------------------------------------------------
     // Create the stream
     //--------------------------------------------------------------------------
     pStream = std::make_unique<Stream>( &pUrl, prefurl );
     pStream->SetTransport( transport );
     pStream->SetPoller( poller );
     pStream->SetIncomingQueue( &pIncoming );
     pStream->SetTaskManager( taskManager );
     pStream->SetJobManager( jobManager );
     pStream->SetChannelData( &pChannelData );
     pStream->Initialize();
  
     //--------------------------------------------------------------------------
     // Register the task generating timeout events
     //--------------------------------------------------------------------------
     pTickGenerator = new TickGeneratorTask( this, pUrl.GetChannelId() );
     pTaskManager->RegisterTask( pTickGenerator, ::time(0)+timeoutResolution );
   }

References XrdCl::Log::Debug(), XrdCl::DefaultTimeoutResolution, XrdCl::URL::GetChannelId(), XrdCl::DefaultEnv::GetEnv(), XrdCl::Env::GetInt(), XrdCl::DefaultEnv::GetLog(), XrdCl::URL::GetParams(), XrdCl::URL::GetProtocol(), XrdCl::TransportHandler::InitializeChannel(), XrdCl::PostMasterMsg, XrdCl::TaskManager::RegisterTask(), XrdCl::URL::SetParams(), and XrdCl::URL::SetProtocol().

Here is the call graph for this function:

◆ ~Channel()

XrdCl::Channel::~Channel ( )

Destructor.

Definition at line 132 of file XrdClChannel.cc.

   {
     pTickGenerator->Invalidate();
     pStream.reset();
     pTransport->FinalizeChannel( pChannelData );
   }

References XrdCl::TransportHandler::FinalizeChannel(), and XrdCl::TickGeneratorTask::Invalidate().

Here is the call graph for this function:

Member Function Documentation

◆ CanCollapse()

bool XrdCl::Channel::CanCollapse ( const URL & url )

Returns: : true if this channel can be collapsed using this URL, false otherwise

Definition at line 230 of file XrdClChannel.cc.

   {
     return pStream->CanCollapse( url );
   }

◆ DecFileInstCnt()

void XrdCl::Channel::DecFileInstCnt ( )

Decrement file object instance count bound to this channel.

Definition at line 238 of file XrdClChannel.cc.

   {
     pTransport->DecFileInstCnt( pChannelData );
   }

References XrdCl::TransportHandler::DecFileInstCnt().

Here is the call graph for this function:

◆ Finalize()

void XrdCl::Channel::Finalize ( )

Used by the PostMaster to indicate the Channel should release all resources. It should be assumed that the jobmanager has already been stopped & finalized and the poller and taskmanager have been stopped.

Definition at line 162 of file XrdClChannel.cc.

   {
     pStream->Finalize();
   }

◆ ForceDisconnect() [1/3]

Status XrdCl::Channel::ForceDisconnect ( )

Force disconnect of all streams.

Definition at line 170 of file XrdClChannel.cc.

   {
     return ForceDisconnect(false);
   }

◆ ForceDisconnect() [2/3]

Status XrdCl::Channel::ForceDisconnect ( bool hush )

Force disconnect of all streams.

Definition at line 178 of file XrdClChannel.cc.

   {
     //--------------------------------------------------------------------------
     // Disconnect the stream and all substreams
     //--------------------------------------------------------------------------
     pStream->ForceError( Status( stError, errOperationInterrupted ), hush, 0);
  
     return Status();
   }

References XrdCl::errOperationInterrupted, and XrdCl::stError.

◆ ForceDisconnect() [3/3]

Status XrdCl::Channel::ForceDisconnect	(	std::shared_ptr< Channel >	self,
		const uint64_t	sess
	)

Force disconnect of all streams. This was triggered internally, e.g. by one of our Streams.

Definition at line 191 of file XrdClChannel.cc.

   {
     //--------------------------------------------------------------------------
     // Disconnect the stream and all substreams
     //--------------------------------------------------------------------------
     pStream->ForceError( Status( stError, errOperationInterrupted ), false, sess );
  
     return Status();
   }

References XrdCl::errOperationInterrupted, and XrdCl::stError.

◆ ForceReconnect()

Status XrdCl::Channel::ForceReconnect ( )

Force reconnect.

Definition at line 205 of file XrdClChannel.cc.

   {
     pStream->ForceConnect();
     return Status();
   }

◆ GetURL()

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

inline

Get the URL.

Definition at line 88 of file XrdClChannel.hh.

       {
         return pUrl;
       }

◆ NbConnectedStrm()

uint16_t XrdCl::Channel::NbConnectedStrm ( )

Get the number of connected data streams.

Definition at line 214 of file XrdClChannel.cc.

   {
     return XRootDTransport::NbConnectedStrm( pChannelData );
   }

References XrdCl::XRootDTransport::NbConnectedStrm().

Here is the call graph for this function:

◆ 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

Definition at line 246 of file XrdClChannel.cc.

   {
     if( query < 2000 )
       return pTransport->Query( query, result, pChannelData );
     return pStream->Query( query, result );
   }

References XrdCl::TransportHandler::Query().

Here is the call graph for this function:

◆ RegisterEventHandler()

void XrdCl::Channel::RegisterEventHandler ( ChannelEventHandler * handler )

Register channel event handler.

Definition at line 256 of file XrdClChannel.cc.

   {
     pStream->RegisterEventHandler( handler );
   }

◆ RemoveEventHandler()

void XrdCl::Channel::RemoveEventHandler ( ChannelEventHandler * handler )

Remove a channel event handler.

Definition at line 264 of file XrdClChannel.cc.

   {
     pStream->RemoveEventHandler( handler );
   }

◆ Send()

XRootDStatus XrdCl::Channel::Send	(	Message *	msg,
		MsgHandler *	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
handler	handler to be notified about the status
stateful	physical stream disconnection causes an error
expires	unix timestamp after which a failure is reported to the listener

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

Definition at line 142 of file XrdClChannel.cc.

   {
     return pStream->Send( msg, handler, stateful, expires );
   }

◆ SetOnDataConnectHandler()

void XrdCl::Channel::SetOnDataConnectHandler ( std::shared_ptr< Job > & onConnJob )

Set the on-connect handler for data streams.

Definition at line 222 of file XrdClChannel.cc.

   {
     pStream->SetOnDataConnectHandler( onConnJob );
   }

◆ SetSelf()

void XrdCl::Channel::SetSelf ( std::shared_ptr< Channel > & self )

Gives us access to the shared pointer that the postmaster holds for us.

Definition at line 269 of file XrdClChannel.cc.

   {
     pSelf = self;
     if( pStream ) pStream->SetChannel( pSelf );
   }

◆ Tick()

void XrdCl::Channel::Tick ( time_t now )

Handle a time event.

Definition at line 154 of file XrdClChannel.cc.

   {
     pStream->Tick( now );
   }

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Channel()

◆ ~Channel()

Member Function Documentation

◆ CanCollapse()

◆ DecFileInstCnt()

◆ Finalize()

◆ ForceDisconnect() [1/3]

◆ ForceDisconnect() [2/3]

◆ ForceDisconnect() [3/3]

◆ ForceReconnect()

◆ GetURL()

◆ NbConnectedStrm()

◆ QueryTransport()

◆ RegisterEventHandler()

◆ RemoveEventHandler()

◆ Send()

◆ SetOnDataConnectHandler()

◆ SetSelf()

◆ Tick()