summaryrefslogtreecommitdiff
path: root/indra/llcorehttp/bufferarray.h
diff options
context:
space:
mode:
authorMonty Brandenberg <monty@lindenlab.com>2012-04-23 16:19:39 -0400
committerMonty Brandenberg <monty@lindenlab.com>2012-04-23 16:19:39 -0400
commit5611cb6d476540e6a1c654c1f9acdce2787b3505 (patch)
treee35afc4aa33ae00e71679ba3ccfead0de563843d /indra/llcorehttp/bufferarray.h
parentb187aeb8f177bd76e792652e773617beff18b47b (diff)
Okay, imported the core-http library and got it compiling suspiciously easily.
The unit/integration tests don't work yet as I'm still battling cmake/autobuild as usual but first milestone passed.
Diffstat (limited to 'indra/llcorehttp/bufferarray.h')
-rw-r--r--indra/llcorehttp/bufferarray.h168
1 files changed, 168 insertions, 0 deletions
diff --git a/indra/llcorehttp/bufferarray.h b/indra/llcorehttp/bufferarray.h
new file mode 100644
index 0000000000..b26ad1b297
--- /dev/null
+++ b/indra/llcorehttp/bufferarray.h
@@ -0,0 +1,168 @@
+/**
+ * @file bufferarray.h
+ * @brief Public-facing declaration for the BufferArray scatter/gather class
+ *
+ * $LicenseInfo:firstyear=2012&license=viewerlgpl$
+ * Second Life Viewer Source Code
+ * Copyright (C) 2012, Linden Research, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation;
+ * version 2.1 of the License only.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ *
+ * Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA
+ * $/LicenseInfo$
+ */
+
+#ifndef _LLCORE_BUFFER_ARRAY_H_
+#define _LLCORE_BUFFER_ARRAY_H_
+
+
+#include <cstdlib>
+#include <vector>
+
+#include "_refcounted.h"
+
+
+namespace LLCore
+{
+
+
+/// A very simple scatter/gather type map for bulk data. The motivation
+/// for this class is the writedata callback used by libcurl. Response
+/// bodies are delivered to the caller in a sequence of sequential write
+/// operations and this class captures them without having to reallocate
+/// and move data.
+///
+/// The interface looks a little like a unix file descriptor but only
+/// just. There is a notion of a current position, starting from 0,
+/// which is used as the position in the data when performing read and
+/// write operations. The position also moves after various operations:
+/// - seek(...)
+/// - read(...)
+/// - write(...)
+/// - append(...)
+/// - appendBufferAlloc(...)
+/// The object also keeps a total length value which is updated after
+/// write and append operations and beyond which the current position
+/// cannot be set.
+///
+/// Threading: not thread-safe
+///
+/// Allocation: Refcounted, heap only. Caller of the constructor
+/// is given a single refcount.
+///
+class BufferArray : public LLCoreInt::RefCounted
+{
+public:
+ BufferArray();
+ virtual ~BufferArray();
+
+private:
+ BufferArray(const BufferArray &); // Not defined
+ void operator=(const BufferArray &); // Not defined
+
+public:
+ /// Appends the indicated data to the BufferArray
+ /// modifying current position and total size. New
+ /// position is one beyond the final byte of the buffer.
+ ///
+ /// @return Count of bytes copied to BufferArray
+ size_t append(const char * src, size_t len);
+
+ /// Similar to @see append(), this call guarantees a
+ /// contiguous block of memory of requested size placed
+ /// at the current end of the BufferArray. On return,
+ /// the data in the memory is considered valid whether
+ /// the caller writes to it or not.
+ ///
+ /// @return Pointer to contiguous region at end
+ /// of BufferArray of 'len' size.
+ char * appendBufferAlloc(size_t len);
+
+ /// Current count of bytes in BufferArray instance.
+ size_t size() const
+ {
+ return mLen;
+ }
+
+ /// Set the current position for subsequent read and
+ /// write operations. 'pos' values before the beginning
+ /// or greater than the size of the buffer are coerced
+ /// to a value within the buffer.
+ ///
+ /// @return Actual current position after seek.
+ size_t seek(size_t pos);
+
+ /// Copies data from the current position in the instance
+ /// to the caller's buffer. Will return a short count of
+ /// bytes copied if the 'len' extends beyond the data.
+ size_t read(char * dst, size_t len);
+
+ /// Copies data from the caller's buffer to the instance
+ /// at the current position. May overwrite existing data,
+ /// append data when current position is equal to the
+ /// size of the instance or do a mix of both.
+ size_t write(const char * src, size_t len);
+
+protected:
+ int findBlock(size_t pos, size_t * ret_offset);
+
+protected:
+ class Block;
+ typedef std::vector<Block *> container_t;
+
+ container_t mBlocks;
+ size_t mPos;
+ size_t mLen;
+}; // end class BufferArray
+
+
+#if 0
+
+// Conceptual for now. Another possibility is going with
+// something like Boost::asio's buffers interface. They're
+// trying to achieve the same thing above and below....
+
+class BufferStream : public std::streambuf
+{
+public:
+ BufferStream(BufferArray * buffer);
+ virtual ~BufferStream();
+
+private:
+ BufferStream(const BufferStream &); // Not defined
+ void operator=(const BufferStream &); // Not defined
+
+public:
+ // Types
+ typedef std::streambuf::pos_type pos_type;
+ typedef std::streambuf::off_type off_type;
+
+ virtual int underflow();
+
+ virtual int overflow(int c);
+
+ virtual int sync();
+
+ virtual pos_type seekoff(off_type off, std::ios::seekdir way, std::ios::openmode which);
+
+protected:
+ BufferArray * mBufferArray;
+}; // end class BufferStream
+
+#endif // 0
+
+} // end namespace LLCore
+
+#endif // _LLCORE_BUFFER_ARRAY_H_