Changeset 2254

Timestamp:

21/08/2008 12:05:38 (19 months ago)

Author:

chris

Message:

Add a Flush() method to IOStream to read and discard all remaining data,
and a SelfFlushingStream? class which can be used to ensure that protocol
streams are always flushed, to avoid breaking protocol.

Location:

box/trunk/lib/common

Files:

• IOStream.cpp (modified) (1 diff)
• IOStream.h (modified) (1 diff)
• SelfFlushingStream.h (added)

box/trunk/lib/common/IOStream.cpp

@@ -239 +239 @@
 }
 
-
+// --------------------------------------------------------------------------
+//
+// Function
+//              Name:    IOStream::Flush(int Timeout)
+//              Purpose: Read and discard all remaining data in stream.
+//                       Useful for protocol streams which must be flushed
+//                       to avoid breaking the protocol.
+//              Created: 2008/08/20
+//
+// --------------------------------------------------------------------------
+void IOStream::Flush(int Timeout)
+{
+        char buffer[4096];
+
+        while(StreamDataLeft())
+        {
+                Read(buffer, sizeof(buffer), Timeout);
+        }
+}
+
+

box/trunk/lib/common/IOStream.h

@@ -58 +58 @@
         bool ReadFullBuffer(void *pBuffer, int NBytes, int *pNBytesRead, int Timeout = IOStream::TimeOutInfinite);
         bool CopyStreamTo(IOStream &rCopyTo, int Timeout = IOStream::TimeOutInfinite, int BufferSize = 1024);
+        void Flush(int Timeout = IOStream::TimeOutInfinite);
         
         static int ConvertSeekTypeToOSWhence(int SeekType);