OpenSync  0.22
opensync_member.h
1 
3 typedef struct OSyncMemberFunctions {
5  void (* rf_change) (OSyncMember *, OSyncChange *, void *);
7  void *(* rf_message) (OSyncMember *, const char *, void *, osync_bool);
9  void (* rf_sync_alert) (OSyncMember *);
11  void (*rf_log) (OSyncMember *, char *);
13 
14 typedef void (* OSyncEngCallback)(OSyncMember *, void *, OSyncError **);
15 
17 void osync_member_free(OSyncMember *member);
18 
19 osync_bool osync_member_instance_plugin(OSyncMember *member, const char *pluginname, OSyncError **error);
21 
22 const char *osync_member_get_configdir(OSyncMember *member);
23 osync_bool osync_member_get_config(OSyncMember *member, char **data, int *size, OSyncError **error);
24 osync_bool osync_member_get_config_or_default(OSyncMember *member, char **data, int *size, OSyncError **error);
25 osync_bool osync_member_need_config(OSyncMember *member, OSyncConfigurationTypes *type, OSyncError **error);
26 
27 void osync_member_set_config(OSyncMember *member, const char *data, int size);
29 const char *osync_member_get_pluginname(OSyncMember *member);
30 osync_bool osync_member_initialize(OSyncMember *member, OSyncError **error);
31 void *osync_member_get_enginedata(OSyncMember *member);
32 void osync_member_set_enginedata(OSyncMember *member, void *data);
33 void *osync_member_get_report_function(OSyncMember *member);
34 void osync_member_set_report_function(OSyncMember *member, void *function);
36 void *osync_member_get_data(OSyncMember *member);
37 void osync_member_set_data(OSyncMember *member, void *data);
38 OSyncMemberFunctions *osync_member_get_memberfunctions(OSyncMember *member);
40 OSyncChange *osync_member_get_changeentry(OSyncMember *member, char *uid);
41 int osync_member_num_changeentries(OSyncMember *member);
42 OSyncChange *osync_member_nth_changeentry(OSyncMember *member, int n);
43 long long int osync_member_get_id(OSyncMember *member);
44 OSyncMember *osync_member_load(OSyncGroup *group, const char *path, OSyncError **error);
45 osync_bool osync_member_save(OSyncMember *member, OSyncError **error);
46 void osync_member_connect(OSyncMember *member, OSyncEngCallback function, void *user_data);
47 void osync_member_disconnect(OSyncMember *member, OSyncEngCallback function, void *user_data);
48 void osync_member_get_changeinfo(OSyncMember *member, OSyncEngCallback function, void *user_data);
49 void osync_member_read_change(OSyncMember *member, OSyncChange *change, OSyncEngCallback function, void *user_data);
50 void osync_member_committed_all(OSyncMember *member, OSyncEngCallback function, void *user_data);
51 void osync_member_set_name(OSyncMember *member, const char *name);
52 const char *osync_member_get_name(OSyncMember *member);
53 
54 void *osync_member_call_plugin(OSyncMember *member, const char *function, void *data, OSyncError **error);
55 void osync_member_commit_change(OSyncMember *member, OSyncChange *change, OSyncEngCallback function, void *user_data);
56 void osync_member_get_change_data(OSyncMember *member, OSyncChange *change, OSyncEngCallback function, void *user_data);
57 OSyncFormatEnv *osync_member_get_format_env(OSyncMember *member);
58 void osync_member_sync_done(OSyncMember *member, OSyncEngCallback function, void *user_data);
59 OSyncChange *osync_member_find_change(OSyncMember *member, const char *uid);
60 void osync_member_add_changeentry(OSyncMember *member, OSyncChange *entry);
62 OSyncChange *osync_member_add_random_data(OSyncMember *member, const char *objtype);
64 void osync_member_remove_changeentry(OSyncMember *member, OSyncChange *entry);
65 osync_bool osync_member_modify_random_data(OSyncMember *member, OSyncChange *change);
66 osync_bool osync_member_delete_data(OSyncMember *member, OSyncChange *change);
67 void osync_member_set_slow_sync(OSyncMember *member, const char *objtypestr, osync_bool slow_sync);
68 osync_bool osync_member_get_slow_sync(OSyncMember *member, const char *objtypestr);
69 osync_bool osync_member_objtype_enabled(OSyncMember *member, const char *objtype);
70 osync_bool osync_member_update_change(OSyncMember *member, OSyncChange **change);
71 void osync_member_set_objtype_enabled(OSyncMember *member, const char *objtypestr, osync_bool enabled);
72 void osync_member_set_pluginname(OSyncMember *member, const char *pluginname);
73 void osync_member_set_configdir(OSyncMember *member, const char *configdir);
75 osync_bool osync_member_has_read_function(OSyncMember *member, OSyncObjType *objtype);
76 
77 void *osync_member_get_loop(OSyncMember *member);
78 void osync_member_set_loop(OSyncMember *member, void *loop);
void osync_member_sync_done(OSyncMember *member, OSyncEngCallback function, void *user_data)
Tells the plugin that the sync was successfull.
osync_bool osync_member_instance_plugin(OSyncMember *member, const char *pluginname, OSyncError **error)
Instances a plugin and loads it if necessary.
void(* rf_change)(OSyncMember *, OSyncChange *, void *)
void osync_member_connect(OSyncMember *member, OSyncEngCallback function, void *user_data)
Connects a member to its device.
void osync_member_free(OSyncMember *member)
Frees a member.
osync_bool osync_member_get_config(OSyncMember *member, char **data, int *size, OSyncError **error)
Gets the configuration data of this member.
osync_bool osync_member_get_slow_sync(OSyncMember *member, const char *objtypestr)
Returns if slow-sync has been set for a object type.
Represent an error.
void osync_member_set_objtype_enabled(OSyncMember *member, const char *objtypestr, osync_bool enabled)
Enables or disables a object type on a member.
void osync_member_get_change_data(OSyncMember *member, OSyncChange *change, OSyncEngCallback function, void *user_data)
Gets the "real" data of a object.
void osync_member_finalize(OSyncMember *member)
Finalizes a plugin.
osync_bool osync_member_has_configuration(OSyncMember *member)
Returns if the member has configuation options.
osync_bool osync_member_initialize(OSyncMember *member, OSyncError **error)
Initialize a member.
osync_bool osync_member_has_read_function(OSyncMember *member, OSyncObjType *objtype)
Checks if the member has a read method for the given objtype.
void osync_member_read_change(OSyncMember *member, OSyncChange *change, OSyncEngCallback function, void *user_data)
Reads a single object by its uid.
void * osync_member_get_plugindata(OSyncMember *member)
Returns the custom data set to the OSyncPluginInfo.
void(* rf_sync_alert)(OSyncMember *)
Represent a synchronzation plugin.
void osync_member_committed_all(OSyncMember *member, OSyncEngCallback function, void *user_data)
Tells the plugin that all changes have been committed.
void osync_member_set_slow_sync(OSyncMember *member, const char *objtypestr, osync_bool slow_sync)
Sets the slow-sync for a given object type on a member.
OSyncMember * osync_member_load(OSyncGroup *group, const char *path, OSyncError **error)
Loads a member from a directory where it has been saved.
void(* rf_log)(OSyncMember *, char *)
void osync_member_set_configdir(OSyncMember *member, const char *configdir)
Sets the directory where a member is supposed to be stored.
osync_bool osync_member_save(OSyncMember *member, OSyncError **error)
Saves a member to it config directory.
Represent a group of members that should be synchronized.
void osync_member_request_synchronization(OSyncMember *member)
Requests synchronization from the sync engine.
OSyncMember * osync_member_new(OSyncGroup *group)
Creates a new member for a group.
OSyncChange * osync_member_add_random_data(OSyncMember *member, const char *objtype)
Adds random data to a member.
A member of a group which represent a single device.
void osync_member_set_data(OSyncMember *member, void *data)
Sets the custom data on a member.
void osync_member_commit_change(OSyncMember *member, OSyncChange *change, OSyncEngCallback function, void *user_data)
Commits a change to the device.
void * osync_member_get_data(OSyncMember *member)
Returns the custom data of a member.
osync_bool osync_member_delete_data(OSyncMember *member, OSyncChange *change)
Deletes data from a device.
void osync_member_set_config(OSyncMember *member, const char *data, int size)
Sets the config data for a member.
osync_bool osync_member_modify_random_data(OSyncMember *member, OSyncChange *change)
Modifies random data on a member.
osync_bool osync_member_get_config_or_default(OSyncMember *member, char **data, int *size, OSyncError **error)
Gets the configuration data of this member.
A change object.
Represents the functions that a member will call to inform the syncengine.
long long int osync_member_get_id(OSyncMember *member)
Gets the unique id of a member.
OSyncGroup * osync_member_get_group(OSyncMember *member)
Gets the group in which the member is stored.
OSyncPlugin * osync_member_get_plugin(OSyncMember *member)
Returns the plugin of member.
const char * osync_member_get_pluginname(OSyncMember *member)
Returns the name of the default plugin of the member.
void * osync_member_call_plugin(OSyncMember *member, const char *function, void *data, OSyncError **error)
Makes a custom call to the plugin that the member has instanced.
void osync_member_set_pluginname(OSyncMember *member, const char *pluginname)
Sets the name of the default plugin of a member.
void * osync_member_get_loop(OSyncMember *member)
Gets the loop in which the member is dispatched.
const char * osync_member_get_configdir(OSyncMember *member)
Returns the configuration directory where this member is stored.
osync_bool osync_member_objtype_enabled(OSyncMember *member, const char *objtype)
Returns if a certain object type is enabled on this member.
Represent a abstract object type (like "contact")
The environment used for conversions.
OSyncMember * osync_member_from_id(OSyncGroup *group, int id)
Searches for a member by its id.
void osync_member_set_loop(OSyncMember *member, void *loop)
Sets the loop in which the member is dispatched.
void osync_member_get_changeinfo(OSyncMember *member, OSyncEngCallback function, void *user_data)
Queries a plugin for the changed objects since the last sync.
OSyncConfigurationTypes
Gives information about wether the plugin has to be configured or not.
void osync_member_disconnect(OSyncMember *member, OSyncEngCallback function, void *user_data)
Disconnects a member from its device.