diff options
author | James Cook <james@lindenlab.com> | 2007-01-02 08:33:20 +0000 |
---|---|---|
committer | James Cook <james@lindenlab.com> | 2007-01-02 08:33:20 +0000 |
commit | 420b91db29485df39fd6e724e782c449158811cb (patch) | |
tree | b471a94563af914d3ed3edd3e856d21cb1b69945 /indra/llmessage/llbufferstream.h |
Print done when done.
Diffstat (limited to 'indra/llmessage/llbufferstream.h')
-rw-r--r-- | indra/llmessage/llbufferstream.h | 134 |
1 files changed, 134 insertions, 0 deletions
diff --git a/indra/llmessage/llbufferstream.h b/indra/llmessage/llbufferstream.h new file mode 100644 index 0000000000..8b972322ce --- /dev/null +++ b/indra/llmessage/llbufferstream.h @@ -0,0 +1,134 @@ +/** + * @file llbufferstream.h + * @author Phoenix + * @date 2005-10-10 + * @brief Classes to treat an LLBufferArray as a c++ iostream. + * + * Copyright (c) 2005-$CurrentYear$, Linden Research, Inc. + * $License$ + */ + +#ifndef LL_LLBUFFERSTREAM_H +#define LL_LLBUFFERSTREAM_H + +#include <iosfwd> +#include <iostream> +#include "llbuffer.h" + +/** + * @class LLBufferStreamBuf + * @brief This implements the buffer wrapper for an istream + * + * The buffer array passed in is not owned by the stream buf object. + */ +class LLBufferStreamBuf : public std::streambuf +{ +public: + LLBufferStreamBuf( + const LLChannelDescriptors& channels, + LLBufferArray* buffer); + virtual ~LLBufferStreamBuf(); + +protected: +#if( LL_WINDOWS || __GNUC__ > 2 ) + typedef std::streambuf::pos_type pos_type; + typedef std::streambuf::off_type off_type; +#endif + + /* @name streambuf vrtual implementations + */ + //@{ + /* + * @brief called when we hit the end of input + * + * @return Returns the character at the current position or EOF. + */ + virtual int underflow(); + + /* + * @brief called when we hit the end of output + * + * @param c The character to store at the current put position + * @return Returns EOF if the function failed. Any other value on success. + */ + virtual int overflow(int c); + + /* + * @brief synchronize the buffer + * + * @return Returns 0 on success or -1 on failure. + */ + virtual int sync(); + + /* + * @brief Seek to an offset position in a stream. + * + * @param off Offset value relative to way paramter + * @param way The seek direction. One of ios::beg, ios::cur, and ios::end. + * @param which Which pointer to modify. One of ios::in, ios::out, + * or both masked together. + * @return Returns the new position or an invalid position on failure. + */ +#if( LL_WINDOWS || __GNUC__ > 2) + virtual pos_type seekoff( + off_type off, + std::ios::seekdir way, + std::ios::openmode which); +#else + virtual streampos seekoff( + streamoff off, + std::ios::seekdir way, + std::ios::openmode which); +#endif + + /* + * @brief Get s sequence of characters from the input + * + * @param dst Pointer to a block of memory to accept the characters + * @param length Number of characters to be read + * @return Returns the number of characters read + */ + //virtual streamsize xsgetn(char* dst, streamsize length); + + /* + * @brief Write some characters to output + * + * @param src Pointer to a sequence of characters to be output + * @param length Number of characters to be put + * @return Returns the number of characters written + */ + //virtual streamsize xsputn(char* src, streamsize length); + //@} + +protected: + // This channels we are working on. + LLChannelDescriptors mChannels; + + // The buffer we work on + LLBufferArray* mBuffer; +}; + + +/** + * @class LLBufferStream + * @brief This implements an istream based wrapper around an LLBufferArray. + * + * This class does not own the buffer array, and does not hold a + * shared pointer to it. Since the class itself is fairly ligthweight, + * just make one on the stack when needed and let it fall out of + * scope. + */ +class LLBufferStream : public std::iostream +{ +public: + LLBufferStream( + const LLChannelDescriptors& channels, + LLBufferArray* buffer); + ~LLBufferStream(); + +protected: + LLBufferStreamBuf mStreamBuf; +}; + + +#endif // LL_LLBUFFERSTREAM_H |