#include <XrdClAsyncSocketHandler.hh>

Inheritance diagram for XrdCl::AsyncSocketHandler:

Collaboration diagram for XrdCl::AsyncSocketHandler:

Public Member Functions
	AsyncSocketHandler (Poller poller, TransportHandler transport, AnyObject *channelData, uint16_t subStreamNum)
	Constructor.
	~AsyncSocketHandler ()
	Destructor.
void	SetAddress (const sockaddr_in &address)
	Set address.
const sockaddr_in &	GetAddress () const
	Get the address that the socket is connected to.
Status	Connect (time_t timeout)
	Connect to the currently set address.
Status	Close ()
	Close the connection.
void	SetStream (Stream *stream)
	Set a stream object to be notified about the status of the operations.
virtual void	Event (uint8_t type, XrdCl::Socket *)
	Handle a socket event.
Status	EnableUplink ()
	Enable uplink.
Status	DisableUplink ()
	Disable uplink.
const std::string &	GetStreamName ()
	Get stream name.
Public Member Functions inherited from XrdCl::SocketHandler
virtual	~SocketHandler ()
virtual void	Initialize (Poller *)
	Initializer.
virtual void	Finalize ()
	Finalizer.

Private Member Functions
void	OnConnectionReturn ()
void	OnWrite ()
void	OnWriteWhileHandshaking ()
Status	WriteCurrentMessage ()
void	OnRead ()
void	OnReadWhileHandshaking ()
Status	ReadMessage ()
void	OnFault (Status st)
void	OnFaultWhileHandshaking (Status st)
void	OnWriteTimeout ()
void	OnReadTimeout ()
void	OnTimeoutWhileHandshaking ()

Private Attributes
Poller *	pPoller
TransportHandler *	pTransport
AnyObject *	pChannelData
uint16_t	pSubStreamNum
Stream *	pStream
std::string	pStreamName
Socket *	pSocket
Message *	pIncoming
Message *	pOutgoing
sockaddr_in	pSockAddr
HandShakeData *	pHandShakeData
bool	pHandShakeDone
uint16_t	pTimeoutResolution
time_t	pConnectionStarted
time_t	pConnectionTimeout
bool	pHeaderDone
std::pair< IncomingMsgHandler *, bool >	pIncHandler
bool	pOutMsgDone
OutgoingMsgHandler *	pOutHandler
uint32_t	pIncMsgSize
uint32_t	pOutMsgSize

Additional Inherited Members
Public Types inherited from XrdCl::SocketHandler
enum	EventType { ReadyToRead = 0x01, ReadTimeOut = 0x02, ReadyToWrite = 0x04, WriteTimeOut = 0x08 }
	Event type. More...
Static Public Member Functions inherited from XrdCl::SocketHandler
static std::string	EventTypeToString (uint8_t event)
	Translate the event type to a string.

Detailed Description

Utility class handling asynchronous socket interactions and forwarding events to the parent stream.

Constructor & Destructor Documentation

XrdCl::AsyncSocketHandler::AsyncSocketHandler	(	Poller *	poller,
		TransportHandler *	transport,
		AnyObject *	channelData,
		uint16_t	subStreamNum
	)

Constructor.

References XrdCl::DefaultTimeoutResolution, XrdCl::DefaultEnv::GetEnv(), XrdCl::Env::GetInt(), pIncHandler, pSockAddr, pSocket, and pTimeoutResolution.

XrdCl::AsyncSocketHandler::~AsyncSocketHandler ( )

Destructor.

References Close(), and pSocket.

Member Function Documentation

Status XrdCl::AsyncSocketHandler::Close ( )

Close the connection.

References XrdCl::AsyncSockMsg, XrdCl::Socket::Close(), XrdCl::Log::Debug(), XrdCl::TransportHandler::Disconnect(), XrdCl::DefaultEnv::GetLog(), XrdCl::Stream::GetStreamNumber(), pChannelData, pPoller, pSocket, pStream, pStreamName, pSubStreamNum, pTransport, and XrdCl::Poller::RemoveSocket().

Referenced by ~AsyncSocketHandler().

Status XrdCl::AsyncSocketHandler::Connect ( time_t timeout )

Status XrdCl::AsyncSocketHandler::DisableUplink ( )

inline

Disable uplink.

References XrdCl::Poller::EnableWriteNotification(), XrdCl::errPollerError, pPoller, pSocket, and XrdCl::stFatal.

Referenced by OnWriteWhileHandshaking().

Status XrdCl::AsyncSocketHandler::EnableUplink ( )

inline

Enable uplink.

References XrdCl::Poller::EnableWriteNotification(), XrdCl::errPollerError, pPoller, pSocket, pTimeoutResolution, and XrdCl::stFatal.

Referenced by OnReadWhileHandshaking().

void XrdCl::AsyncSocketHandler::Event	(	uint8_t	type,
		XrdCl::Socket *
	)

virtual

Handle a socket event.

Implements XrdCl::SocketHandler.

References XrdCl::Socket::Connecting, XrdCl::Socket::GetStatus(), likely, OnConnectionReturn(), OnRead(), OnReadTimeout(), OnReadWhileHandshaking(), OnTimeoutWhileHandshaking(), OnWrite(), OnWriteTimeout(), OnWriteWhileHandshaking(), pHandShakeDone, pSocket, XrdCl::SocketHandler::ReadTimeOut, XrdCl::SocketHandler::ReadyToRead, XrdCl::SocketHandler::ReadyToWrite, unlikely, and XrdCl::SocketHandler::WriteTimeOut.

const sockaddr_in& XrdCl::AsyncSocketHandler::GetAddress ( ) const

inline

Get the address that the socket is connected to.

References pSockAddr.

const std::string& XrdCl::AsyncSocketHandler::GetStreamName ( )

inline

Get stream name.

References pStreamName.

void XrdCl::AsyncSocketHandler::OnConnectionReturn ( )

private

References XrdCl::AsyncSockMsg, XrdCl::HandShakeData::clientName, XrdCl::Socket::Connected, XrdCl::Log::Debug(), XrdCl::Poller::EnableReadNotification(), XrdCl::errConnectionError, XrdCl::Log::Error(), XrdCl::errPollerError, XrdCl::errSocketOptError, XrdCl::DefaultEnv::GetLog(), XrdCl::Socket::GetServerAddress(), XrdCl::Socket::GetSockName(), XrdCl::Socket::GetSockOpt(), XrdCl::Stream::GetStreamNumber(), XrdCl::Stream::GetURL(), XrdCl::TransportHandler::HandShake(), XrdCl::Status::IsOK(), XrdCl::Stream::OnConnectError(), XrdCl::HandShakeData::out, pChannelData, pHandShakeData, pOutgoing, pPoller, pSocket, pStream, pStreamName, pSubStreamNum, pTimeoutResolution, pTransport, XrdCl::HandShakeData::serverAddr, XrdCl::Socket::SetStatus(), XrdCl::HandShakeData::step, XrdCl::stError, XrdCl::stFatal, and XrdCl::HandShakeData::streamName.

Referenced by Event().

void XrdCl::AsyncSocketHandler::OnFault ( Status st )

private

References XrdCl::AsyncSockMsg, XrdCl::Log::Error(), XrdCl::DefaultEnv::GetLog(), XrdCl::Stream::OnError(), pIncHandler, pIncoming, pOutgoing, pOutHandler, pStream, pStreamName, pSubStreamNum, and XrdCl::Status::ToString().

Referenced by OnRead(), and OnWrite().

void XrdCl::AsyncSocketHandler::OnFaultWhileHandshaking ( Status st )

private

References XrdCl::AsyncSockMsg, XrdCl::Log::Error(), XrdCl::DefaultEnv::GetLog(), XrdCl::Stream::OnConnectError(), pIncoming, pOutgoing, pStream, pStreamName, pSubStreamNum, and XrdCl::Status::ToString().

Referenced by OnReadWhileHandshaking(), OnTimeoutWhileHandshaking(), and OnWriteWhileHandshaking().

void XrdCl::AsyncSocketHandler::OnRead ( )

private

void XrdCl::AsyncSocketHandler::OnReadTimeout ( )

private

References XrdCl::Stream::OnReadTimeout(), pStream, and pSubStreamNum.

Referenced by Event().

void XrdCl::AsyncSocketHandler::OnReadWhileHandshaking ( )

private

void XrdCl::AsyncSocketHandler::OnTimeoutWhileHandshaking ( )

private

References XrdCl::errSocketTimeout, OnFaultWhileHandshaking(), pConnectionStarted, pConnectionTimeout, and XrdCl::stError.

Referenced by Event().

void XrdCl::AsyncSocketHandler::OnWrite ( )

private

void XrdCl::AsyncSocketHandler::OnWriteTimeout ( )

private

References XrdCl::Stream::OnWriteTimeout(), pStream, and pSubStreamNum.

Referenced by Event().

void XrdCl::AsyncSocketHandler::OnWriteWhileHandshaking ( )

private

References XrdCl::Status::code, DisableUplink(), OnFaultWhileHandshaking(), pOutgoing, XrdCl::suRetry, and WriteCurrentMessage().

Referenced by Event().

Status XrdCl::AsyncSocketHandler::ReadMessage ( )

private

References XrdCl::AsyncSockMsg, XrdCl::Status::code, XrdCl::Log::Dump(), XrdCl::TransportHandler::GetBody(), XrdCl::Buffer::GetCursor(), XrdCl::Socket::GetFD(), XrdCl::TransportHandler::GetHeader(), XrdCl::DefaultEnv::GetLog(), XrdCl::Buffer::GetSize(), XrdCl::Status::IsOK(), pHeaderDone, pIncoming, pSocket, pStreamName, pTransport, and XrdCl::suDone.

Referenced by OnReadWhileHandshaking().

void XrdCl::AsyncSocketHandler::SetAddress ( const sockaddr_in & address )

inline

Set address.

References pSockAddr.

void XrdCl::AsyncSocketHandler::SetStream ( Stream * stream )

Set a stream object to be notified about the status of the operations.

References XrdCl::URL::GetHostId(), XrdCl::Stream::GetStreamNumber(), XrdCl::Stream::GetURL(), pStream, pStreamName, pSubStreamNum, and PC3::stream().

Referenced by XrdCl::Stream::Initialize(), and XrdCl::Stream::OnConnect().

Status XrdCl::AsyncSocketHandler::WriteCurrentMessage ( )

private

References XrdCl::Buffer::AdvanceCursor(), XrdCl::AsyncSockMsg, XrdCl::Log::Dump(), XrdCl::errSocketError, XrdCl::Buffer::GetBufferAtCursor(), XrdCl::Buffer::GetCursor(), XrdCl::Message::GetDescription(), XrdCl::DefaultEnv::GetLog(), XrdCl::Buffer::GetSize(), pOutgoing, pSocket, pStreamName, XrdCl::Socket::Send(), XrdCl::Buffer::SetCursor(), XrdCl::stError, XrdCl::stOK, and XrdCl::suRetry.

Referenced by OnWrite(), and OnWriteWhileHandshaking().

Member Data Documentation

AnyObject* XrdCl::AsyncSocketHandler::pChannelData

private

Referenced by Close(), OnConnectionReturn(), and OnReadWhileHandshaking().

time_t XrdCl::AsyncSocketHandler::pConnectionStarted

private

Referenced by Connect(), and OnTimeoutWhileHandshaking().

time_t XrdCl::AsyncSocketHandler::pConnectionTimeout

private

Referenced by Connect(), and OnTimeoutWhileHandshaking().

HandShakeData* XrdCl::AsyncSocketHandler::pHandShakeData

private

Referenced by OnConnectionReturn(), and OnReadWhileHandshaking().

bool XrdCl::AsyncSocketHandler::pHandShakeDone

private

Referenced by Connect(), Event(), and OnReadWhileHandshaking().

bool XrdCl::AsyncSocketHandler::pHeaderDone

private

Referenced by OnRead(), and ReadMessage().

std::pair<IncomingMsgHandler*, bool> XrdCl::AsyncSocketHandler::pIncHandler

private

Referenced by AsyncSocketHandler(), OnFault(), and OnRead().

uint32_t XrdCl::AsyncSocketHandler::pIncMsgSize

private

Referenced by OnRead().

Message* XrdCl::AsyncSocketHandler::pIncoming

private

Referenced by OnFault(), OnFaultWhileHandshaking(), OnRead(), OnReadWhileHandshaking(), and ReadMessage().

Message* XrdCl::AsyncSocketHandler::pOutgoing

private

Referenced by OnConnectionReturn(), OnFault(), OnFaultWhileHandshaking(), OnReadWhileHandshaking(), OnWrite(), OnWriteWhileHandshaking(), and WriteCurrentMessage().

OutgoingMsgHandler* XrdCl::AsyncSocketHandler::pOutHandler

private

Referenced by OnFault(), and OnWrite().

bool XrdCl::AsyncSocketHandler::pOutMsgDone

private

Referenced by OnWrite().

uint32_t XrdCl::AsyncSocketHandler::pOutMsgSize

private

Referenced by OnWrite().

Poller* XrdCl::AsyncSocketHandler::pPoller

private

Referenced by Close(), Connect(), DisableUplink(), EnableUplink(), and OnConnectionReturn().

sockaddr_in XrdCl::AsyncSocketHandler::pSockAddr

private

Referenced by AsyncSocketHandler(), Connect(), GetAddress(), and SetAddress().

Socket* XrdCl::AsyncSocketHandler::pSocket

private

Referenced by AsyncSocketHandler(), Close(), Connect(), DisableUplink(), EnableUplink(), Event(), OnConnectionReturn(), OnRead(), OnWrite(), ReadMessage(), WriteCurrentMessage(), and ~AsyncSocketHandler().

Stream* XrdCl::AsyncSocketHandler::pStream

private

Referenced by Close(), OnConnectionReturn(), OnFault(), OnFaultWhileHandshaking(), OnRead(), OnReadTimeout(), OnReadWhileHandshaking(), OnWrite(), OnWriteTimeout(), and SetStream().

std::string XrdCl::AsyncSocketHandler::pStreamName

private

Referenced by Close(), Connect(), GetStreamName(), OnConnectionReturn(), OnFault(), OnFaultWhileHandshaking(), OnRead(), OnWrite(), ReadMessage(), SetStream(), and WriteCurrentMessage().

uint16_t XrdCl::AsyncSocketHandler::pSubStreamNum

private

Referenced by Close(), OnConnectionReturn(), OnFault(), OnFaultWhileHandshaking(), OnRead(), OnReadTimeout(), OnReadWhileHandshaking(), OnWrite(), OnWriteTimeout(), and SetStream().

uint16_t XrdCl::AsyncSocketHandler::pTimeoutResolution

private

Referenced by AsyncSocketHandler(), Connect(), EnableUplink(), and OnConnectionReturn().

TransportHandler* XrdCl::AsyncSocketHandler::pTransport

private

Referenced by Close(), OnConnectionReturn(), OnRead(), OnReadWhileHandshaking(), and ReadMessage().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation