CrystalSpace

Public API Reference

Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

csEventFlattener Class Reference

Standard event flattener(also known as serializer). More...

#include <csutil/cseventflattener.h>

List of all members.

Static Public Member Functions

static csEventFlattenerError Flatten (iEvent *event, char *buffer)
 Flatten am event.
static csEventFlattenerError FlattenSize (iEvent *event, size_t &size)
 Query the size consumed by the flattened event.
static csEventFlattenerError Unflatten (iEvent *event, const char *buffer, size_t length)
 Unflatten an event.


Detailed Description

Standard event flattener(also known as serializer).

Converts events from/to a binary representation. Can be used for e.g. disk storage or network transfer.

Definition at line 54 of file cseventflattener.h.


Member Function Documentation

static csEventFlattenerError csEventFlattener::Flatten iEvent event,
char *  buffer
[static]
 

Flatten am event.

Remarks:
The user is responsible for allocating and deallocating the buffer memory.

static csEventFlattenerError csEventFlattener::FlattenSize iEvent event,
size_t &  size
[static]
 

Query the size consumed by the flattened event.

static csEventFlattenerError csEventFlattener::Unflatten iEvent event,
const char *  buffer,
size_t  length
[static]
 

Unflatten an event.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.4.4