SPRpcValue

typedef struct sp_rpc_value_t SPRpcValue;

enum SPRpcTypeValue

typedef enum
{
  SP_RPC_TYPE_NULL,

  SP_RPC_TYPE_NUMBER,
  SP_RPC_TYPE_BOOLEAN,
  
  SP_RPC_TYPE_STRING,

  SP_RPC_TYPE_ARRAY,
  SP_RPC_TYPE_STRUCT
} SPRpcTypeValue;

The types for a SPRpcValue

sp_rpc_value_new ()

SPRpcValue*         sp_rpc_value_new                    (void);

Creates a new SPRpcValue with type SP_RPC_TYPE_NULL.

sp_rpc_value_ref ()

void                sp_rpc_value_ref                    (SPRpcValue *value);

Increases the reference count of a SPRpcValue.

sp_rpc_value_unref ()

void                sp_rpc_value_unref                  (SPRpcValue *value);

Decreases the reference count of a SPRpcValue. When its reference count drops to 0, the SPRpcValue is finalized.

sp_rpc_value_set_type ()

void                sp_rpc_value_set_type               (SPRpcValue *value,
                                                         SPRpcTypeValue type);

Changes the type of a SPRpcValue. It removes the previous value of the SPRpcValue.

sp_rpc_value_get_type ()

SPRpcTypeValue      sp_rpc_value_get_type               (SPRpcValue *value);

Returns the type of a SPRpcValue

sp_rpc_value_get_number ()

gdouble             sp_rpc_value_get_number             (SPRpcValue *value);

Returns the value of SPRpcValue if its type is SP_RPC_TYPE_NUMBER.

sp_rpc_value_set_number ()

void                sp_rpc_value_set_number             (SPRpcValue *value,
                                                         gdouble v_number);

Sets the v_number into a SPRpcValue if its type is SP_RPC_TYPE_NUMBER.

sp_rpc_value_set_boolean ()

void                sp_rpc_value_set_boolean            (SPRpcValue *value,
                                                         gboolean v_boolean);

Sets a boolean value into a SPRpcValue if its type is SP_RPC_TYPE_BOOLEAN.

sp_rpc_value_get_boolean ()

gboolean            sp_rpc_value_get_boolean            (SPRpcValue *value);

Returns the value of SPRpcValue if its type is SP_RPC_TYPE_BOOLEAN.

sp_rpc_value_set_string ()

void                sp_rpc_value_set_string             (SPRpcValue *value,
                                                         gchar *v_string);

Sets a string into a SPRpcValue if its type is SP_RPC_TYPE_STRING.

sp_rpc_value_set_string_printf ()

void                sp_rpc_value_set_string_printf      (SPRpcValue *value,
                                                         gchar *format,
                                                         ...);

Sets a string from a format string into a SPRpcValue if its type is SP_RPC_TYPE_STRING.

sp_rpc_value_get_string ()

gchar*              sp_rpc_value_get_string             (SPRpcValue *value);

Returns the value of SPRpcValue if its type is SP_RPC_TYPE_STRING. This string must be freed with g_free().

sp_rpc_value_array_length ()

guint               sp_rpc_value_array_length           (SPRpcValue *varray);

Returns the number of items of an array if the varray is a SP_RPC_TYPE_ARRAY.

sp_rpc_value_array_get ()

SPRpcValue*         sp_rpc_value_array_get              (SPRpcValue *varray,
                                                         guint id);

Returns an item of an array if the varray is a SP_RPC_TYPE_ARRAY.

sp_rpc_value_array_get_id_by_value ()

gint                sp_rpc_value_array_get_id_by_value  (SPRpcValue *varray,
                                                         SPRpcValue *v);

Returns the position of the value v into the varray or -1 if it is not into the array.

sp_rpc_value_array_set ()

void                sp_rpc_value_array_set              (SPRpcValue *varray,
                                                         SPRpcValue *v);

Inserts a new value into the varray. The count references of the value will be increased.

sp_rpc_value_array_set_new ()

void                sp_rpc_value_array_set_new          (SPRpcValue *varray,
                                                         SPRpcValue **v);

Creates and inserts a value into an varray.

sp_rpc_value_array_set_before ()

void                sp_rpc_value_array_set_before       (SPRpcValue *varray,
                                                         SPRpcValue *v,
                                                         SPRpcValue *sibling);

Inserts a new value into the array before the given position.

sp_rpc_value_array_set_before_new ()

void                sp_rpc_value_array_set_before_new   (SPRpcValue *varray,
                                                         SPRpcValue **v,
                                                         SPRpcValue *sibling);

Creates and inserts a new value into the array before the given position.

sp_rpc_value_array_set_position ()

void                sp_rpc_value_array_set_position     (SPRpcValue *varray,
                                                         SPRpcValue *v,
                                                         gint position);

Inserts a new value into the varray at the given position.

sp_rpc_value_array_set_position_new ()

void                sp_rpc_value_array_set_position_new (SPRpcValue *varray,
                                                         SPRpcValue **v,
                                                         gint position);

Creates and inserts a new value into the array at the given position.

sp_rpc_value_array_remove ()

void                sp_rpc_value_array_remove           (SPRpcValue *varray,
                                                         SPRpcValue *v);

Removes a value from the array and decreases its reference count.

sp_rpc_value_array_remove_by_id ()

void                sp_rpc_value_array_remove_by_id     (SPRpcValue *varray,
                                                         guint id);

Removes a value by its position from the array and decreases its reference count.

sp_rpc_value_struct_has_key ()

gboolean            sp_rpc_value_struct_has_key         (SPRpcValue *vstruct,
                                                         const gchar *key);

Looks whether the struct has the key key.

sp_rpc_value_struct_get_key ()

SPRpcValue*         sp_rpc_value_struct_get_key         (SPRpcValue *vstruct,
                                                         const gchar *key);

returns the value of a key

sp_rpc_value_struct_get_key_by_value ()

const gchar*        sp_rpc_value_struct_get_key_by_value
                                                        (SPRpcValue *vstruct,
                                                         SPRpcValue *v);

Returns the key of a value, or NULL if the value v is not into the struct. The string is internal and you should not free it.

sp_rpc_value_struct_get_keys ()

gchar**             sp_rpc_value_struct_get_keys        (SPRpcValue *vstruct,
                                                         guint *length);

creates an array of the keys of a struct. Use g_strfreev() after the usage.

sp_rpc_value_struct_set_key ()

void                sp_rpc_value_struct_set_key         (SPRpcValue *vstruct,
                                                         const gchar *key,
                                                         SPRpcValue *v);

Inserts a new key and value into a struct.

If the key already exists into the struct, its current value is replaced with the new value and the old value will be unreferenced.

The count reference of the v will be increased.

sp_rpc_value_struct_set_key_new ()

void                sp_rpc_value_struct_set_key_new     (SPRpcValue *vstruct,
                                                         const gchar *key,
                                                         SPRpcValue **v);

Creates and inserts a new key and value into a struct. Read how the sp_rpc_value_struct_set_key() works.

sp_rpc_value_struct_remove_key ()

void                sp_rpc_value_struct_remove_key      (SPRpcValue *vstruct,
                                                         const gchar *key);

Removes a key and its associated value from a struct. The count reference of the value will be decreased.

sp_rpc_value_struct_iter_init ()

void                sp_rpc_value_struct_iter_init       (SPRpcValue *vstruct,
                                                         SPRpcIter *iter);

Initializes a key/value pair iterator and associates it with the vstruct. Modifying the struct after calling this function invalidates the returned iterator.

gchar *key;
SPRpcValue *value;
SPRpcIter iter;

sp_rpc_value_struct_iter_init(vstruct, &iter);
while (sp_rpc_value_struct_iter_next(&iter, &key, &value)) 
  {
    /* do something with key and value */
  }

sp_rpc_value_struct_iter_next ()

gboolean            sp_rpc_value_struct_iter_next       (SPRpcIter *iter,
                                                         gchar **key,
                                                         SPRpcValue **value);

Advances iter and retrieves the key and/or value that are now pointed to as a result of this advancement. If FALSE is returned, key and value are not set, and the iterator becomes invalid.

sp_rpc_value_struct_iter_remove ()

void                sp_rpc_value_struct_iter_remove     (SPRpcIter *iter);

Removes the key/value pair currently pointed to by the iterator from its associated SPRpcValue. Can only be called after sp_rpc_value_struct_iter_next() returned TRUE, and cannot be called more than once for the same key/value pair.

The count reference of the removed value will be decreased.