GNUMessenger::VBuffer Class Reference

A vector based byte buffer class. More...

#include <buffer.h>

Collaboration diagram for GNUMessenger::VBuffer:

[legend]List of all members.

Public Member Functions
	VBuffer ()
	Default. The internal vector has length zero.
	~VBuffer ()
	"Secure" deallocator.
	VBuffer (const string &str)
	String constructor.
	VBuffer (const char *str, unsigned long length)
	Constant character array constructor.
	VBuffer (const VBuffer &buf)
	Copy constructor.
	VBuffer (byte *str, unsigned long length)
	Byte array constructor.
void	wipe ()
const byte *	data () const
	Returns the data in the vector as a constant byte array Time complexity: Approx.
VBuffer	operator+ (const VBuffer &buf)
	VBuffer addition, returns a new VBuffer that is the union of two VBuffers.
VBuffer &	operator= (const VBuffer &buf)
	Assignment operator.
VBuffer &	operator+= (const VBuffer &buf)
	Concatination operator.
VBuffer &	operator+= (const byte &b)
	Appends a byte to the end of the vector.
VBuffer	sub (unsigned long start, unsigned long length=0) const
	Extracts a range of elements.

---

Detailed Description

A vector based byte buffer class.

Author:

Jesse Lovelace

Definition at line 37 of file buffer.h.

---

Constructor & Destructor Documentation

GNUMessenger::VBuffer::~VBuffer (   )  [inline]

"Secure" deallocator. Of course, this does not do anything if the memory was swapped to disk Definition at line 46 of file buffer.h. References GNUMessenger::scoped_array< T >::get(). { zero(); if (m_data.get()) memset(m_data.get(), 0, m_size * sizeof(byte)); } Here is the call graph for this function:

GNUMessenger::VBuffer::VBuffer (  const string &  str  )  [inline]

String constructor. Parameters: str  The VBuffer copies the string into the byte vector, this is a deep copy. Definition at line 57 of file buffer.h. :vector<byte>(str.length()) { for ( unsigned int i = 0; i < str.length(); i++) (*this)[i] = ((byte)str[i]); }

GNUMessenger::VBuffer::VBuffer (  const char *  str, unsigned long  length )  [inline]

Constant character array constructor. This is a deep copy. Parameters: str  A constant pointer to an array of characters The length of the character array Definition at line 65 of file buffer.h. :vector<byte>(length) { for ( unsigned int i = 0; i < length; i++) (*this)[i] = ((byte)str[i]); }

GNUMessenger::VBuffer::VBuffer (  const VBuffer &  buf  )  [inline]

Copy constructor. Parameters: buf  This copies the VBuffer. Definition at line 74 of file buffer.h. :vector<byte>() { reserve(buf.size()); insert(end(), buf.begin(), buf.end()); }

GNUMessenger::VBuffer::VBuffer (  byte *  str, unsigned long  length )  [inline]

Byte array constructor. Parameters: str  A pointer to byte array. length  The length of the byte array Definition at line 83 of file buffer.h. :vector<byte>(length) { for ( unsigned int i = 0; i < length; i++) (*this)[i] = (str[i]); }

---

Member Function Documentation

const byte* GNUMessenger::VBuffer::data (   )  const [inline]

Returns the data in the vector as a constant byte array Time complexity: Approx. O(N) Returns: Constant byte array. Definition at line 99 of file buffer.h. References GNUMessenger::scoped_array< T >::get(), and GNUMessenger::scoped_array< T >::reset(). { vector<byte>::const_iterator it = begin(); // zero old buffer data if (m_data.get()) memset(m_data.get(), 0,m_size * sizeof(byte)); m_size = static_cast<unsigned long>(size()); m_data.reset( new byte[size()] ); for (unsigned long i = 0; i < size(); i++) { m_data[i] = *it; it++; } return m_data.get(); } Here is the call graph for this function:

VBuffer GNUMessenger::VBuffer::operator+ (  const VBuffer &  buf  )  [inline]

VBuffer addition, returns a new VBuffer that is the union of two VBuffers. Parameters: buf  The VBuffer to union with this VBuffer Returns: A new VBuffer object Note: This is a costly operation and should be avoided if possible. Definition at line 126 of file buffer.h. { VBuffer tmp(*this); tmp.insert(tmp.end(), buf.begin(), buf.end()); return tmp; }

VBuffer& GNUMessenger::VBuffer::operator+= (  const VBuffer &  buf  )  [inline]

Concatination operator. Parameters: buf  VBuffer to append to the current VBuffer Definition at line 146 of file buffer.h. { reserve(size() + buf.size()); insert(end(), buf.begin(), buf.end()); return *this; }

---

The documentation for this class was generated from the following file:

• buffer.h

---