Changes between Version 7 and Version 8 of Documentation/Serialization

Timestamp:

Feb 8, 2010, 3:18:06 PM (14 years ago)

Author:

mies

Comment:

--

Documentation/Serialization

@@ -74 +74 @@
 }}}
 Note the {{{T()}}} macro that is used for serialization of {{{std::string}}} objects. The following special handlers are provided:
- * integer support - I( value, length )
- * const int support - cI( uintmax_t )
+ * Integer support - I( variable, length ) 
+   * (De-)Serializes the lower "length"-bits of the integer variable. Beware that serialization is done bitwise. Consider filling up a byte by using cI( 0, 8 - length % 8 ) to align preceding data to a byte-boundary!
+   
+ * const int support - cI( uintmax_t, length )
+   * Serializes a constant integer value with the given bit-length.
+
  * const char* support - cT( const char* )
- * string and char* support - T( char* | std::string )
+   * Serializes a zero-terminated c-style string
+
+ * string and char* support - T( char* | std::string [, length] )
+   * (De-)Serializes a string. If no length is given, the string is serialized zero-terminated. If a length is given the length must be serialized and taken care of separately.   
+
  * pointer serialization - VO( pointer* )
+   * (De-)Serializes virtual object. Note: The object is created with new.
 
 It is always best to use types that have a specified length, e.g. {{{uint8_t}}}, {{{uint16_t}}}, ... etc. If you are serializing through a inherited type where the serialization is provided in the base class, use the {{{&}}} operator before. Such a case is e.g. the {{{NodeID}}} class: