TPSocket.h

Go to the documentation of this file.

// @(#)root/net:$Id$
// Author: Fons Rademakers   20/1/2001
 
/*************************************************************************
 * Copyright (C) 1995-2001, Rene Brun and Fons Rademakers.               *
 * All rights reserved.                                                  *
 *                                                                       *
 * For the licensing terms see $ROOTSYS/LICENSE.                         *
 * For the list of contributors see $ROOTSYS/README/CREDITS.             *
 *************************************************************************/
 
#ifndef ROOT_TPSocket
#define ROOT_TPSocket
 
 
//////////////////////////////////////////////////////////////////////////
//                                                                      //
// TPSocket                                                             //
//                                                                      //
// This class implements parallel client sockets. A parallel socket is  //
// an endpoint for communication between two machines. It is parallel   //
// because several TSockets are open at the same time to the same       //
// destination. This especially speeds up communication over Big Fat    //
// Pipes (i.e. high bandwidth, high latency WAN connections).           //
//                                                                      //
//////////////////////////////////////////////////////////////////////////
 
#include "TSocket.h"
 
class TMonitor;
 
 
class TPSocket : public TSocket {
 
friend class TPServerSocket;
 
private:
   TSocket   **fSockets = nullptr;         // array of parallel sockets
   TMonitor   *fWriteMonitor = nullptr;    // monitor write on parallel sockets
   TMonitor   *fReadMonitor = nullptr;     // monitor read from parallel sockets
   Int_t       fSize;                      // number of parallel sockets
   Int_t      *fWriteBytesLeft = nullptr;  // bytes left to write for specified socket
   Int_t      *fReadBytesLeft = nullptr;   // bytes left to read for specified socket
   char      **fWritePtr = nullptr;        // pointer to write buffer for specified socket
   char      **fReadPtr = nullptr;         // pointer to read buffer for specified socket
 
   TPSocket(TSocket *pSockets[], Int_t size);
   TPSocket(const TPSocket &) = delete;
   void operator=(const TPSocket &) = delete;
   void Init(Int_t tcpwindowsize, TSocket *sock = nullptr);
   Option_t *GetOption() const override { return TObject::GetOption(); }
 
public:
   TPSocket(TInetAddress address, const char *service, Int_t size,
            Int_t tcpwindowsize = -1);
   TPSocket(TInetAddress address, Int_t port, Int_t size,
            Int_t tcpwindowsize = -1);
   TPSocket(const char *host, const char *service, Int_t size,
            Int_t tcpwindowsize = -1);
   TPSocket(const char *host, Int_t port, Int_t size, Int_t tcpwindowsize = -1);
   TPSocket(const char *host, Int_t port, Int_t size, TSocket *sock);
   virtual ~TPSocket();
 
   void          Close(Option_t *opt="") override;
   Int_t         GetDescriptor() const override;
   TInetAddress  GetLocalInetAddress() override;
 
   Int_t   Send(const TMessage &mess) override;
   Int_t   Send(Int_t kind) override { return TSocket::Send(kind); }
   Int_t   Send(Int_t status, Int_t kind) override { return TSocket::Send(status, kind); }
   Int_t   Send(const char *mess, Int_t kind = kMESS_STRING) override { return TSocket::Send(mess, kind); }
   Int_t   SendRaw(const void *buffer, Int_t length, ESendRecvOptions opt = kDefault) override;
   Int_t   Recv(TMessage *&mess) override;
   Int_t   Recv(Int_t &status, Int_t &kind) override { return TSocket::Recv(status, kind); }
   Int_t   Recv(char *mess, Int_t max) override { return TSocket::Recv(mess, max); }
   Int_t   Recv(char *mess, Int_t max, Int_t &kind) override { return TSocket::Recv(mess, max, kind); }
   Int_t   RecvRaw(void *buffer, Int_t length, ESendRecvOptions opt = kDefault) override;
 
   Bool_t  IsValid() const override { return fSockets ? kTRUE : kFALSE; }
   Int_t   GetErrorCode() const;
   Int_t   SetOption(ESockOptions opt, Int_t val) override;
   Int_t   GetOption(ESockOptions opt, Int_t &val) override;
   Int_t   GetSize() const { return fSize; }
 
   ClassDefOverride(TPSocket,0)  // Parallel client socket
};
 
#endif