TPServerSocket Class Reference

Definition at line 33 of file TPServerSocket.h.

Public Member Functions
	TPServerSocket (const char *service, Bool_t reuse=kFALSE, Int_t backlog=kDefaultBacklog, Int_t tcpwindowsize=-1)
	Create a parallel server socket object for a named service.
	TPServerSocket (Int_t port, Bool_t reuse=kFALSE, Int_t backlog=kDefaultBacklog, Int_t tcpwindowsize=-1)
	Create a parallel server socket object on a specified port.
virtual	~TPServerSocket ()
virtual TSocket *	Accept (UChar_t Opt=kSrvNoAuth)
	Accept a connection on a parallel server socket.
Public Member Functions inherited from TServerSocket
	TServerSocket (const char *service, Bool_t reuse=kFALSE, Int_t backlog=kDefaultBacklog, Int_t tcpwindowsize=-1)
	Create a server socket object for a named service.
	TServerSocket (Int_t port, Bool_t reuse=kFALSE, Int_t backlog=kDefaultBacklog, Int_t tcpwindowsize=-1)
	Create a server socket object on a specified port.
virtual	~TServerSocket ()
	Destructor: cleanup authentication stuff (if any) and close.
virtual TInetAddress	GetLocalInetAddress ()
	Return internet address of host to which the server socket is bound, i.e.
virtual Int_t	GetLocalPort ()
	Get port # to which server socket is bound. In case of error returns -1.
Int_t	Recv (char *, Int_t)
	Receive a character string message of maximum max length.
Int_t	Recv (char *, Int_t, Int_t &)
	Receive a character string message of maximum max length.
Int_t	Recv (Int_t &, Int_t &)
	Receives a status and a message type.
Int_t	Recv (TMessage *&)
	Receive a TMessage object.
Int_t	RecvRaw (void *, Int_t, ESendRecvOptions=kDefault)
	Receive a raw buffer of specified length bytes.
Int_t	Send (const char *, Int_t=kMESS_STRING)
	Send a character string buffer.
Int_t	Send (const TMessage &)
	Send a TMessage object.
Int_t	Send (Int_t)
	Send a single message opcode.
Int_t	Send (Int_t, Int_t)
	Send a status and a single message opcode.
Int_t	SendObject (const TObject *, Int_t=kMESS_OBJECT)
	Send an object.
Int_t	SendRaw (const void *, Int_t, ESendRecvOptions=kDefault)
	Send a raw buffer of specified length.
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 ()
virtual void	Close (Option_t *opt="")
	Close the socket.
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 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
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	Select (Int_t interest=kRead, Long_t timeout=-1)
	Waits for this socket to change status.
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.
virtual Int_t	SetOption (ESockOptions opt, Int_t val)
	Set socket options.
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 TObject *	Clone (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.
TNamed &	operator= (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 TObject *	DrawClone (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 TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.
virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.
virtual Option_t *	GetDrawOption () 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 [].
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.
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.

Private Member Functions
	TPServerSocket (const TPServerSocket &)
void	operator= (const TPServerSocket &)

Private Attributes
Int_t	fTcpWindowSize

Additional Inherited Members
Public Types inherited from TServerSocket
enum	{ kDefaultBacklog = 10 }
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 TServerSocket
static UChar_t	GetAcceptOptions ()
	Return default options for Accept.
static void	SetAcceptOptions (UChar_t Opt)
	Set default options for Accept according to modifier 'mod'.
static void	ShowAcceptOptions ()
	Print default options for Accept.
Static Public Member Functions inherited from TSocket
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.
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'.
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
virtual void	DoError (int level, const char *location, const char *fmt, va_list va) const
	Interface to ErrorHandler (protected).
void	MakeZombie ()
Protected Attributes inherited from TSocket
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 inherited from TSocket
static ULong64_t	fgBytesRecv = 0
static ULong64_t	fgBytesSent = 0
static Int_t	fgClientProtocol = 17

#include <TPServerSocket.h>

Inheritance diagram for TPServerSocket:

Constructor & Destructor Documentation

TPServerSocket() [1/3]

TPServerSocket::TPServerSocket ( const TPServerSocket &  )

private

TPServerSocket() [2/3]

TPServerSocket::TPServerSocket	(	Int_t	port,
		Bool_t	reuse = kFALSE,
		Int_t	backlog = kDefaultBacklog,
		Int_t	tcpwindowsize = -1
	)

Create a parallel server socket object on a specified port.

Set reuse to true to force reuse of the server socket (i.e. do not wait for the time out to pass). Using backlog one can set the desirable queue length for pending connections. 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). Use IsValid() to check the validity of the server socket. In case server socket is not valid use GetErrorCode() to obtain the specific error value. These values are: 0 = no error (socket is valid) -1 = low level socket() call failed -2 = low level bind() call failed -3 = low level listen() call failed Every valid server 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 50 of file TPServerSocket.cxx.

TPServerSocket() [3/3]

TPServerSocket::TPServerSocket	(	const char *	service,
		Bool_t	reuse = kFALSE,
		Int_t	backlog = kDefaultBacklog,
		Int_t	tcpwindowsize = -1
	)

Create a parallel server socket object for a named service.

Set reuse to true to force reuse of the server socket (i.e. do not wait for the time out to pass). Using backlog one can set the desirable queue length for pending connections. 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). Use IsValid() to check the validity of the server socket. In case server socket is not valid use GetErrorCode() to obtain the specific error value. These values are: 0 = no error (socket is valid) -1 = low level socket() call failed -2 = low level bind() call failed -3 = low level listen() call failed Every valid server 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 TPServerSocket.cxx.

~TPServerSocket()

virtual TPServerSocket::~TPServerSocket ( )

inlinevirtual

Definition at line 49 of file TPServerSocket.h.

Member Function Documentation

Accept()

TSocket * TPServerSocket::Accept ( UChar_t  Opt = kSrvNoAuth )

virtual

Accept a connection on a parallel server socket.

Returns a full-duplex parallel communication TPSocket object. If no pending connections are present on the queue and nonblocking mode has not been enabled with SetOption(kNoBlock,1) the call blocks until a connection is present. The returned socket must be deleted by the user. The socket is also added to the TROOT sockets list which will make sure that any open sockets are properly closed on program termination. In case of error 0 is returned and in case non-blocking I/O is enabled and no connections are available -1 is returned.

Reimplemented from TServerSocket.

Definition at line 96 of file TPServerSocket.cxx.

operator=()

void TPServerSocket::operator= ( const TPServerSocket &  )

private

Member Data Documentation

fTcpWindowSize

Int_t TPServerSocket::fTcpWindowSize

private

Definition at line 36 of file TPServerSocket.h.

Libraries for TPServerSocket:

---

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

• net/net/inc/TPServerSocket.h
• net/net/src/TPServerSocket.cxx