ROOT  6.06/09
Reference Guide
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
TSSLSocket Class Reference

Definition at line 30 of file TSSLSocket.h.

Public Member Functions

 TSSLSocket (TInetAddress addr, const char *service, Int_t tcpwindowsize=-1)
 
 TSSLSocket (TInetAddress addr, Int_t port, Int_t tcpwindowsize=-1)
 
 TSSLSocket (const char *host, const char *service, Int_t tcpwindowsize=-1)
 
 TSSLSocket (const char *url, Int_t port, Int_t tcpwindowsize=-1)
 
 TSSLSocket (const char *sockpath)
 
 TSSLSocket (Int_t desc)
 
 TSSLSocket (Int_t desc, const char *sockpath)
 
 TSSLSocket (const TSSLSocket &s)
 
virtual ~TSSLSocket ()
 Close gracefully the connection, and free SSL structures. More...
 
void Close (Option_t *option="")
 Close the SSL connection. More...
 
Int_t Recv (TMessage *&mess)
 Receive a TMessage object. More...
 
Int_t RecvRaw (void *buffer, Int_t length, ESendRecvOptions opt=kDefault)
 Receive a raw buffer of specified length bytes. More...
 
Int_t Send (const TMessage &mess)
 Send a TMessage object. More...
 
Int_t SendRaw (const void *buffer, Int_t length, ESendRecvOptions opt=kDefault)
 Send a raw buffer of specified length. More...
 
Int_t Send (Int_t kind)
 Send a single message opcode. More...
 
Int_t Send (Int_t status, Int_t kind)
 Send a status and a single message opcode. More...
 
Int_t Send (const char *mess, Int_t kind=kMESS_STRING)
 Send a character string buffer. More...
 
Int_t Recv (Int_t &status, Int_t &kind)
 Receives a status and a message type. More...
 
Int_t Recv (char *mess, Int_t max)
 Receive a character string message of maximum max length. More...
 
Int_t Recv (char *mess, Int_t max, Int_t &kind)
 Receive a character string message of maximum max length. More...
 
- Public Member Functions inherited from TSocket
 TSocket (TInetAddress address, const char *service, Int_t tcpwindowsize=-1)
 
 TSocket (TInetAddress address, Int_t port, Int_t tcpwindowsize=-1)
 Create a socket. More...
 
 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 (Int_t descriptor)
 Create a socket. More...
 
 TSocket (Int_t descriptor, const char *sockpath)
 Create a socket. More...
 
 TSocket (const TSocket &s)
 TSocket copy ctor. More...
 
virtual ~TSocket ()
 
virtual Int_t GetDescriptor () const
 
TInetAddress GetInetAddress () const
 
virtual TInetAddress GetLocalInetAddress ()
 Return internet address of local host to which the socket is bound. More...
 
Int_t GetPort () const
 
const char * GetService () const
 
Int_t GetServType () const
 
virtual Int_t GetLocalPort ()
 Return the local port # to which the socket is bound. More...
 
UInt_t GetBytesSent () const
 
UInt_t GetBytesRecv () const
 
Int_t GetCompressionAlgorithm () const
 
Int_t GetCompressionLevel () const
 
Int_t GetCompressionSettings () const
 
Int_t GetErrorCode () const
 Returns error code. More...
 
virtual Int_t GetOption (ESockOptions opt, Int_t &val)
 Get socket options. Returns -1 in case of error. More...
 
Int_t GetRemoteProtocol () const
 
TSecContextGetSecContext () const
 
Int_t GetTcpWindowSize () const
 
TTimeStamp GetLastUsage ()
 
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. More...
 
virtual Int_t SendObject (const TObject *obj, Int_t kind=kMESS_OBJECT)
 Send an object. More...
 
void SetCompressionAlgorithm (Int_t algorithm=0)
 See comments for function SetCompressionSettings. More...
 
void SetCompressionLevel (Int_t level=1)
 See comments for function SetCompressionSettings. More...
 
void SetCompressionSettings (Int_t settings=1)
 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 TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual ~TNamed ()
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (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 SetName (const char *name)
 Change (i.e. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Change (i.e. set) all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Change (i.e. set) the title of the TNamed. More...
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual ~TObject ()
 TObject destructor. 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...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. 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 TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current pad. More...
 
virtual void Dump () const
 Dump contents of object on stdout. 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 TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetIconName () const
 Returns mime type 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 Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. 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...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. 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 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...
 
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...
 
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 UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. 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...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz, void *vp)
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
void ResetBit (UInt_t f)
 
Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
void InvertBit (UInt_t f)
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. 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...
 
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...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 

Static Public Member Functions

static void SetUpSSL (const char *cafile, const char *capath, const char *ucert, const char *ukey)
 Set up the static configuration variables. More...
 
- Static Public Member Functions inherited from TSocket
static Int_t GetClientProtocol ()
 Static method returning supported client protocol. More...
 
static ULong64_t GetSocketBytesSent ()
 Get total number of bytes sent via all sockets. More...
 
static ULong64_t GetSocketBytesRecv ()
 Get total number of bytes received via all sockets. More...
 
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'. More...
 
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. 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 void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

Protected Member Functions

 TSSLSocket ()
 
- Protected Member Functions inherited from TSocket
 TSocket ()
 
Bool_t Authenticate (const char *user)
 Authenticated the socket with specified user. More...
 
void SetDescriptor (Int_t desc)
 
void SendStreamerInfos (const TMessage &mess)
 Check if TStreamerInfo must be sent. 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...
 
Bool_t RecvProcessIDs (TMessage *mess)
 Receive a message containing process ids. More...
 
- Protected Member Functions inherited from TObject
void MakeZombie ()
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 

Private Member Functions

void WrapWithSSL ()
 Wraps the socket with OpenSSL. More...
 

Private Attributes

SSL_CTXfSSLCtx
 
SSLfSSL
 

Static Private Attributes

static char fgSSLCAFile [] = ""
 
static char fgSSLCAPath [] = ""
 
static char fgSSLUCert [] = ""
 
static char fgSSLUKey [] = ""
 

Additional Inherited Members

- Public Types inherited from TSocket
enum  EStatusBits { kIsUnix = BIT(16), kBrokenConn = BIT(17) }
 
enum  EInterest { kRead = 1, kWrite = 2 }
 
enum  EServiceType { kSOCKD, kROOTD, kPROOFD }
 
- Public Types inherited from TObject
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
- Protected Attributes inherited from TSocket
TInetAddress fAddress
 
UInt_t fBytesRecv
 
UInt_t fBytesSent
 
Int_t fCompress
 
TInetAddress fLocalAddress
 
Int_t fRemoteProtocol
 
TSecContextfSecContext
 
TString fService
 
EServiceType fServType
 
Int_t fSocket
 
Int_t fTcpWindowSize
 
TString fUrl
 
TBits fBitsInfo
 
TListfUUIDs
 
TVirtualMutexfLastUsageMtx
 
TTimeStamp fLastUsage
 
- 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 <TSSLSocket.h>

+ Inheritance diagram for TSSLSocket:
+ Collaboration diagram for TSSLSocket:

Constructor & Destructor Documentation

TSSLSocket::TSSLSocket ( )
inlineprotected

Definition at line 32 of file TSSLSocket.h.

TSSLSocket::TSSLSocket ( TInetAddress  addr,
const char *  service,
Int_t  tcpwindowsize = -1 
)
TSSLSocket::TSSLSocket ( TInetAddress  addr,
Int_t  port,
Int_t  tcpwindowsize = -1 
)

Definition at line 99 of file TSSLSocket.cxx.

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

Definition at line 107 of file TSSLSocket.cxx.

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

Definition at line 115 of file TSSLSocket.cxx.

TSSLSocket::TSSLSocket ( const char *  sockpath)

Definition at line 123 of file TSSLSocket.cxx.

TSSLSocket::TSSLSocket ( Int_t  desc)

Definition at line 130 of file TSSLSocket.cxx.

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

Definition at line 137 of file TSSLSocket.cxx.

TSSLSocket::TSSLSocket ( const TSSLSocket s)

Definition at line 144 of file TSSLSocket.cxx.

TSSLSocket::~TSSLSocket ( )
virtual

Close gracefully the connection, and free SSL structures.

Definition at line 152 of file TSSLSocket.cxx.

Member Function Documentation

void TSSLSocket::Close ( Option_t option = "")
virtual

Close the SSL connection.

Reimplemented from TSocket.

Definition at line 164 of file TSSLSocket.cxx.

Referenced by RecvRaw(), SendRaw(), WrapWithSSL(), and ~TSSLSocket().

Int_t TSSLSocket::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 from TSocket.

Definition at line 189 of file TSSLSocket.cxx.

Int_t TSSLSocket::Recv ( Int_t status,
Int_t kind 
)
inlinevirtual

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

Definition at line 76 of file TSSLSocket.h.

Int_t TSSLSocket::Recv ( char *  str,
Int_t  max 
)
inlinevirtual

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

Definition at line 77 of file TSSLSocket.h.

Int_t TSSLSocket::Recv ( char *  str,
Int_t  max,
Int_t kind 
)
inlinevirtual

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

Definition at line 78 of file TSSLSocket.h.

Int_t TSSLSocket::RecvRaw ( void buffer,
Int_t  length,
ESendRecvOptions  opt = kDefault 
)
virtual

Receive a raw buffer of specified length bytes.

Reimplemented from TSocket.

Definition at line 198 of file TSSLSocket.cxx.

Int_t TSSLSocket::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 from TSocket.

Definition at line 254 of file TSSLSocket.cxx.

Int_t TSSLSocket::Send ( Int_t  kind)
inlinevirtual

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

Definition at line 73 of file TSSLSocket.h.

Int_t TSSLSocket::Send ( Int_t  status,
Int_t  kind 
)
inlinevirtual

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

Definition at line 74 of file TSSLSocket.h.

Int_t TSSLSocket::Send ( const char *  str,
Int_t  kind = kMESS_STRING 
)
inlinevirtual

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

Definition at line 75 of file TSSLSocket.h.

Int_t TSSLSocket::SendRaw ( const void buffer,
Int_t  length,
ESendRecvOptions  opt = kDefault 
)
virtual

Send a raw buffer of specified length.

Reimplemented from TSocket.

Definition at line 263 of file TSSLSocket.cxx.

void TSSLSocket::SetUpSSL ( const char *  cafile,
const char *  capath,
const char *  ucert,
const char *  ukey 
)
static

Set up the static configuration variables.

Definition at line 174 of file TSSLSocket.cxx.

void TSSLSocket::WrapWithSSL ( void  )
private

Wraps the socket with OpenSSL.

Definition at line 35 of file TSSLSocket.cxx.

Referenced by TSSLSocket().

Member Data Documentation

char TSSLSocket::fgSSLCAFile = ""
staticprivate

Definition at line 36 of file TSSLSocket.h.

Referenced by SetUpSSL(), and WrapWithSSL().

char TSSLSocket::fgSSLCAPath = ""
staticprivate

Definition at line 37 of file TSSLSocket.h.

Referenced by SetUpSSL(), and WrapWithSSL().

char TSSLSocket::fgSSLUCert = ""
staticprivate

Definition at line 38 of file TSSLSocket.h.

Referenced by SetUpSSL(), and WrapWithSSL().

char TSSLSocket::fgSSLUKey = ""
staticprivate

Definition at line 39 of file TSSLSocket.h.

Referenced by SetUpSSL(), and WrapWithSSL().

SSL* TSSLSocket::fSSL
private

Definition at line 43 of file TSSLSocket.h.

Referenced by Close(), RecvRaw(), SendRaw(), WrapWithSSL(), and ~TSSLSocket().

SSL_CTX* TSSLSocket::fSSLCtx
private

Definition at line 42 of file TSSLSocket.h.

Referenced by WrapWithSSL(), and ~TSSLSocket().


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