ROOT  6.06/09
Reference Guide
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TFileHandler Class Reference

Definition at line 69 of file TSysEvtHandler.h.

Public Types

enum  { kRead = 1, kWrite = 2 }
 
- 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) }
 

Public Member Functions

 TFileHandler (int fd, int mask)
 Create a file descriptor event handler. More...
 
virtual ~TFileHandler ()
 
int GetFd () const
 
void SetFd (int fd)
 
virtual Bool_t Notify ()
 Notify when event occurred on descriptor associated with this handler. More...
 
virtual Bool_t ReadNotify ()
 Notify when something can be read from the descriptor associated with this handler. More...
 
virtual Bool_t WriteNotify ()
 Notify when something can be written to the descriptor associated with this handler. More...
 
virtual Bool_t HasReadInterest ()
 True if handler is interested in read events. More...
 
virtual Bool_t HasWriteInterest ()
 True if handler is interested in write events. More...
 
virtual void SetInterest (Int_t mask)
 Set interest mask to 'mask'. More...
 
virtual void ResetReadyMask ()
 
virtual void SetReadReady ()
 
virtual void SetWriteReady ()
 
virtual Bool_t IsReadReady () const
 
virtual Bool_t IsWriteReady () const
 
virtual void Add ()
 Add file event handler to system file handler list. More...
 
virtual void Remove ()
 Remove file event handler from system file handler list. More...
 
- Public Member Functions inherited from TSysEvtHandler
 TSysEvtHandler ()
 
virtual ~TSysEvtHandler ()
 
void Activate ()
 
void DeActivate ()
 De-activate a system event handler. More...
 
Bool_t IsActive () const
 
virtual void Activated ()
 
virtual void DeActivated ()
 
virtual void Notified ()
 
virtual void Added ()
 
virtual void Removed ()
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (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 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 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 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 UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual Option_tGetOption () 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...
 
virtual Bool_t IsSortable () const
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
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 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...
 
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...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator 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 TQObject
 TQObject ()
 TQObject Constructor. More...
 
virtual ~TQObject ()
 TQObject Destructor. More...
 
TListGetListOfClassSignals () const
 Returns pointer to list of signals of this class. More...
 
TListGetListOfSignals () const
 
TListGetListOfConnections () const
 
Bool_t AreSignalsBlocked () const
 
Bool_t BlockSignals (Bool_t b)
 
void CollectClassSignalLists (TList &list, TClass *cls)
 Collect class signal lists from class cls and all its base-classes. More...
 
template<typename... T>
void EmitVA (const char *signal_name, Int_t, const T &...params)
 
void EmitVA (const char *signal, Int_t nargs, va_list va)=delete
 
void Emit (const char *signal)
 Acitvate signal without args. More...
 
void Emit (const char *signal, Long_t *paramArr)
 Emit a signal with a varying number of arguments, paramArr is an array of the parameters. More...
 
void Emit (const char *signal, const char *params)
 Activate signal with parameter text string. More...
 
void Emit (const char *signal, Double_t param)
 Activate signal with single parameter. More...
 
void Emit (const char *signal, Long_t param)
 Activate signal with single parameter. More...
 
void Emit (const char *signal, Long64_t param)
 Activate signal with single parameter. More...
 
void Emit (const char *signal, Bool_t param)
 
void Emit (const char *signal, Char_t param)
 
void Emit (const char *signal, UChar_t param)
 
void Emit (const char *signal, Short_t param)
 
void Emit (const char *signal, UShort_t param)
 
void Emit (const char *signal, Int_t param)
 
void Emit (const char *signal, UInt_t param)
 
void Emit (const char *signal, ULong_t param)
 
void Emit (const char *signal, ULong64_t param)
 
void Emit (const char *signal, Float_t param)
 
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...
 
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 HighPriority (const char *signal_name, const char *slot_name=0)
 
virtual void LowPriority (const char *signal_name, const char *slot_name=0)
 
virtual Bool_t HasConnection (const char *signal_name) const
 Return true if there is any object connected to this signal. More...
 
virtual Int_t NumberOfSignals () const
 Return number of signals for this object. More...
 
virtual Int_t NumberOfConnections () const
 Return number of connections for this object. More...
 
virtual void Connected (const char *)
 
virtual void Disconnected (const char *)
 
virtual void Destroyed ()
 
virtual void ChangedBy (const char *method)
 
virtual void Message (const char *msg)
 

Protected Member Functions

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

Protected Attributes

int fFileNum
 
int fMask
 
int fReadyMask
 
- Protected Attributes inherited from TQObject
TListfListOfSignals
 
TListfListOfConnections
 list of signals from this object More...
 
Bool_t fSignalsBlocked
 list of connections to this object More...
 

Additional Inherited Members

- 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...
 
- Static Public Member Functions inherited from TQObject
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 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 Protected Member Functions inherited from TQObject
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...
 
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)
 
- Static Protected Attributes inherited from TQObject
static Bool_t fgAllSignalsBlocked = kFALSE
 flag used for suppression of signals More...
 

#include <TSysEvtHandler.h>

+ Inheritance diagram for TFileHandler:
+ Collaboration diagram for TFileHandler:

Member Enumeration Documentation

anonymous enum
Enumerator
kRead 
kWrite 

Definition at line 79 of file TSysEvtHandler.h.

Constructor & Destructor Documentation

TFileHandler::TFileHandler ( )
inlineprotected

Definition at line 76 of file TSysEvtHandler.h.

TFileHandler::TFileHandler ( int  fd,
int  mask 
)

Create a file descriptor event handler.

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

Definition at line 57 of file TSysEvtHandler.cxx.

virtual TFileHandler::~TFileHandler ( )
inlinevirtual

Definition at line 82 of file TSysEvtHandler.h.

Member Function Documentation

void TFileHandler::Add ( )
virtual
int TFileHandler::GetFd ( ) const
inline
Bool_t TFileHandler::HasReadInterest ( )
virtual

True if handler is interested in read events.

Definition at line 98 of file TSysEvtHandler.cxx.

Referenced by TUnixSystem::AddFileHandler(), TWinNTSystem::AddFileHandler(), TUnixSystem::RemoveFileHandler(), TUnixSystem::Select(), and TWinNTSystem::Select().

Bool_t TFileHandler::HasWriteInterest ( )
virtual

True if handler is interested in write events.

Definition at line 106 of file TSysEvtHandler.cxx.

Referenced by TUnixSystem::AddFileHandler(), TWinNTSystem::AddFileHandler(), TUnixSystem::RemoveFileHandler(), TUnixSystem::Select(), and TWinNTSystem::Select().

virtual Bool_t TFileHandler::IsReadReady ( ) const
inlinevirtual

Definition at line 94 of file TSysEvtHandler.h.

virtual Bool_t TFileHandler::IsWriteReady ( ) const
inlinevirtual

Definition at line 95 of file TSysEvtHandler.h.

Bool_t TFileHandler::Notify ( )
virtual

Notify when event occurred on descriptor associated with this handler.

Implements TSysEvtHandler.

Reimplemented in TProofServLogHandler, TProofInputHandler, TASLogHandler, and TXSocketHandler.

Definition at line 69 of file TSysEvtHandler.cxx.

Referenced by TMacOSXSystem::DispatchOneEvent(), TUnixSystem::DispatchOneEvent(), and TWinNTSystem::DispatchOneEvent().

Bool_t TFileHandler::ReadNotify ( )
virtual

Notify when something can be read from the descriptor associated with this handler.

Reimplemented in TProofServLogHandler, TProofInputHandler, TASLogHandler, and TXSocketHandler.

Definition at line 79 of file TSysEvtHandler.cxx.

Referenced by TWinNTSystem::CheckDescriptors(), and TUnixSystem::CheckDescriptors().

void TFileHandler::Remove ( )
virtual

Remove file event handler from system file handler list.

Implements TSysEvtHandler.

Definition at line 135 of file TSysEvtHandler.cxx.

Referenced by TProof::DeActivateAsyncInput(), ~TFileHandler(), and TRint::~TRint().

virtual void TFileHandler::ResetReadyMask ( )
inlinevirtual

Definition at line 91 of file TSysEvtHandler.h.

Referenced by TUnixSystem::Select(), and TWinNTSystem::Select().

void TFileHandler::SetFd ( int  fd)
inline
void TFileHandler::SetInterest ( Int_t  mask)
virtual

Set interest mask to 'mask'.

Definition at line 114 of file TSysEvtHandler.cxx.

virtual void TFileHandler::SetReadReady ( )
inlinevirtual

Definition at line 92 of file TSysEvtHandler.h.

Referenced by TUnixSystem::Select(), and TWinNTSystem::Select().

virtual void TFileHandler::SetWriteReady ( )
inlinevirtual

Definition at line 93 of file TSysEvtHandler.h.

Referenced by TUnixSystem::Select(), and TWinNTSystem::Select().

Bool_t TFileHandler::WriteNotify ( )
virtual

Notify when something can be written to the descriptor associated with this handler.

Definition at line 89 of file TSysEvtHandler.cxx.

Referenced by TWinNTSystem::CheckDescriptors(), and TUnixSystem::CheckDescriptors().

Member Data Documentation

int TFileHandler::fFileNum
protected

Definition at line 72 of file TSysEvtHandler.h.

Referenced by Add(), GetFd(), Remove(), and TFileHandler().

int TFileHandler::fMask
protected

Definition at line 73 of file TSysEvtHandler.h.

Referenced by HasReadInterest(), HasWriteInterest(), SetInterest(), and TFileHandler().

int TFileHandler::fReadyMask
protected

Definition at line 74 of file TSysEvtHandler.h.

Referenced by TFileHandler().


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