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

This class represents an Internet Protocol (IP) address.

Definition at line 36 of file TInetAddress.h.

Public Types

typedef std::vector< UInt_tAddressList_t
 
typedef std::vector< TStringAliasList_t
 
- 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

 TInetAddress ()
 Default ctor. Used in case of unknown host. Not a valid address.
 
 TInetAddress (const TInetAddress &adr)
 TInetAddress copy ctor.
 
virtual ~TInetAddress ()
 
UInt_t GetAddress () const
 
UChar_tGetAddressBytes () const
 Returns the raw IP address in host byte order.
 
const AddressList_tGetAddresses () const
 
const AliasList_tGetAliases () const
 
Int_t GetFamily () const
 
const char * GetHostAddress () const
 Returns the IP address string "%d.%d.%d.%d".
 
const char * GetHostName () const
 
Int_t GetPort () const
 
TClassIsA () const override
 
Bool_t IsValid () const
 
TInetAddressoperator= (const TInetAddress &rhs)
 TInetAddress assignment operator.
 
void Print (Option_t *option="") const override
 Print internet address as string.
 
void Streamer (TBuffer &) override
 Stream an object of class TInetAddress.
 
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).
 
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)
 
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 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.
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static const char * GetHostAddress (UInt_t addr)
 Returns the IP address string "%d.%d.%d.%d", use it to convert alternative addresses obtained via GetAddresses().
 
- 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.
 

Private Member Functions

 TInetAddress (const char *host, UInt_t addr, Int_t family, Int_t port=-1)
 Create TInetAddress.
 
void AddAddress (UInt_t addr)
 Add alternative address to list of addresses.
 
void AddAlias (const char *alias)
 Add alias to list of aliases.
 

Private Attributes

AddressList_t fAddresses
 
AliasList_t fAliases
 
Int_t fFamily
 
TString fHostname
 
Int_t fPort
 

Friends

class TServerSocket
 
class TSocket
 
class TSystem
 
class TUDPSocket
 
class TUnixSystem
 
class TUUID
 
class TWinNTSystem
 
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 ()
 

#include <TInetAddress.h>

Inheritance diagram for TInetAddress:
[legend]

Member Typedef Documentation

◆ AddressList_t

typedef std::vector<UInt_t> TInetAddress::AddressList_t

Definition at line 48 of file TInetAddress.h.

◆ AliasList_t

typedef std::vector<TString> TInetAddress::AliasList_t

Definition at line 49 of file TInetAddress.h.

Constructor & Destructor Documentation

◆ TInetAddress() [1/3]

TInetAddress::TInetAddress ( const char *  host,
UInt_t  addr,
Int_t  family,
Int_t  port = -1 
)
private

Create TInetAddress.

Private ctor. TInetAddress objects can only be created via the friend classes TSystem, TServerSocket and TSocket. Use the IsValid() method to check the validity of a TInetAddress.

Definition at line 39 of file TInetAddress.cxx.

◆ TInetAddress() [2/3]

TInetAddress::TInetAddress ( )

Default ctor. Used in case of unknown host. Not a valid address.

Definition at line 26 of file TInetAddress.cxx.

◆ TInetAddress() [3/3]

TInetAddress::TInetAddress ( const TInetAddress adr)

TInetAddress copy ctor.

Definition at line 53 of file TInetAddress.cxx.

◆ ~TInetAddress()

virtual TInetAddress::~TInetAddress ( )
inlinevirtual

Definition at line 66 of file TInetAddress.h.

Member Function Documentation

◆ AddAddress()

void TInetAddress::AddAddress ( UInt_t  addr)
private

Add alternative address to list of addresses.

Definition at line 150 of file TInetAddress.cxx.

◆ AddAlias()

void TInetAddress::AddAlias ( const char *  alias)
private

Add alias to list of aliases.

Definition at line 158 of file TInetAddress.cxx.

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 81 of file TInetAddress.h.

◆ DeclFileName()

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

Definition at line 81 of file TInetAddress.h.

◆ GetAddress()

UInt_t TInetAddress::GetAddress ( ) const
inline

Definition at line 68 of file TInetAddress.h.

◆ GetAddressBytes()

UChar_t * TInetAddress::GetAddressBytes ( ) const

Returns the raw IP address in host byte order.

The highest order byte position is in addr[0]. To be prepared for 64-bit IP addresses an array of bytes is returned. User must delete allocated memory.

Definition at line 84 of file TInetAddress.cxx.

◆ GetAddresses()

const AddressList_t & TInetAddress::GetAddresses ( ) const
inline

Definition at line 74 of file TInetAddress.h.

◆ GetAliases()

const AliasList_t & TInetAddress::GetAliases ( ) const
inline

Definition at line 75 of file TInetAddress.h.

◆ GetFamily()

Int_t TInetAddress::GetFamily ( ) const
inline

Definition at line 72 of file TInetAddress.h.

◆ GetHostAddress() [1/2]

const char * TInetAddress::GetHostAddress ( ) const

Returns the IP address string "%d.%d.%d.%d".

Copy string immediately, it will be reused.

Definition at line 113 of file TInetAddress.cxx.

◆ GetHostAddress() [2/2]

const char * TInetAddress::GetHostAddress ( UInt_t  addr)
static

Returns the IP address string "%d.%d.%d.%d", use it to convert alternative addresses obtained via GetAddresses().

Copy string immediately, it will be reused. Static function.

Definition at line 101 of file TInetAddress.cxx.

◆ GetHostName()

const char * TInetAddress::GetHostName ( ) const
inline

Definition at line 71 of file TInetAddress.h.

◆ GetPort()

Int_t TInetAddress::GetPort ( ) const
inline

Definition at line 73 of file TInetAddress.h.

◆ IsA()

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

Reimplemented from TObject.

Definition at line 81 of file TInetAddress.h.

◆ IsValid()

Bool_t TInetAddress::IsValid ( ) const
inline

Definition at line 76 of file TInetAddress.h.

◆ operator=()

TInetAddress & TInetAddress::operator= ( const TInetAddress rhs)

TInetAddress assignment operator.

Definition at line 65 of file TInetAddress.cxx.

◆ Print()

void TInetAddress::Print ( Option_t option = "") const
overridevirtual

Print internet address as string.

Reimplemented from TObject.

Definition at line 121 of file TInetAddress.cxx.

◆ Streamer()

void TInetAddress::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TInetAddress.

Reimplemented from TObject.

Definition at line 166 of file TInetAddress.cxx.

◆ StreamerNVirtual()

void TInetAddress::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 81 of file TInetAddress.h.

Friends And Related Symbol Documentation

◆ TServerSocket

friend class TServerSocket
friend

Definition at line 44 of file TInetAddress.h.

◆ TSocket

friend class TSocket
friend

Definition at line 42 of file TInetAddress.h.

◆ TSystem

friend class TSystem
friend

Definition at line 38 of file TInetAddress.h.

◆ TUDPSocket

friend class TUDPSocket
friend

Definition at line 43 of file TInetAddress.h.

◆ TUnixSystem

friend class TUnixSystem
friend

Definition at line 39 of file TInetAddress.h.

◆ TUUID

friend class TUUID
friend

Definition at line 41 of file TInetAddress.h.

◆ TWinNTSystem

friend class TWinNTSystem
friend

Definition at line 40 of file TInetAddress.h.

◆ TXSocket

friend class TXSocket
friend

Definition at line 45 of file TInetAddress.h.

Member Data Documentation

◆ fAddresses

AddressList_t TInetAddress::fAddresses
private

Definition at line 55 of file TInetAddress.h.

◆ fAliases

AliasList_t TInetAddress::fAliases
private

Definition at line 56 of file TInetAddress.h.

◆ fFamily

Int_t TInetAddress::fFamily
private

Definition at line 53 of file TInetAddress.h.

◆ fHostname

TString TInetAddress::fHostname
private

Definition at line 52 of file TInetAddress.h.

◆ fPort

Int_t TInetAddress::fPort
private

Definition at line 54 of file TInetAddress.h.

Libraries for TInetAddress:

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