CatalinaBinaryFormatter

CatalinaBinaryFormatter — binary serialization reader/writer

Synopsis

#define             CATALINA_BINARY_FORMATTER_ERROR
enum                CatalinaBinaryFormatterError;
                    CatalinaBinaryFormatterPrivate;
                    CatalinaBinaryFormatter;
CatalinaFormatter*  catalina_binary_formatter_new       (void);
GQuark              catalina_binary_formatter_error_quark
                                                        (void);
gboolean            catalina_binary_formatter_write_boolean
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gboolean value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_read_boolean
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gboolean *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_write_char
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gchar value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_read_char (CatalinaBinaryFormatter *formatter,
                                                         gchar *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_write_uchar
                                                        (CatalinaBinaryFormatter *formatter,
                                                         guchar value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_read_uchar
                                                        (CatalinaBinaryFormatter *formatter,
                                                         guchar *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_write_short
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gshort value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_read_short
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gshort *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_write_ushort
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gushort value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_read_ushort
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gushort *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_write_int (CatalinaBinaryFormatter *formatter,
                                                         gint value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_read_int  (CatalinaBinaryFormatter *formatter,
                                                         gint *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_write_uint
                                                        (CatalinaBinaryFormatter *formatter,
                                                         guint value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_read_uint (CatalinaBinaryFormatter *formatter,
                                                         guint *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_write_long
                                                        (CatalinaBinaryFormatter *formatter,
                                                         glong value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_read_long (CatalinaBinaryFormatter *formatter,
                                                         glong *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_write_ulong
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gulong value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_read_ulong
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gulong *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_write_int64
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gint64 value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_read_int64
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gint64 *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_write_uint64
                                                        (CatalinaBinaryFormatter *formatter,
                                                         guint64 value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_read_uint64
                                                        (CatalinaBinaryFormatter *formatter,
                                                         guint64 *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_write_string
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gchar *value,
                                                         gint value_length,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_read_string
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gchar **value,
                                                         guint *value_length,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_write_double
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gdouble value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_read_double
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gdouble *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_write_float
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gfloat value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_read_float
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gfloat *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_write_object
                                                        (CatalinaBinaryFormatter *formatter,
                                                         GObject *object,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_read_object
                                                        (CatalinaBinaryFormatter *formatter,
                                                         GObject **object,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_write_value
                                                        (CatalinaBinaryFormatter *formatter,
                                                         GValue *value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);
gboolean            catalina_binary_formatter_read_value
                                                        (CatalinaBinaryFormatter *formatter,
                                                         GValue *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);

Object Hierarchy

  GObject
   +----CatalinaBinaryFormatter

Implemented Interfaces

CatalinaBinaryFormatter implements CatalinaFormatter.

Description

Implements CatalinaFormatter providing a compact binary serialization format.

Details

CATALINA_BINARY_FORMATTER_ERROR

#define CATALINA_BINARY_FORMATTER_ERROR (catalina_binary_formatter_error_quark ())

CatalinaBinaryFormatter GError domain.


enum CatalinaBinaryFormatterError

typedef enum {
	CATALINA_BINARY_FORMATTER_ERROR_BAD_TYPE,
	CATALINA_BINARY_FORMATTER_ERROR_BAD_DATA,
} CatalinaBinaryFormatterError;

CatalinaBinaryFormatter error enumeration.

CATALINA_BINARY_FORMATTER_ERROR_BAD_TYPE

The formatter could not determine how to format the rquested GType.

CATALINA_BINARY_FORMATTER_ERROR_BAD_DATA

The data within the buffer was invalid.

CatalinaBinaryFormatterPrivate

typedef struct {
	gpointer dummy;
} CatalinaBinaryFormatterPrivate;


CatalinaBinaryFormatter

typedef struct _CatalinaBinaryFormatter CatalinaBinaryFormatter;


catalina_binary_formatter_new ()

CatalinaFormatter*  catalina_binary_formatter_new       (void);

Creates a new instance of the binary formatter.

Returns :

the newly created CatalinaBinaryFormatter instance

catalina_binary_formatter_error_quark ()

GQuark              catalina_binary_formatter_error_quark
                                                        (void);

Returns :


catalina_binary_formatter_write_boolean ()

gboolean            catalina_binary_formatter_write_boolean
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gboolean value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);

Serializes value into a buffer which is stored at the location buffer. The resulting buffer length is stored to buffer_length.

formatter :

A CatalinaBinaryFormatter

value :

A gboolean

buffer :

A location for the resulting buffer

buffer_length :

A location to store the resulting buffer length

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_read_boolean ()

gboolean            catalina_binary_formatter_read_boolean
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gboolean *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);

Deserializes a gboolean from buffer and stores it at the location pointed by value.

formatter :

A CatalinaBinaryFormatter

value :

A location for a gboolean

buffer :

the buffer to read

buffer_length :

the length of the buffer

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_write_char ()

gboolean            catalina_binary_formatter_write_char
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gchar value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);

Serializes value into a buffer which is stored at the location buffer. The resulting buffer length is stored to buffer_length.

formatter :

A CatalinaBinaryFormatter

value :

A gchar

buffer :

A location for the resulting buffer

buffer_length :

A location to store the resulting buffer length

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_read_char ()

gboolean            catalina_binary_formatter_read_char (CatalinaBinaryFormatter *formatter,
                                                         gchar *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);

Deserializes a gchar from buffer and stores it at the location pointed by value.

formatter :

A CatalinaBinaryFormatter

value :

A location for a gchar

buffer :

the buffer to read

buffer_length :

the length of the buffer

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_write_uchar ()

gboolean            catalina_binary_formatter_write_uchar
                                                        (CatalinaBinaryFormatter *formatter,
                                                         guchar value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);

Serializes value into a buffer which is stored at the location buffer. The resulting buffer length is stored to buffer_length.

formatter :

A CatalinaBinaryFormatter

value :

A guchar

buffer :

A location for the resulting buffer

buffer_length :

A location to store the resulting buffer length

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_read_uchar ()

gboolean            catalina_binary_formatter_read_uchar
                                                        (CatalinaBinaryFormatter *formatter,
                                                         guchar *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);

Deserializes a guchar from buffer and stores it at the location pointed by value.

formatter :

A CatalinaBinaryFormatter

value :

A location for a guchar

buffer :

the buffer to read

buffer_length :

the length of the buffer

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_write_short ()

gboolean            catalina_binary_formatter_write_short
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gshort value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);

Serializes value into a buffer which is stored at the location buffer. The resulting buffer length is stored to buffer_length.

formatter :

A CatalinaBinaryFormatter

value :

A gshort

buffer :

A location for the resulting buffer

buffer_length :

A location to store the resulting buffer length

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_read_short ()

gboolean            catalina_binary_formatter_read_short
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gshort *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);

Deserializes a gshort from buffer and stores it at the location pointed by value.

formatter :

A CatalinaBinaryFormatter

value :

A location for a gshort

buffer :

the buffer to read

buffer_length :

the length of the buffer

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_write_ushort ()

gboolean            catalina_binary_formatter_write_ushort
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gushort value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);

Serializes value into a buffer which is stored at the location buffer. The resulting buffer length is stored to buffer_length.

formatter :

A CatalinaBinaryFormatter

value :

A gushort

buffer :

A location for the resulting buffer

buffer_length :

A location to store the resulting buffer length

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_read_ushort ()

gboolean            catalina_binary_formatter_read_ushort
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gushort *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);

Deserializes a gushort from buffer and stores it at the location pointed by value.

formatter :

A CatalinaBinaryFormatter

value :

A location for a gushort

buffer :

the buffer to read

buffer_length :

the length of the buffer

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_write_int ()

gboolean            catalina_binary_formatter_write_int (CatalinaBinaryFormatter *formatter,
                                                         gint value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);

Serializes value into a buffer which is stored at the location buffer. The resulting buffer length is stored to buffer_length.

formatter :

A CatalinaBinaryFormatter

value :

A gint

buffer :

A location for the resulting buffer

buffer_length :

A location to store the resulting buffer length

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_read_int ()

gboolean            catalina_binary_formatter_read_int  (CatalinaBinaryFormatter *formatter,
                                                         gint *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);

Deserializes a gint from buffer and stores it at the location pointed by value.

formatter :

A CatalinaBinaryFormatter

value :

A location for a gint

buffer :

the buffer to read

buffer_length :

the length of the buffer

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_write_uint ()

gboolean            catalina_binary_formatter_write_uint
                                                        (CatalinaBinaryFormatter *formatter,
                                                         guint value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);

Serializes value into a buffer which is stored at the location buffer. The resulting buffer length is stored to buffer_length.

formatter :

A CatalinaBinaryFormatter

value :

A guint

buffer :

A location for the resulting buffer

buffer_length :

A location to store the resulting buffer length

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_read_uint ()

gboolean            catalina_binary_formatter_read_uint (CatalinaBinaryFormatter *formatter,
                                                         guint *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);

Deserializes a guint from buffer and stores it at the location pointed by value.

formatter :

A CatalinaBinaryFormatter

value :

A location for a guint

buffer :

the buffer to read

buffer_length :

the length of the buffer

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_write_long ()

gboolean            catalina_binary_formatter_write_long
                                                        (CatalinaBinaryFormatter *formatter,
                                                         glong value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);

Serializes value into a buffer which is stored at the location buffer. The resulting buffer length is stored to buffer_length.

formatter :

A CatalinaBinaryFormatter

value :

A glong

buffer :

A location for the resulting buffer

buffer_length :

A location to store the resulting buffer length

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_read_long ()

gboolean            catalina_binary_formatter_read_long (CatalinaBinaryFormatter *formatter,
                                                         glong *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);

Deserializes a glong from buffer and stores it at the location pointed by value.

formatter :

A CatalinaBinaryFormatter

value :

A location for a glong

buffer :

the buffer to read

buffer_length :

the length of the buffer

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_write_ulong ()

gboolean            catalina_binary_formatter_write_ulong
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gulong value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);

Serializes value into a buffer which is stored at the location buffer. The resulting buffer length is stored to buffer_length.

formatter :

A CatalinaBinaryFormatter

value :

A gulong

buffer :

A location for the resulting buffer

buffer_length :

A location to store the resulting buffer length

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_read_ulong ()

gboolean            catalina_binary_formatter_read_ulong
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gulong *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);

Deserializes a gulong from buffer and stores it at the location pointed by value.

formatter :

A CatalinaBinaryFormatter

value :

A location for a gulong

buffer :

the buffer to read

buffer_length :

the length of the buffer

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_write_int64 ()

gboolean            catalina_binary_formatter_write_int64
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gint64 value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);

Serializes value into a buffer which is stored at the location buffer. The resulting buffer length is stored to buffer_length.

formatter :

A CatalinaBinaryFormatter

value :

A gint64

buffer :

A location for the resulting buffer

buffer_length :

A location to store the resulting buffer length

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_read_int64 ()

gboolean            catalina_binary_formatter_read_int64
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gint64 *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);

Deserializes a gint64 from buffer and stores it at the location pointed by value.

formatter :

A CatalinaBinaryFormatter

value :

A location for a gint64

buffer :

the buffer to read

buffer_length :

the length of the buffer

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_write_uint64 ()

gboolean            catalina_binary_formatter_write_uint64
                                                        (CatalinaBinaryFormatter *formatter,
                                                         guint64 value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);

Serializes value into a buffer which is stored at the location buffer. The resulting buffer length is stored to buffer_length.

formatter :

A CatalinaBinaryFormatter

value :

A guint64

buffer :

A location for the resulting buffer

buffer_length :

A location to store the resulting buffer length

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_read_uint64 ()

gboolean            catalina_binary_formatter_read_uint64
                                                        (CatalinaBinaryFormatter *formatter,
                                                         guint64 *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);

Deserializes a guint64 from buffer and stores it at the location pointed by value.

formatter :

A CatalinaBinaryFormatter

value :

A location for a guint64

buffer :

the buffer to read

buffer_length :

the length of the buffer

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_write_string ()

gboolean            catalina_binary_formatter_write_string
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gchar *value,
                                                         gint value_length,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);

Serializes value into a buffer which is stored at the location buffer. The resulting buffer length is stored to buffer_length.

formatter :

A CatalinaBinaryFormatter

value :

A string or NULL

value_length :

the length of the string or -1 if it is NULL terminated

buffer :

A location for the resulting buffer

buffer_length :

A location to store the resulting buffer length

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_read_string ()

gboolean            catalina_binary_formatter_read_string
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gchar **value,
                                                         guint *value_length,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);

Deserializes a string from buffer and stores it at the location pointed by value.

formatter :

A CatalinaBinaryFormatter

value :

A location for a string

value_length :

A location for the strings length

buffer :

the buffer to read

buffer_length :

the length of the buffer

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_write_double ()

gboolean            catalina_binary_formatter_write_double
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gdouble value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);

Serializes value into a buffer which is stored at the location buffer. The resulting buffer length is stored to buffer_length.

formatter :

A CatalinaBinaryFormatter

value :

A gdouble

buffer :

A location for the resulting buffer

buffer_length :

A location to store the resulting buffer length

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_read_double ()

gboolean            catalina_binary_formatter_read_double
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gdouble *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);

Serializes value into a buffer which is stored at the location buffer. The resulting buffer length is stored to buffer_length.

formatter :

A CatalinaBinaryFormatter

value :

A gdouble

buffer :

A location for the resulting buffer

buffer_length :

A location to store the resulting buffer length

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_write_float ()

gboolean            catalina_binary_formatter_write_float
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gfloat value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);

Serializes value into a buffer which is stored at the location buffer. The resulting buffer length is stored to buffer_length.

formatter :

A CatalinaBinaryFormatter

value :

A gfloat

buffer :

A location for the resulting buffer

buffer_length :

A location to store the resulting buffer length

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_read_float ()

gboolean            catalina_binary_formatter_read_float
                                                        (CatalinaBinaryFormatter *formatter,
                                                         gfloat *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);

Serializes value into a buffer which is stored at the location buffer. The resulting buffer length is stored to buffer_length.

formatter :

A CatalinaBinaryFormatter

value :

A gfloat

buffer :

A location for the resulting buffer

buffer_length :

A location to store the resulting buffer length

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_write_object ()

gboolean            catalina_binary_formatter_write_object
                                                        (CatalinaBinaryFormatter *formatter,
                                                         GObject *object,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);

Serialized object and stores the resulting buffer into the location provided by buffer. The buffer length is stored in buffer_length.

formatter :

A CatalinaBinaryFormatter

object :

the object to serialize

buffer :

a location for the resulting buffer

buffer_length :

a location for the size of the resulting buffer

error :

a location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_read_object ()

gboolean            catalina_binary_formatter_read_object
                                                        (CatalinaBinaryFormatter *formatter,
                                                         GObject **object,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);

Deserializes buffer and generates a GObject instances from it. Upon error, FALSE is returned and error is set.

formatter :

A CatalinaBinaryFormatter

object :

a location for a GObject

buffer :

the buffer to deserialize

buffer_length :

the length of buffer

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_write_value ()

gboolean            catalina_binary_formatter_write_value
                                                        (CatalinaBinaryFormatter *formatter,
                                                         GValue *value,
                                                         gchar **buffer,
                                                         guint *buffer_length,
                                                         GError **error);

Serializes the real value stored in value using the most appropriate serialization method. The resulting buffer is stored in buffer.

Upon error, FALSE is returned and error is set.

formatter :

A CatalinaBinaryFormatter

value :

A GValue

buffer :

a location to store the resulting buffer

buffer_length :

A location to store the resulting buffer length

error :

A location for a GError or NULL

Returns :

TRUE on success

catalina_binary_formatter_read_value ()

gboolean            catalina_binary_formatter_read_value
                                                        (CatalinaBinaryFormatter *formatter,
                                                         GValue *value,
                                                         gchar *buffer,
                                                         guint buffer_length,
                                                         GError **error);

Attempts to determine the data-type stored within the buffer and deserializes it. The resulting deserialized value is stored within value.

Upon error, FALSE is returned and error is set.

formatter :

A CatalinaBinaryFormatter

value :

A GValue

buffer :

the buffer to deserialize

buffer_length :

the length of buffer

error :

a location for a GError or NULL

Returns :

TRUE on success