| Catalina Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | ||||
#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);
#define CATALINA_BINARY_FORMATTER_ERROR (catalina_binary_formatter_error_quark ())
CatalinaBinaryFormatter GError domain.
typedef enum {
CATALINA_BINARY_FORMATTER_ERROR_BAD_TYPE,
CATALINA_BINARY_FORMATTER_ERROR_BAD_DATA,
} CatalinaBinaryFormatterError;
CatalinaBinaryFormatter error enumeration.
CatalinaFormatter* catalina_binary_formatter_new (void);
Creates a new instance of the binary formatter.
Returns : |
the newly created CatalinaBinaryFormatter instance |
GQuark catalina_binary_formatter_error_quark (void);
Returns : |
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.
|
A CatalinaBinaryFormatter |
|
A gboolean |
|
A location for the resulting buffer |
|
A location to store the resulting buffer length |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A location for a gboolean |
|
the buffer to read |
|
the length of the buffer |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A gchar |
|
A location for the resulting buffer |
|
A location to store the resulting buffer length |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A location for a gchar |
|
the buffer to read |
|
the length of the buffer |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A guchar |
|
A location for the resulting buffer |
|
A location to store the resulting buffer length |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A location for a guchar |
|
the buffer to read |
|
the length of the buffer |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A gshort |
|
A location for the resulting buffer |
|
A location to store the resulting buffer length |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A location for a gshort |
|
the buffer to read |
|
the length of the buffer |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A gushort |
|
A location for the resulting buffer |
|
A location to store the resulting buffer length |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A location for a gushort |
|
the buffer to read |
|
the length of the buffer |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A gint |
|
A location for the resulting buffer |
|
A location to store the resulting buffer length |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A location for a gint |
|
the buffer to read |
|
the length of the buffer |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A guint |
|
A location for the resulting buffer |
|
A location to store the resulting buffer length |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A location for a guint |
|
the buffer to read |
|
the length of the buffer |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A glong |
|
A location for the resulting buffer |
|
A location to store the resulting buffer length |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A location for a glong |
|
the buffer to read |
|
the length of the buffer |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A gulong |
|
A location for the resulting buffer |
|
A location to store the resulting buffer length |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A location for a gulong |
|
the buffer to read |
|
the length of the buffer |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A gint64 |
|
A location for the resulting buffer |
|
A location to store the resulting buffer length |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A location for a gint64 |
|
the buffer to read |
|
the length of the buffer |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A guint64 |
|
A location for the resulting buffer |
|
A location to store the resulting buffer length |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A location for a guint64 |
|
the buffer to read |
|
the length of the buffer |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A string or NULL
|
|
the length of the string or -1 if it is NULL terminated
|
|
A location for the resulting buffer |
|
A location to store the resulting buffer length |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A location for a string |
|
A location for the strings length |
|
the buffer to read |
|
the length of the buffer |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A gdouble |
|
A location for the resulting buffer |
|
A location to store the resulting buffer length |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A gdouble |
|
A location for the resulting buffer |
|
A location to store the resulting buffer length |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A gfloat |
|
A location for the resulting buffer |
|
A location to store the resulting buffer length |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A gfloat |
|
A location for the resulting buffer |
|
A location to store the resulting buffer length |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
the object to serialize |
|
a location for the resulting buffer |
|
a location for the size of the resulting buffer |
|
a location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
a location for a GObject |
|
the buffer to deserialize |
|
the length of buffer
|
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A GValue |
|
a location to store the resulting buffer |
|
A location to store the resulting buffer length |
|
A location for a GError or NULL
|
Returns : |
TRUE on success
|
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.
|
A CatalinaBinaryFormatter |
|
A GValue |
|
the buffer to deserialize |
|
the length of buffer
|
|
a location for a GError or NULL
|
Returns : |
TRUE on success
|