Logo ROOT  
Reference Guide
Go to the documentation of this file.
1// @(#)root/net:$Id$
2// Author: Marcelo Sousa 26/10/2011
5 * Copyright (C) 1995-2011, Rene Brun and Fons Rademakers. *
6 * All rights reserved. *
7 * *
8 * For the licensing terms see $ROOTSYS/LICENSE. *
9 * For the list of contributors see $ROOTSYS/README/CREDITS. *
10 *************************************************************************/
12#ifndef ROOT_TUDPSocket
13#define ROOT_TUDPSocket
17// //
18// TUDPSocket //
19// //
20// This class implements udp client sockets. A socket is an endpoint //
21// for communication between two machines. //
22// The actual work is done via the TSystem class (either TUnixSystem, //
23// or TWinNTSystem). //
24// //
27#include "TNamed.h"
28#include "TBits.h"
29#include "TInetAddress.h"
30#include "MessageTypes.h"
31#include "TVirtualAuth.h"
32#include "TSecContext.h"
33#include "TTimeStamp.h"
34#include "TVirtualMutex.h"
35#include "TSocket.h"
37class TUDPSocket : public TNamed {
39friend class TServerSocket;
42 enum EStatusBits { kIsUnix = BIT(16), // set if unix socket
43 kBrokenConn = BIT(17) // set if conn reset by peer or broken
44 };
45 enum EInterest { kRead = 1, kWrite = 2 };
49 TInetAddress fAddress; // remote internet address and port #
50 UInt_t fBytesRecv; // total bytes received over this socket
51 UInt_t fBytesSent; // total bytes sent using this socket
52 Int_t fCompress; // Compression level and algorithm
53 TInetAddress fLocalAddress; // local internet address and port #
54 Int_t fRemoteProtocol; // protocol of remote daemon
55 TSecContext *fSecContext; // after a successful Authenticate call
56 // points to related security context
57 TString fService; // name of service (matches remote port #)
58 EServiceType fServType; // remote service type
59 Int_t fSocket; // socket descriptor
60 TString fUrl; // needs this for special authentication options
61 TBits fBitsInfo; // bits array to mark TStreamerInfo classes already sent
62 TList *fUUIDs; // list of TProcessIDs already sent through the socket
64 TVirtualMutex *fLastUsageMtx; // Protect last usage setting / reading
65 TTimeStamp fLastUsage; // Time stamp of last usage
67 static ULong64_t fgBytesRecv; // total bytes received by all socket objects
68 static ULong64_t fgBytesSent; // total bytes sent by all socket objects
73 fBitsInfo(), fUUIDs(nullptr), fLastUsageMtx(0), fLastUsage() { }
75 void SetDescriptor(Int_t desc) { fSocket = desc; }
76 void SendStreamerInfos(const TMessage &mess);
78 void SendProcessIDs(const TMessage &mess);
82 TUDPSocket& operator=(const TUDPSocket &) = delete;
83 Option_t *GetOption() const override { return TObject::GetOption(); }
86 TUDPSocket(TInetAddress address, const char *service);
87 TUDPSocket(TInetAddress address, Int_t port);
88 TUDPSocket(const char *host, const char *service);
89 TUDPSocket(const char *host, Int_t port);
90 TUDPSocket(const char *sockpath);
92 TUDPSocket(Int_t descriptor);
93 TUDPSocket(Int_t descriptor, const char *sockpath);
94 TUDPSocket(const TUDPSocket &s);
96 virtual ~TUDPSocket() { Close(); }
98 virtual void Close(Option_t *opt="");
99 virtual Int_t GetDescriptor() const { return fSocket; }
102 Int_t GetPort() const { return fAddress.GetPort(); }
103 const char *GetService() const { return fService; }
104 Int_t GetServType() const { return (Int_t)fServType; }
105 virtual Int_t GetLocalPort();
106 UInt_t GetBytesSent() const { return fBytesSent; }
107 UInt_t GetBytesRecv() const { return fBytesRecv; }
111 Int_t GetErrorCode() const;
112 virtual Int_t GetOption(ESockOptions opt, Int_t &val);
117 const char *GetUrl() const { return fUrl; }
119 virtual Bool_t IsValid() const { return fSocket < 0 ? kFALSE : kTRUE; }
120 virtual Int_t Recv(TMessage *&mess);
121 virtual Int_t Recv(Int_t &status, Int_t &kind);
122 virtual Int_t Recv(char *mess, Int_t max);
123 virtual Int_t Recv(char *mess, Int_t max, Int_t &kind);
124 virtual Int_t RecvRaw(void *buffer, Int_t length, ESendRecvOptions opt = kDefault);
125 virtual Int_t Reconnect() { return -1; }
126 virtual Int_t Select(Int_t interest = kRead, Long_t timeout = -1);
127 virtual Int_t Send(const TMessage &mess);
128 virtual Int_t Send(Int_t kind);
129 virtual Int_t Send(Int_t status, Int_t kind);
130 virtual Int_t Send(const char *mess, Int_t kind = kMESS_STRING);
131 virtual Int_t SendObject(const TObject *obj, Int_t kind = kMESS_OBJECT);
132 virtual Int_t SendRaw(const void *buffer, Int_t length,
137 virtual Int_t SetOption(ESockOptions opt, Int_t val);
138 void SetRemoteProtocol(Int_t rproto) { fRemoteProtocol = rproto; }
140 void SetService(const char *service) { fService = service; }
142 void SetUrl(const char *url) { fUrl = url; }
149 static void NetError(const char *where, Int_t error);
151 ClassDefOverride(TUDPSocket,0) //This class implements UDP client sockets
157 return (fCompress < 0) ? -1 : fCompress / 100;
163 return (fCompress < 0) ? -1 : fCompress % 100;
169 return (fCompress < 0) ? -1 : fCompress;
Definition: MessageTypes.h:34
Definition: MessageTypes.h:35
bool Bool_t
Definition: RtypesCore.h:63
int Int_t
Definition: RtypesCore.h:45
const Bool_t kFALSE
Definition: RtypesCore.h:101
long Long_t
Definition: RtypesCore.h:54
unsigned long long ULong64_t
Definition: RtypesCore.h:81
const Bool_t kTRUE
Definition: RtypesCore.h:100
const char Option_t
Definition: RtypesCore.h:66
#define BIT(n)
Definition: Rtypes.h:85
#define ClassDefOverride(name, id)
Definition: Rtypes.h:339
Option_t Option_t TPoint TPoint const char GetTextMagnitude GetFillStyle GetLineColor GetLineWidth GetMarkerStyle GetTextAlign GetTextColor GetTextSize void char Point_t Rectangle_t WindowAttributes_t Float_t Float_t Float_t Int_t Int_t UInt_t UInt_t Rectangle_t Int_t Int_t Window_t TString Int_t GCValues_t GetPrimarySelectionOwner GetDisplay GetScreen GetColormap GetNativeEvent const char const char dpyName wid window const char font_name cursor keysym reg const char only_if_exist regb h Point_t winding char text const char depth char const char Int_t count const char ColorStruct_t color const char Pixmap_t Pixmap_t PictureAttributes_t attr const char char ret_data h unsigned char height h length
Definition: TSystem.h:215
Definition: TSystem.h:228
@ kDefault
Definition: TSystem.h:229
#define R__LOCKGUARD2(mutex)
Container of bits.
Definition: TBits.h:26
This class represents an Internet Protocol (IP) address.
Definition: TInetAddress.h:36
Int_t GetPort() const
Definition: TInetAddress.h:73
A doubly linked list.
Definition: TList.h:44
The TNamed class is the base class for all named ROOT classes.
Definition: TNamed.h:29
Mother of all ROOT objects.
Definition: TObject.h:37
virtual Option_t * GetOption() const
Definition: TObject.h:135
Definition: TObject.h:57
Basic string class.
Definition: TString.h:136
The TTimeStamp encapsulates seconds and ns since EPOCH.
Definition: TTimeStamp.h:71
void Set()
Set Date/Time to current time as reported by the system.
Definition: TTimeStamp.cxx:556
void SetCompressionSettings(Int_t settings=ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault)
Used to specify the compression level and algorithm: settings = 100 * algorithm + level.
UInt_t fBytesRecv
Definition: TUDPSocket.h:50
void SetRemoteProtocol(Int_t rproto)
Definition: TUDPSocket.h:138
TTimeStamp GetLastUsage()
Definition: TUDPSocket.h:116
Int_t GetErrorCode() const
Returns error code.
UInt_t fBytesSent
Definition: TUDPSocket.h:51
Int_t fCompress
Definition: TUDPSocket.h:52
Bool_t RecvStreamerInfos(TMessage *mess)
Receive a message containing streamer infos.
Definition: TUDPSocket.cxx:898
virtual TInetAddress GetLocalInetAddress()
Return internet address of local host to which the socket is bound.
Definition: TUDPSocket.cxx:373
EServiceType fServType
Definition: TUDPSocket.h:58
TInetAddress fLocalAddress
Definition: TUDPSocket.h:53
void SetCompressionLevel(Int_t level=ROOT::RCompressionSetting::ELevel::kUseMin)
See comments for function SetCompressionSettings.
TUDPSocket & operator=(const TUDPSocket &)=delete
UInt_t GetBytesSent() const
Definition: TUDPSocket.h:106
virtual Int_t RecvRaw(void *buffer, Int_t length, ESendRecvOptions opt=kDefault)
Receive a raw buffer of specified length bytes.
Definition: TUDPSocket.cxx:867
TVirtualMutex * fLastUsageMtx
Definition: TUDPSocket.h:64
virtual Int_t GetLocalPort()
Return the local port # to which the socket is bound.
Definition: TUDPSocket.cxx:387
TInetAddress fAddress
Definition: TUDPSocket.h:49
TString fService
Definition: TUDPSocket.h:57
static ULong64_t fgBytesRecv
Definition: TUDPSocket.h:67
const char * GetUrl() const
Definition: TUDPSocket.h:117
Bool_t RecvProcessIDs(TMessage *mess)
Receive a message containing process ids.
Definition: TUDPSocket.cxx:945
virtual Bool_t IsValid() const
Definition: TUDPSocket.h:119
const char * GetService() const
Definition: TUDPSocket.h:103
Int_t fRemoteProtocol
Definition: TUDPSocket.h:54
static void NetError(const char *where, Int_t error)
Print error string depending on error code.
TInetAddress GetInetAddress() const
Definition: TUDPSocket.h:100
void SetCompressionAlgorithm(Int_t algorithm=ROOT::RCompressionSetting::EAlgorithm::kUseGlobal)
See comments for function SetCompressionSettings.
virtual Int_t Recv(TMessage *&mess)
Receive a TMessage object.
Definition: TUDPSocket.cxx:784
virtual void Close(Option_t *opt="")
Close the socket.
Definition: TUDPSocket.cxx:354
virtual ~TUDPSocket()
Definition: TUDPSocket.h:96
Int_t GetRemoteProtocol() const
Definition: TUDPSocket.h:113
virtual Int_t SetOption(ESockOptions opt, Int_t val)
Set socket options.
Definition: TUDPSocket.cxx:983
static ULong64_t fgBytesSent
Definition: TUDPSocket.h:68
void SetDescriptor(Int_t desc)
Definition: TUDPSocket.h:75
Int_t GetCompressionLevel() const
Definition: TUDPSocket.h:161
void SendStreamerInfos(const TMessage &mess)
Check if TStreamerInfo must be sent.
Definition: TUDPSocket.cxx:616
virtual Int_t SendObject(const TObject *obj, Int_t kind=kMESS_OBJECT)
Send an object.
Definition: TUDPSocket.cxx:566
TList * fUUIDs
Definition: TUDPSocket.h:62
void SetSecContext(TSecContext *ctx)
Definition: TUDPSocket.h:139
TSecContext * GetSecContext() const
Definition: TUDPSocket.h:114
void Touch()
Definition: TUDPSocket.h:144
TBits fBitsInfo
Definition: TUDPSocket.h:61
Int_t GetPort() const
Definition: TUDPSocket.h:102
TTimeStamp fLastUsage
Definition: TUDPSocket.h:65
static ULong64_t GetSocketBytesRecv()
Get total number of bytes received via all sockets.
TString fUrl
Definition: TUDPSocket.h:60
void SetServType(Int_t st)
Definition: TUDPSocket.h:141
virtual Int_t Send(const TMessage &mess)
Send a TMessage object.
Definition: TUDPSocket.cxx:486
Int_t GetCompressionSettings() const
Definition: TUDPSocket.h:167
Option_t * GetOption() const override
Definition: TUDPSocket.h:83
UInt_t GetBytesRecv() const
Definition: TUDPSocket.h:107
void SetService(const char *service)
Definition: TUDPSocket.h:140
static ULong64_t GetSocketBytesSent()
Get total number of bytes sent via all sockets.
Int_t fSocket
Definition: TUDPSocket.h:59
virtual Int_t Reconnect()
Definition: TUDPSocket.h:125
virtual Int_t Select(Int_t interest=kRead, Long_t timeout=-1)
Waits for this socket to change status.
Definition: TUDPSocket.cxx:407
Int_t GetCompressionAlgorithm() const
Definition: TUDPSocket.h:155
virtual Int_t SendRaw(const void *buffer, Int_t length, ESendRecvOptions opt=kDefault)
Send a raw buffer of specified length.
Definition: TUDPSocket.cxx:586
virtual Int_t GetDescriptor() const
Definition: TUDPSocket.h:99
void SetUrl(const char *url)
Definition: TUDPSocket.h:142
Int_t GetServType() const
Definition: TUDPSocket.h:104
void SendProcessIDs(const TMessage &mess)
Check if TProcessIDs must be sent.
Definition: TUDPSocket.cxx:651
TSecContext * fSecContext
Definition: TUDPSocket.h:55
This class implements a mutex interface.
Definition: TVirtualMutex.h:32
static constexpr double s
@ kUseGlobal
Use the global compression algorithm.
Definition: Compression.h:88
@ kUseCompiledDefault
Use the compile-time default setting.
Definition: Compression.h:50
@ kUseMin
Compression level reserved when we are not sure what to use (1 is for the fastest compression)
Definition: Compression.h:68