packable.h File Reference

#include "byte_array.h"

Include dependency graph for packable.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	basis
Classes
class	packable
	A base class for objects that can pack into bytes. More...
Functions
void	basis::attach (byte_array &packed_form, bool to_attach)
	Packs a bool "to_attach" into "packed_form".
bool	basis::detach (byte_array &packed_form, bool &to_detach)
	Unpacks a bool "to_detach" from "packed_form".
void	basis::attach (byte_array &packed_form, byte to_attach)
	Packs a byte "to_attach" into "packed_form".
bool	basis::detach (byte_array &packed_form, byte &to_detach)
	Unpacks a byte "to_detach" from "packed_form".
int	basis::packed_size (byte_array &packed_form)
	Reports the size required to pack a byte array into a byte array.
void	basis::attach (byte_array &packed_form, const byte_array &to_attach)
	Packs a byte_array "to_attach" into "packed_form".
bool	basis::detach (byte_array &packed_form, byte_array &to_detach)
	Unpacks a byte_array "to_detach" from "packed_form".
void	basis::attach (byte_array &packed_form, char to_attach)
	Packs a char "to_attach" into "packed_form".
bool	basis::detach (byte_array &packed_form, char &to_detach)
	Unpacks a char "to_detach" from "packed_form".
void	basis::attach (byte_array &packed_form, const char *to_attach)
	Packs a character string "to_attach" into "packed_form".
bool	basis::detach (byte_array &packed_form, istring &to_detach)
	Unpacks a character string "to_attach" from "packed_form".
void	basis::attach (byte_array &packed_form, double to_pack)
	Packs a double precision floating point "to_attach" into "packed_form".
bool	basis::detach (byte_array &packed_form, double &to_unpack)
	Unpacks a double precision floating point "to_attach" from "packed_form".
void	basis::attach (byte_array &packed_form, float to_pack)
	Packs a floating point "to_attach" into "packed_form".
bool	basis::detach (byte_array &packed_form, float &to_unpack)
	Unpacks a floating point "to_attach" from "packed_form".
void	basis::attach (byte_array &packed_form, int to_attach)
	Packs an integer "to_attach" into "packed_form".
bool	basis::detach (byte_array &packed_form, int &to_detach)
	Unpacks an integer "to_attach" from "packed_form".
void	basis::obscure_attach (byte_array &packed_form, int to_attach)
	like the normal attach but shifts in some recognizable sentinel data.
bool	basis::obscure_detach (byte_array &packed_form, int &to_detach)
	shifts the number back and checks validity, false returned if corrupted.
void	basis::attach (byte_array &packed_form, long to_attach)
	Packs a long integer "to_attach" into "packed_form".
bool	basis::detach (byte_array &packed_form, long &to_detach)
	Unpacks a long integer "to_attach" from "packed_form".
void	basis::attach (byte_array &packed_form, short to_attach)
	Packs a short integer "to_attach" into "packed_form".
bool	basis::detach (byte_array &packed_form, short &to_detach)
	Unpacks a short integer "to_attach" from "packed_form".
void	basis::attach (byte_array &packed_form, u_int to_attach)
	Packs an unsigned integer "to_attach" into "packed_form".
bool	basis::detach (byte_array &packed_form, u_int &to_detach)
	Unpacks an unsigned integer "to_attach" from "packed_form".
void	basis::attach (byte_array &packed_form, u_long to_attach)
	Packs an unsigned long integer "to_attach" into "packed_form".
bool	basis::detach (byte_array &packed_form, u_long &to_detach)
	Unpacks an unsigned long integer "to_attach" from "packed_form".
void	basis::attach (byte_array &packed_form, u_short to_attach)
	Packs an unsigned short integer "to_attach" into "packed_form".
bool	basis::detach (byte_array &packed_form, u_short &to_detach)
	Unpacks an unsigned short integer "to_attach" from "packed_form".
template<class contents>
void	basis::pack (byte_array &packed_form, const array< contents > &to_pack)
	provides a way to pack any array that stores packable objects.
template<class contents>
bool	basis::unpack (byte_array &packed_form, array< contents > &to_unpack)
	provides a way to unpack any array that stores packable objects.
template<class contents>
int	basis::packed_size (const array< contents > &to_pack)
	provides space estimation for the objects to be packed.
template<class contents>
void	basis::pack_simple (byte_array &packed_form, const array< contents > &to_pack)
	Packs flat objects into an array of bytes.
template<class contents>
bool	basis::unpack_simple (byte_array &packed_form, array< contents > &to_unpack)
	Unpacks flat objects from an array of bytes.

---