Data unpacking interfaces. More...

#include <data_stream.hh>

Inheritance diagram for CInByteStream:

[legend]

Collaboration diagram for CInByteStream:

[legend]

Public Member Functions

CInByteStream ()

Construct an empty object. More...

CInByteStream (const char *buf, size_t sz, bool net=kByteOrderDefault)

Construct from a byte buffer. More...

CInByteStream (const unsigned char *buf, size_t sz, bool net=kByteOrderDefault)

Construct from a byte buffer. More...

CInByteStream (const signed char *buf, size_t sz, bool net=kByteOrderDefault)

Construct from a byte buffer. More...

CInByteStream (const std::string &buf, bool net=kByteOrderDefault)

Construct from a byte buffer. More...

void setSource (const char *buf, size_t sz, bool net=kByteOrderDefault)

Initialize with a byte buffer. More...

void setSource (const unsigned char *buf, size_t sz, bool net=kByteOrderDefault)

Initialize with a byte buffer. More...

void setSource (const signed char *buf, size_t sz, bool net=kByteOrderDefault)

Initialize with a byte buffer. More...

void setSource (const std::string &buf, bool net=kByteOrderDefault)

Initialize with a byte buffer. More...

__Myt & bad (int code)

Set status. More...

ssize_t seek (size_t pos)

Set current pointer. More...

ssize_t skip (ssize_t off)

Skip some data. More...

size_t cur () const

Get current pointer. More...

const char * data () const

Get a pointer to left data. More...

size_t left () const

Get byte size of left data. More...

std::string toString () const

Get a readable description of this object. More...

Unpack primitive types

These functions read sizeof c bytes from underlying data, and store result in c, with appropriate byte order transformation.

Parameters

[out] c An integer to receive the result

Returns: Reference to self

__Myt & operator>> (char &c)

__Myt & operator>> (signed char &c)

__Myt & operator>> (unsigned char &c)

__Myt & operator>> (short &c)

__Myt & operator>> (unsigned short &c)

__Myt & operator>> (int &c)

__Myt & operator>> (unsigned int &c)

__Myt & operator>> (long &c)

__Myt & operator>> (unsigned long &c)

__Myt & operator>> (long long &c)

__Myt & operator>> (unsigned long long &c)

__Myt & operator>> (wchar_t &c)

Unpack compound types

__Myt & operator>> (std::string &c)

Unpack a string. More...

__Myt & operator>> (std::wstring &c)

Unpack a wide string. More...

template<class T , size_t N>

__Myt & operator>> (T(&c)[N])

Unpack an array. More...

Manipulators

These functions operates on different manipulators to achieve special purpose.

Please see the corresponding manipulator generators in Manip for more information.

Parameters

m	Manipulator object

Returns: Reference of self

__Myt & operator>> (void(*m)(__MyBase &))

template<class T >

__Myt & operator>> (const NS_IMPL::CManipulatorRawPtr< T > &m)

template<class T >

__Myt & operator>> (const NS_IMPL::CManipulatorRawCont< T > &m)

template<class ForwardIter >

__Myt & operator>> (const NS_IMPL::CManipulatorRawRange< ForwardIter > &m)

template<typename LenT , class T >

__Myt & operator>> (const NS_IMPL::CManipulatorArrayPtr< LenT, T > &m)

template<typename LenT , class T >

__Myt & operator>> (const NS_IMPL::CManipulatorArrayCont< LenT, T > &m)

template<class T >

__Myt & operator>> (const NS_IMPL::CManipulatorValueByteOrder< T > &m)

__Myt & operator>> (const NS_IMPL::CManipulatorSeek &m)

__Myt & operator>> (const NS_IMPL::CManipulatorSkip &m)

template<typename T >

__Myt & operator>> (const NS_IMPL::CManipulatorSkipPtr< T > &m)

template<class T >

__Myt & operator>> (const NS_IMPL::CManipulatorOffsetValue< T > &m)

template<class T >

__Myt & operator>> (const NS_IMPL::CManipulatorProtobuf< T > &m)

template<typename T >

__Myt & operator>> (const NS_IMPL::CManipulatorVarint< T > &m)

__Myt & operator>> (const NS_IMPL::CManipulatorStubPush &m)

__Myt & operator>> (const NS_IMPL::CManipulatorStubPop &m)

template<class T , class S >

__Myt & operator>> (const NS_IMPL::CManipulatorEnd< T, S > &m)

__Myt & operator>> (NS_IMPL::CManipulatorEnd< void, void >(*m)())

Detailed Description

Data unpacking interfaces.

CInByteStream is super convenient for unpacking data. It receives a byte buffer containing serialized data, and tries to decode whatever you want from it.
CInByteStream manages data endianness automatically, so you don't need to call hton/ntoh family APIs manually.It also performs sufficient boundary checks so you won't end up with memory access violations.
What makes CInByteStream really powerful is that it integrates a number of manipulators, which makes unpacking complex structures a joy of life.
Sample code:

CInByteStream in(buf, sz);   // initialize from a byte buffer
// Following are the data we want to unpack
uint32_t version;        // a 32-bit integer
string name;             // a string
vector<uint64_t> orders; // an array of 64-bit integers
// Then we extract all data in ONE line!
in >> version >> name >> Manip::array(orders);

Constructor & Destructor Documentation

CInByteStream::CInByteStream ( )

inline

Construct an empty object.

You need to call setSource before you can use this object to unpack data.

See also: setSource

CInByteStream::CInByteStream	(	const char *	buf,
		size_t	sz,
		bool	net = `kByteOrderDefault`
	)

inline

Construct from a byte buffer.

Parameters

buf	Pointer to a byte buffer containing data to be unpacked
sz	Byte size of `buf`, if present
net	Byte order of the data in `buf:` `true:` Net byte order, this is the default; `false:` Host byte order;

CInByteStream::CInByteStream	(	const unsigned char *	buf,
		size_t	sz,
		bool	net = `kByteOrderDefault`
	)

inline

Construct from a byte buffer.

Parameters

buf	Pointer to a byte buffer containing data to be unpacked
sz	Byte size of `buf`, if present
net	Byte order of the data in `buf:` `true:` Net byte order, this is the default; `false:` Host byte order;

CInByteStream::CInByteStream	(	const signed char *	buf,
		size_t	sz,
		bool	net = `kByteOrderDefault`
	)

inline

Construct from a byte buffer.

Parameters

buf	Pointer to a byte buffer containing data to be unpacked
sz	Byte size of `buf`
net	Byte order of the data in `buf:` `true:` Net byte order, this is the default; `false:` Host byte order;

CInByteStream::CInByteStream	(	const std::string &	buf,
		bool	net = `kByteOrderDefault`
	)

inline

Construct from a byte buffer.

Parameters

buf	A byte buffer containing data to be unpacked
net	Byte order of the data in `buf:` `true:` Net byte order, this is the default; `false:` Host byte order;

Member Function Documentation

__Myt& CInByteStream::bad ( int code )

inline

Set status.

If status is not 0, all unpacking operations will fail.

Parameters

code	`0`: Reset status. Otherwise: A number indicating error status.

Returns: Reference of self

size_t CInByteStream::cur ( ) const

inline

Get current pointer.

Current pointer is the index of underlying data where next unpacking operation will take place. Every unpacking operation increases current pointer by the amount of data it reads.

Returns: Current pointer

const char* CInByteStream::data ( ) const

inline

Get a pointer to left data.

This function returns a pointer to the first unread byte, which is also indicated by current pointer.

Returns: A pointer to the unread data

See also: cur

size_t CInByteStream::left ( ) const

inline

Get byte size of left data.

If there are stubs, this function returns data size before current effective stub.

Returns: Bytes size of left data

See also: Manip::stub Mapip::stub_pop

__Myt& CInByteStream::operator>> ( std::string & c )

inline

Unpack a string.

This function first reads a uint16_t as the length of the result string, then reads the whole string.

Parameters

[out] c A string to receive the result

Returns: Reference to self

__Myt& CInByteStream::operator>> ( std::wstring & c )

inline

Unpack a wide string.

This function first reads a uint16_t as the length of the result wide string, then reads the whole wide string.

Parameters

[out] c A wide string to receive the result

Returns: Reference to self

template<class T , size_t N>

__Myt& CInByteStream::operator>> ( T(&) c[N] )

inline

Unpack an array.

This function reads N elements directly (without leading length field), and stores them in c.
T must be a type supported by operator >> of CInByteStream.

Template Parameters

T	Type of element in array
N	Number of elements in array

Parameters

[out] c An array to receive the result

Returns: Reference to self

ssize_t CInByteStream::seek ( size_t pos )

inline

Set current pointer.

If this function makes current pointer smaller, old data will be read again; And if current pointer becomes larger, some data will be skipped.

Parameters

pos	New current pointer

Returns

Negative: Operation failed, status will be set to a nonzero value;
Otherwise: New current pointer;

void CInByteStream::setSource	(	const char *	buf,
		size_t	sz,
		bool	net = `kByteOrderDefault`
	)

inline

Initialize with a byte buffer.

This function will also reset current pointer and status.

Parameters

buf	Pointer to a byte buffer containing data to be unpacked
sz	Byte size of `buf`, if present
net	Byte order of the data in `buf:` `true:` Net byte order, this is the default; `false:` Host byte order;

void CInByteStream::setSource	(	const unsigned char *	buf,
		size_t	sz,
		bool	net = `kByteOrderDefault`
	)

inline

Initialize with a byte buffer.

This function will also reset current pointer and status.

Parameters

buf	Pointer to a byte buffer containing data to be unpacked
sz	Byte size of `buf`, if present
net	Byte order of the data in `buf:` `true:` Net byte order, this is the default; `false:` Host byte order;

void CInByteStream::setSource	(	const signed char *	buf,
		size_t	sz,
		bool	net = `kByteOrderDefault`
	)

inline

Initialize with a byte buffer.

This function will also reset current pointer (current reading position) and status.

Parameters

buf	Pointer to a byte buffer containing data to be unpacked
sz	Byte size of `buf`, if present
net	Byte order of the data in `buf:` `true:` Net byte order, this is the default; `false:` Host byte order;

void CInByteStream::setSource	(	const std::string &	buf,
		bool	net = `kByteOrderDefault`
	)

inline

Initialize with a byte buffer.

Parameters

buf	A byte buffer containing data to be unpacked
net	Byte order of the data in `buf:` `true:` Net byte order, this is the default; `false:` Host byte order;

ssize_t CInByteStream::skip ( ssize_t off )

inline

Skip some data.

This function is equivalent to seek(cur() + off).

Parameters

off	Bytes size of data to skip.

Returns

Negative: Operation failed, status will be set to a nonzero value;
Otherwise: New current pointer;

Note: You can also give a negative off to jump back to old data.

std::string CInByteStream::toString ( ) const

inline

Get a readable description of this object.

Returns: A readable description of this object

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

data_stream.hh