diff options
Diffstat (limited to 'indra/llmessage/lliobuffer.h')
| -rw-r--r-- | indra/llmessage/lliobuffer.h | 156 |
1 files changed, 78 insertions, 78 deletions
diff --git a/indra/llmessage/lliobuffer.h b/indra/llmessage/lliobuffer.h index 3349848947..4d4fab5fe4 100644 --- a/indra/llmessage/lliobuffer.h +++ b/indra/llmessage/lliobuffer.h @@ -1,4 +1,4 @@ -/** +/** * @file lliobuffer.h * @author Phoenix * @date 2005-05-04 @@ -7,21 +7,21 @@ * $LicenseInfo:firstyear=2005&license=viewerlgpl$ * Second Life Viewer Source Code * Copyright (C) 2010, 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$ */ @@ -31,7 +31,7 @@ #include "lliopipe.h" -/** +/** * @class LLIOBuffer * @brief This class is an io class that represents an automtically * resizing io buffer. @@ -46,90 +46,90 @@ class LLIOBuffer : public LLIOPipe { public: - LLIOBuffer(); - virtual ~LLIOBuffer(); + LLIOBuffer(); + virtual ~LLIOBuffer(); - /** - * @brief Return a raw pointer to the current data set. - * - * The pointer returned can be used for reading or even adjustment - * if you are a bit crazy up to size() bytes into memory. - * @return A potentially NULL pointer to the raw buffer data - */ - U8* data() const; + /** + * @brief Return a raw pointer to the current data set. + * + * The pointer returned can be used for reading or even adjustment + * if you are a bit crazy up to size() bytes into memory. + * @return A potentially NULL pointer to the raw buffer data + */ + U8* data() const; - /** - * @brief Return the size of the buffer - */ - S64 size() const; + /** + * @brief Return the size of the buffer + */ + S64 size() const; - /** - * @brief Return a raw pointer to the current read position in the data. - * - * The pointer returned can be used for reading or even adjustment - * if you are a bit crazy up to bytesLeft() bytes into memory. - * @return A potentially NULL pointer to the buffer data starting - * at the read point - */ - U8* current() const; + /** + * @brief Return a raw pointer to the current read position in the data. + * + * The pointer returned can be used for reading or even adjustment + * if you are a bit crazy up to bytesLeft() bytes into memory. + * @return A potentially NULL pointer to the buffer data starting + * at the read point + */ + U8* current() const; - /** - * @brief Return the number of unprocessed bytes in buffer. - */ - S64 bytesLeft() const; + /** + * @brief Return the number of unprocessed bytes in buffer. + */ + S64 bytesLeft() const; - /** - * @brief Move the buffer offsets back to the beginning. - * - * This method effectively clears what has been stored here, - * without mucking around with memory allocation. - */ - void clear(); + /** + * @brief Move the buffer offsets back to the beginning. + * + * This method effectively clears what has been stored here, + * without mucking around with memory allocation. + */ + void clear(); - /** - * @brief Enumeration passed into the seek function - * - * The READ head is used for where to start processing data for - * the next link in the chain, while the WRITE head specifies - * where new data processed from the previous link in the chain - * will be written. - */ - enum EHead - { - READ, - WRITE - }; + /** + * @brief Enumeration passed into the seek function + * + * The READ head is used for where to start processing data for + * the next link in the chain, while the WRITE head specifies + * where new data processed from the previous link in the chain + * will be written. + */ + enum EHead + { + READ, + WRITE + }; - /** - * @brief Seek to a place in the buffer - * - * @param head The READ or WRITE head. - * @param delta The offset from the current position to seek. - * @return The status of the operation. status >= if head moved. - */ - EStatus seek(EHead head, S64 delta); + /** + * @brief Seek to a place in the buffer + * + * @param head The READ or WRITE head. + * @param delta The offset from the current position to seek. + * @return The status of the operation. status >= if head moved. + */ + EStatus seek(EHead head, S64 delta); public: - /* @name LLIOPipe virtual implementations - */ - //@{ + /* @name LLIOPipe virtual implementations + */ + //@{ protected: - /** - * @brief Process the data in buffer - */ - virtual EStatus process_impl( - const LLChannelDescriptors& channels, - buffer_ptr_t& buffer, - bool& eos, - LLSD& context, - LLPumpIO* pump); - //@} + /** + * @brief Process the data in buffer + */ + virtual EStatus process_impl( + const LLChannelDescriptors& channels, + buffer_ptr_t& buffer, + bool& eos, + LLSD& context, + LLPumpIO* pump); + //@} protected: - U8* mBuffer; - S64 mBufferSize; - U8* mReadHead; - U8* mWriteHead; + U8* mBuffer; + S64 mBufferSize; + U8* mReadHead; + U8* mWriteHead; }; #endif // LL_LLIOBUFFER_H |