BinaryStream

-=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- (c) WidthPadding Industries 1987 0\|311\|0 -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=- -=+=-
SoCoder -> Snippet Home -> Misc

Afr0	Created : 19 September 2009 Edited : 20 September 2009 System : Nintendo DS Language : Monkey BinaryStream Binary (memory) stream in C++
/=============================================================================================================== / /* Class name: BinaryStream /* Purpose: Provide an interface for reading basic types (int, uint, char etc) from char arrays /* /==============================================================================================================/ class BinaryStream { private: char m_Buffer; int m_BufPosition; //Size of the buffer. Will be 0 if an existing buffer was used to initialize the stream. int m_BufSize; public: BinaryStream(char Buf[]); BinaryStream(int Size); ~BinaryStream(); char ReadByte(); char* ReadBytes(int NumBytes); int ReadInt(); unsigned int ReadUInt(); short ReadShort(); void WriteBytes(char Bytes[], int Length); //Writes any standard datatype to the stream (int, unsigned int, long, char). //POD = Plain Ol' Data template <typename T> void WritePODType(T Value) { memcpy(m_Buffer + m_BufPosition, &Value, sizeof(Value)); m_BufPosition += sizeof(Value); } }; --v #include "stdafx.h" #include <assert.h> #include <sstream> #include "BinaryStream.h" BinaryStream::BinaryStream(char Buf[]) { assert(Buf); m_Buffer = Buf; m_BufPosition = 0; } BinaryStream::BinaryStream(int Size) { m_Buffer = new char[Size]; for(int i = 0; i < Size; i++) m_Buffer[i] = 0; //Initialize all elements to 0. m_BufSize = Size; } BinaryStream::~BinaryStream() { if(m_BufSize > 0) { delete [] m_Buffer; m_Buffer = 0; } } char BinaryStream::ReadByte() { return m_Buffer[m_BufPosition++]; } char BinaryStream::ReadBytes(int NumBytes) { char Buf = new char[NumBytes]; for(int i = 0; i < NumBytes; i++) Buf[i] = m_Buffer[m_BufPosition++]; return Buf; } int BinaryStream::ReadInt() { return (int)ReadBytes(4); } unsigned int BinaryStream::ReadUInt() { return (unsigned int)ReadBytes(4); } short BinaryStream::ReadShort() { return (short)ReadBytes(2); } void BinaryStream::WriteBytes(char Bytes[], int Length) { for(int i = 0; i < Length; i++) { m_Buffer[m_BufPosition] = *Bytes[i]; m_BufPosition++; } } --v Using this class should be fairly self-explanatory. Very handy for reading packets when working with network code for instance!

Comments
Saturday, 19 September 2009, 16:58
JL235	I believe you should use memcpy for WriteBytes, as it'll be far more efficient then a for loop.
Sunday, 20 September 2009, 01:53
Afr0	These appear to be straight C-style functions wrapped in a class (why?) The C++ way would be to overload the insertion "<<" and extraction ">>" operator for each data type. This is already done for you in the standard stringstream class (I see you've included <sstream> but aren't actually using it). All you need to do is instantiate with the "binary" flag. I tried using stringstream to read binary data from a char array, but using it was really confusing to me. So I came up with this instead, which is closer to the C# interface. You're right about memory allocation though! The constructor should allocate it and the destructor should release it. I'll get around to changing it right away!
Sunday, 20 September 2009, 04:14
Phoenix	1. Why do you want the BinaryStream's constructor parameter to be passed as an array of char pointers, as opposed to just a char pointer? 2. You can't place a template's definition in a separate source file, because it will lead to linker errors. Try calling WritePODType to see why. There is also nothing to guarantee that the type passed is in fact a POD type. 3. The standard library already has plenty of functionality for dealing with this. Don't skip it because it's confusing. 4. To avoid the memory leak Agent Smith mentioned without having someone tell you about it, use smart pointers. That way, dynamically allocated memory is automatically cleaned up. Almost like what you're used to in C#.
Sunday, 20 September 2009, 05:32
Afr0	Thanks for the feedback Phoenix! I did get a linker error, but I had no idea why! I haven't learned about smart pointers yet, though I've heard about them. Anyways, I updated the original code. I kept the original constructor, but added an additional one. Reason being that I can pass already existing char arrays containing received packets right into a BinaryStream object, like so: void SWGPacketHandler::HandlePacket(char Data[], sockaddr_in ClientAddress) { std::cout << "SWGPacketHandler: Ready to handle SWG packet!" << std::endl; switch(Data[0] + Data[1]) { case SOEOpcodes::SOE_SESSION_REQUEST: std::cout << "Received SOE_SESSION_REQUEST packet!" << std::endl; SWGClient Client = new SWGClient(); Client->ClientAddress = ClientAddress; BinaryStream BinStream = new BinaryStream(&Data); short Opcode = BinStream->ReadShort(); int CRCLength = ntohl(BinStream->ReadInt()); int ConnectionID = ntohl(BinStream->ReadInt()); int ClientUDPSize = ntohl(BinStream->ReadInt()); std::cout << "CRCLength: " << CRCLength << std::endl; std::cout << "ConnectionID: " << ConnectionID << std::endl; std::cout << "ClientUDPSize: " << ClientUDPSize << std::endl << std::endl; Client->ConnectionID = ConnectionID; Client->CRCLength = CRCLength; Client->ClientUDPSize = ClientUDPSize; delete BinStream; BinStream = 0; SWGClientManager::Insert(Client); //Now all the neccessary reading is done, construct a SOESessionResponse packet. char PacketBuf = new char[17]; BinaryStream *PacketStream = new BinaryStream(&PacketBuf); PacketStream->WritePODType<short>(0x02); } } --v
Monday, 21 September 2009, 07:16
Afr0	Why don't you just use a struct for your packet data? Then you could access the fields directly. This seems like a very inefficient way to go about it. What? Do you mean when I'm receiving it? No I can't, the recvfrom() function only takes a char* array as a parameter for the buffer to receive into.
Monday, 21 September 2009, 07:32
Afr0	o_O Wouldn't that require more than a cast? The memory wouldn't be automagically organized in the right way, would it?

Comments