An interface for serializable objects. More...

Inheritance diagram for ISerializable:

Public Member Functions
virtual	~ISerializable ()

virtual size_t	GetSerializedLength () const =0
	Return the length of the serialized form of this object. More...

virtual u8 *	Serialize (u8 *buffer) const =0
	Serialize the object into the passed buffer. More...

virtual const u8 *	Deserialize (const u8 buffer, const u8 end)=0
	Deserialize the object (i.e. More...

Detailed Description

An interface for serializable objects.

For a serializable object to be usable as a network message field, it must have a constructor without arguments.

Definition at line 75 of file Serialization.h.

Constructor & Destructor Documentation

virtual ISerializable::~ISerializable ( )

inlinevirtual

Definition at line 78 of file Serialization.h.

virtual const u8* ISerializable::Deserialize	(	const u8 *	buffer,
		const u8 *	end
	)

pure virtual

Deserialize the object (i.e.

read in data from the buffer and initialize the object's fields). Note that it is up to the deserializer to detect errors in data format.

Parameters

buffer	A pointer pointing to the start of the serialized data.
end	A pointer to the end of the message.

Returns: a pointer to the location in the buffer right after the serialized object, or NULL if there was a data format error

virtual size_t ISerializable::GetSerializedLength ( ) const

pure virtual

Return the length of the serialized form of this object.

virtual u8* ISerializable::Serialize ( u8 * buffer ) const

pure virtual

Serialize the object into the passed buffer.

Returns: a pointer to the location in the buffer right after the serialized object

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