XrdLinkCtl Class Reference

#include <XrdLinkCtl.hh>

Inheritance diagram for XrdLinkCtl:

Collaboration diagram for XrdLinkCtl:

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

Static Public Member Functions
static XrdLink *	Alloc (XrdNetAddr &peer, int opts=0)
static XrdLink *	fd2link (int fd)
static XrdLink *	fd2link (int fd, unsigned int inst)
static XrdPollInfo *	fd2PollInfo (int fd)
static XrdLink *	Find (int &curr, XrdLinkMatch *who=0)
static int	getName (int &curr, char *bname, int blen, XrdLinkMatch *who=0)
static void	idleScan ()
	Look for idle links and close hem down. More...
static void	setKWT (int wkSec, int kwSec)
static int	Setup (int maxfds, int idlewt)
static void	SyncAll ()
	Synchronize statustics for ll links. More...
static void	Unhook (int fd)
	Unhook a link from the active table of links. More...

Static Public Attributes
static short	killWait
	Link destruction control constants. More...
static short	waitKill

Private Member Functions
	~XrdLinkCtl ()

Static Private Attributes
static XrdSysMutex	LTMutex
static XrdLinkCtl **	LinkTab
static char *	LinkBat
static unsigned int	LinkAlloc
static int	LTLast
static int	maxFD
static const char *	TraceID

Additional Inherited Members
Protected Types inherited from XrdLink
typedef XrdOucSFVec	sfVec
Protected Member Functions inherited from XrdLinkXeq
int	RecvIOV (const struct iovec *iov, int iocnt)
void	Reset ()
int	sendData (const char *Buff, int Blen)
int	SendIOV (const struct iovec *iov, int iocnt, int bytes)
int	SFError (int rc)
int	TLS_Error (const char *act, XrdTls::RC rc)
bool	TLS_Write (const char *Buff, int Blen)
XrdNetAddrInfo *	AddrInfo ()
int	Backlog ()
int	Client (char *buff, int blen)
int	Close (bool defer=false)
void	DoIt ()
int	getIOStats (long long &inbytes, long long &outbytes, int &numstall, int &numtardy)
XrdTlsPeerCerts *	getPeerCerts ()
XrdProtocol *	getProtocol ()
const char *	Name () const
const XrdNetAddr *	NetAddr () const
int	Peek (char *buff, int blen, int timeout=-1)
int	Recv (char *buff, int blen)
int	Recv (char *buff, int blen, int timeout)
int	Recv (const struct iovec *iov, int iocnt, int timeout)
int	RecvAll (char *buff, int blen, int timeout=-1)
bool	Register (const char *hName)
int	Send (const char *buff, int blen)
int	Send (const struct iovec *iov, int iocnt, int bytes=0)
int	Send (const sfVec *sdP, int sdn)
void	setID (const char *userid, int procid)
void	setLocation (XrdNetAddrInfo::LocInfo &loc)
bool	setNB ()
XrdProtocol *	setProtocol (XrdProtocol *pp, bool push)
void	setProtName (const char *name)
bool	setTLS (bool enable, XrdTlsContext *ctx=0)
void	Shutdown (bool getLock)
void	syncStats (int *ctime=0)
int	TLS_Peek (char *Buff, int Blen, int timeout)
int	TLS_Recv (char *Buff, int Blen)
int	TLS_Recv (char *Buff, int Blen, int timeout, bool havelock=false)
int	TLS_Recv (const struct iovec *iov, int iocnt, int timeout)
int	TLS_RecvAll (char *Buff, int Blen, int timeout)
int	TLS_Send (const char *Buff, int Blen)
int	TLS_Send (const struct iovec *iov, int iocnt, int bytes)
int	TLS_Send (const sfVec *sfP, int sfN)
const char *	verTLS ()
	XrdLinkXeq ()
	~XrdLinkXeq ()
Protected Member Functions inherited from XrdLink
	~XrdLink ()
void	ResetLink ()
int	Wait4Data (int timeout)
bool	Activate ()
XrdNetAddrInfo *	AddrInfo ()
int	Backlog ()
int	Client (char *buff, int blen)
int	Close (bool defer=false)
void	Enable ()
	Enable the link to field interrupts. More...
int	FDnum ()
int	getIOStats (long long &inbytes, long long &outbytes, int &numstall, int &numtardy)
XrdTlsPeerCerts *	getPeerCerts ()
XrdProtocol *	getProtocol ()
	Obtain current protocol object pointer. More...
void	Hold (bool lk)
const char *	Host () const
unsigned int	Inst () const
bool	isFlawed () const
bool	isInstance (unsigned int inst) const
const char *	Name () const
const XrdNetAddr *	NetAddr () const
int	Peek (char *buff, int blen, int timeout=-1)
int	Recv (char *buff, int blen)
int	Recv (char *buff, int blen, int timeout)
int	Recv (const struct iovec *iov, int iocnt, int timeout)
int	RecvAll (char *buff, int blen, int timeout=-1)
bool	Register (const char *hName)
int	Send (const char *buff, int blen)
int	Send (const struct iovec *iov, int iocnt, int bytes=0)
int	Send (const sfVec *sdP, int sdn)
void	Serialize ()
	Wait for all outstanding requests to be completed on the link. More...
int	setEtext (const char *text)
void	setID (const char *userid, int procid)
void	setLocation (XrdNetAddrInfo::LocInfo &loc)
bool	setNB ()
XrdProtocol *	setProtocol (XrdProtocol *pp, bool runit=false, bool push=false)
void	setProtName (const char *name)
void	setRef (int cnt)
bool	setTLS (bool enable, XrdTlsContext *ctx=0)
	Enable or disable TLS on the link. More...
void	Shutdown (bool getLock)
void	syncStats (int *ctime=0)
int	Terminate (const char *owner, int fdnum, unsigned int inst)
time_t	timeCon () const
	Return the time the link was made active (i.e. time of connection). More...
int	UseCnt () const
	Return link's reference count. More...
void	armBridge ()
	Mark this link as an in-memory communications bridge (internal use only). More...
bool	hasBridge () const
bool	hasTLS () const
const char *	verTLS ()
	XrdLink (XrdLinkXeq &lxq)
Protected Member Functions inherited from XrdJob
	XrdJob (const char *desc="")
virtual	~XrdJob ()
Static Protected Member Functions inherited from XrdLinkXeq
static int	getName (int &curr, char *bname, int blen, XrdLinkMatch *who=0)
static int	Stats (char *buff, int blen, bool do_sync=false)
Static Protected Member Functions inherited from XrdLink
static XrdLink *	Find (int &curr, XrdLinkMatch *who=0)
static int	getName (int &curr, char *bname, int blen, XrdLinkMatch *who=0)
static int	Stats (char *buff, int blen, bool do_sync=0)
Protected Attributes inherited from XrdLinkXeq
long long	BytesIn
long long	BytesInTot
long long	BytesOut
long long	BytesOutTot
int	stallCnt
int	stallCntTot
int	tardyCnt
int	tardyCntTot
int	SfIntr
XrdProtocol *	Protocol
XrdProtocol *	ProtoAlt
XrdTlsSocket	tlsIO
XrdNetAddr	Addr
XrdSysMutex	rdMutex
XrdSysMutex	wrMutex
XrdSendQ *	sendQ
int	HNlen
bool	LockReads
bool	KeepFD
char	isIdle
char	Uname [24]
char	Lname [256]
XrdLinkInfo	LinkInfo
XrdPollInfo	PollInfo
Protected Attributes inherited from XrdLink
void *	rsvd1 [3]
XrdLinkXeq &	linkXQ
char *	HostName
unsigned int	Instance
bool	isBridged
bool	isTLS
char	rsvd2 [2]
char *	ID
	Pointer to the client's link identity. More...
Protected Attributes inherited from XrdJob
XrdJob *	NextJob
const char *	Comment
Static Protected Attributes inherited from XrdLinkXeq
static const char *	TraceID
static long long	LinkBytesIn
static long long	LinkBytesOut
static long long	LinkConTime
static long long	LinkCountTot
static int	LinkCount
static int	LinkCountMax
static int	LinkTimeOuts
static int	LinkStalls
static int	LinkSfIntr
static XrdSysMutex	statsMutex
Static Protected Attributes inherited from XrdLink
static bool	sfOK

Constructor & Destructor Documentation

XrdLinkCtl::XrdLinkCtl ( )

inline

Constructor.

XrdLinkCtl::~XrdLinkCtl ( )

inlineprivate

Member Function Documentation

static XrdLink* XrdLinkCtl::Alloc ( XrdNetAddr &  peer, int  opts = 0  )

static

static XrdLink* XrdLinkCtl::fd2link ( int  fd )

inlinestatic

Translate a file descriptor number to the corresponding link object.

Parameters

fd	The file descriptor number.

Returns

!0 Pointer to the link object. =0 The file descriptor is not associated with a link.

References LinkBat, LinkTab, and LTLast.

static XrdLink* XrdLinkCtl::fd2link ( int  fd, unsigned int  inst  )

inlinestatic

Translate a file descriptor number and an instance to a link object.

Parameters

fd	The file descriptor number.
inst	The file descriptor number instance number.

Returns

!0 Pointer to the link object. =0 The file descriptor instance is not associated with a link.

References XrdLink::Instance, LinkBat, LinkTab, and LTLast.

static XrdPollInfo* XrdLinkCtl::fd2PollInfo ( int  fd )

inlinestatic

Translate a file descriptor number to the corresponding PollInfo object.

Parameters

fd	The file descriptor number.

Returns

!0 Pointer to the PollInfo object. =0 The file descriptor is not associated with a link.

References LinkBat, LinkTab, LTLast, and XrdLinkXeq::PollInfo.

static XrdLink* XrdLinkCtl::Find ( int &  curr, XrdLinkMatch *  who = 0  )

static

Find the next link matching certain attributes.

Parameters

curr	Is an internal tracking value that allows repeated calls. It must be set to a value of 0 or less on the initial call and not touched therafter unless a null pointer is returned.
who	If the object use to check if the link matches the wanted criterea (typically, client name and host name). If the ppointer is nil, the next link is always returned.

Returns

!0 Pointer to the link object that matches the criterea. The link's reference counter is increased to prevent it from being reused. A subsequent call will reduce the number. =0 No more links exist with the specified criterea.

static int XrdLinkCtl::getName ( int &  curr, char *  bname, int  blen, XrdLinkMatch *  who = 0  )

static

Find the next client name matching certain attributes.

Parameters

curr	Is an internal tracking value that allows repeated calls. It must be set to a value of 0 or less on the initial call and not touched therafter unless zero is returned.
bname	Pointer to a buffer where the name is to be returned.
blen	The length of the buffer.
who	If the object use to check if the link matches the wanted criterea (typically, client name and host name). If the pointer is nil, a match always occurs.

Returns

!0 The length of the name placed in the buffer. =0 No more links exist with the specified criterea.

static void XrdLinkCtl::idleScan ( )

static

Look for idle links and close hem down.

static void XrdLinkCtl::setKWT ( int  wkSec, int  kwSec  )

static

Set kill constants.

Parameters

wkSec	Seconds to wait for kill to happed,
kwSec	The minimum number of seconds to wait after killing a connection for it to end.

static int XrdLinkCtl::Setup ( int  maxfds, int  idlewt  )

static

Setup link processing.

Parameters

maxfds	The maximum number of connections to handle.
idlewt	The time interval to check for idle connections.

Returns

!0 Successful. =0 Setup failed.

static void XrdLinkCtl::SyncAll ( )

static

Synchronize statustics for ll links.

static void XrdLinkCtl::Unhook ( int  fd )

static

Unhook a link from the active table of links.

Member Data Documentation

short XrdLinkCtl::killWait

static

Link destruction control constants.

unsigned int XrdLinkCtl::LinkAlloc

staticprivate

char* XrdLinkCtl::LinkBat

staticprivate

Referenced by fd2link(), and fd2PollInfo().

XrdLinkCtl** XrdLinkCtl::LinkTab

staticprivate

Referenced by fd2link(), and fd2PollInfo().

int XrdLinkCtl::LTLast

staticprivate

Referenced by fd2link(), and fd2PollInfo().

XrdSysMutex XrdLinkCtl::LTMutex

staticprivate

int XrdLinkCtl::maxFD

staticprivate

const char* XrdLinkCtl::TraceID

staticprivate

short XrdLinkCtl::waitKill

static

---

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

• XrdLinkCtl.hh