This is the version of TSlave for workers servers based on XProofD.

See TSlave and TXSocket for details.

Definition at line 32 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.

	~TXSlave () override
	Destroy slave.

void	Close (Option_t *opt="") override
	Close slave socket.

void	DoError (int level, const char location, const char fmt, va_list va) const override
	Interface to ErrorHandler (protected).

Bool_t	HandleError (const void *in=0) override
	Handle error on the input socket.

Bool_t	HandleInput (const void *in=0) override
	Handle asynchronous input on the socket.

TClass *	IsA () const override

void	SetInterruptHandler (Bool_t on=kTRUE) override
	Set/Unset the interrupt handler.

Int_t	SetupServ (Int_t stype, const char *conffile) override
	Init a PROOF slave object.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

void	Touch () override
	Touch the client admin file to proof we are alive.

Public Member Functions inherited from TSlave
	~TSlave () override
	Destroy slave.

Int_t	Compare (const TObject *obj) const override
	Used to sort slaves by performance index.

const char *	GetArchCompiler () const

Long64_t	GetBytesRead () const

Float_t	GetCpuTime () const

const char *	GetGroup () const

const char *	GetImage () const

TFileHandler *	GetInputHandler () const

const char *	GetMsd () const

const char *	GetName () const override
	Returns name of object.

const char *	GetOrdinal () const

Int_t	GetParallel () const

Int_t	GetPerfIdx () const

Int_t	GetPort () const

TProof *	GetProof () const

const char *	GetProofWorkDir () const

Int_t	GetProtocol () const

Float_t	GetRealTime () const

const char *	GetROOTVersion () const

const char *	GetSessionTag () const

Int_t	GetSlaveType () const

TSocket *	GetSocket () const

Int_t	GetStatus () const

const char *	GetUser () const

const char *	GetWorkDir () const

Bool_t	IsSortable () const override

virtual Bool_t	IsValid () const

void	Print (Option_t *option="") const override
	Printf info about slave.

void	SetArchCompiler (const char *ac)

void	SetInputHandler (TFileHandler *ih)
	Adopt and register input handler for this slave.

void	SetROOTVersion (const char *rv)

void	SetSessionTag (const char *st)

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual void	Copy (TObject &object) const
	Copy this to obj.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const
	Returns title of object.

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

virtual ULong_t	Hash () const
	Return hash value for this object.

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout.

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).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification (the base implementation is no-op).

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete (void ptr, void vp)
	Only called by placement new when throwing an exception.

void	operator delete[] (void *ptr)
	Operator delete [].

void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Public Member Functions inherited from TXHandler
	TXHandler ()

virtual	~TXHandler ()

TClass *	IsA () const override

void	Streamer (TBuffer &) override

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TSlave
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static void	SetTXSlaveHook (TSlave_t xslavehook)
	Set hook to TXSlave ctor.

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Static Public Member Functions inherited from TXHandler
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Protected Member Functions
void	FlushSocket () override
	Clean any input on the socket.

void	Interrupt (Int_t type) override
	Send interrupt to master or slave servers.

Int_t	Ping () override
	Ping the remote master or slave servers.

TObjString *	SendCoordinator (Int_t kind, const char *msg=0, Int_t int2=0) override
	Send message to intermediate coordinator.

Int_t	SendGroupPriority (const char *grp, Int_t priority) override
	Communicate to the coordinator the priprity of the group to which the user belongs Return 0 on success.

void	SetAlias (const char *alias) override
	Set an alias for this session.

void	StopProcess (Bool_t abort, Int_t timeout) override
	Sent stop/abort request to PROOF server.

Protected Member Functions inherited from TSlave
	TSlave ()
	Default constructor used by derived classes.

void	Init (TSocket *s, Int_t stype)
	Init a PROOF slave object using the connection opened via s.

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.

void	ParseBuffer ()
	Parse fBuffer after a connection attempt.

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

Private Attributes
TSignalHandler *	fIntHandler

Int_t	fNWrks

Bool_t	fValid

Friends
class	TProof

class	TXProofMgr

Additional Inherited Members
Public Types inherited from TSlave
enum	ESlaveStatus { kInvalid , kActive , kInactive }

enum	ESlaveType { kMaster , kSlave }

enum	EStatusBits { kOutputRequested = (1ULL << ( 15 )) }

Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

enum	EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) }

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

Protected Attributes inherited from TSlave
TString	fArchComp

Long64_t	fBytesRead

Float_t	fCpuTime

TString	fGroup

TString	fImage

TFileHandler *	fInput

TString	fMsd

TString	fName

TString	fOrdinal

Int_t	fParallel

Int_t	fPerfIdx

Int_t	fPort

TProof *	fProof

TString	fProofWorkDir

Int_t	fProtocol

Float_t	fRealTime

TString	fROOTVers

TString	fSessionTag

ESlaveType	fSlaveType

TSocket *	fSocket

Int_t	fStatus

TString	fUser

TString	fWorkDir

#include <TXSlave.h>

Inheritance diagram for TXSlave:

[legend]

Constructor & Destructor Documentation

◆ TXSlave()

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 102 of file TXSlave.cxx.

◆ ~TXSlave()

TXSlave::~TXSlave ( )

override

Destroy slave.

Definition at line 374 of file TXSlave.cxx.

Member Function Documentation

◆ Class()

static TClass * TXSlave::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TXSlave::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TXSlave::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 76 of file TXSlave.h.

◆ Close()

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

overridevirtual

Close slave socket.

Reimplemented from TSlave.

Definition at line 382 of file TXSlave.cxx.

◆ DeclFileName()

static const char * TXSlave::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 76 of file TXSlave.h.

◆ DoError()

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

overridevirtual

Interface to ErrorHandler (protected).

Reimplemented from TObject.

Definition at line 68 of file TXSlave.cxx.

◆ FlushSocket()

void TXSlave::FlushSocket ( )

overrideprotectedvirtual

Clean any input on the socket.

Reimplemented from TSlave.

Definition at line 698 of file TXSlave.cxx.

◆ GetProofdProtocol()

Int_t TXSlave::GetProofdProtocol ( TSocket * s )

staticprivate

Find out the remote proofd protocol version.

Returns -1 in case of error.

Definition at line 469 of file TXSlave.cxx.

◆ HandleError()

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

overridevirtual

Handle error on the input socket.

Reimplemented from TXHandler.

Definition at line 563 of file TXSlave.cxx.

◆ HandleInput()

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

overridevirtual

Handle asynchronous input on the socket.

Reimplemented from TXHandler.

Definition at line 636 of file TXSlave.cxx.

◆ Init()

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 132 of file TXSlave.cxx.

◆ Interrupt()

void TXSlave::Interrupt ( Int_t type )

overrideprotectedvirtual

Send interrupt to master or slave servers.

Returns 0 if ok, -1 in case of error

Reimplemented from TSlave.

Definition at line 418 of file TXSlave.cxx.

◆ IsA()

TClass * TXSlave::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TSlave.

Definition at line 76 of file TXSlave.h.

◆ ParseBuffer()

void TXSlave::ParseBuffer ( )

private

Parse fBuffer after a connection attempt.

Definition at line 302 of file TXSlave.cxx.

◆ Ping()

Int_t TXSlave::Ping ( )

overrideprotectedvirtual

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 396 of file TXSlave.cxx.

◆ SendCoordinator()

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

overrideprotectedvirtual

Send message to intermediate coordinator.

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

Reimplemented from TSlave.

Definition at line 525 of file TXSlave.cxx.

◆ SendGroupPriority()

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

overrideprotectedvirtual

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

Reimplemented from TSlave.

Definition at line 550 of file TXSlave.cxx.

◆ SetAlias()

void TXSlave::SetAlias ( const char * alias )

overrideprotectedvirtual

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 535 of file TXSlave.cxx.

◆ SetInterruptHandler()

void TXSlave::SetInterruptHandler ( Bool_t on = kTRUE )

overridevirtual

Set/Unset the interrupt handler.

Reimplemented from TSlave.

Definition at line 680 of file TXSlave.cxx.

◆ SetupServ()

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

overridevirtual

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 333 of file TXSlave.cxx.

◆ StopProcess()

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

overrideprotectedvirtual

Sent stop/abort request to PROOF server.

It will be processed asynchronously by a separate thread.

Reimplemented from TSlave.

Definition at line 456 of file TXSlave.cxx.

◆ Streamer()

void TXSlave::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TSlave.

◆ StreamerNVirtual()

void TXSlave::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 76 of file TXSlave.h.

◆ Touch()

void TXSlave::Touch ( )

overridevirtual

Touch the client admin file to proof we are alive.

Reimplemented from TSlave.

Definition at line 406 of file TXSlave.cxx.

Friends And Related Symbol Documentation

◆ TProof

friend class TProof

friend

Definition at line 34 of file TXSlave.h.

◆ TXProofMgr

friend class TXProofMgr

friend

Definition at line 35 of file TXSlave.h.

Member Data Documentation

◆ fIntHandler

TSignalHandler* TXSlave::fIntHandler

private

Definition at line 40 of file TXSlave.h.

◆ fNWrks

Int_t TXSlave::fNWrks

private

Definition at line 39 of file TXSlave.h.

◆ fValid

Bool_t TXSlave::fValid

private

Definition at line 38 of file TXSlave.h.

proof/proofx/inc/TXSlave.h

proof/proofx/src/TXSlave.cxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ TXSlave()

◆ ~TXSlave()

Member Function Documentation

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ Close()

◆ DeclFileName()

◆ DoError()

◆ FlushSocket()

◆ GetProofdProtocol()

◆ HandleError()

◆ HandleInput()

◆ Init()

◆ Interrupt()

◆ IsA()

◆ ParseBuffer()

◆ Ping()

◆ SendCoordinator()

◆ SendGroupPriority()

◆ SetAlias()

◆ SetInterruptHandler()

◆ SetupServ()

◆ StopProcess()

◆ Streamer()

◆ StreamerNVirtual()

◆ Touch()

Friends And Related Symbol Documentation

◆ TProof

◆ TXProofMgr

Member Data Documentation

◆ fIntHandler

◆ fNWrks

◆ fValid