Ddf

Namespace: dmDDF
Include: #include <>
TYPES
Descriptor descriptor handle
ENUMS
Result result enumeration
FUNCTIONS
void FreeMessage(void* message) Free message
dmDDF::Descriptor* GetDescriptorFromHash(dmhash_t hash) Get Descriptor from hash name
 LoadMessage(const void* buffer, uint32_t buffer_size, dmDDF::Descriptor* desc, void** message) Load/decode a DDF message from buffer
 LoadMessage(const void* buffer, uint32_t buffer_size, dmDDF::Descriptor* desc, void** message, uint32_t options, uint32_t* size) Load/decode a DDF message from buffer
 LoadMessage(const void* buffer, uint32_t buffer_size, T** message) Load/decode a DDF message from buffer. Template va...
 LoadMessageFromFile(const char* file_name, dmDDF::Descriptor* desc, void** message) Load/decode a DDF message from file
void OPTION_OFFSET_POINTERS() Store pointers as offset from base address. Needed...
 ResolvePointers(dmDDF::Descriptor* desc, void* message) If the message was loaded with the flag dmDDF::OPT...
 SaveMessageToArray(const void* message, dmDDF::Descriptor* desc, dmArray& buffer) Save message to array

Functions

FreeMessage

void FreeMessage(void* message)

Free message

PARAMETERS

void* message The message

GetDescriptorFromHash

dmDDF::Descriptor* GetDescriptorFromHash(dmhash_t hash)

Get Descriptor from hash name

PARAMETERS

dmhash_t hash hash of type name

RETURNS

dmDDF::Descriptor* 0 if not found

LoadMessage

 LoadMessage(const void* buffer, uint32_t buffer_size, dmDDF::Descriptor* desc, void** message)

Load/decode a DDF message from buffer

PARAMETERS

const void* buffer Input buffer
uint32_t buffer_size Input buffer size in bytes
dmDDF::Descriptor* desc DDF descriptor
void** message (out) Destination pointer to message

RETURNS

on success

LoadMessage

 LoadMessage(const void* buffer, uint32_t buffer_size, dmDDF::Descriptor* desc, void** message, uint32_t options, uint32_t* size)

Load/decode a DDF message from buffer

PARAMETERS

const void* buffer Input buffer
uint32_t buffer_size Input buffer size in bytes
dmDDF::Descriptor* desc DDF descriptor
void** message (out) Destination pointer to message
uint32_t options options, eg dmDDF::OPTION_OFFSET_POINTERS
uint32_t* size (out) loaded message size

RETURNS

on success

LoadMessage

 LoadMessage(const void* buffer, uint32_t buffer_size, T** message)

Load/decode a DDF message from buffer. Template variant

PARAMETERS

const void* buffer Input buffer
uint32_t buffer_size Input buffer size in bytes
T** message (out) Destination pointer to message

RETURNS

on success

LoadMessageFromFile

 LoadMessageFromFile(const char* file_name, dmDDF::Descriptor* desc, void** message)

Load/decode a DDF message from file

PARAMETERS

const char* file_name File name
dmDDF::Descriptor* desc DDF descriptor
void** message (out) Destination pointer to message

RETURNS

on success

OPTION_OFFSET_POINTERS

void OPTION_OFFSET_POINTERS()

Store pointers as offset from base address. Needed when serializing entire messages (copy). Value (1 << 0)

PARAMETERS

ResolvePointers

 ResolvePointers(dmDDF::Descriptor* desc, void* message)

If the message was loaded with the flag dmDDF::OPTION_OFFSET_POINTERS, all pointers have their offset stored. This function resolves those offsets into actual pointers

PARAMETERS

dmDDF::Descriptor* desc DDF descriptor
void* message (int/out) The message to patch pointers in

RETURNS

on success

SaveMessageToArray

 SaveMessageToArray(const void* message, dmDDF::Descriptor* desc, dmArray& buffer)

Save message to array

PARAMETERS

const void* message Message
dmDDF::Descriptor* desc DDF descriptor
dmArray& buffer Buffer to save to

RETURNS

on success

Types

Descriptor

Opaque pointer that holds info about a message type.

Enums

Result

Result enumeration.

dmDDF::RESULT_OK = 0,
dmDDF::RESULT_FIELDTYPE_MISMATCH = 1,
dmDDF::RESULT_WIRE_FORMAT_ERROR = 2,
dmDDF::RESULT_IO_ERROR = 3,
dmDDF::RESULT_VERSION_MISMATCH = 4,
dmDDF::RESULT_MISSING_REQUIRED = 5,
dmDDF::RESULT_INTERNAL_ERROR = 1000,