Definition at line 61 of file TSocket.h.

Public Types
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) }

Public Member Functions
	TSocket (const char host, const char service, Int_t tcpwindowsize=-1)
	Create a socket. More...

	TSocket (const char *host, Int_t port, Int_t tcpwindowsize=-1)
	Create a socket; see CreateAuthSocket for the form of url. More...

	TSocket (const char *sockpath)
	Create a socket in the Unix domain on 'sockpath'. More...

	TSocket (const TSocket &s)
	TSocket copy ctor. More...

	TSocket (Int_t descriptor)
	Create a socket. More...

	TSocket (Int_t descriptor, const char *sockpath)
	Create a socket. More...

	TSocket (TInetAddress address, const char *service, Int_t tcpwindowsize=-1)
	Create a socket. More...

	TSocket (TInetAddress address, Int_t port, Int_t tcpwindowsize=-1)
	Create a socket. More...

virtual	~TSocket ()

virtual void	Close (Option_t *opt="")
	Close the socket. More...

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

TInetAddress	GetInetAddress () const

TTimeStamp	GetLastUsage ()

virtual TInetAddress	GetLocalInetAddress ()
	Return internet address of local host to which the socket is bound. More...

virtual Int_t	GetLocalPort ()
	Return the local port # to which the socket is bound. More...

virtual Int_t	GetOption (ESockOptions opt, Int_t &val)
	Get socket options. Returns -1 in case of error. More...

Int_t	GetPort () const

Int_t	GetRemoteProtocol () const

TSecContext *	GetSecContext () const

const char *	GetService () const

Int_t	GetServType () const

Int_t	GetTcpWindowSize () const

const char *	GetUrl () const

virtual Bool_t	IsAuthenticated () const

virtual Bool_t	IsValid () const

virtual Int_t	Reconnect ()

virtual Int_t	Recv (char *mess, Int_t max)
	Receive a character string message of maximum max length. More...

virtual Int_t	Recv (char *mess, Int_t max, Int_t &kind)
	Receive a character string message of maximum max length. More...

virtual Int_t	Recv (Int_t &status, Int_t &kind)
	Receives a status and a message type. More...

virtual Int_t	Recv (TMessage *&mess)
	Receive a TMessage object. More...

virtual Int_t	RecvRaw (void *buffer, Int_t length, ESendRecvOptions opt=kDefault)
	Receive a raw buffer of specified length bytes. More...

virtual Int_t	Select (Int_t interest=kRead, Long_t timeout=-1)
	Waits for this socket to change status. More...

virtual Int_t	Send (const char *mess, Int_t kind=kMESS_STRING)
	Send a character string buffer. More...

virtual Int_t	Send (const TMessage &mess)
	Send a TMessage object. More...

virtual Int_t	Send (Int_t kind)
	Send a single message opcode. More...

virtual Int_t	Send (Int_t status, Int_t kind)
	Send a status and a single message opcode. More...

virtual Int_t	SendObject (const TObject *obj, Int_t kind=kMESS_OBJECT)
	Send an object. More...

virtual Int_t	SendRaw (const void *buffer, Int_t length, ESendRecvOptions opt=kDefault)
	Send a raw buffer of specified length. More...

void	SetCompressionAlgorithm (Int_t algorithm=ROOT::RCompressionSetting::EAlgorithm::kUseGlobal)
	See comments for function SetCompressionSettings. More...

void	SetCompressionLevel (Int_t level=ROOT::RCompressionSetting::ELevel::kUseMin)
	See comments for function SetCompressionSettings. More...

void	SetCompressionSettings (Int_t settings=ROOT::RCompressionSetting::EDefaults::kUseGeneralPurpose)
	Used to specify the compression level and algorithm: settings = 100 * algorithm + level. More...

virtual Int_t	SetOption (ESockOptions opt, Int_t val)
	Set socket options. More...

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

	TNamed (const TString &name, const TString &title)

virtual	~TNamed ()
	TNamed destructor. More...

virtual void	Clear (Option_t *option="")
	Set name and title to empty strings (""). More...

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility. More...

virtual Int_t	Compare (const TObject *obj) const
	Compare two TNamed objects. More...

virtual void	Copy (TObject &named) const
	Copy this to obj. More...

virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer. More...

virtual const char *	GetName () const
	Returns name of object. More...

virtual const char *	GetTitle () const
	Returns title of object. More...

virtual ULong_t	Hash () const
	Return hash value for this object. More...

virtual Bool_t	IsSortable () const

virtual void	ls (Option_t *option="") const
	List TNamed name and title. More...

TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator. More...

virtual void	Print (Option_t *option="") const
	Print TNamed name and title. More...

virtual void	SetName (const char *name)
	Set the name of the TNamed. More...

virtual void	SetNameTitle (const char name, const char title)
	Set all the TNamed parameters (name and title). More...

virtual void	SetTitle (const char *title="")
	Set the title of the TNamed. More...

virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject. 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 TObject *	Clone (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 TObject *	DrawClone (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 TObject *	FindObject (const char *name) const
	Must be redefined in derived classes. More...

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes. More...

virtual Option_t *	GetDrawOption () 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_t *	GetOption () 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...

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)

TObject &	operator= (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...

Static Public Member Functions
static TSocket *	CreateAuthSocket (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. More...

static TSocket *	CreateAuthSocket (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'. More...

static Int_t	GetClientProtocol ()
	Static method returning supported client protocol. More...

static ULong64_t	GetSocketBytesRecv ()
	Get total number of bytes received via all sockets. More...

static ULong64_t	GetSocketBytesSent ()
	Get total number of bytes sent via all sockets. More...

static void	NetError (const char *where, Int_t error)
	Print error string depending on error code. More...

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

Protected Types
enum	ESocketErrors { kInvalid = -1 , kInvalidStillInList = -2 }

Protected Member Functions
	TSocket ()

Bool_t	Authenticate (const char *user)
	Authenticated the socket with specified user. More...

void	MarkBrokenConnection ()
	Close the socket and mark as due to a broken connection. More...

Bool_t	RecvProcessIDs (TMessage *mess)
	Receive a message containing process ids. More...

Bool_t	RecvStreamerInfos (TMessage *mess)
	Receive a message containing streamer infos. More...

void	SendProcessIDs (const TMessage &mess)
	Check if TProcessIDs must be sent. More...

void	SendStreamerInfos (const TMessage &mess)
	Check if TStreamerInfo must be sent. More...

void	SetDescriptor (Int_t desc)

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 Attributes
TInetAddress	fAddress

TBits	fBitsInfo

UInt_t	fBytesRecv

UInt_t	fBytesSent

Int_t	fCompress

TTimeStamp	fLastUsage

TVirtualMutex *	fLastUsageMtx

TInetAddress	fLocalAddress

Int_t	fRemoteProtocol

TSecContext *	fSecContext

TString	fService

EServiceType	fServType

Int_t	fSocket

Int_t	fTcpWindowSize

TString	fUrl

TList *	fUUIDs

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Static Protected Attributes
static ULong64_t	fgBytesRecv = 0

static ULong64_t	fgBytesSent = 0

static Int_t	fgClientProtocol = 17

Private Member Functions
Option_t *	GetOption () const

TSocket &	operator= (const TSocket &)

Friends
class	TProofServ

class	TServerSocket

class	TSlave

#include <TSocket.h>

Inheritance diagram for TSocket:

[legend]

Member Enumeration Documentation

◆ EInterest

enum TSocket::EInterest

Enumerator
kRead
kWrite

Definition at line 71 of file TSocket.h.

◆ EServiceType

enum TSocket::EServiceType

Enumerator
kSOCKD
kROOTD
kPROOFD

Definition at line 72 of file TSocket.h.

◆ ESocketErrors

enum TSocket::ESocketErrors

protected

Enumerator
kInvalid
kInvalidStillInList

Definition at line 75 of file TSocket.h.

◆ EStatusBits

enum TSocket::EStatusBits

Enumerator
kIsUnix
kBrokenConn

Definition at line 68 of file TSocket.h.

Constructor & Destructor Documentation

◆ TSocket() [1/9]

TSocket::TSocket ( )

inlineprotected

Definition at line 103 of file TSocket.h.

◆ TSocket() [2/9]

TSocket::TSocket	(	TInetAddress	addr,
		const char *	service,
		Int_t	tcpwindowsize = `-1`
	)

Create a socket.

Connect to the named service at address addr. Use tcpwindowsize to specify the size of the receive buffer, it has to be specified here to make sure the window scale option is set (for tcpwindowsize > 65KB and for platforms supporting window scaling). Returns when connection has been accepted by remote side. Use IsValid() to check the validity of the socket. Every socket is added to the TROOT sockets list which will make sure that any open sockets are properly closed on program termination.

Definition at line 77 of file TSocket.cxx.

◆ TSocket() [3/9]

TSocket::TSocket	(	TInetAddress	addr,
		Int_t	port,
		Int_t	tcpwindowsize = `-1`
	)

Create a socket.

Connect to the specified port # at address addr. Use tcpwindowsize to specify the size of the receive buffer, it has to be specified here to make sure the window scale option is set (for tcpwindowsize > 65KB and for platforms supporting window scaling). Returns when connection has been accepted by remote side. Use IsValid() to check the validity of the socket. Every socket is added to the TROOT sockets list which will make sure that any open sockets are properly closed on program termination.

Definition at line 122 of file TSocket.cxx.

◆ TSocket() [4/9]

TSocket::TSocket	(	const char *	host,
		const char *	service,
		Int_t	tcpwindowsize = `-1`
	)

Create a socket.

Connect to named service on the remote host. Use tcpwindowsize to specify the size of the receive buffer, it has to be specified here to make sure the window scale option is set (for tcpwindowsize > 65KB and for platforms supporting window scaling). Returns when connection has been accepted by remote side. Use IsValid() to check the validity of the socket. Every socket is added to the TROOT sockets list which will make sure that any open sockets are properly closed on program termination.

Definition at line 165 of file TSocket.cxx.

◆ TSocket() [5/9]

TSocket::TSocket	(	const char *	url,
		Int_t	port,
		Int_t	tcpwindowsize = `-1`
	)

Create a socket; see CreateAuthSocket for the form of url.

Connect to the specified port # on the remote host. If user is specified in url, try authentication as user. Use tcpwindowsize to specify the size of the receive buffer, it has to be specified here to make sure the window scale option is set (for tcpwindowsize > 65KB and for platforms supporting window scaling). Returns when connection has been accepted by remote side. Use IsValid() to check the validity of the socket. Every socket is added to the TROOT sockets list which will make sure that any open sockets are properly closed on program termination.

Definition at line 210 of file TSocket.cxx.

◆ TSocket() [6/9]

TSocket::TSocket ( const char * sockpath )

Create a socket in the Unix domain on 'sockpath'.

Returns when connection has been accepted by the server. Use IsValid() to check the validity of the socket. Every socket is added to the TROOT sockets list which will make sure that any open sockets are properly closed on program termination.

Definition at line 253 of file TSocket.cxx.

◆ TSocket() [7/9]

TSocket::TSocket ( Int_t desc )

Create a socket.

The socket will adopt previously opened TCP socket with descriptor desc.

Definition at line 285 of file TSocket.cxx.

◆ TSocket() [8/9]

TSocket::TSocket	(	Int_t	desc,
		const char *	sockpath
	)

Create a socket.

The socket will adopt previously opened Unix socket with descriptor desc. The sockpath arg is for info purposes only. Use this method to adopt e.g. a socket created via socketpair().

Definition at line 314 of file TSocket.cxx.

◆ TSocket() [9/9]

TSocket::TSocket ( const TSocket & s )

TSocket copy ctor.

Definition at line 347 of file TSocket.cxx.

◆ ~TSocket()

virtual TSocket::~TSocket ( )

inlinevirtual

Definition at line 129 of file TSocket.h.

Member Function Documentation

◆ Authenticate()

Bool_t TSocket::Authenticate ( const char * user )

protected

Authenticated the socket with specified user.

Definition at line 1105 of file TSocket.cxx.

◆ Close()

void TSocket::Close ( Option_t * option = "" )

virtual

Close the socket.

If option is "force", calls shutdown(id,2) to shut down the connection. This will close the connection also for the parent of this process. Also called via the dtor (without option "force", call explicitly Close("force") if this is desired).

Reimplemented in TPSocket, TXSocket, and TSSLSocket.

Definition at line 389 of file TSocket.cxx.

◆ CreateAuthSocket() [1/2]

TSocket * TSocket::CreateAuthSocket	(	const char *	url,
		Int_t	size = `0`,
		Int_t	tcpwindowsize = `-1`,
		TSocket *	opensock = `0`,
		Int_t *	err = `0`
	)

static

Creates a socket or a parallel socket and authenticates to the remote server.

url: [[proto][p][auth]://][user@]host[:port][/service][?options]

where proto = "sockd", "rootd", "proofd" indicates the type of remote server; if missing "sockd" is assumed ("sockd" indicates any remote server session using TServerSocket) [p] = for parallel sockets (forced internally for rootd; ignored for proofd) [auth] = "up", "s", "k", "g", "h", "ug" to force UsrPwd, SRP, Krb5, Globus, SSH or UidGid authentication [port] = is the remote port number [service] = service name used to determine the port (for backward compatibility, specification of port as priority) options = "m" or "s", when proto=proofd indicates whether we are master or slave (used internally by TSlave)

An already opened connection can be used by passing its socket in opensock.

If 'err' is defined, '*err' on return from a failed call contains an error code (see NetErrors.h).

Example:

TSocket::CreateAuthSocket("rootds://qwerty@machine.fq.dn:5051")

creates an authenticated socket to a rootd server running on remote machine machine.fq.dn on port 5051; "parallel" sockets are forced internally because rootd expects parallel sockets; however a simple socket will be created in this case because the size is 0 (the default); authentication will attempt protocol SRP first.

TSocket::CreateAuthSocket("pk://qwerty@machine.fq.dn:5052",3)

creates an authenticated parallel socket of size 3 to a sockd server running on remote machine machine.fq.dn on port 5052; authentication will attempt protocol Kerberos first.

NB: may hang if the remote server is not of the correct type; at present TSocket has no way to find out the type of the remote server automatically

Returns pointer to an authenticated socket or 0 if creation or authentication is unsuccessful.

Definition at line 1299 of file TSocket.cxx.

◆ CreateAuthSocket() [2/2]

TSocket * TSocket::CreateAuthSocket	(	const char *	user,
		const char *	url,
		Int_t	port,
		Int_t	size = `0`,
		Int_t	tcpwindowsize = `-1`,
		TSocket *	opensock = `0`,
		Int_t *	err = `0`
	)

static

Creates a socket or a parallel socket and authenticates to the remote server specified in 'url' on remote 'port' as 'user'.

url: [[proto][p][auth]://]host[/?options]

where proto = "sockd", "rootd", "proofd" indicates the type of remote server if missing "sockd" is assumed ("sockd" indicates any remote server session using TServerSocket) [p] = for parallel sockets (forced internally for rootd) [auth] = "up", "s", "k", "g", "h", "ug" to force UsrPwd, SRP, Krb5, Globus, SSH or UidGid authentication [options] = "m" or "s", when proto=proofd indicates whether we are master or slave (used internally by TSlave)

An already opened connection can be used by passing its socket in opensock.

If 'err' is defined, '*err' on return from a failed call contains an error code (see NetErrors.h).

Example:

TSocket::CreateAuthSocket("qwerty","rootdps://machine.fq.dn",5051)

creates an authenticated socket to a rootd server running on remote machine machine.fq.dn on port 5051; "parallel" sockets are forced internally because rootd expects parallel sockets; however a simple socket will be created in this case because the size is 0 (the default); authentication will attempt protocol SRP first.

TSocket::CreateAuthSocket("qwerty","pk://machine.fq.dn:5052",3)

creates an authenticated parallel socket of size 3 to a sockd server running on remote machine machine.fq.dn on port 5052; authentication will attempt protocol Kerberos first.

NB: may hang if the remote server is not of the correct type; at present TSocket has no way to find out the type of the remote server automatically

Returns pointer to an authenticated socket or 0 if creation or authentication is unsuccessful.

Definition at line 1451 of file TSocket.cxx.

◆ GetBytesRecv()

UInt_t TSocket::GetBytesRecv ( ) const

inline

Definition at line 140 of file TSocket.h.

◆ GetBytesSent()

UInt_t TSocket::GetBytesSent ( ) const

inline

Definition at line 139 of file TSocket.h.

◆ GetClientProtocol()

Int_t TSocket::GetClientProtocol ( )

static

Static method returning supported client protocol.

Definition at line 1488 of file TSocket.cxx.

◆ GetCompressionAlgorithm()

Int_t TSocket::GetCompressionAlgorithm ( ) const

inline

Definition at line 195 of file TSocket.h.

◆ GetCompressionLevel()

Int_t TSocket::GetCompressionLevel ( ) const

inline

Definition at line 201 of file TSocket.h.

◆ GetCompressionSettings()

Int_t TSocket::GetCompressionSettings ( ) const

inline

Definition at line 207 of file TSocket.h.

◆ GetDescriptor()

virtual Int_t TSocket::GetDescriptor ( ) const

inlinevirtual

Reimplemented in TPSocket.

Definition at line 132 of file TSocket.h.

◆ GetErrorCode()

Int_t TSocket::GetErrorCode ( ) const

Returns error code.

Meaning depends on context where it is called. If no error condition returns 0 else a value < 0. For example see TServerSocket ctor.

Definition at line 1034 of file TSocket.cxx.

◆ GetInetAddress()

TInetAddress TSocket::GetInetAddress ( ) const

inline

Definition at line 133 of file TSocket.h.

◆ GetLastUsage()

TTimeStamp TSocket::GetLastUsage ( )

inline

Definition at line 149 of file TSocket.h.

◆ GetLocalInetAddress()

TInetAddress TSocket::GetLocalInetAddress ( )

virtual

Return internet address of local host to which the socket is bound.

In case of error TInetAddress::IsValid() returns kFALSE.

Reimplemented in TPSocket, and TServerSocket.

Definition at line 409 of file TSocket.cxx.

◆ GetLocalPort()

Int_t TSocket::GetLocalPort ( )

virtual

Return the local port # to which the socket is bound.

In case of error return -1.

Reimplemented in TServerSocket.

Definition at line 423 of file TSocket.cxx.

◆ GetOption() [1/2]

Option_t * TSocket::GetOption ( ) const

inlineprivatevirtual

Reimplemented from TObject.

Definition at line 118 of file TSocket.h.

◆ GetOption() [2/2]

Int_t TSocket::GetOption	(	ESockOptions	opt,
		Int_t &	val
	)

virtual

Get socket options. Returns -1 in case of error.

Reimplemented in TPSocket.

Definition at line 1022 of file TSocket.cxx.

◆ GetPort()

Int_t TSocket::GetPort ( ) const

inline

Definition at line 135 of file TSocket.h.

◆ GetRemoteProtocol()

Int_t TSocket::GetRemoteProtocol ( ) const

inline

Definition at line 146 of file TSocket.h.

◆ GetSecContext()

TSecContext * TSocket::GetSecContext ( ) const

inline

Definition at line 147 of file TSocket.h.

◆ GetService()

const char * TSocket::GetService ( ) const

inline

Definition at line 136 of file TSocket.h.

◆ GetServType()

Int_t TSocket::GetServType ( ) const

inline

Definition at line 137 of file TSocket.h.

◆ GetSocketBytesRecv()

ULong64_t TSocket::GetSocketBytesRecv ( )

static

Get total number of bytes received via all sockets.

Definition at line 1516 of file TSocket.cxx.

◆ GetSocketBytesSent()

ULong64_t TSocket::GetSocketBytesSent ( )

static

Get total number of bytes sent via all sockets.

Definition at line 1508 of file TSocket.cxx.

◆ GetTcpWindowSize()

Int_t TSocket::GetTcpWindowSize ( ) const

inline

Definition at line 148 of file TSocket.h.

◆ GetUrl()

const char * TSocket::GetUrl ( ) const

inline

Definition at line 150 of file TSocket.h.

◆ IsAuthenticated()

virtual Bool_t TSocket::IsAuthenticated ( ) const

inlinevirtual

Definition at line 151 of file TSocket.h.

◆ IsValid()

virtual Bool_t TSocket::IsValid ( ) const

inlinevirtual

Reimplemented in TPSocket, and TXSocket.

Definition at line 152 of file TSocket.h.

◆ MarkBrokenConnection()

void TSocket::MarkBrokenConnection ( )

protected

Close the socket and mark as due to a broken connection.

Definition at line 371 of file TSocket.cxx.

◆ NetError()

void TSocket::NetError	(	const char *	where,
		Int_t	error
	)

static

Print error string depending on error code.

Definition at line 1496 of file TSocket.cxx.

◆ operator=()

TSocket & TSocket::operator= ( const TSocket & )

private

◆ Reconnect()

virtual Int_t TSocket::Reconnect ( )

inlinevirtual

Reimplemented in TXSocket, and TXUnixSocket.

Definition at line 158 of file TSocket.h.

◆ Recv() [1/4]

Int_t TSocket::Recv	(	char *	str,
		Int_t	max
	)

virtual

Receive a character string message of maximum max length.

The expected message must be of type kMESS_STRING. Returns length of received string (can be 0 if otherside of connection is closed) or -1 in case of error or -4 in case a non-blocking socket would block (i.e. there is nothing to be read).

Reimplemented in TServerSocket, TPSocket, TSSLSocket, and TXSocket.

Definition at line 727 of file TSocket.cxx.

◆ Recv() [2/4]

Int_t TSocket::Recv	(	char *	str,
		Int_t	max,
		Int_t &	kind
	)

virtual

Receive a character string message of maximum max length.

Returns in kind the message type. Returns length of received string+4 (can be 0 if other side of connection is closed) or -1 in case of error or -4 in case a non-blocking socket would block (i.e. there is nothing to be read).

Reimplemented in TServerSocket, TPSocket, TSSLSocket, and TXSocket.

Definition at line 755 of file TSocket.cxx.

◆ Recv() [3/4]

Int_t TSocket::Recv	(	Int_t &	status,
		Int_t &	kind
	)

virtual

Receives a status and a message type.

Returns length of received integers, 2*sizeof(Int_t) (can be 0 if other side of connection is closed) or -1 in case of error or -4 in case a non-blocking socket would block (i.e. there is nothing to be read).

Reimplemented in TServerSocket, TPSocket, TSSLSocket, and TXSocket.

Definition at line 788 of file TSocket.cxx.

◆ Recv() [4/4]

Int_t TSocket::Recv ( TMessage *& mess )

virtual

Receive a TMessage object.

The user must delete the TMessage object. Returns length of message in bytes (can be 0 if other side of connection is closed) or -1 in case of error or -4 in case a non-blocking socket would block (i.e. there is nothing to be read) or -5 if pipe broken or reset by peer (EPIPE || ECONNRESET). In those case mess == 0.

Reimplemented in TServerSocket, TPSocket, TSSLSocket, and TXSocket.

Definition at line 817 of file TSocket.cxx.

◆ RecvProcessIDs()

Bool_t TSocket::RecvProcessIDs ( TMessage * mess )

protected

Receive a message containing process ids.

In case the message contains process ids they are imported, the message will be deleted and the method returns kTRUE.

Definition at line 974 of file TSocket.cxx.

◆ RecvRaw()

Int_t TSocket::RecvRaw	(	void *	buffer,
		Int_t	length,
		ESendRecvOptions	opt = `kDefault`
	)

virtual

Receive a raw buffer of specified length bytes.

Using option kPeek one can peek at incoming data. Returns number of received bytes. Returns -1 in case of error. In case of opt == kOob: -2 means EWOULDBLOCK and -3 EINVAL. In case of non-blocking mode (kNoBlock) -4 means EWOULDBLOCK. Returns -5 if pipe broken or reset by peer (EPIPE || ECONNRESET).

Reimplemented in TServerSocket, TXSocket, TPSocket, and TSSLSocket.

Definition at line 897 of file TSocket.cxx.

◆ RecvStreamerInfos()

Bool_t TSocket::RecvStreamerInfos ( TMessage * mess )

protected

Receive a message containing streamer infos.

In case the message contains streamer infos they are imported, the message will be deleted and the method returns kTRUE.

Definition at line 927 of file TSocket.cxx.

◆ Select()

Int_t TSocket::Select	(	Int_t	interest = `kRead`,
		Long_t	timeout = `-1`
	)

virtual

Waits for this socket to change status.

If interest=kRead, the socket will be watched to see if characters become available for reading; if interest=kWrite the socket will be watched to see if a write will not block. The argument 'timeout' specifies a maximum time to wait in millisec. Default no timeout. Returns 1 if a change of status of interest has been detected within timeout; 0 in case of timeout; < 0 if an error occured.

Definition at line 443 of file TSocket.cxx.

◆ Send() [1/4]

Int_t TSocket::Send	(	const char *	str,
		Int_t	kind = `kMESS_STRING`
	)

virtual

Send a character string buffer.

Use kind to set the TMessage "what" field. Returns the number of bytes in the string str that were sent and -1 in case of error. In case the kind has been or'ed with kMESS_ACK, the call will only return after having received an acknowledgement, making the sending process synchronous.

Reimplemented in TServerSocket, TPSocket, TSSLSocket, and TXSocket.

Definition at line 500 of file TSocket.cxx.

◆ Send() [2/4]

Int_t TSocket::Send ( const TMessage & mess )

virtual

Send a TMessage object.

Returns the number of bytes in the TMessage that were sent and -1 in case of error. In case the TMessage::What has been or'ed with kMESS_ACK, the call will only return after having received an acknowledgement, making the sending process synchronous. Returns -4 in case of kNoBlock and errno == EWOULDBLOCK. Returns -5 if pipe broken or reset by peer (EPIPE || ECONNRESET). support for streaming TStreamerInfo added by Rene Brun May 2008 support for streaming TProcessID added by Rene Brun June 2008

Reimplemented in TServerSocket, TPSocket, TSSLSocket, and TXSocket.

Definition at line 522 of file TSocket.cxx.

◆ Send() [3/4]

Int_t TSocket::Send ( Int_t kind )

virtual

Send a single message opcode.

Use kind (opcode) to set the TMessage "what" field. Returns the number of bytes that were sent (always sizeof(Int_t)) and -1 in case of error. In case the kind has been or'ed with kMESS_ACK, the call will only return after having received an acknowledgement, making the sending process synchronous.

Reimplemented in TPSocket, TSSLSocket, TXSocket, and TServerSocket.

Definition at line 463 of file TSocket.cxx.

◆ Send() [4/4]

Int_t TSocket::Send	(	Int_t	status,
		Int_t	kind
	)

virtual

Send a status and a single message opcode.

Use kind (opcode) to set the TMessage "what" field. Returns the number of bytes that were sent (always 2*sizeof(Int_t)) and -1 in case of error. In case the kind has been or'ed with kMESS_ACK, the call will only return after having received an acknowledgement, making the sending process synchronous.

Reimplemented in TPSocket, TSSLSocket, TXSocket, and TServerSocket.

Definition at line 481 of file TSocket.cxx.

◆ SendObject()

Int_t TSocket::SendObject	(	const TObject *	obj,
		Int_t	kind = `kMESS_OBJECT`
	)

virtual

Send an object.

Returns the number of bytes sent and -1 in case of error. In case the "kind" has been or'ed with kMESS_ACK, the call will only return after having received an acknowledgement, making the sending synchronous.

Reimplemented in TServerSocket.

Definition at line 600 of file TSocket.cxx.

◆ SendProcessIDs()

void TSocket::SendProcessIDs ( const TMessage & mess )

protected

Check if TProcessIDs must be sent.

The list of TProcessIDs in the object in the message is found by looking in the TMessage bits. We send only the TProcessIDs not yet send on this socket.

Definition at line 684 of file TSocket.cxx.

◆ SendRaw()

Int_t TSocket::SendRaw	(	const void *	buffer,
		Int_t	length,
		ESendRecvOptions	opt = `kDefault`
	)

virtual

Send a raw buffer of specified length.

Using option kOob one can send OOB data. Returns the number of bytes sent or -1 in case of error. Returns -4 in case of kNoBlock and errno == EWOULDBLOCK. Returns -5 if pipe broken or reset by peer (EPIPE || ECONNRESET).

Reimplemented in TServerSocket, TXSocket, TPSocket, and TSSLSocket.

Definition at line 620 of file TSocket.cxx.

◆ SendStreamerInfos()

void TSocket::SendStreamerInfos ( const TMessage & mess )

protected

Check if TStreamerInfo must be sent.

The list of TStreamerInfo of classes in the object in the message is in the fInfos list of the message. We send only the TStreamerInfos not yet sent on this socket.

Definition at line 649 of file TSocket.cxx.

◆ SetCompressionAlgorithm()

void TSocket::SetCompressionAlgorithm ( Int_t algorithm = ROOT::RCompressionSetting::EAlgorithm::kUseGlobal )

See comments for function SetCompressionSettings.

Definition at line 1045 of file TSocket.cxx.

◆ SetCompressionLevel()

void TSocket::SetCompressionLevel ( Int_t level = ROOT::RCompressionSetting::ELevel::kUseMin )

See comments for function SetCompressionSettings.

Definition at line 1059 of file TSocket.cxx.

◆ SetCompressionSettings()

void TSocket::SetCompressionSettings ( Int_t settings = ROOT::RCompressionSetting::EDefaults::kUseGeneralPurpose )

Used to specify the compression level and algorithm: settings = 100 * algorithm + level.

level = 0, objects written to this file will not be compressed. level = 1, minimal compression level but fast. .... level = 9, maximal compression level but slower and might use more memory. (For the currently supported algorithms, the maximum level is 9) If compress is negative it indicates the compression level is not set yet.

The enumeration ROOT::RCompressionSetting::EAlgorithm associates each algorithm with a number. There is a utility function to help to set the value of the argument. For example, ROOT::CompressionSettings(ROOT::kLZMA, 1) will build an integer which will set the compression to use the LZMA algorithm and compression level 1. These are defined in the header file Compression.h.

Note that the compression settings may be changed at any time. The new compression settings will only apply to branches created or attached after the setting is changed and other objects written after the setting is changed.

Definition at line 1097 of file TSocket.cxx.

◆ SetDescriptor()

void TSocket::SetDescriptor ( Int_t desc )

inlineprotected

Definition at line 109 of file TSocket.h.

◆ SetOption()

Int_t TSocket::SetOption	(	ESockOptions	opt,
		Int_t	val
	)

virtual

Set socket options.

Reimplemented in TPSocket, and TXSocket.

Definition at line 1012 of file TSocket.cxx.

◆ SetRemoteProtocol()

void TSocket::SetRemoteProtocol ( Int_t rproto )

inline

Definition at line 171 of file TSocket.h.

◆ SetSecContext()

void TSocket::SetSecContext ( TSecContext * ctx )

inline

Definition at line 172 of file TSocket.h.

◆ SetService()

void TSocket::SetService ( const char * service )

inline

Definition at line 173 of file TSocket.h.

◆ SetServType()

void TSocket::SetServType ( Int_t st )

inline

Definition at line 174 of file TSocket.h.

◆ SetUrl()

void TSocket::SetUrl ( const char * url )

inline

Definition at line 175 of file TSocket.h.

◆ Touch()

void TSocket::Touch ( )

inline

Definition at line 177 of file TSocket.h.

Friends And Related Function Documentation

◆ TProofServ

friend class TProofServ

friend

Definition at line 64 of file TSocket.h.

◆ TServerSocket

friend class TServerSocket

friend

Definition at line 63 of file TSocket.h.

◆ TSlave

friend class TSlave

friend

Definition at line 65 of file TSocket.h.

Member Data Documentation

◆ fAddress

TInetAddress TSocket::fAddress

protected

Definition at line 79 of file TSocket.h.

◆ fBitsInfo

TBits TSocket::fBitsInfo

protected

Definition at line 92 of file TSocket.h.

◆ fBytesRecv

UInt_t TSocket::fBytesRecv

protected

Definition at line 80 of file TSocket.h.

◆ fBytesSent

UInt_t TSocket::fBytesSent

protected

Definition at line 81 of file TSocket.h.

◆ fCompress

Int_t TSocket::fCompress

protected

Definition at line 82 of file TSocket.h.

◆ fgBytesRecv

ULong64_t TSocket::fgBytesRecv = 0

staticprotected

Definition at line 98 of file TSocket.h.

◆ fgBytesSent

ULong64_t TSocket::fgBytesSent = 0

staticprotected

Definition at line 99 of file TSocket.h.

◆ fgClientProtocol

Int_t TSocket::fgClientProtocol = 17

staticprotected

Definition at line 101 of file TSocket.h.

◆ fLastUsage

TTimeStamp TSocket::fLastUsage

protected

Definition at line 96 of file TSocket.h.

◆ fLastUsageMtx

TVirtualMutex* TSocket::fLastUsageMtx

protected

Definition at line 95 of file TSocket.h.

◆ fLocalAddress

TInetAddress TSocket::fLocalAddress

protected

Definition at line 83 of file TSocket.h.

◆ fRemoteProtocol

Int_t TSocket::fRemoteProtocol

protected

Definition at line 84 of file TSocket.h.

◆ fSecContext

TSecContext* TSocket::fSecContext

protected

Definition at line 85 of file TSocket.h.

◆ fService

TString TSocket::fService

protected

Definition at line 87 of file TSocket.h.

◆ fServType

EServiceType TSocket::fServType

protected

Definition at line 88 of file TSocket.h.

◆ fSocket

Int_t TSocket::fSocket

protected

Definition at line 89 of file TSocket.h.

◆ fTcpWindowSize

Int_t TSocket::fTcpWindowSize

protected

Definition at line 90 of file TSocket.h.

◆ fUrl

TString TSocket::fUrl

protected

Definition at line 91 of file TSocket.h.

◆ fUUIDs

TList* TSocket::fUUIDs

protected

Definition at line 93 of file TSocket.h.

Libraries for TSocket:

[legend]

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Friends

Member Enumeration Documentation

◆ EInterest

◆ EServiceType

◆ ESocketErrors

◆ EStatusBits

Constructor & Destructor Documentation

◆ TSocket() [1/9]

◆ TSocket() [2/9]

◆ TSocket() [3/9]

◆ TSocket() [4/9]

◆ TSocket() [5/9]

◆ TSocket() [6/9]

◆ TSocket() [7/9]

◆ TSocket() [8/9]

◆ TSocket() [9/9]

◆ ~TSocket()

Member Function Documentation

◆ Authenticate()

◆ Close()

◆ CreateAuthSocket() [1/2]

◆ CreateAuthSocket() [2/2]

◆ GetBytesRecv()

◆ GetBytesSent()

◆ GetClientProtocol()

◆ GetCompressionAlgorithm()

◆ GetCompressionLevel()

◆ GetCompressionSettings()

◆ GetDescriptor()

◆ GetErrorCode()

◆ GetInetAddress()

◆ GetLastUsage()

◆ GetLocalInetAddress()

◆ GetLocalPort()

◆ GetOption() [1/2]

◆ GetOption() [2/2]

◆ GetPort()

◆ GetRemoteProtocol()

◆ GetSecContext()

◆ GetService()

◆ GetServType()

◆ GetSocketBytesRecv()

◆ GetSocketBytesSent()

◆ GetTcpWindowSize()

◆ GetUrl()

◆ IsAuthenticated()

◆ IsValid()

◆ MarkBrokenConnection()

◆ NetError()

◆ operator=()

◆ Reconnect()

◆ Recv() [1/4]

◆ Recv() [2/4]

◆ Recv() [3/4]

◆ Recv() [4/4]

◆ RecvProcessIDs()

◆ RecvRaw()

◆ RecvStreamerInfos()

◆ Select()

◆ Send() [1/4]

◆ Send() [2/4]

◆ Send() [3/4]

◆ Send() [4/4]

◆ SendObject()

◆ SendProcessIDs()

◆ SendRaw()

◆ SendStreamerInfos()

◆ SetCompressionAlgorithm()

◆ SetCompressionLevel()

◆ SetCompressionSettings()

◆ SetDescriptor()

◆ SetOption()