Definition at line 36 of file TMonitor.h.

Public Types
enum	EInterest { kRead = 1 , kWrite = 2 }

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

Public Member Functions
	TMonitor (Bool_t mainloop=kTRUE)
	Create a monitor object.

	TMonitor (const TMonitor &m)
	Copy constructor.

virtual	~TMonitor ()
	Cleanup the monitor object. Does not delete sockets being monitored.

virtual void	Activate (TSocket *sock)
	Activate a de-activated socket.

virtual void	ActivateAll ()
	Activate all de-activated sockets.

virtual void	Add (TSocket *sock, Int_t interest=kRead)
	Add socket to the monitor's active list.

virtual void	DeActivate (TSocket *sock)
	De-activate a socket.

virtual void	DeActivateAll ()
	De-activate all activated sockets.

Int_t	GetActive (Long_t timeout=-1) const
	Return number of sockets in the active list.

Int_t	GetDeActive () const
	Return number of sockets in the de-active list.

TList *	GetListOfActives () const
	Returns a list with all active sockets.

TList *	GetListOfDeActives () const
	Returns a list with all de-active sockets.

void	Interrupt ()

TClass *	IsA () const override

Bool_t	IsActive (TSocket *s) const
	Check if socket 's' is in the active list.

virtual void	Ready (TSocket *sock)
	Emit signal when some socket is ready.

virtual void	Remove (TSocket *sock)
	Remove a socket from the monitor.

virtual void	RemoveAll ()
	Remove all sockets from the monitor.

void	ResetInterrupt ()

TSocket *	Select ()
	Return pointer to socket for which an event is waiting.

TSocket *	Select (Long_t timeout)
	Return pointer to socket for which an event is waiting.

Int_t	Select (TList rdready, TList wrready, Long_t timeout)
	Return numbers of sockets that are ready for reading or writing.

virtual void	SetInterest (TSocket *sock, Int_t interest=kRead)
	Set interest mask for socket sock to interest.

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

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 Int_t	Compare (const TObject *obj) const
	Compare abstract method.

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

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.

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

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 TQObject
	TQObject ()
	TQObject Constructor.

virtual	~TQObject ()
	TQObject Destructor.

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.

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.

virtual void	Connected (const char *)

virtual void	Destroyed ()

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

virtual void	Disconnected (const char *)

void	Emit (const char *signal)
	Activate signal without args.

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

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

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

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.

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

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

virtual void	Message (const char *msg)

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

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

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 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 TQObject
static Bool_t	AreAllSignalsBlocked ()
	Returns true if all signals are blocked.

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

static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

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.

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

static const char *	DeclFileName ()

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

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

Private Member Functions
void *	GetSender () override

void	SetReady (TSocket *sock)
	Called by TSocketHandler::Notify() to signal which socket is ready to be read or written.

Private Attributes
TList *	fActive

TList *	fDeActive

Bool_t	fInterrupt

Bool_t	fMainLoop

TSocket *	fReady

Friends
class	TSocketHandler

class	TTimeOutTimer

class	TXSlave

class	TXSocket

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

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

void	MakeZombie ()

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

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 consistency of sender/receiver methods/arguments.

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.

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.

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

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

TList *	fListOfSignals

Bool_t	fSignalsBlocked
	list of connections to this object

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

#include <TMonitor.h>

Inheritance diagram for TMonitor:

[legend]

Member Enumeration Documentation

◆ EInterest

enum TMonitor::EInterest

Enumerator
kRead
kWrite

Definition at line 54 of file TMonitor.h.

Constructor & Destructor Documentation

◆ TMonitor() [1/2]

TMonitor::TMonitor ( Bool_t mainloop = kTRUE )

Create a monitor object.

If mainloop is true the monitoring will be done in the main event loop.

Definition at line 109 of file TMonitor.cxx.

◆ TMonitor() [2/2]

TMonitor::TMonitor ( const TMonitor & m )

Copy constructor.

Definition at line 123 of file TMonitor.cxx.

◆ ~TMonitor()

TMonitor::~TMonitor ( )

virtual

Cleanup the monitor object. Does not delete sockets being monitored.

Definition at line 153 of file TMonitor.cxx.

Member Function Documentation

◆ Activate()

void TMonitor::Activate ( TSocket * sock )

virtual

Activate a de-activated socket.

Definition at line 250 of file TMonitor.cxx.

◆ ActivateAll()

void TMonitor::ActivateAll ( )

virtual

Activate all de-activated sockets.

Definition at line 268 of file TMonitor.cxx.

◆ Add()

void TMonitor::Add	(	TSocket *	sock,
		Int_t	interest = `kRead`
	)

virtual

Add socket to the monitor's active list.

If interest=kRead then we want to monitor the socket for read readiness, if interest=kWrite then we monitor the socket for write readiness, if interest=kRead|kWrite then we monitor both read and write readiness.

Definition at line 168 of file TMonitor.cxx.

◆ Class()

static TClass * TMonitor::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TMonitor::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TMonitor::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 85 of file TMonitor.h.

◆ DeActivate()

void TMonitor::DeActivate ( TSocket * sock )

virtual

De-activate a socket.

Definition at line 284 of file TMonitor.cxx.

◆ DeActivateAll()

void TMonitor::DeActivateAll ( )

virtual

De-activate all activated sockets.

Definition at line 302 of file TMonitor.cxx.

◆ DeclFileName()

static const char * TMonitor::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 85 of file TMonitor.h.

◆ GetActive()

Int_t TMonitor::GetActive ( Long_t timeout = -1 ) const

Return number of sockets in the active list.

If timeout > 0, remove from the list those sockets which did not have any activity since timeout millisecs. If timeout = 0, then reset activity timestamp on all active sockets. This time out is typically used if GetActive() is used to see how many remotes still need to send something. If they pass the timeout they will be skipped and GetActive() will return 0 and the loop can be exited.

Definition at line 438 of file TMonitor.cxx.

◆ GetDeActive()

Int_t TMonitor::GetDeActive ( ) const

Return number of sockets in the de-active list.

Definition at line 473 of file TMonitor.cxx.

◆ GetListOfActives()

TList * TMonitor::GetListOfActives ( ) const

Returns a list with all active sockets.

This list must be deleted by the user. DO NOT call Delete() on this list as it will delete the sockets that are still being used by the monitor.

Definition at line 498 of file TMonitor.cxx.

◆ GetListOfDeActives()

TList * TMonitor::GetListOfDeActives ( ) const

Returns a list with all de-active sockets.

This list must be deleted by the user. DO NOT call Delete() on this list as it will delete the sockets that are still being used by the monitor.

Definition at line 515 of file TMonitor.cxx.

◆ GetSender()

void * TMonitor::GetSender ( )

inlineoverrideprivatevirtual

Reimplemented from TQObject.

Definition at line 51 of file TMonitor.h.

◆ Interrupt()

void TMonitor::Interrupt ( )

inline

Definition at line 71 of file TMonitor.h.

◆ IsA()

TClass * TMonitor::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 85 of file TMonitor.h.

◆ IsActive()

Bool_t TMonitor::IsActive ( TSocket * sock ) const

Check if socket 's' is in the active list.

Avoids the duplication of active list via TMonitor::GetListOfActives().

Definition at line 482 of file TMonitor.cxx.

◆ Ready()

void TMonitor::Ready ( TSocket * sock )

virtual

Emit signal when some socket is ready.

Definition at line 530 of file TMonitor.cxx.

◆ Remove()

void TMonitor::Remove ( TSocket * sock )

virtual

Remove a socket from the monitor.

Definition at line 214 of file TMonitor.cxx.

◆ RemoveAll()

void TMonitor::RemoveAll ( )

virtual

Remove all sockets from the monitor.

Definition at line 241 of file TMonitor.cxx.

◆ ResetInterrupt()

void TMonitor::ResetInterrupt ( )

inline

Definition at line 72 of file TMonitor.h.

◆ Select() [1/3]

TSocket * TMonitor::Select ( )

Return pointer to socket for which an event is waiting.

Select can be interrupt by a call to Interrupt() (e.g. connected with a Ctrl-C handler); a call to ResetInterrupt() before Select() is advisable in such a case. Return 0 in case of error.

Definition at line 322 of file TMonitor.cxx.

◆ Select() [2/3]

TSocket * TMonitor::Select ( Long_t timeout )

Return pointer to socket for which an event is waiting.

Wait a maximum of timeout milliseconds. If return is due to timeout it returns (TSocket *)-1. Select() can be interrupt by a call to Interrupt() (e.g. connected with a Ctrl-C handler); a call to ResetInterrupt() before Select() is advisable in such a case. Return 0 in case of any other error situation.

Definition at line 348 of file TMonitor.cxx.

◆ Select() [3/3]

Int_t TMonitor::Select	(	TList *	rdready,
		TList *	wrready,
		Long_t	timeout
	)

Return numbers of sockets that are ready for reading or writing.

Wait a maximum of timeout milliseconds. Return 0 if timed-out. Return < 0 in case of error. If rdready and/or wrready are not 0, the lists of sockets with something to read and/or write are also returned.

Definition at line 377 of file TMonitor.cxx.

◆ SetInterest()

void TMonitor::SetInterest	(	TSocket *	sock,
		Int_t	interest = `kRead`
	)

virtual

Set interest mask for socket sock to interest.

If the socket is not in the active list move it or add it there. If interest=kRead then we want to monitor the socket for read readiness, if interest=kWrite then we monitor the socket for write readiness, if interest=kRead|kWrite then we monitor both read and write readiness.

Definition at line 180 of file TMonitor.cxx.

◆ SetReady()

void TMonitor::SetReady ( TSocket * sock )

private

Called by TSocketHandler::Notify() to signal which socket is ready to be read or written.

User should not call this routine. The ready socket will be returned via the Select() user function. The Ready(TSocket *sock) signal is emitted.

Definition at line 423 of file TMonitor.cxx.

◆ Streamer()

void TMonitor::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TMonitor::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 85 of file TMonitor.h.

Friends And Related Symbol Documentation

◆ TSocketHandler

friend class TSocketHandler

friend

Definition at line 38 of file TMonitor.h.

◆ TTimeOutTimer

friend class TTimeOutTimer

friend

Definition at line 39 of file TMonitor.h.

◆ TXSlave

friend class TXSlave

friend

Definition at line 40 of file TMonitor.h.

◆ TXSocket

friend class TXSocket

friend

Definition at line 41 of file TMonitor.h.

Member Data Documentation

◆ fActive

TList* TMonitor::fActive

private

Definition at line 44 of file TMonitor.h.

◆ fDeActive

TList* TMonitor::fDeActive

private

Definition at line 45 of file TMonitor.h.

◆ fInterrupt

Bool_t TMonitor::fInterrupt

private

Definition at line 48 of file TMonitor.h.

◆ fMainLoop

Bool_t TMonitor::fMainLoop

private

Definition at line 47 of file TMonitor.h.

◆ fReady

TSocket* TMonitor::fReady

private

Definition at line 46 of file TMonitor.h.

Libraries for TMonitor:

[legend]

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

net/net/inc/TMonitor.h
net/net/src/TMonitor.cxx

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Member Enumeration Documentation

◆ EInterest

Constructor & Destructor Documentation

◆ TMonitor() [1/2]

◆ TMonitor() [2/2]

◆ ~TMonitor()

Member Function Documentation

◆ Activate()

◆ ActivateAll()

◆ Add()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeActivate()

◆ DeActivateAll()

◆ DeclFileName()

◆ GetActive()

◆ GetDeActive()

◆ GetListOfActives()

◆ GetListOfDeActives()

◆ GetSender()

◆ Interrupt()

◆ IsA()

◆ IsActive()

◆ Ready()

◆ Remove()

◆ RemoveAll()

◆ ResetInterrupt()

◆ Select() [1/3]

◆ Select() [2/3]

◆ Select() [3/3]

◆ SetInterest()

◆ SetReady()

◆ Streamer()

◆ StreamerNVirtual()

Friends And Related Symbol Documentation

◆ TSocketHandler

◆ TTimeOutTimer

◆ TXSlave

◆ TXSocket

Member Data Documentation

◆ fActive

◆ fDeActive

◆ fInterrupt

◆ fMainLoop

◆ fReady