TXUnixSocket Class Reference

Definition at line 31 of file TXUnixSocket.h.

Public Member Functions
	TXUnixSocket (const char *u, Int_t psid=-1, Char_t ver=-1, TXHandler *handler=0, int fd=-1)
	Constructor. More...
virtual	~TXUnixSocket ()
Int_t	GetClientID () const
Int_t	GetClientIDSize () const
void	RemoveClientID ()
void	SetClientID (Int_t cid)
Int_t	Reconnect ()
	Try reconnection after failure. More...
Public Member Functions inherited from TXSocket
	TXSocket (const char *url, Char_t mode='M', Int_t psid=-1, Char_t ver=-1, const char *logbuf=0, Int_t loglevel=-1, TXHandler *handler=0)
	Constructor Open the connection to a remote XrdProofd instance and start a PROOF session. More...
virtual	~TXSocket ()
	Destructor. More...
virtual void	Close (Option_t *opt="")
	Close connection. More...
Bool_t	Create (Bool_t attach=kFALSE)
	This method sends a request for creation of (or attachment to) a remote server application. More...
void	DisconnectSession (Int_t id, Option_t *opt="")
	Disconnect a session. More...
void	DoError (int level, const char *location, const char *fmt, va_list va) const
	Interface to ErrorHandler (protected). More...
virtual UnsolRespProcResult	ProcessUnsolicitedMsg (XrdClientUnsolMsgSender *s, XrdClientMessage *msg)
	We are here if an unsolicited response comes from a logical conn The response comes in the form of an XrdClientMessage *, that must NOT be destroyed after processing. More...
Int_t	GetLogConnID () const
	Getter for logical connection ID. More...
Int_t	GetOpenError () const
	Getter for last error. More...
Int_t	GetServType () const
	Getter for server type. More...
Int_t	GetSessionID () const
	Getter for session ID. More...
Int_t	GetXrdProofdVersion () const
Bool_t	IsValid () const
	Getter for validity status. More...
Bool_t	IsServProofd ()
	Return kTRUE if the remote server is a 'proofd'. More...
void	SetSendOpt (ESendRecvOptions o)
void	SetSessionID (Int_t id)
	Set session ID to 'id'. If id < 0, disable also the asynchronous handler. More...
Int_t	Send (const TMessage &mess)
	Send a TMessage object. More...
Int_t	Send (Int_t kind)
	Send a single message opcode. More...
Int_t	Send (Int_t status, Int_t kind)
	Send a status and a single message opcode. More...
Int_t	Send (const char *mess, Int_t kind=kMESS_STRING)
	Send a character string buffer. More...
Int_t	SendRaw (const void *buf, Int_t len, ESendRecvOptions opt=kDontBlock)
	Send a raw buffer of specified length. More...
TObjString *	SendCoordinator (Int_t kind, const char *msg=0, Int_t int2=0, Long64_t l64=0, Int_t int3=0, const char *opt=0)
	Send message to intermediate coordinator. More...
Int_t	Recv (TMessage *&mess)
	Receive a TMessage object. More...
Int_t	Recv (Int_t &status, Int_t &kind)
	Receives a status and a message type. More...
Int_t	Recv (char *mess, Int_t max)
	Receive a character string message of maximum max length. More...
Int_t	Recv (char *mess, Int_t max, Int_t &kind)
	Receive a character string message of maximum max length. More...
Int_t	RecvRaw (void *buf, Int_t len, ESendRecvOptions opt=kDefault)
	Receive a raw buffer of specified length bytes. More...
Int_t	SendInterrupt (Int_t type)
	Send urgent message (interrupt) to remote server Returns 0 or -1 in case of error. More...
Int_t	GetInterrupt (Bool_t &forward)
	Get latest interrupt level and reset it; if the interrupt has to be propagated to lower stages forward will be kTRUE after the call. More...
void	SendUrgent (Int_t type, Int_t int1, Int_t int2)
	Send urgent message to counterpart; 'type' specifies the type of the message (see TXSocket::EUrgentMsgType), and 'int1', 'int2' two containers for additional information. More...
void	SetInterrupt (Bool_t i=kTRUE)
Bool_t	IsInterrupt ()
void	SetAWait (Bool_t w=kTRUE)
Bool_t	IsAWait ()
Int_t	Flush ()
	Flush the asynchronous queue. More...
Bool_t	Ping (const char *ord=0)
	Ping functionality: contact the server to check its vitality. More...
void	RemoteTouch ()
	Remote touch functionality: contact the server to proof our vitality. More...
void	CtrlC ()
	Interrupt the remote protocol instance. More...
Int_t	SetOption (ESockOptions, Int_t)
	Set socket options. More...
void	DisableTimeout ()
void	EnableTimeout ()
Public Member Functions inherited from TSocket
	TSocket (TInetAddress address, const char *service, Int_t tcpwindowsize=-1)
	Create a socket. More...
	TSocket (TInetAddress address, Int_t port, Int_t tcpwindowsize=-1)
	Create a socket. More...
	TSocket (const char *host, const char *service, Int_t tcpwindowsize=-1)
	Create a socket. More...
	TSocket (const char *host, Int_t port, Int_t tcpwindowsize=-1)
	Create a socket; see CreateAuthSocket for the form of url. More...
	TSocket (const char *sockpath)
	Create a socket in the Unix domain on 'sockpath'. More...
	TSocket (Int_t descriptor)
	Create a socket. More...
	TSocket (Int_t descriptor, const char *sockpath)
	Create a socket. More...
	TSocket (const TSocket &s)
	TSocket copy ctor. More...
virtual	~TSocket ()
virtual Int_t	GetDescriptor () const
TInetAddress	GetInetAddress () const
virtual TInetAddress	GetLocalInetAddress ()
	Return internet address of local host to which the socket is bound. More...
Int_t	GetPort () const
const char *	GetService () const
Int_t	GetServType () const
virtual Int_t	GetLocalPort ()
	Return the local port # to which the socket is bound. More...
UInt_t	GetBytesSent () const
UInt_t	GetBytesRecv () const
Int_t	GetCompressionAlgorithm () const
Int_t	GetCompressionLevel () const
Int_t	GetCompressionSettings () const
Int_t	GetErrorCode () const
	Returns error code. More...
virtual Int_t	GetOption (ESockOptions opt, Int_t &val)
	Get socket options. Returns -1 in case of error. More...
Int_t	GetRemoteProtocol () const
TSecContext *	GetSecContext () const
Int_t	GetTcpWindowSize () const
TTimeStamp	GetLastUsage ()
const char *	GetUrl () const
virtual Bool_t	IsAuthenticated () const
virtual Int_t	Select (Int_t interest=kRead, Long_t timeout=-1)
	Waits for this socket to change status. More...
virtual Int_t	SendObject (const TObject *obj, Int_t kind=kMESS_OBJECT)
	Send an object. More...
void	SetCompressionAlgorithm (Int_t algorithm=0)
	See comments for function SetCompressionSettings. More...
void	SetCompressionLevel (Int_t level=1)
	See comments for function SetCompressionSettings. More...
void	SetCompressionSettings (Int_t settings=1)
	Used to specify the compression level and algorithm: settings = 100 * algorithm + level. More...
void	SetRemoteProtocol (Int_t rproto)
void	SetSecContext (TSecContext *ctx)
void	SetService (const char *service)
void	SetServType (Int_t st)
void	SetUrl (const char *url)
void	Touch ()
Public Member Functions inherited from TNamed
	TNamed ()
	TNamed (const char *name, const char *title)
	TNamed (const TString &name, const TString &title)
	TNamed (const TNamed &named)
	TNamed copy ctor. More...
TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator. More...
virtual	~TNamed ()
virtual void	Clear (Option_t *option="")
	Set name and title to empty strings (""). More...
virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility. More...
virtual Int_t	Compare (const TObject *obj) const
	Compare two TNamed objects. More...
virtual void	Copy (TObject &named) const
	Copy this to obj. More...
virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer. More...
virtual const char *	GetName () const
	Returns name of object. More...
virtual const char *	GetTitle () const
	Returns title of object. More...
virtual ULong_t	Hash () const
	Return hash value for this object. More...
virtual Bool_t	IsSortable () const
virtual void	SetName (const char *name)
	Change (i.e. More...
virtual void	SetNameTitle (const char *name, const char *title)
	Change (i.e. set) all the TNamed parameters (name and title). More...
virtual void	SetTitle (const char *title="")
	Change (i.e. set) the title of the TNamed. More...
virtual void	ls (Option_t *option="") const
	List TNamed name and title. More...
virtual void	Print (Option_t *option="") const
	Print TNamed name and title. More...
virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject. More...
Public Member Functions inherited from TObject
	TObject ()
	TObject constructor. More...
	TObject (const TObject &object)
	TObject copy ctor. More...
TObject &	operator= (const TObject &rhs)
	TObject assignment operator. More...
virtual	~TObject ()
	TObject destructor. More...
virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad. More...
virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action. More...
virtual const char *	ClassName () const
	Returns name of class to which the object belongs. More...
virtual void	Delete (Option_t *option="")
	Delete this object. More...
virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object. More...
virtual void	Draw (Option_t *option="")
	Default Draw method for all objects. More...
virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs. More...
virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current pad. More...
virtual void	Dump () const
	Dump contents of object on stdout. More...
virtual void	Execute (const char *method, const char *params, Int_t *error=0)
	Execute method on this object with the given parameter string, e.g. More...
virtual void	Execute (TMethod *method, TObjArray *params, Int_t *error=0)
	Execute method on this object with parameters stored in the TObjArray. More...
virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py). More...
virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes. More...
virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes. More...
virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object. More...
virtual UInt_t	GetUniqueID () const
	Return the unique object id. More...
virtual const char *	GetIconName () const
	Returns mime type name of object. More...
virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py). More...
virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out. More...
virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname". More...
virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl. More...
virtual void	Inspect () const
	Dump contents of this object in a graphics canvas. More...
virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory). More...
Bool_t	IsOnHeap () const
Bool_t	IsZombie () const
virtual Bool_t	Notify ()
	This method must be overridden to handle object notification. More...
virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself. More...
virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list. More...
virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory. More...
virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list. More...
virtual void	SaveAs (const char *filename="", Option_t *option="") const
	Save this object in the file specified by filename. More...
virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out". More...
virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object. More...
virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id. More...
virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory. More...
virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory. More...
void *	operator new (size_t sz)
void *	operator new[] (size_t sz)
void *	operator new (size_t sz, void *vp)
void *	operator new[] (size_t sz, void *vp)
void	operator delete (void *ptr)
	Operator delete. More...
void	operator delete[] (void *ptr)
	Operator delete []. More...
void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f. More...
void	SetBit (UInt_t f)
void	ResetBit (UInt_t f)
Bool_t	TestBit (UInt_t f) const
Int_t	TestBits (UInt_t f) const
void	InvertBit (UInt_t f)
virtual void	Info (const char *method, const char *msgfmt,...) const
	Issue info message. More...
virtual void	Warning (const char *method, const char *msgfmt,...) const
	Issue warning message. More...
virtual void	Error (const char *method, const char *msgfmt,...) const
	Issue error message. More...
virtual void	SysError (const char *method, const char *msgfmt,...) const
	Issue system error message. More...
virtual void	Fatal (const char *method, const char *msgfmt,...) const
	Issue fatal error message. More...
void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
void	Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete. More...

Private Attributes
std::list< Int_t >	fClientIDs

Friends
class	TXProofServ

Additional Inherited Members
Public Types inherited from TXSocket
enum	EUrgentMsgType { kStopProcess = 2000 }
Public Types inherited from TSocket
enum	EStatusBits { kIsUnix = BIT(16), kBrokenConn = BIT(17) }
enum	EInterest { kRead = 1, kWrite = 2 }
enum	EServiceType { kSOCKD, kROOTD, kPROOFD }
Public Types inherited from TObject
enum	EStatusBits {   kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),   kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13) }
enum	{ kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
enum	{ kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
Static Public Member Functions inherited from TSocket
static Int_t	GetClientProtocol ()
	Static method returning supported client protocol. More...
static ULong64_t	GetSocketBytesSent ()
	Get total number of bytes sent via all sockets. More...
static ULong64_t	GetSocketBytesRecv ()
	Get total number of bytes received via all sockets. More...
static TSocket *	CreateAuthSocket (const char *user, const char *host, Int_t port, Int_t size=0, Int_t tcpwindowsize=-1, TSocket *s=0, Int_t *err=0)
	Creates a socket or a parallel socket and authenticates to the remote server specified in 'url' on remote 'port' as 'user'. More...
static TSocket *	CreateAuthSocket (const char *url, Int_t size=0, Int_t tcpwindowsize=-1, TSocket *s=0, Int_t *err=0)
	Creates a socket or a parallel socket and authenticates to the remote server. More...
static void	NetError (const char *where, Int_t error)
	Print error string depending on error code. More...
Static Public Member Functions inherited from TObject
static Long_t	GetDtorOnly ()
	Return destructor only flag. More...
static void	SetDtorOnly (void *obj)
	Set destructor only flag. More...
static Bool_t	GetObjectStat ()
	Get status of object stat flag. More...
static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable. More...
Protected Member Functions inherited from TSocket
	TSocket ()
Bool_t	Authenticate (const char *user)
	Authenticated the socket with specified user. More...
void	SetDescriptor (Int_t desc)
void	SendStreamerInfos (const TMessage &mess)
	Check if TStreamerInfo must be sent. More...
Bool_t	RecvStreamerInfos (TMessage *mess)
	Receive a message containing streamer infos. More...
void	SendProcessIDs (const TMessage &mess)
	Check if TProcessIDs must be sent. More...
Bool_t	RecvProcessIDs (TMessage *mess)
	Receive a message containing process ids. More...
Protected Member Functions inherited from TObject
void	MakeZombie ()
Protected Attributes inherited from TSocket
TInetAddress	fAddress
UInt_t	fBytesRecv
UInt_t	fBytesSent
Int_t	fCompress
TInetAddress	fLocalAddress
Int_t	fRemoteProtocol
TSecContext *	fSecContext
TString	fService
EServiceType	fServType
Int_t	fSocket
Int_t	fTcpWindowSize
TString	fUrl
TBits	fBitsInfo
TList *	fUUIDs
TVirtualMutex *	fLastUsageMtx
TTimeStamp	fLastUsage
Protected Attributes inherited from TNamed
TString	fName
TString	fTitle
Static Protected Attributes inherited from TSocket
static ULong64_t	fgBytesRecv = 0
static ULong64_t	fgBytesSent = 0
static Int_t	fgClientProtocol = 17

#include <TXUnixSocket.h>

Inheritance diagram for TXUnixSocket:

Collaboration diagram for TXUnixSocket:

Constructor & Destructor Documentation

TXUnixSocket()

TXUnixSocket::TXUnixSocket	(	const char *	u,
		Int_t	psid = -1,
		Char_t	ver = -1,
		TXHandler *	handler = 0,
		int	fd = -1
	)

Constructor.

Definition at line 32 of file TXUnixSocket.cxx.

~TXUnixSocket()

virtual TXUnixSocket::~TXUnixSocket ( )

inlinevirtual

Definition at line 41 of file TXUnixSocket.h.

Member Function Documentation

GetClientID()

Int_t TXUnixSocket::GetClientID ( ) const

inlinevirtual

Reimplemented from TXSocket.

Definition at line 43 of file TXUnixSocket.h.

GetClientIDSize()

Int_t TXUnixSocket::GetClientIDSize ( ) const

inlinevirtual

Reimplemented from TXSocket.

Definition at line 44 of file TXUnixSocket.h.

Reconnect()

Int_t TXUnixSocket::Reconnect ( )

virtual

Try reconnection after failure.

Reimplemented from TXSocket.

Definition at line 65 of file TXUnixSocket.cxx.

Referenced by TXSocket::EnableTimeout(), and SetClientID().

RemoveClientID()

void TXUnixSocket::RemoveClientID ( )

inlinevirtual

Reimplemented from TXSocket.

Definition at line 46 of file TXUnixSocket.h.

SetClientID()

void TXUnixSocket::SetClientID ( Int_t  cid )

inlinevirtual

Reimplemented from TXSocket.

Definition at line 47 of file TXUnixSocket.h.

Friends And Related Function Documentation

TXProofServ

friend class TXProofServ

friend

Definition at line 33 of file TXUnixSocket.h.

Member Data Documentation

fClientIDs

std::list<Int_t> TXUnixSocket::fClientIDs

private

Definition at line 36 of file TXUnixSocket.h.

---

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

• proof/proofx/inc/TXUnixSocket.h
• proof/proofx/src/TXUnixSocket.cxx