TXSlave Class Reference

Definition at line 36 of file TXSlave.h.

Public Member Functions
	TXSlave (const char *url, const char *ord, Int_t perf, const char *image, TProof *proof, Int_t stype, const char *workdir, const char *msd, Int_t nwk=1)
	Create a PROOF slave object. Called via the TProof ctor. More...
virtual	~TXSlave ()
	Destroy slave. More...
void	Close (Option_t *opt="")
	Close slave socket. More...
void	DoError (int level, const char *location, const char *fmt, va_list va) const
	Interface to ErrorHandler (protected). More...
Bool_t	HandleError (const void *in=0)
	Handle error on the input socket. More...
Bool_t	HandleInput (const void *in=0)
	Handle asynchronous input on the socket. More...
void	SetInterruptHandler (Bool_t on=kTRUE)
	Set/Unset the interrupt handler. More...
Int_t	SetupServ (Int_t stype, const char *conffile)
	Init a PROOF slave object. More...
void	Touch ()
	Touch the client admin file to proof we are alive. More...
Public Member Functions inherited from TSlave
virtual	~TSlave ()
	Destroy slave. More...
Int_t	Compare (const TObject *obj) const
	Used to sort slaves by performance index. More...
Bool_t	IsSortable () const
const char *	GetName () const
	Returns name of object. More...
const char *	GetImage () const
const char *	GetProofWorkDir () const
const char *	GetWorkDir () const
const char *	GetUser () const
const char *	GetGroup () const
Int_t	GetPort () const
const char *	GetOrdinal () const
Int_t	GetPerfIdx () const
Int_t	GetProtocol () const
TSocket *	GetSocket () const
TProof *	GetProof () const
Long64_t	GetBytesRead () const
Float_t	GetRealTime () const
Float_t	GetCpuTime () const
Int_t	GetSlaveType () const
Int_t	GetStatus () const
Int_t	GetParallel () const
const char *	GetMsd () const
const char *	GetSessionTag () const
TFileHandler *	GetInputHandler () const
void	SetInputHandler (TFileHandler *ih)
	Adopt and register input handler for this slave. More...
const char *	GetArchCompiler () const
const char *	GetROOTVersion () const
virtual Bool_t	IsValid () const
virtual void	Print (Option_t *option="") const
	Printf info about slave. More...
void	SetArchCompiler (const char *ac)
void	SetROOTVersion (const char *rv)
void	SetSessionTag (const char *st)
Public Member Functions inherited from TObject
	TObject ()
	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	Clear (Option_t *="")
virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility. More...
virtual void	Copy (TObject &object) const
	Copy this to obj. 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 Option_t *	GetOption () const
virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py). More...
virtual const char *	GetTitle () const
	Returns title of object. More...
virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out. More...
virtual ULong_t	Hash () const
	Return hash value for this object. 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	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout. 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...
Public Member Functions inherited from TXHandler
	TXHandler ()
virtual	~TXHandler ()

Protected Member Functions
void	FlushSocket ()
	Clean any input on the socket. More...
void	Interrupt (Int_t type)
	Send interrupt to master or slave servers. More...
Int_t	Ping ()
	Ping the remote master or slave servers. More...
TObjString *	SendCoordinator (Int_t kind, const char *msg=0, Int_t int2=0)
	Send message to intermediate coordinator. More...
Int_t	SendGroupPriority (const char *grp, Int_t priority)
	Communicate to the coordinator the priprity of the group to which the user belongs Return 0 on success. More...
void	SetAlias (const char *alias)
	Set an alias for this session. More...
void	StopProcess (Bool_t abort, Int_t timeout)
	Sent stop/abort request to PROOF server. More...
Protected Member Functions inherited from TSlave
	TSlave ()
	Default constructor used by derived classes. More...
void	Init (TSocket *s, Int_t stype)
	Init a PROOF slave object using the connection opened via s. More...
void	SetSocket (TSocket *s)
virtual void	SetStatus (Int_t st)
Protected Member Functions inherited from TObject
void	MakeZombie ()

Private Member Functions
void	Init (const char *host, Int_t stype)
	Init a PROOF slave object. More...
void	ParseBuffer ()
	Parse fBuffer after a connection attempt. More...

Static Private Member Functions
static Int_t	GetProofdProtocol (TSocket *s)
	Find out the remote proofd protocol version. More...

Private Attributes
Bool_t	fValid
Int_t	fNWrks
TSignalHandler *	fIntHandler

Friends
class	TProof
class	TXProofMgr

Additional Inherited Members
Public Types inherited from TSlave
enum	ESlaveType { kMaster, kSlave }
enum	ESlaveStatus { kInvalid, kActive, kInactive }
enum	EStatusBits { kOutputRequested = BIT(15) }
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 TSlave
static void	SetTXSlaveHook (TSlave_t xslavehook)
	Set hook to TXSlave ctor. 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 Attributes inherited from TSlave
TString	fName
TString	fImage
TString	fProofWorkDir
TString	fWorkDir
TString	fUser
TString	fGroup
Int_t	fPort
TString	fOrdinal
Int_t	fPerfIdx
Int_t	fProtocol
TSocket *	fSocket
TProof *	fProof
TFileHandler *	fInput
Long64_t	fBytesRead
Float_t	fRealTime
Float_t	fCpuTime
ESlaveType	fSlaveType
Int_t	fStatus
Int_t	fParallel
TString	fMsd
TString	fSessionTag
TString	fROOTVers
TString	fArchComp

#include <TXSlave.h>

Inheritance diagram for TXSlave:

Collaboration diagram for TXSlave:

Constructor & Destructor Documentation

TXSlave::TXSlave	(	const char *	url,
		const char *	ord,
		Int_t	perf,
		const char *	image,
		TProof *	proof,
		Int_t	stype,
		const char *	workdir,
		const char *	msd,
		Int_t	nwk = 1
	)

Create a PROOF slave object. Called via the TProof ctor.

Definition at line 103 of file TXSlave.cxx.

TXSlave::~TXSlave ( )

virtual

Destroy slave.

Definition at line 375 of file TXSlave.cxx.

Member Function Documentation

void TXSlave::Close ( Option_t *  opt = "" )

virtual

Close slave socket.

Reimplemented from TSlave.

Definition at line 383 of file TXSlave.cxx.

Referenced by SetupServ(), and ~TXSlave().

void TXSlave::DoError ( int  level, const char *  location, const char *  fmt, va_list  va  ) const

virtual

Interface to ErrorHandler (protected).

Reimplemented from TObject.

Definition at line 69 of file TXSlave.cxx.

void TXSlave::FlushSocket ( )

protectedvirtual

Clean any input on the socket.

Reimplemented from TSlave.

Definition at line 701 of file TXSlave.cxx.

Referenced by HandleInput().

Int_t TXSlave::GetProofdProtocol ( TSocket *  s )

staticprivate

Find out the remote proofd protocol version.

Returns -1 in case of error.

Definition at line 472 of file TXSlave.cxx.

Bool_t TXSlave::HandleError ( const void *  in = 0 )

virtual

Handle error on the input socket.

Reimplemented from TXHandler.

Definition at line 566 of file TXSlave.cxx.

Bool_t TXSlave::HandleInput ( const void *  in = 0 )

virtual

Handle asynchronous input on the socket.

Reimplemented from TXHandler.

Definition at line 639 of file TXSlave.cxx.

void TXSlave::Init ( const char *  host, Int_t  stype  )

private

Init a PROOF slave object.

Called via the TXSlave ctor. The Init method is technology specific and is overwritten by derived classes.

Definition at line 133 of file TXSlave.cxx.

Referenced by TXSlave().

void TXSlave::Interrupt ( Int_t  type )

protectedvirtual

Send interrupt to master or slave servers.

Returns 0 if ok, -1 in case of error

Reimplemented from TSlave.

Definition at line 419 of file TXSlave.cxx.

void TXSlave::ParseBuffer ( )

private

Parse fBuffer after a connection attempt.

Definition at line 303 of file TXSlave.cxx.

Referenced by Init().

Int_t TXSlave::Ping ( )

protectedvirtual

Ping the remote master or slave servers.

Returns 0 if ok, -1 if it did not ping or in case of error

Reimplemented from TSlave.

Definition at line 397 of file TXSlave.cxx.

TObjString * TXSlave::SendCoordinator ( Int_t  kind, const char *  msg = 0, Int_t  int2 = 0  )

protectedvirtual

Send message to intermediate coordinator.

If any output is due, this is returned as a generic message

Reimplemented from TSlave.

Definition at line 528 of file TXSlave.cxx.

Int_t TXSlave::SendGroupPriority ( const char *  grp, Int_t  priority  )

protectedvirtual

Communicate to the coordinator the priprity of the group to which the user belongs Return 0 on success.

Reimplemented from TSlave.

Definition at line 553 of file TXSlave.cxx.

void TXSlave::SetAlias ( const char *  alias )

protectedvirtual

Set an alias for this session.

If reconnection is supported, the alias will be communicated to the remote coordinator so that it can be recovered when reconnecting

Reimplemented from TSlave.

Definition at line 538 of file TXSlave.cxx.

void TXSlave::SetInterruptHandler ( Bool_t  on = kTRUE )

virtual

Set/Unset the interrupt handler.

Reimplemented from TSlave.

Definition at line 683 of file TXSlave.cxx.

Referenced by HandleError().

Int_t TXSlave::SetupServ ( Int_t  stype, const char *  conffile  )

virtual

Init a PROOF slave object.

Called via the TXSlave ctor. The Init method is technology specific and is overwritten by derived classes.

Reimplemented from TSlave.

Definition at line 334 of file TXSlave.cxx.

void TXSlave::StopProcess ( Bool_t  abort, Int_t  timeout  )

protectedvirtual

Sent stop/abort request to PROOF server.

It will be processed asynchronously by a separate thread.

Reimplemented from TSlave.

Definition at line 459 of file TXSlave.cxx.

void TXSlave::Touch ( )

virtual

Touch the client admin file to proof we are alive.

Reimplemented from TSlave.

Definition at line 407 of file TXSlave.cxx.

Friends And Related Function Documentation

friend class TProof

friend

Definition at line 38 of file TXSlave.h.

friend class TXProofMgr

friend

Definition at line 39 of file TXSlave.h.

Member Data Documentation

TSignalHandler* TXSlave::fIntHandler

private

Definition at line 44 of file TXSlave.h.

Referenced by SetInterruptHandler(), and TXSlave().

Int_t TXSlave::fNWrks

private

Definition at line 43 of file TXSlave.h.

Referenced by Init(), and TXSlave().

Bool_t TXSlave::fValid

private

Definition at line 42 of file TXSlave.h.

Referenced by Init(), SetupServ(), and TXSlave().

---

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

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