From 255bd27d4e26d2e5cef9ad4d57bb9c18bc986c67 Mon Sep 17 00:00:00 2001 From: Mike Buland Date: Thu, 16 Feb 2012 03:35:41 +0000 Subject: Added MemBuf docs and a new readAll function to the base stream class. More helpers never really hurt. --- src/stream.h | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'src/stream.h') diff --git a/src/stream.h b/src/stream.h index fb70f21..b35f6ee 100644 --- a/src/stream.h +++ b/src/stream.h @@ -55,6 +55,16 @@ namespace Bu */ virtual Bu::String readLine(); + /** + * Reads all data from the current position onward until isEos returns + * true and returns it as a Bu::String. This will also return if no + * data is available and the stream is in non-blocking mode. This + * function is intended for very particular circumstances and is often + * not the most efficient way to access the data that you would like. + *@returns The entire stream contents. + */ + virtual Bu::String readAll(); + /** * Write data to the stream. *@param pBuf (const void *) The data to be written. -- cgit v1.2.3