diff options
| author | madmaxoft@gmail.com <madmaxoft@gmail.com@0a769ca7-a7f5-676a-18bf-c427514a06d6> | 2012-08-17 12:18:07 +0200 |
|---|---|---|
| committer | madmaxoft@gmail.com <madmaxoft@gmail.com@0a769ca7-a7f5-676a-18bf-c427514a06d6> | 2012-08-17 12:18:07 +0200 |
| commit | 70a4ca5bc196676e8926028b2187fe7bd2874d42 (patch) | |
| tree | 38056355c35459c35802f93eca974a20a07d4623 /source/ByteBuffer.h | |
| parent | MCServer should run just fine on Android now :D (diff) | |
| download | cuberite-70a4ca5bc196676e8926028b2187fe7bd2874d42.tar cuberite-70a4ca5bc196676e8926028b2187fe7bd2874d42.tar.gz cuberite-70a4ca5bc196676e8926028b2187fe7bd2874d42.tar.bz2 cuberite-70a4ca5bc196676e8926028b2187fe7bd2874d42.tar.lz cuberite-70a4ca5bc196676e8926028b2187fe7bd2874d42.tar.xz cuberite-70a4ca5bc196676e8926028b2187fe7bd2874d42.tar.zst cuberite-70a4ca5bc196676e8926028b2187fe7bd2874d42.zip | |
Diffstat (limited to '')
| -rw-r--r-- | source/ByteBuffer.h | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/source/ByteBuffer.h b/source/ByteBuffer.h new file mode 100644 index 000000000..23be3e922 --- /dev/null +++ b/source/ByteBuffer.h @@ -0,0 +1,90 @@ +
+// ByteStream.h
+
+// Interfaces to the cByteBuffer class representing a ringbuffer of bytes
+
+
+
+
+
+#pragma once
+
+
+
+
+
+/** An object that can store incoming bytes and lets its clients read the bytes sequentially
+The bytes are stored in a ringbuffer of constant size; if more than that size
+is requested, the write operation fails.
+The bytes stored can be retrieved using various ReadXXX functions; these assume that the needed
+number of bytes are present in the buffer (ASSERT; for performance reasons).
+The reading doesn't actually remove the bytes, it only moves the internal read ptr.
+To remove the bytes, call CommitRead().
+To re-start reading from the beginning, call ResetRead().
+This class doesn't implement thread safety, the clients of this class need to provide
+their own synchronization.
+*/
+class cByteBuffer
+{
+public:
+ cByteBuffer(int a_BufferSize);
+ ~cByteBuffer();
+
+ /// Writes the bytes specified to the ringbuffer. Returns true if successful, false if not
+ bool Write(const char * a_Bytes, int a_Count);
+
+ /// Returns the number of bytes that can be successfully written to the ringbuffer
+ int GetFreeSpace(void) const;
+
+ /// Returns the number of bytes that are currently in the ringbuffer. Note GetReadableBytes()
+ int GetUsedSpace(void) const;
+
+ /// Returns the number of bytes that are currently available for reading (may be less than UsedSpace due to some data having been read already)
+ int GetReadableSpace(void) const;
+
+ /// Returns true if the specified amount of bytes are available for reading
+ bool CanReadBytes(int a_Count) const;
+
+ // Read the specified datatype and advance the read pointer; return true if successfully read:
+ bool ReadChar (char & a_Value);
+ bool ReadByte (unsigned char & a_Value);
+ bool ReadBEShort (short & a_Value);
+ bool ReadBEInt (int & a_Value);
+ bool ReadBEInt64 (Int64 & a_Value);
+ bool ReadBEFloat (float & a_Value);
+ bool ReadBEDouble (double & a_Value);
+ bool ReadBool (bool & a_Value);
+ bool ReadBEUTF16String16(AString & a_Value);
+
+ /// Reads a_Count bytes into a_Buffer; return true if successful
+ bool ReadBuf(void * a_Buffer, int a_Count);
+
+ /// Reads a_Count bytes into a_String; return true if successful
+ bool ReadString(AString & a_String, int a_Count);
+
+ /// Reads 2 * a_NumChars bytes and interprets it as a UTF16 string, converting it into UTF8 string a_String
+ bool ReadUTF16String(AString & a_String, int a_NumChars);
+
+ /// Skips reading by a_Count bytes
+ void SkipRead(int a_Count);
+
+ /// Removes the bytes that have been read from the ringbuffer
+ void CommitRead(void);
+
+ /// Restarts next reading operation at the start of the ringbuffer
+ void ResetRead(void);
+
+protected:
+ char * m_Buffer;
+ int m_BufferSize; // Total size of the ringbuffer
+ int m_DataStart; // Where the data starts in the ringbuffer
+ int m_WritePos; // Where the data ends in the ringbuffer
+ int m_ReadPos; // Where the next read will start in the ringbuffer
+
+ /// Advances the m_ReadPos by a_Count bytes
+ void AdvanceReadPos(int a_Count);
+} ;
+
+
+
+
|