---

ISerial Class Reference

Inherited by ISerialData, and ISerialString.

List of all members.

---

Detailed Description

An ISerial is analogous to an ObjectInputStream in Java.

To deserialize objects:

1. Create an istream object.
2. Create an ISerial object pointing to that ostream.
3. Read objects from the OSerial object using the >> operator.

Please refer to the OSerial documentation for a more in-depth description and example.

Public Types
enum	{   typesafe, readable, binary, compact,   automatic }
Public Methods
	ISerial (int mode=automatic)
	Constructor.
virtual	~ISerial ()
void	init ()
	operator const void * () const
	Returns a null value if an error has occured, or a non-null value if deserialization has succeeded.
Status	stat ()
	Returns an error description if some aspect of serialization has failed.
void	set_error (const string &s)
	Indicates that an aspect of serialization has failed and sets the error description.
template<class T> ISerial &	operator>> (T &t)
	Deserializes a T.
template<class T> ISerial &	insert_into (T &t)
	Deserializes all remaining elements in the stream, inserting them into into t.
template<class T> ISerial &	push_back_into (T &t)
	Deserializes all remaining elements in the stream, appending them into into t.
Protected Methods
	ISerial (const ISerial &)
ISerial &	operator= (const ISerial &)
virtual int	peek ()=0
virtual int	get ()=0
virtual bool	get (char *ch, unsigned int len)=0
template<typename T> void	default_unfreeze (ptr< T > &t)
template<typename T> void	default_unfreeze (T &t)
void	default_unfreeze (string &s)
void	default_unfreeze (dynbuf &s)
template<typename T, typename U> void	default_unfreeze (pair< T, U > &p)
template<typename Container, typename Data> void	default_unfreeze_container (Container &c)
template<typename T> void	default_unfreeze (vector< T > &t)
template<typename T, typename U> void	default_unfreeze (map< T, U > &t)
template<typename T> void	default_unfreeze (set< T > &t)
template<typename T> void	read_compact_signed (T &out)
template<typename T> void	read_compact_unsigned (T &out)
ISerial &	check_type (const char *type)
ISerial &	check_type (const char *type, unsigned int &actual_length)
string	read_string (unsigned int length)
template<class T> T	read_scalar (unsigned int length)
Protected Attributes
Status	st
int	mode
Static Protected Attributes
const int	eof = -1

---

Member Enumeration Documentation

anonymous enum

Enumeration values: typesafe  readable  binary  compact  automatic

---

Constructor & Destructor Documentation

ISerial::ISerial (  const ISerial &    )  [protected]

ISerial::ISerial (  int    mode = automatic )

Constructor. Note that ISerial automatically figures out the mode with which the stream was serialized, so there is no need to specify the mode (i.e., typesafe, binary, or compact).

virtual ISerial::~ISerial (    )  [virtual]

---

Member Function Documentation

ISerial& ISerial::check_type (  const char *    type, unsigned int &    actual_length )  [protected]

ISerial& ISerial::check_type (  const char *    type )  [protected]

template<typename T> void ISerial::default_unfreeze (  set< T > &    t )  [protected]

template<typename T, typename U> void ISerial::default_unfreeze (  map< T, U > &    t )  [protected]

template<typename T> void ISerial::default_unfreeze (  vector< T > &    t )  [protected]

template<typename T, typename U> void ISerial::default_unfreeze (  pair< T, U > &    p )  [protected]

void ISerial::default_unfreeze (  dynbuf &    s )  [protected]

void ISerial::default_unfreeze (  string &    s )  [protected]

template<typename T> void ISerial::default_unfreeze (  T &    t )  [protected]

template<typename T> void ISerial::default_unfreeze (  ptr< T > &    t )  [protected]

template<typename Container, typename Data> void ISerial::default_unfreeze_container (  Container &    c )  [protected]

virtual bool ISerial::get (  char *    ch, unsigned int    len )  [protected, pure virtual]

Implemented in ISerialData, and ISerialString.

virtual int ISerial::get (    )  [protected, pure virtual]

Implemented in ISerialData, and ISerialString.

void ISerial::init (    )

template<class T> ISerial& ISerial::insert_into (  T &    t )

Deserializes all remaining elements in the stream, inserting them into into t. T must be a container type with a single-argument insert defined (e.g., map) and T::value_type must be defined (as in STL container types).

ISerial::operator const void * (    )  const

Returns a null value if an error has occured, or a non-null value if deserialization has succeeded. Exists to facilitate the "if (my_iserial) { ... }" metaphor to test whether an error has occurred on my_iserial.

ISerial& ISerial::operator= (  const ISerial &    )  [protected]

template<class T> ISerial& ISerial::operator>> (  T &    t )

Deserializes a T.

virtual int ISerial::peek (    )  [protected, pure virtual]

Implemented in ISerialData, and ISerialString.

template<class T> ISerial& ISerial::push_back_into (  T &    t )

Deserializes all remaining elements in the stream, appending them into into t. T must be a container type with push_back defined (e.g., vector) and T::value_type must be defined (as in STL container types).

template<typename T> void ISerial::read_compact_signed (  T &    out )  [protected]

template<typename T> void ISerial::read_compact_unsigned (  T &    out )  [protected]

template<class T> T ISerial::read_scalar (  unsigned int    length )  [protected]

string ISerial::read_string (  unsigned int    length )  [protected]

void ISerial::set_error (  const string &    s )

Indicates that an aspect of serialization has failed and sets the error description.

Status ISerial::stat (    )

Returns an error description if some aspect of serialization has failed.

---

Member Data Documentation

const int ISerial::eof = -1 [static, protected]

int ISerial::mode [protected]

Status ISerial::st [protected]

---

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

• serial

---