Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TFileHandler Class Reference

Definition at line 65 of file TSysEvtHandler.h.

Public Types

enum  { 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

 TFileHandler (int fd, int mask)
 Create a file descriptor event handler.
 
virtual ~TFileHandler ()
 
void Add () override
 Add file event handler to system file handler list.
 
int GetFd () const
 
virtual Bool_t HasReadInterest ()
 True if handler is interested in read events.
 
virtual Bool_t HasWriteInterest ()
 True if handler is interested in write events.
 
TClassIsA () const override
 
virtual Bool_t IsReadReady () const
 
virtual Bool_t IsWriteReady () const
 
Bool_t Notify () override
 Notify when event occurred on descriptor associated with this handler.
 
virtual Bool_t ReadNotify ()
 Notify when something can be read from the descriptor associated with this handler.
 
void Remove () override
 Remove file event handler from system file handler list.
 
virtual void ResetReadyMask ()
 
void SetFd (int fd)
 
virtual void SetInterest (Int_t mask)
 Set interest mask to 'mask'.
 
virtual void SetReadReady ()
 
virtual void SetWriteReady ()
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual Bool_t WriteNotify ()
 Notify when something can be written to the descriptor associated with this handler.
 
- Public Member Functions inherited from TSysEvtHandler
 TSysEvtHandler ()
 
virtual ~TSysEvtHandler ()
 
void Activate ()
 Activate a system event handler.
 
virtual void Activated ()
 
virtual void Added ()
 
void DeActivate ()
 De-activate a system event handler.
 
virtual void DeActivated ()
 
TClassIsA () const override
 
Bool_t IsActive () const
 
virtual void Notified ()
 
virtual void Removed ()
 
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 TObjectClone (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 TObjectDrawClone (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 TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () 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_tGetOption () 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).
 
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)
 Operator delete [].
 
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)
 
TObjectoperator= (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.
 
TListGetListOfClassSignals () const
 Returns pointer to list of signals of this class.
 
TListGetListOfConnections () const
 
TListGetListOfSignals () 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 TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TSysEvtHandler
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
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 TClassClass ()
 
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.
 

Protected Member Functions

 TFileHandler ()
 
- 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
 

Protected Attributes

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

Additional Inherited Members

- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 
- 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.
 
- Static Protected Attributes inherited from TQObject
static Bool_t fgAllSignalsBlocked = kFALSE
 flag used for suppression of signals
 

#include <TSysEvtHandler.h>

Inheritance diagram for TFileHandler:
[legend]

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
kRead 
kWrite 

Definition at line 75 of file TSysEvtHandler.h.

Constructor & Destructor Documentation

◆ TFileHandler() [1/2]

TFileHandler::TFileHandler ( )
inlineprotected

Definition at line 72 of file TSysEvtHandler.h.

◆ TFileHandler() [2/2]

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 59 of file TSysEvtHandler.cxx.

◆ ~TFileHandler()

virtual TFileHandler::~TFileHandler ( )
inlinevirtual

Definition at line 78 of file TSysEvtHandler.h.

Member Function Documentation

◆ Add()

void TFileHandler::Add ( )
overridevirtual

Add file event handler to system file handler list.

Implements TSysEvtHandler.

Definition at line 126 of file TSysEvtHandler.cxx.

◆ Class()

static TClass * TFileHandler::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TFileHandler::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t TFileHandler::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 95 of file TSysEvtHandler.h.

◆ DeclFileName()

static const char * TFileHandler::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 95 of file TSysEvtHandler.h.

◆ GetFd()

int TFileHandler::GetFd ( ) const
inline

Definition at line 79 of file TSysEvtHandler.h.

◆ HasReadInterest()

Bool_t TFileHandler::HasReadInterest ( )
virtual

True if handler is interested in read events.

Definition at line 100 of file TSysEvtHandler.cxx.

◆ HasWriteInterest()

Bool_t TFileHandler::HasWriteInterest ( )
virtual

True if handler is interested in write events.

Definition at line 108 of file TSysEvtHandler.cxx.

◆ IsA()

TClass * TFileHandler::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Reimplemented in TXSocketHandler.

Definition at line 95 of file TSysEvtHandler.h.

◆ IsReadReady()

virtual Bool_t TFileHandler::IsReadReady ( ) const
inlinevirtual

Definition at line 90 of file TSysEvtHandler.h.

◆ IsWriteReady()

virtual Bool_t TFileHandler::IsWriteReady ( ) const
inlinevirtual

Definition at line 91 of file TSysEvtHandler.h.

◆ Notify()

Bool_t TFileHandler::Notify ( )
overridevirtual

Notify when event occurred on descriptor associated with this handler.

Implements TSysEvtHandler.

Reimplemented in TProofInputHandler, TProofServLogHandler, TProofServInputHandler, TProofServLiteInputHandler, TXSocketHandler, TXProofServInputHandler, TXSocketPingHandler, TTermInputHandler, TGInputHandler, and TSocketHandler.

Definition at line 71 of file TSysEvtHandler.cxx.

◆ ReadNotify()

Bool_t TFileHandler::ReadNotify ( )
virtual

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

Reimplemented in TProofInputHandler, TProofServLogHandler, TProofServInputHandler, TProofServLiteInputHandler, TXSocketHandler, TXProofServInputHandler, TXSocketPingHandler, TTermInputHandler, TASLogHandler, TASInputHandler, and TSocketHandler.

Definition at line 81 of file TSysEvtHandler.cxx.

◆ Remove()

void TFileHandler::Remove ( )
overridevirtual

Remove file event handler from system file handler list.

Implements TSysEvtHandler.

Definition at line 137 of file TSysEvtHandler.cxx.

◆ ResetReadyMask()

virtual void TFileHandler::ResetReadyMask ( )
inlinevirtual

Definition at line 87 of file TSysEvtHandler.h.

◆ SetFd()

void TFileHandler::SetFd ( int  fd)
inline

Definition at line 80 of file TSysEvtHandler.h.

◆ SetInterest()

void TFileHandler::SetInterest ( Int_t  mask)
virtual

Set interest mask to 'mask'.

Definition at line 116 of file TSysEvtHandler.cxx.

◆ SetReadReady()

virtual void TFileHandler::SetReadReady ( )
inlinevirtual

Definition at line 88 of file TSysEvtHandler.h.

◆ SetWriteReady()

virtual void TFileHandler::SetWriteReady ( )
inlinevirtual

Definition at line 89 of file TSysEvtHandler.h.

◆ Streamer()

void TFileHandler::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

Reimplemented in TXSocketHandler.

◆ StreamerNVirtual()

void TFileHandler::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 95 of file TSysEvtHandler.h.

◆ WriteNotify()

Bool_t TFileHandler::WriteNotify ( )
virtual

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

Reimplemented in TSocketHandler.

Definition at line 91 of file TSysEvtHandler.cxx.

Member Data Documentation

◆ fFileNum

int TFileHandler::fFileNum
protected

Definition at line 68 of file TSysEvtHandler.h.

◆ fMask

int TFileHandler::fMask
protected

Definition at line 69 of file TSysEvtHandler.h.

◆ fReadyMask

int TFileHandler::fReadyMask
protected

Definition at line 70 of file TSysEvtHandler.h.

  • core/base/inc/TSysEvtHandler.h
  • core/base/src/TSysEvtHandler.cxx