TSocket

class TSocket : public TNamed

    private:

      virtual Option_t* GetOption() const
                   void operator=(const TSocket&)
                   void SetDescriptor(Int_t desc)

    protected:

      TSocket TSocket()

    public:

                   TSocket TSocket(TInetAddress address, const char* service, Int_t tcpwindowsize = -1)
                   TSocket TSocket(TInetAddress address, Int_t port, Int_t tcpwindowsize = -1)
                   TSocket TSocket(const char* host, const char* service, Int_t tcpwindowsize = -1)
                   TSocket TSocket(const char* host, Int_t port, Int_t tcpwindowsize = -1)
                   TSocket TSocket(Int_t descriptor)
                   TSocket TSocket(const TSocket& s)
              virtual void ~TSocket()
            static TClass* Class()
              virtual void Close(Option_t* opt)
                    UInt_t GetBytesRecv() const
                    UInt_t GetBytesSent() const
             virtual Int_t GetDescriptor() const
                     Int_t GetErrorCode() const
              TInetAddress GetInetAddress() const
      virtual TInetAddress GetLocalInetAddress()
             virtual Int_t GetLocalPort()
             virtual Int_t GetOption(ESockOptions opt, Int_t& val)
                     Int_t GetPort() const
               const char* GetService() const
             static UInt_t GetSocketBytesRecv()
             static UInt_t GetSocketBytesSent()
           virtual TClass* IsA() const
            virtual Bool_t IsValid() const
             virtual Int_t Recv(TMessage*& mess)
             virtual Int_t Recv(Int_t& status, Int_t& kind)
             virtual Int_t Recv(char* mess, Int_t max)
             virtual Int_t Recv(char* mess, Int_t max, Int_t& kind)
             virtual Int_t RecvRaw(void* buffer, Int_t length, ESendRecvOptions opt = kDefault)
             virtual Int_t Send(const TMessage& mess)
             virtual Int_t Send(Int_t kind)
             virtual Int_t Send(Int_t status, Int_t kind)
             virtual Int_t Send(const char* mess, Int_t kind = kMESS_STRING)
             virtual Int_t SendObject(const TObject* obj, Int_t kind = kMESS_OBJECT)
             virtual Int_t SendRaw(const void* buffer, Int_t length, ESendRecvOptions opt = kDefault)
             virtual Int_t SetOption(ESockOptions opt, Int_t val)
              virtual void ShowMembers(TMemberInspector& insp, char* parent)
              virtual void Streamer(TBuffer& b)
                      void StreamerNVirtual(TBuffer& b)

Data Members

    private:

             UInt_t fBytesSent   total bytes sent using this socket
             UInt_t fBytesRecv   total bytes received over this socket
      static UInt_t fgBytesSent  total bytes sent by all socket objects
      static UInt_t fgBytesRecv  total bytes received by all socket objects

    protected:

             Int_t fSocket        socket descriptor
           TString fService       name of service (matches remote port #)
      TInetAddress fAddress       remote internet address and port #
      TInetAddress fLocalAddress  local internet address and port #

See also

TPSocket, TServerSocket

Class Description

                                                                      
 TSocket                                                              
                                                                      
 This class implements client sockets. A socket is an endpoint for    
 communication between two machines.                                  
 The actual work is done via the TSystem class (either TUnixSystem,   
 TWin32System or TMacSystem).                                         
                                                                      

 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.

 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.

 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.

 Create a socket. Connect to specified port # 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.

 Create a socket. The socket will use descriptor desc.

 TSocket copy ctor.

 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 explicitely Close("force") if this is desired).

 Return internet address of local host to which the socket is bound.
 In case of error TInetAddress::IsValid() returns kFALSE.

 Return the local port # to which the socket is bound.
 In case of error return -1.

 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.

 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.

 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.

 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.

 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.

 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.

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

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

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

 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). In those case mess == 0.

 Receive a raw buffer of specified length bytes. Using option kPeek
 one can peek at incoming data. 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.

 Set socket options.

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

 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.

Inline Functions

                void operator=(const TSocket&)
                void SetDescriptor(Int_t desc)
             TSocket TSocket(const TSocket& s)
               Int_t GetDescriptor() const
        TInetAddress GetInetAddress() const
               Int_t GetPort() const
         const char* GetService() const
              UInt_t GetBytesSent() const
              UInt_t GetBytesRecv() const
              Bool_t IsValid() const
               Int_t GetOption(ESockOptions opt, Int_t& val)
              UInt_t GetSocketBytesSent()
              UInt_t GetSocketBytesRecv()
             TClass* Class()
             TClass* IsA() const
                void ShowMembers(TMemberInspector& insp, char* parent)
                void Streamer(TBuffer& b)
                void StreamerNVirtual(TBuffer& b)
                void ~TSocket()