Internal class steering processing in PROOF.

Instances of the TProofPlayer class are created on the worker nodes per session and do the processing. Instances of its subclass - TProofPlayerRemote are created per each query on the master(s) and on the client. On the master(s), TProofPlayerRemote coordinate processing, check the dataset, create the packetizer and take care of merging the results of the workers. The instance on the client collects information on the input (dataset and selector), it invokes the Begin() method and finalizes the query by calling Terminate().

Definition at line 60 of file TProofPlayer.h.

Classes
class	TCleanup

Public Types
enum	EStatusBits { kDispatchOneEvent = BIT(15), kIsProcessing = BIT(16), kMaxProcTimeReached = BIT(17), kMaxProcTimeExtended = BIT(18) }

Public Types inherited from TVirtualProofPlayer
enum	EExitStatus { kFinished, kStopped, kAborted }

enum	EStatusBits { kIsSubmerger = BIT(14) }

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

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

enum	EDeprecatedStatusBits { kObjInCanvas = BIT(3) }

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

Public Member Functions
	TProofPlayer (TProof *proof=0)
	Default ctor. More...

virtual	~TProofPlayer ()
	Destructor. More...

void	AddEventsProcessed (Long64_t ev)

void	AddInput (TObject *inp)
	Add object to input list. More...

void	AddOutput (TList *out)
	Incorporate output list (may not be used in this class). More...

Int_t	AddOutputObject (TObject *obj)
	Incorporate output object (may not be used in this class). More...

void	AddQueryResult (TQueryResult *q)
	Add query result to the list, making sure that there are no duplicates. More...

void	ClearInput ()
	Clear input list. More...

TDrawFeedback *	CreateDrawFeedback (TProof *p)
	Draw feedback creation proxy. More...

void	DeleteDrawFeedback (TDrawFeedback *f)
	Delete draw feedback object. More...

Long64_t	DrawSelect (TDSet set, const char varexp, const char selection, Option_t option="", Long64_t nentries=-1, Long64_t firstentry=0)
	Draw (may not be used in this class). More...

void	Feedback (TList *objs)
	Set feedback list (may not be used in this class). More...

void	FeedBackCanvas (const char *name, Bool_t create)
	Create/destroy a named canvas for feedback. More...

Long64_t	Finalize (Bool_t force=kFALSE, Bool_t sync=kFALSE)
	Finalize query (may not be used in this class). More...

Long64_t	Finalize (TQueryResult *qr)
	Finalize query (may not be used in this class). More...

Long64_t	GetCacheSize ()
	Return the size in bytes of the cache. More...

TQueryResult *	GetCurrentQuery () const

Int_t	GetDrawArgs (const char var, const char sel, Option_t *opt, TString &selector, TString &objname)
	Parse the arguments from var, sel and opt and fill the selector and object name accordingly. More...

Long64_t	GetEventsProcessed () const

EExitStatus	GetExitStatus () const

TList *	GetInputList () const

Int_t	GetLearnEntries ()
	Return the number of entries in the learning phase. More...

TList *	GetListOfResults () const

TDSetElement *	GetNextPacket (TSlave slave, TMessage r)
	Get next packet (may not be used in this class). More...

TObject *	GetOutput (const char *name) const
	Get output object by name. More...

TList *	GetOutputList () const
	Get output list. More...

TVirtualPacketizer *	GetPacketizer () const

TProofProgressStatus *	GetProgressStatus () const

TQueryResult *	GetQueryResult (const char *ref)
	Get query result instances referenced 'ref' from the list of results. More...

void	HandleGetTreeHeader (TMessage *mess)
	Handle tree header request. More...

void	HandleRecvHisto (TMessage *mess)
	Receive histo from slave. More...

Bool_t	IsClient () const

virtual Bool_t	JoinProcess (TList *workers)
	Not implemented: meaningful only in the remote player. Returns kFALSE. More...

Long64_t	Process (TDSet set, const char selector, Option_t *option="", Long64_t nentries=-1, Long64_t firstentry=0)
	Process specified TDSet on PROOF worker. More...

Long64_t	Process (TDSet set, TSelector selector, Option_t *option="", Long64_t nentries=-1, Long64_t firstentry=0)
	Process specified TDSet on PROOF worker with TSelector object The return value is -1 in case of error and TSelector::GetStatus() in case of success. More...

void	Progress (Long64_t total, Long64_t processed)
	Report progress (may not be used in this class). More...

void	Progress (TSlave *, Long64_t total, Long64_t processed)

void	Progress (Long64_t total, Long64_t processed, Long64_t bytesread, Float_t initTime, Float_t procTime, Float_t evtrti, Float_t mbrti)
	Report progress (may not be used in this class). More...

void	Progress (TSlave *, Long64_t total, Long64_t processed, Long64_t bytesread, Float_t initTime, Float_t procTime, Float_t evtrti, Float_t mbrti)

void	Progress (TProofProgressInfo *pi)
	Report progress (may not be used in this class). More...

void	Progress (TSlave , TProofProgressInfo pi)

Int_t	ReinitSelector (TQueryResult *qr)
	Reinitialize fSelector using the selector files in the query result. More...

void	RemoveQueryResult (const char *ref)
	Remove all query result instances referenced 'ref' from the list of results. More...

void	RestorePreviousQuery ()

Int_t	SavePartialResults (Bool_t queryend=kFALSE, Bool_t force=kFALSE)
	Save the partial results of this query to a dedicated file under the user data directory. More...

void	SetCurrentQuery (TQueryResult *q)
	Set current query and save previous value. More...

void	SetDispatchTimer (Bool_t on=kTRUE)
	Enable/disable the timer to dispatch pening events while processing. More...

void	SetDrawFeedbackOption (TDrawFeedback f, Option_t opt)
	Set draw feedback option. More...

void	SetExitStatus (EExitStatus st)

virtual void	SetInitTime ()

void	SetMaxDrawQueries (Int_t max)

virtual void	SetMerging (Bool_t=kTRUE)

void	SetOutputFilePath (const char *fp)

void	SetProcessing (Bool_t on=kTRUE)
	Set processing bit according to 'on'. More...

void	SetStopTimer (Bool_t on=kTRUE, Bool_t abort=kFALSE, Int_t timeout=0)
	Enable/disable the timer to stop/abort processing. More...

virtual void	StopFeedback ()
	Stop feedback (may not be used in this class). More...

void	StopProcess (Bool_t abort, Int_t timeout=-1)
	Stop the process after this event. More...

void	StoreFeedback (TObject slave, TList out)
	Store feedback list (may not be used in this class). More...

void	StoreOutput (TList *out)
	Store output list (may not be used in this class). More...

void	UpdateAutoBin (const char *name, Double_t &xmin, Double_t &xmax, Double_t &ymin, Double_t &ymax, Double_t &zmin, Double_t &zmax)
	Update automatic binning parameters for given object "name". More...

void	UpdateProgressInfo ()
	Update fProgressStatus. More...

Public Member Functions inherited from TVirtualProofPlayer
	TVirtualProofPlayer ()

virtual	~TVirtualProofPlayer ()

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

	TObject (const TObject &object)
	TObject copy ctor. More...

virtual	~TObject ()
	TObject destructor. 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...

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

ULong_t	CheckedHash ()
	Checked and record whether for this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. 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 Int_t	Compare (const TObject *obj) const
	Compare abstract method. 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 selected pad for instance with: `gROOT->SetSelectedPad(gPad)`. More...

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

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message. 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 void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message. 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 const char *	GetIconName () const
	Returns mime type name of object. More...

virtual const char *	GetName () const
	Returns 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 Option_t *	GetOption () const

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

virtual UInt_t	GetUniqueID () const
	Return the unique object id. 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...

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

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message. 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...

void	InvertBit (UInt_t f)

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

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

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

virtual Bool_t	IsSortable () 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. 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...

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification. More...

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

void	operator delete (void *ptr)
	Operator delete. More...

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

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. 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 void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself. 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...

void	ResetBit (UInt_t f)

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

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)

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	SysError (const char method, const char msgfmt,...) const
	Issue system error message. More...

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

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message. 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...

Public Member Functions inherited from TQObject
	TQObject ()
	TQObject Constructor. More...

virtual	~TQObject ()
	TQObject Destructor. More...

Bool_t	AreSignalsBlocked () const

Bool_t	BlockSignals (Bool_t b)

virtual void	ChangedBy (const char *method)

void	CollectClassSignalLists (TList &list, TClass *cls)
	Collect class signal lists from class cls and all its base-classes. More...

Bool_t	Connect (const char signal, const char receiver_class, void receiver, const char slot)
	Non-static method is used to connect from the signal of this object to the receiver slot. More...

virtual void	Connected (const char *)

virtual void	Destroyed ()

Bool_t	Disconnect (const char signal=0, void receiver=0, const char *slot=0)
	Disconnects signal of this object from slot of receiver. More...

virtual void	Disconnected (const char *)

template<typename T >
void	Emit (const char *signal, const T &arg)
	Activate signal with single parameter. More...

void	Emit (const char *signal)
	Acitvate signal without args. More...

template<typename... T>
void	EmitVA (const char *signal_name, Int_t, const T &... params)
	Emit a signal with a varying number of arguments. More...

TList *	GetListOfClassSignals () const
	Returns pointer to list of signals of this class. More...

TList *	GetListOfConnections () const

TList *	GetListOfSignals () const

virtual Bool_t	HasConnection (const char *signal_name) const
	Return true if there is any object connected to this signal. More...

virtual void	HighPriority (const char signal_name, const char slot_name=0)

virtual void	LowPriority (const char signal_name, const char slot_name=0)

virtual void	Message (const char *msg)

virtual Int_t	NumberOfConnections () const
	Return number of connections for this object. More...

virtual Int_t	NumberOfSignals () const
	Return number of signals for this object. More...

Protected Member Functions
Int_t	AssertSelector (const char *selector_file)
	Make sure that a valid selector object Return -1 in case of problems, 0 otherwise. More...

Bool_t	CheckMemUsage (Long64_t &mfreq, Bool_t &w80r, Bool_t &w80v, TString &wmsg)
	Check the memory usage, if requested. More...

virtual Int_t	DrawCanvas (TObject *obj)
	Draw the object if it is a canvas. More...

void *	GetSender ()

void	MapOutputListToDataMembers () const

virtual void	MergeOutput (Bool_t savememvalues=kFALSE)
	Merge output (may not be used in this class). More...

virtual void	SetupFeedback ()
	Set up feedback (may not be used in this class). More...

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected). More...

void	MakeZombie ()

Protected Member Functions inherited from TQObject
virtual const char *	GetSenderClassName () const

Protected Attributes
Bool_t	fCreateSelObj
	the latest selector More...

TTimer *	fDispatchTimer

Int_t	fDrawQueries

TEventIter *	fEvIter
	period (ms) for sending intermediate results More...

EExitStatus	fExitStatus
	status of query in progress More...

Long_t	fFeedbackPeriod
	timer for sending intermediate results More...

TTimer *	fFeedbackTimer
	class of the latest selector More...

TList *	fInput

Int_t	fMaxDrawQueries

THashList *	fOutput

TFile *	fOutputFile

TString	fOutputFilePath

TQueryResult *	fPreviousQuery

Long64_t	fProcessedRun
	Read calls in this run. More...

TStopwatch *	fProcTime

TTimer *	fProcTimeTimer

TProofProgressStatus *	fProgressStatus

TQueryResult *	fQuery

TList *	fQueryResults
	Events processed in this run. More...

Long64_t	fReadBytesRun

Long64_t	fReadCallsRun
	Bytes read in this run. More...

Long_t	fSaveMemThreshold

Bool_t	fSavePartialResults

Bool_t	fSaveResultsPerPacket

TSelector *	fSelector

TClass *	fSelectorClass
	kTRUE when fSelector has been created locally More...

TStatus *	fSelStatus
	iterator on events or objects More...

TTimer *	fStopTimer

std::mutex	fStopTimerMtx

Long64_t	fTotalEvents

Protected Attributes inherited from TQObject
TList *	fListOfConnections
	list of signals from this object More...

TList *	fListOfSignals

Bool_t	fSignalsBlocked
	list of connections to this object More...

Static Protected Attributes
static THashList *	fgDrawInputPars = 0

Static Protected Attributes inherited from TQObject
static Bool_t	fgAllSignalsBlocked = kFALSE
	flag used for suppression of signals More...

Private Attributes
TList *	fAutoBins

Additional Inherited Members
Static Public Member Functions inherited from TVirtualProofPlayer
static TVirtualProofPlayer *	Create (const char player, TProof p, TSocket *s=0)
	Create a PROOF player. More...

Static Public Member Functions inherited from TObject
static Long_t	GetDtorOnly ()
	Return destructor only flag. More...

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

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

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

Static Public Member Functions inherited from TQObject
static Bool_t	AreAllSignalsBlocked ()
	Returns true if all signals are blocked. More...

static Bool_t	BlockAllSignals (Bool_t b)
	Block or unblock all signals. Returns the previous block status. More...

static Bool_t	Connect (TQObject sender, const char signal, const char receiver_class, void receiver, const char *slot)
	Create connection between sender and receiver. More...

static Bool_t	Connect (const char sender_class, const char signal, const char receiver_class, void receiver, const char *slot)
	This method allows to make a connection from any object of the same class to a single slot. More...

static Bool_t	Disconnect (TQObject sender, const char signal=0, void receiver=0, const char slot=0)
	Disconnects signal in object sender from slot_method in object receiver. More...

static Bool_t	Disconnect (const char class_name, const char signal, void receiver=0, const char slot=0)
	Disconnects "class signal". More...

Static Protected Member Functions inherited from TQObject
static Int_t	CheckConnectArgs (TQObject sender, TClass sender_class, const char signal, TClass receiver_class, const char *slot)
	Checking of consitency of sender/receiver methods/arguments. More...

static TString	CompressName (const char *method_name)
	Removes "const" words and blanks from full (with prototype) method name and resolve any typedefs in the method signature. More...

static Bool_t	ConnectToClass (TQObject sender, const char signal, TClass receiver_class, void receiver, const char *slot)
	Create connection between sender and receiver. More...

static Bool_t	ConnectToClass (const char sender_class, const char signal, TClass receiver_class, void receiver, const char *slot)
	This method allows to make connection from any object of the same class to the receiver object. More...

#include <TProofPlayer.h>

Inheritance diagram for TProofPlayer:

[legend]

Member Enumeration Documentation

◆ EStatusBits

enum TProofPlayer::EStatusBits

Enumerator
kDispatchOneEvent
kIsProcessing
kMaxProcTimeReached
kMaxProcTimeExtended

Definition at line 131 of file TProofPlayer.h.

Constructor & Destructor Documentation

◆ TProofPlayer()

TProofPlayer::TProofPlayer ( TProof * proof = 0 )

Default ctor.

Definition at line 227 of file TProofPlayer.cxx.

◆ ~TProofPlayer()

TProofPlayer::~TProofPlayer ( )

virtual

Destructor.

Definition at line 257 of file TProofPlayer.cxx.

Member Function Documentation

◆ AddEventsProcessed()

void TProofPlayer::AddEventsProcessed ( Long64_t ev )

inlinevirtual

void TProofPlayer::FeedBackCanvas	(	const char *	name,
		Bool_t	create
	)

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ EStatusBits

Constructor & Destructor Documentation

◆ TProofPlayer()

◆ ~TProofPlayer()

Member Function Documentation

◆ AddEventsProcessed()

◆ AddInput()

◆ AddOutput()

◆ AddOutputObject()

◆ AddQueryResult()

◆ AssertSelector()

◆ CheckMemUsage()

◆ ClearInput()

◆ CreateDrawFeedback()

◆ DeleteDrawFeedback()

◆ DrawCanvas()

◆ DrawSelect()

◆ Feedback()

◆ FeedBackCanvas()

◆ Finalize() [1/2]

◆ Finalize() [2/2]

◆ GetCacheSize()

◆ GetCurrentQuery()

◆ GetDrawArgs()

◆ GetEventsProcessed()

◆ GetExitStatus()

◆ GetInputList()

◆ GetLearnEntries()

◆ GetListOfResults()

◆ GetNextPacket()

◆ GetOutput()

◆ GetOutputList()

◆ GetPacketizer()

◆ GetProgressStatus()

◆ GetQueryResult()

◆ GetSender()

◆ HandleGetTreeHeader()

◆ HandleRecvHisto()

◆ IsClient()

◆ JoinProcess()

◆ MapOutputListToDataMembers()

◆ MergeOutput()

◆ Process() [1/2]

◆ Process() [2/2]

◆ Progress() [1/6]

◆ Progress() [2/6]

◆ Progress() [3/6]

◆ Progress() [4/6]

◆ Progress() [5/6]

◆ Progress() [6/6]

◆ ReinitSelector()

◆ RemoveQueryResult()

◆ RestorePreviousQuery()

◆ SavePartialResults()

◆ SetCurrentQuery()

◆ SetDispatchTimer()

◆ SetDrawFeedbackOption()

◆ SetExitStatus()

◆ SetInitTime()

◆ SetMaxDrawQueries()

◆ SetMerging()

◆ SetOutputFilePath()

◆ SetProcessing()

◆ SetStopTimer()

◆ SetupFeedback()

◆ StopFeedback()

◆ StopProcess()

◆ StoreFeedback()

◆ StoreOutput()

◆ UpdateAutoBin()

◆ UpdateProgressInfo()