Ddf

Descriptor

descriptor handle

Opaque pointer that holds info about a message type.


OPTION_OFFSET_POINTERS()

Store pointers as offset from base address. Needed...

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


Result

result enumeration

Result enumeration.

MEMBERS

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,


GetDescriptorFromHash(hash)

Get Descriptor from hash name

Get Descriptor from hash name

PARAMETERS

hash - hash of type name

RETURN

descriptor - 0 if not found


LoadMessage(buffer, buffer_size, desc, message)

Load/decode a DDF message from buffer

Load/decode a DDF message from buffer

PARAMETERS

buffer - Input buffer

buffer_size - Input buffer size in bytes

desc - DDF descriptor

message - (out) Destination pointer to message

RETURN

RESULT_OK - on success


LoadMessage(buffer, buffer_size, desc, message, options, size)

Load/decode a DDF message from buffer

Load/decode a DDF message from buffer

PARAMETERS

buffer - Input buffer

buffer_size - Input buffer size in bytes

desc - DDF descriptor

message - (out) Destination pointer to message

options - options, eg dmDDF::OPTION_OFFSET_POINTERS

size - (out) loaded message size

RETURN

RESULT_OK - on success


SaveMessageToArray(message, desc, buffer)

Save message to array

Save message to array

PARAMETERS

message - Message

desc - DDF descriptor

buffer - Buffer to save to

RETURN

RESULT_OK - on success


LoadMessage(buffer, buffer_size, message)

Load/decode a DDF message from buffer. Template va...

Load/decode a DDF message from buffer. Template variant

PARAMETERS

buffer - Input buffer

buffer_size - Input buffer size in bytes

message - (out) Destination pointer to message

RETURN

RESULT_OK - on success


LoadMessageFromFile(file_name, desc, message)

Load/decode a DDF message from file

Load/decode a DDF message from file

PARAMETERS

file_name - File name

desc - DDF descriptor

message - (out) Destination pointer to message

RETURN

RESULT_OK - on success


ResolvePointers(desc, message)

If the message was loaded with the flag dmDDF::OPT...

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

desc - DDF descriptor

message - (int/out) The message to patch pointers in

RETURN

RESULT_OK - on success


FreeMessage(message)

Free message

Free message

PARAMETERS

message - The message