XrdClientSock Class Reference

#include <XrdClientSock.hh>

Inheritance diagram for XrdClientSock:

[legend]

Collaboration diagram for XrdClientSock:

[legend]

List of all members.

Public Types
typedef int	Sockid
typedef int	Sockdescr
Public Member Functions
	XrdClientSock (XrdClientUrlInfo host, int windowsize=0, int fd=-1)
virtual	~XrdClientSock ()
virtual void	BanSockDescr (Sockdescr, Sockid)
virtual void	UnBanSockDescr (Sockdescr)
void	ReinitFDTable ()
virtual int	RecvRaw (void *buffer, int length, Sockid substreamid=-1, Sockid *usedsubstreamid=0)
virtual int	SendRaw (const void *buffer, int length, Sockid substreamid=0)
void	SetRequestTimeout (int timeout=-1)
virtual int	Socks4Handshake (Sockid sockid)
virtual void	TryConnect (bool isUnix=0)
virtual Sockdescr	TryConnectParallelSock (int, int, Sockid &)
virtual int	EstablishParallelSock (Sockid, Sockid)
virtual int	RemoveParallelSock (Sockid)
virtual Sockid	GetSockIdHint (int)
virtual void	Disconnect ()
bool	IsConnected ()
virtual int	GetSockIdCount ()
virtual void	PauseSelectOnSubstream (Sockid)
virtual void	RestartSelectOnSubstream (Sockid)
Protected Member Functions
virtual int	SaveSocket ()
void	SetInterrupt (int which=0)
int	TryConnect_low (bool isUnix=0, int altport=0, int windowsz=0)
virtual int	SendRaw_sock (const void *buffer, int length, Sockdescr sock)
Protected Attributes
int	fRequestTimeout
XrdClientSockConnectParms	fHost
bool	fConnected
bool	fRDInterrupt
bool	fWRInterrupt
bool	fReinit_fd
Private Attributes
int	fSocket
Friends
class	XrdClientPhyConnection

---

Member Typedef Documentation

typedef int XrdClientSock::Sockdescr

typedef int XrdClientSock::Sockid

---

Constructor & Destructor Documentation

XrdClientSock::XrdClientSock	(	XrdClientUrlInfo	host,
		int	windowsize = 0,
		int	fd = -1
	)

Construct a socket helper

Parameters:

	host	Remote location to connect to
	windowSize	TCP window size: 0 for OS defaults or the ENV setting
	fd	A descriptor pointing to an already connected socket, -1 if not available

virtual XrdClientSock::~XrdClientSock

(

)

[virtual]

---

Member Function Documentation

virtual void XrdClientSock::BanSockDescr	(	Sockdescr	,
		Sockid
	)			[inline, virtual]

Reimplemented in XrdClientPSock.

Referenced by XrdClientPhyConnection::BanSockDescr().

virtual void XrdClientSock::Disconnect

(

)

[virtual]

Reimplemented in XrdClientPSock.

virtual int XrdClientSock::EstablishParallelSock	(	Sockid	,
		Sockid
	)			[inline, virtual]

Reimplemented in XrdClientPSock.

Referenced by XrdClientPhyConnection::EstablishPendingParallelStream().

virtual int XrdClientSock::GetSockIdCount

(

)

[inline, virtual]

Reimplemented in XrdClientPSock.

Referenced by XrdClientPhyConnection::GetSockIdCount().

virtual Sockid XrdClientSock::GetSockIdHint

(

int

)

[inline, virtual]

Reimplemented in XrdClientPSock.

Referenced by XrdClientPhyConnection::GetSockIdHint().

bool XrdClientSock::IsConnected

(

)

[inline]

References fConnected.

virtual void XrdClientSock::PauseSelectOnSubstream

(

Sockid

)

[inline, virtual]

Reimplemented in XrdClientPSock.

Referenced by XrdClientPhyConnection::PauseSelectOnSubstream().

virtual int XrdClientSock::RecvRaw	(	void *	buffer,
		int	length,
		Sockid	substreamid = -1,
		Sockid *	usedsubstreamid = 0
	)			[virtual]

Reimplemented in XrdClientPSock.

void XrdClientSock::ReinitFDTable

(

)

[inline]

References fReinit_fd.

Referenced by XrdClientPhyConnection::ReinitFDTable().

virtual int XrdClientSock::RemoveParallelSock

(

Sockid

)

[inline, virtual]

Reimplemented in XrdClientPSock.

Referenced by XrdClientPhyConnection::RemoveParallelStream().

virtual void XrdClientSock::RestartSelectOnSubstream

(

Sockid

)

[inline, virtual]

Reimplemented in XrdClientPSock.

Referenced by XrdClientPhyConnection::RestartSelectOnSubstream().

virtual int XrdClientSock::SaveSocket

(

)

[inline, protected, virtual]

Reimplemented in XrdClientPSock.

References fConnected, fRDInterrupt, fSocket, and fWRInterrupt.

Referenced by XrdClientPhyConnection::SaveSocket().

virtual int XrdClientSock::SendRaw	(	const void *	buffer,
		int	length,
		Sockid	substreamid = 0
	)			[virtual]

Reimplemented in XrdClientPSock.

virtual int XrdClientSock::SendRaw_sock	(	const void *	buffer,
		int	length,
		Sockdescr	sock
	)			[protected, virtual]

void XrdClientSock::SetInterrupt

(

int

which = 0

)

[inline, protected]

References fRDInterrupt, and fWRInterrupt.

Referenced by XrdClientPhyConnection::SetInterrupt().

void XrdClientSock::SetRequestTimeout

(

int

timeout = -1

)

virtual int XrdClientSock::Socks4Handshake

(

Sockid

sockid

)

[virtual]

virtual void XrdClientSock::TryConnect

(

bool

isUnix = 0

)

[virtual]

Reimplemented in XrdClientPSock.

int XrdClientSock::TryConnect_low	(	bool	isUnix = 0,
		int	altport = 0,
		int	windowsz = 0
	)			[protected]

virtual Sockdescr XrdClientSock::TryConnectParallelSock	(	int	,
		int	,
		Sockid &
	)			[inline, virtual]

Reimplemented in XrdClientPSock.

Referenced by XrdClientPhyConnection::TryConnectParallelStream().

virtual void XrdClientSock::UnBanSockDescr

(

Sockdescr

)

[inline, virtual]

Reimplemented in XrdClientPSock.

Referenced by XrdClientPhyConnection::UnBanSockDescr().

---

Friends And Related Function Documentation

friend class XrdClientPhyConnection [friend]

Reimplemented in XrdClientPSock.

---

Member Data Documentation

bool XrdClientSock::fConnected [protected]

Referenced by IsConnected(), SaveSocket(), and XrdClientPSock::SaveSocket().

XrdClientSockConnectParms XrdClientSock::fHost [protected]

bool XrdClientSock::fRDInterrupt [protected]

Referenced by SaveSocket(), XrdClientPSock::SaveSocket(), and SetInterrupt().

bool XrdClientSock::fReinit_fd [protected]

Referenced by ReinitFDTable().

int XrdClientSock::fRequestTimeout [protected]

int XrdClientSock::fSocket [private]

Referenced by XrdClientPhyConnection::GetSocket(), and SaveSocket().

bool XrdClientSock::fWRInterrupt [protected]

Referenced by SaveSocket(), XrdClientPSock::SaveSocket(), and SetInterrupt().

---

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

• XrdClientSock.hh