TCPSocketDataIO.h

/* This file is Copyright 2000-2008 Meyer Sound Laboratories Inc.  See the included LICENSE.txt file for details. */

#ifndef MuscleTCPSocketDataIO_h
#define MuscleTCPSocketDataIO_h

#include "support/MuscleSupport.h"

#include "dataio/DataIO.h"
#include "util/NetworkUtilityFunctions.h"

BEGIN_NAMESPACE(muscle);

#ifndef MUSCLE_DEFAULT_TCP_STALL_TIMEOUT
# define MUSCLE_DEFAULT_TCP_STALL_TIMEOUT (3*60*((uint64)1000000))  // 3 minutes is our default timeout period
#endif

class TCPSocketDataIO : public DataIO
{
public:
   TCPSocketDataIO(const SocketRef & sock, bool blocking) : _sock(sock), _blocking(true), _naglesEnabled(true), _stallLimit(MUSCLE_DEFAULT_TCP_STALL_TIMEOUT)
   {
      (void) SetBlockingIOEnabled(blocking);
   }

   virtual ~TCPSocketDataIO() 
   {
      Shutdown();
   }

   virtual int32 Read(void * buffer, uint32 size) {return ReceiveData(_sock, buffer, size, _blocking);}
   virtual int32 Write(const void * buffer, uint32 size) {return SendData(_sock, buffer, size, _blocking);}

   virtual status_t Seek(int64 /*seekOffset*/, int /*whence*/) {return B_ERROR;}

   virtual int64 GetPosition() const {return -1;}

   virtual uint64 GetOutputStallLimit() const {return _stallLimit;}

   void SetOutputStallLimit(uint64 limit) {_stallLimit = limit;}

   virtual void FlushOutput()
   {
      if ((_sock())&&(_naglesEnabled))
      {
         SetSocketNaglesAlgorithmEnabled(_sock, false);
#ifndef __linux__
         (void) SendData(_sock, NULL, 0, _blocking);  // Force immediate buffer flush (not necessary under Linux)
#endif
         SetSocketNaglesAlgorithmEnabled(_sock, true);
      }
   }
   
   virtual void Shutdown() {_sock.Reset();}

   virtual const SocketRef & GetSelectSocket() const {return _sock;}

   status_t SetBlockingIOEnabled(bool blocking)
   {
      status_t ret = SetSocketBlockingEnabled(_sock, blocking);
      if (ret == B_NO_ERROR) _blocking = blocking;
      return ret;
   }

   status_t SetNaglesAlgorithmEnabled(bool enabled)
   {
      status_t ret = SetSocketNaglesAlgorithmEnabled(_sock, enabled);
      if (ret == B_NO_ERROR) _naglesEnabled = enabled;
      return ret;
   }

   bool IsBlockingIOEnabled() const {return _blocking;}

   bool IsNaglesAlgorithmEnabled() const {return _naglesEnabled;}

private:
   SocketRef _sock;
   bool _blocking;
   bool _naglesEnabled;
   uint64 _stallLimit;
};

END_NAMESPACE(muscle);

#endif

---