Logo ROOT  
Reference Guide
No Matches
TXUnixSocket Class Reference

Implementation of TXSocket using PF_UNIX sockets.

Used for the internal connection between coordinator and TXProofServ.

Definition at line 29 of file TXUnixSocket.h.

Public Member Functions

 TXUnixSocket (const char *u, Int_t psid=-1, Char_t ver=-1, TXHandler *handler=0, int fd=-1)
virtual ~TXUnixSocket ()
Int_t GetClientID () const
Int_t GetClientIDSize () const
Int_t Reconnect ()
 Try reconnection after failure.
void RemoveClientID ()
void SetClientID (Int_t cid)
- Public Member Functions inherited from TXSocket
 TXSocket (const char *url, Char_t mode='M', Int_t psid=-1, Char_t ver=-1, const char *logbuf=0, Int_t loglevel=-1, TXHandler *handler=0)
 Constructor Open the connection to a remote XrdProofd instance and start a PROOF session.
virtual ~TXSocket ()
virtual void Close (Option_t *opt="")
 Close connection.
Bool_t Create (Bool_t attach=kFALSE)
 This method sends a request for creation of (or attachment to) a remote server application.
void CtrlC ()
 Interrupt the remote protocol instance.
void DisableTimeout ()
void DisconnectSession (Int_t id, Option_t *opt="")
 Disconnect a session.
void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
void EnableTimeout ()
Int_t Flush ()
 Flush the asynchronous queue.
Int_t GetInterrupt (Bool_t &forward)
 Get latest interrupt level and reset it; if the interrupt has to be propagated to lower stages forward will be kTRUE after the call.
Int_t GetLogConnID () const
 Getter for logical connection ID.
Int_t GetOpenError () const
 Getter for last error.
Int_t GetServType () const
 Getter for server type.
Int_t GetSessionID () const
 Getter for session ID.
Int_t GetXrdProofdVersion () const
Bool_t IsAWait ()
Bool_t IsInterrupt ()
Bool_t IsServProofd ()
 Return kTRUE if the remote server is a 'proofd'.
Bool_t IsValid () const
 Getter for validity status.
Bool_t Ping (const char *ord=0)
 Ping functionality: contact the server to check its vitality.
virtual UnsolRespProcResult ProcessUnsolicitedMsg (XrdClientUnsolMsgSender *s, XrdClientMessage *msg)
 We are here if an unsolicited response comes from a logical conn The response comes in the form of an XrdClientMessage *, that must NOT be destroyed after processing.
Int_t Recv (char *mess, Int_t max)
 Receive a character string message of maximum max length.
Int_t Recv (char *mess, Int_t max, Int_t &kind)
 Receive a character string message of maximum max length.
Int_t Recv (Int_t &status, Int_t &kind)
 Receives a status and a message type.
Int_t Recv (TMessage *&mess)
 Receive a TMessage object.
Int_t RecvRaw (void *buf, Int_t len, ESendRecvOptions opt=kDefault)
 Receive a raw buffer of specified length bytes.
void RemoteTouch ()
 Remote touch functionality: contact the server to proof our vitality.
Int_t Send (const char *mess, Int_t kind=kMESS_STRING)
 Send a character string buffer.
Int_t Send (const TMessage &mess)
 Send a TMessage object.
Int_t Send (Int_t kind)
 Send a single message opcode.
Int_t Send (Int_t status, Int_t kind)
 Send a status and a single message opcode.
TObjStringSendCoordinator (Int_t kind, const char *msg=0, Int_t int2=0, Long64_t l64=0, Int_t int3=0, const char *opt=0)
 Send message to intermediate coordinator.
Int_t SendInterrupt (Int_t type)
 Send urgent message (interrupt) to remote server Returns 0 or -1 in case of error.
Int_t SendRaw (const void *buf, Int_t len, ESendRecvOptions opt=kDontBlock)
 Send a raw buffer of specified length.
void SendUrgent (Int_t type, Int_t int1, Int_t int2)
 Send urgent message to counterpart; 'type' specifies the type of the message (see TXSocket::EUrgentMsgType), and 'int1', 'int2' two containers for additional information.
void SetAWait (Bool_t w=kTRUE)
void SetInterrupt (Bool_t i=kTRUE)
Int_t SetOption (ESockOptions, Int_t)
 Set socket options.
void SetSendOpt (ESendRecvOptions o)
void SetSessionID (Int_t id)
 Set session ID to 'id'. If id < 0, disable also the asynchronous handler.
- Public Member Functions inherited from TSocket
 TSocket (const char *host, const char *service, Int_t tcpwindowsize=-1)
 Create a socket.
 TSocket (const char *host, Int_t port, Int_t tcpwindowsize=-1)
 Create a socket; see CreateAuthSocket for the form of url.
 TSocket (const char *sockpath)
 Create a socket in the Unix domain on 'sockpath'.
 TSocket (const TSocket &s)
 TSocket copy ctor.
 TSocket (Int_t descriptor)
 Create a socket.
 TSocket (Int_t descriptor, const char *sockpath)
 Create a socket.
 TSocket (TInetAddress address, const char *service, Int_t tcpwindowsize=-1)
 Create a socket.
 TSocket (TInetAddress address, Int_t port, Int_t tcpwindowsize=-1)
 Create a socket.
virtual ~TSocket ()
UInt_t GetBytesRecv () const
UInt_t GetBytesSent () const
Int_t GetCompressionAlgorithm () const
Int_t GetCompressionLevel () const
Int_t GetCompressionSettings () const
virtual Int_t GetDescriptor () const
Int_t GetErrorCode () const
 Returns error code.
TInetAddress GetInetAddress () const
TTimeStamp GetLastUsage ()
virtual TInetAddress GetLocalInetAddress ()
 Return internet address of local host to which the socket is bound.
virtual Int_t GetLocalPort ()
 Return the local port # to which the socket is bound.
virtual Int_t GetOption (ESockOptions opt, Int_t &val)
 Get socket options. Returns -1 in case of error.
Int_t GetPort () const
Int_t GetRemoteProtocol () const
TSecContextGetSecContext () const
const char * GetService () const
Int_t GetServType () const
Int_t GetTcpWindowSize () const
const char * GetUrl () const
virtual Bool_t IsAuthenticated () const
virtual Int_t Select (Int_t interest=kRead, Long_t timeout=-1)
 Waits for this socket to change status.
virtual Int_t SendObject (const TObject *obj, Int_t kind=kMESS_OBJECT)
 Send an object.
void SetCompressionAlgorithm (Int_t algorithm=ROOT::RCompressionSetting::EAlgorithm::kUseGlobal)
 See comments for function SetCompressionSettings.
void SetCompressionLevel (Int_t level=ROOT::RCompressionSetting::ELevel::kUseMin)
 See comments for function SetCompressionSettings.
void SetCompressionSettings (Int_t settings=ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault)
 Used to specify the compression level and algorithm: settings = 100 * algorithm + level.
void SetRemoteProtocol (Int_t rproto)
void SetSecContext (TSecContext *ctx)
void SetService (const char *service)
void SetServType (Int_t st)
void SetUrl (const char *url)
void Touch ()
- Public Member Functions inherited from TNamed
 TNamed ()
 TNamed (const char *name, const char *title)
 TNamed (const TNamed &named)
 TNamed copy ctor.
 TNamed (const TString &name, const TString &title)
virtual ~TNamed ()
 TNamed destructor.
virtual void Clear (Option_t *option="")
 Set name and title to empty strings ("").
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 two TNamed objects.
virtual void Copy (TObject &named) const
 Copy this to obj.
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
virtual const char * GetName () const
 Returns name of object.
virtual const char * GetTitle () const
 Returns title of object.
virtual ULong_t Hash () const
 Return hash value for this object.
virtual Bool_t IsSortable () const
virtual void ls (Option_t *option="") const
 List TNamed name and title.
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator.
virtual void Print (Option_t *option="") const
 Print TNamed name and title.
virtual void SetName (const char *name)
 Set the name of the TNamed.
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title).
virtual void SetTitle (const char *title="")
 Set the title of the TNamed.
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject.
- 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 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 for instance with: gROOT->SetSelectedPad(gPad).
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=0)
 Execute method on this object with the given parameter string, e.g.
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 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 char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
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.
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)
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
R__ALWAYS_INLINE Bool_t IsZombie () const
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.
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 [].
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.
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.
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=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
- Public Member Functions inherited from XrdClientAbsUnsolMsgHandler
virtual ~XrdClientAbsUnsolMsgHandler ()

Private Attributes

std::list< Int_tfClientIDs


class TXProofServ

Additional Inherited Members

- Public Types inherited from TXSocket
enum  EUrgentMsgType { kStopProcess = 2000 }
- Public Types inherited from TSocket
enum  EInterest { kRead = 1 , kWrite = 2 }
enum  EServiceType { kSOCKD , kROOTD , kPROOFD }
enum  EStatusBits { kIsUnix = BIT(16) , kBrokenConn = BIT(17) }
- 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)
- Static Public Member Functions inherited from TSocket
static TSocketCreateAuthSocket (const char *url, Int_t size=0, Int_t tcpwindowsize=-1, TSocket *s=0, Int_t *err=0)
 Creates a socket or a parallel socket and authenticates to the remote server.
static TSocketCreateAuthSocket (const char *user, const char *host, Int_t port, Int_t size=0, Int_t tcpwindowsize=-1, TSocket *s=0, Int_t *err=0)
 Creates a socket or a parallel socket and authenticates to the remote server specified in 'url' on remote 'port' as 'user'.
static Int_t GetClientProtocol ()
 Static method returning supported client protocol.
static ULong64_t GetSocketBytesRecv ()
 Get total number of bytes received via all sockets.
static ULong64_t GetSocketBytesSent ()
 Get total number of bytes sent via all sockets.
static void NetError (const char *where, Int_t error)
 Print error string depending on error code.
- Static Public Member Functions inherited from TObject
static Long_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.
- Protected Types inherited from TSocket
enum  ESocketErrors { kInvalid = -1 , kInvalidStillInList = -2 }
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = BIT(3) }
- Protected Member Functions inherited from TSocket
 TSocket ()
Bool_t Authenticate (const char *user)
 Authenticated the socket with specified user.
void MarkBrokenConnection ()
 Close the socket and mark as due to a broken connection.
Bool_t RecvProcessIDs (TMessage *mess)
 Receive a message containing process ids.
Bool_t RecvStreamerInfos (TMessage *mess)
 Receive a message containing streamer infos.
void SendProcessIDs (const TMessage &mess)
 Check if TProcessIDs must be sent.
void SendStreamerInfos (const TMessage &mess)
 Check if TStreamerInfo must be sent.
void SetDescriptor (Int_t desc)
- Protected Member Functions inherited from TObject
void MakeZombie ()
- Protected Attributes inherited from TSocket
TInetAddress fAddress
TBits fBitsInfo
UInt_t fBytesRecv
UInt_t fBytesSent
Int_t fCompress
TTimeStamp fLastUsage
TInetAddress fLocalAddress
Int_t fRemoteProtocol
TString fService
EServiceType fServType
Int_t fSocket
Int_t fTcpWindowSize
TString fUrl
- Protected Attributes inherited from TNamed
TString fName
TString fTitle
- Static Protected Attributes inherited from TSocket
static ULong64_t fgBytesRecv = 0
static ULong64_t fgBytesSent = 0
static Int_t fgClientProtocol = 17

#include <TXUnixSocket.h>

Inheritance diagram for TXUnixSocket:

Constructor & Destructor Documentation

◆ TXUnixSocket()

TXUnixSocket::TXUnixSocket ( const char *  u,
Int_t  psid = -1,
Char_t  ver = -1,
TXHandler handler = 0,
int  fd = -1 


Definition at line 32 of file TXUnixSocket.cxx.

◆ ~TXUnixSocket()

virtual TXUnixSocket::~TXUnixSocket ( )

Definition at line 39 of file TXUnixSocket.h.

Member Function Documentation

◆ GetClientID()

Int_t TXUnixSocket::GetClientID ( ) const

Reimplemented from TXSocket.

Definition at line 41 of file TXUnixSocket.h.

◆ GetClientIDSize()

Int_t TXUnixSocket::GetClientIDSize ( ) const

Reimplemented from TXSocket.

Definition at line 42 of file TXUnixSocket.h.

◆ Reconnect()

Int_t TXUnixSocket::Reconnect ( )

Try reconnection after failure.

Reimplemented from TXSocket.

Definition at line 65 of file TXUnixSocket.cxx.

◆ RemoveClientID()

void TXUnixSocket::RemoveClientID ( )

Reimplemented from TXSocket.

Definition at line 44 of file TXUnixSocket.h.

◆ SetClientID()

void TXUnixSocket::SetClientID ( Int_t  cid)

Reimplemented from TXSocket.

Definition at line 45 of file TXUnixSocket.h.

Friends And Related Symbol Documentation

◆ TXProofServ

friend class TXProofServ

Definition at line 31 of file TXUnixSocket.h.

Member Data Documentation

◆ fClientIDs

std::list<Int_t> TXUnixSocket::fClientIDs

Definition at line 34 of file TXUnixSocket.h.

  • proof/proofx/inc/TXUnixSocket.h
  • proof/proofx/src/TXUnixSocket.cxx