Logo ROOT   6.16/01
Reference Guide
List of all members | Public Types | Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
TMonitor Class Reference

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

 TMonitor (Bool_t mainloop=kTRUE)
 Create a monitor object. More...
 
 TMonitor (const TMonitor &m)
 Copy constructor. More...
 
virtual ~TMonitor ()
 Cleanup the monitor object. Does not delete sockets being monitored. More...
 
virtual void Activate (TSocket *sock)
 Activate a de-activated socket. More...
 
virtual void ActivateAll ()
 Activate all de-activated sockets. More...
 
virtual void Add (TSocket *sock, Int_t interest=kRead)
 Add socket to the monitor's active list. More...
 
virtual void DeActivate (TSocket *sock)
 De-activate a socket. More...
 
virtual void DeActivateAll ()
 De-activate all activated sockets. More...
 
Int_t GetActive (Long_t timeout=-1) const
 Return number of sockets in the active list. More...
 
Int_t GetDeActive () const
 Return number of sockets in the de-active list. More...
 
TListGetListOfActives () const
 Returns a list with all active sockets. More...
 
TListGetListOfDeActives () const
 Returns a list with all de-active sockets. More...
 
void Interrupt ()
 
Bool_t IsActive (TSocket *s) const
 Check if socket 's' is in the active list. More...
 
virtual void Ready (TSocket *sock)
 Emit signal when some socket is ready. More...
 
virtual void Remove (TSocket *sock)
 Remove a socket from the monitor. More...
 
virtual void RemoveAll ()
 Remove all sockets from the monitor. More...
 
void ResetInterrupt ()
 
TSocketSelect ()
 Return pointer to socket for which an event is waiting. More...
 
TSocketSelect (Long_t timeout)
 Return pointer to socket for which an event is waiting. More...
 
Int_t Select (TList *rdready, TList *wrready, Long_t timeout)
 Return numbers of sockets that are ready for reading or writing. More...
 
virtual void SetInterest (TSocket *sock, Int_t interest=kRead)
 Set interest mask for socket sock to interest. More...
 
- 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 ()
 Check and record whether 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 TObjectClone (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 TObjectDrawClone (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 TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () 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_tGetOption () 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...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (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)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. 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 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 *)
 
void Emit (const char *signal)
 Acitvate signal without args. More...
 
template<typename T >
void Emit (const char *signal, const T &arg)
 Activate signal with single parameter. 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...
 
TListGetListOfClassSignals () const
 Returns pointer to list of signals of this class. More...
 
TListGetListOfConnections () const
 
TListGetListOfSignals () 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...
 

Private Member Functions

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

Private Attributes

TListfActive
 
TListfDeActive
 
Bool_t fInterrupt
 
Bool_t fMainLoop
 
TSocketfReady
 

Friends

class TSocketHandler
 
class TTimeOutTimer
 
class TXSlave
 
class TXSocket
 

Additional Inherited Members

- 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 (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 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 Disconnect (const char *class_name, const char *signal, void *receiver=0, const char *slot=0)
 Disconnects "class signal". 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...
 
- 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 voidGetSender ()
 
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 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 (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...
 
static Bool_t ConnectToClass (TQObject *sender, const char *signal, TClass *receiver_class, void *receiver, const char *slot)
 Create connection between sender and receiver. More...
 
- Protected Attributes inherited from TQObject
TListfListOfConnections
 list of signals from this object More...
 
TListfListOfSignals
 
Bool_t fSignalsBlocked
 list of connections to this object More...
 
- Static Protected Attributes inherited from TQObject
static Bool_t fgAllSignalsBlocked = kFALSE
 flag used for suppression of signals More...
 

#include <TMonitor.h>

Inheritance diagram for TMonitor:
[legend]

Member Enumeration Documentation

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

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

◆ 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 ( )
inlineprivatevirtual

Reimplemented from TQObject.

Definition at line 51 of file TMonitor.h.

◆ Interrupt()

void TMonitor::Interrupt ( )
inline

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

Friends And Related Function 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: