OobsObject

OobsObject —

Synopsis




enum        OobsObjectResult;
            OobsObject;
void        (*OobsObjectAsyncFunc)          (OobsObject *object,
                                             OobsObjectResult result,
                                             gpointer data);
OobsObjectResult oobs_object_commit         (OobsObject *object);
OobsObjectResult oobs_object_commit_async   (OobsObject *object,
                                             OobsObjectAsyncFunc func,
                                             gpointer data);
OobsObjectResult oobs_object_update         (OobsObject *object);
OobsObjectResult oobs_object_update_async   (OobsObject *object,
                                             OobsObjectAsyncFunc func,
                                             gpointer data);

Description

Details

enum OobsObjectResult

typedef enum {
  OOBS_OBJECT_RESULT_OK,
  OOBS_OBJECT_RESULT_DENIED,
  OOBS_OBJECT_RESULT_NO_PLATFORM,
  OOBS_OBJECT_RESULT_MALFORMED,
  OOBS_OBJECT_RESULT_ERROR
} OobsObjectResult;


OobsObject

typedef struct {
  GObject parent;
} OobsObject;


OobsObjectAsyncFunc ()

void        (*OobsObjectAsyncFunc)          (OobsObject *object,
                                             OobsObjectResult result,
                                             gpointer data);

object :
result :
data :

oobs_object_commit ()

OobsObjectResult oobs_object_commit         (OobsObject *object);

Commits to the system all the changes done to the configuration held by an OobsObject.

object : an OobsObject
Returns : an OobsObjectResult enum with the error code.

oobs_object_commit_async ()

OobsObjectResult oobs_object_commit_async   (OobsObject *object,
                                             OobsObjectAsyncFunc func,
                                             gpointer data);

Commits to the system all the changes done to the configuration held by an OobsObject. This change will be asynchronous, being run the function func when the change has been done.

object : An OobsObject.
func : An OobsObjectAsyncFunc that will be called when the asynchronous operation has ended.
data : Aditional data to pass to func.
Returns : an OobsObjectResult enum with the error code. Due to the asynchronous nature of the function, only OOBS_OBJECT_RESULT_MALFORMED and OOBS_OBJECT_RESULT_OK can be returned.

oobs_object_update ()

OobsObjectResult oobs_object_update         (OobsObject *object);

Synchronizes the configuration held by the OobsObject with the actual system configuration. All the changes done to the configuration held by the OobsObject will be forgotten.

object : an OobsObject
Returns : an OobsObjectResult enum with the error code.

oobs_object_update_async ()

OobsObjectResult oobs_object_update_async   (OobsObject *object,
                                             OobsObjectAsyncFunc func,
                                             gpointer data);

Synchronizes the configuration held by the OobsObject with the actual system configuration. All the changes done to the configuration held by the OobsObject will be forgotten. The update operation will be asynchronous, being run the function func when the update has been done.

object : An OobsObject
func : An OobsObjectAsyncFunc that will be called when the asynchronous operation has ended.
data : Aditional data to pass to func.
Returns : an OobsObjectResult enum with the error code. Due to the asynchronous nature of the function, only OOBS_OBJECT_RESULT_MALFORMED and OOBS_OBJECT_RESULT_OK can be returned.