OpenSync
0.22
|
Used to manipulate members, which represent one device or application in a group. More...
Functions | |
OSyncMember * | osync_member_new (OSyncGroup *group) |
Creates a new member for a group. More... | |
void | osync_member_free (OSyncMember *member) |
Frees a member. More... | |
void | osync_member_unload_plugin (OSyncMember *member) |
Unloads the plugin of a member. More... | |
osync_bool | osync_member_instance_plugin (OSyncMember *member, const char *pluginname, OSyncError **error) |
Instances a plugin and loads it if necessary. More... | |
osync_bool | osync_member_instance_default_plugin (OSyncMember *member, OSyncError **error) |
Tries to instance the default plugin of a member (if set) More... | |
OSyncPlugin * | osync_member_get_plugin (OSyncMember *member) |
Returns the plugin of member. More... | |
const char * | osync_member_get_pluginname (OSyncMember *member) |
Returns the name of the default plugin of the member. More... | |
void | osync_member_set_pluginname (OSyncMember *member, const char *pluginname) |
Sets the name of the default plugin of a member. More... | |
void * | osync_member_get_plugindata (OSyncMember *member) |
Returns the custom data set to the OSyncPluginInfo. More... | |
const char * | osync_member_get_configdir (OSyncMember *member) |
Returns the configuration directory where this member is stored. More... | |
void | osync_member_set_configdir (OSyncMember *member, const char *configdir) |
Sets the directory where a member is supposed to be stored. More... | |
osync_bool | osync_member_need_config (OSyncMember *member, OSyncConfigurationTypes *type, OSyncError **error) |
osync_bool | osync_member_get_config_or_default (OSyncMember *member, char **data, int *size, OSyncError **error) |
Gets the configuration data of this member. More... | |
osync_bool | osync_member_get_config (OSyncMember *member, char **data, int *size, OSyncError **error) |
Gets the configuration data of this member. More... | |
void | osync_member_set_config (OSyncMember *member, const char *data, int size) |
Sets the config data for a member. More... | |
void * | osync_member_get_loop (OSyncMember *member) |
Gets the loop in which the member is dispatched. More... | |
void | osync_member_set_loop (OSyncMember *member, void *loop) |
Sets the loop in which the member is dispatched. More... | |
osync_bool | osync_member_has_configuration (OSyncMember *member) |
Returns if the member has configuation options. More... | |
OSyncMember * | osync_member_load (OSyncGroup *group, const char *path, OSyncError **error) |
Loads a member from a directory where it has been saved. More... | |
osync_bool | osync_member_save (OSyncMember *member, OSyncError **error) |
Saves a member to it config directory. More... | |
long long int | osync_member_get_id (OSyncMember *member) |
Gets the unique id of a member. More... | |
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. More... | |
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. More... | |
osync_bool | osync_member_get_slow_sync (OSyncMember *member, const char *objtypestr) |
Returns if slow-sync has been set for a object type. More... | |
void | osync_member_request_synchronization (OSyncMember *member) |
Requests synchronization from the sync engine. More... | |
OSyncObjFormatSink * | osync_member_make_random_data (OSyncMember *member, OSyncChange *change, const char *objtypename) |
Makes random data of a object type that could be writen to the given member. More... | |
void * | osync_member_get_data (OSyncMember *member) |
Returns the custom data of a member. More... | |
void | osync_member_set_data (OSyncMember *member, void *data) |
Sets the custom data on a member. More... | |
OSyncGroup * | osync_member_get_group (OSyncMember *member) |
Gets the group in which the member is stored. More... | |
OSyncMember * | osync_member_from_id (OSyncGroup *group, int id) |
Searches for a member by its id. More... | |
osync_bool | osync_member_objtype_enabled (OSyncMember *member, const char *objtype) |
Returns if a certain object type is enabled on this member. More... | |
void | osync_member_set_objtype_enabled (OSyncMember *member, const char *objtypestr, osync_bool enabled) |
Enables or disables a object type on a member. More... | |
Used to manipulate members, which represent one device or application in a group.
OSyncMember* osync_member_new | ( | OSyncGroup * | group | ) |
Creates a new member for a group.
group | The parent group. NULL if none |
Definition at line 170 of file opensync_member.c.
Referenced by osync_member_load().
void osync_member_free | ( | OSyncMember * | member | ) |
Frees a member.
member | The member to free |
Definition at line 189 of file opensync_member.c.
Referenced by osync_group_free(), and osync_member_load().
void osync_member_unload_plugin | ( | OSyncMember * | member | ) |
Unloads the plugin of a member.
member | The member for which to unload the plugin |
Definition at line 214 of file opensync_member.c.
Referenced by osync_member_instance_plugin().
osync_bool osync_member_instance_plugin | ( | OSyncMember * | member, |
const char * | pluginname, | ||
OSyncError ** | error | ||
) |
Instances a plugin and loads it if necessary.
member | The member |
pluginname | The name of the plugin that the member should use |
error | Pointer to a error |
Definition at line 242 of file opensync_member.c.
Referenced by osync_member_instance_default_plugin().
osync_bool osync_member_instance_default_plugin | ( | OSyncMember * | member, |
OSyncError ** | error | ||
) |
Tries to instance the default plugin of a member (if set)
member | The member |
error | Pointer to a error |
Definition at line 305 of file opensync_member.c.
Referenced by osync_member_call_plugin(), osync_member_get_config(), osync_member_get_plugin(), osync_member_initialize(), osync_member_save(), and osync_member_set_configdir().
OSyncPlugin* osync_member_get_plugin | ( | OSyncMember * | member | ) |
Returns the plugin of member.
member | The member |
Definition at line 324 of file opensync_member.c.
Referenced by osync_member_get_plugindata().
const char* osync_member_get_pluginname | ( | OSyncMember * | member | ) |
Returns the name of the default plugin of the member.
member | The member |
Definition at line 337 of file opensync_member.c.
void osync_member_set_pluginname | ( | OSyncMember * | member, |
const char * | pluginname | ||
) |
Sets the name of the default plugin of a member.
member | The member |
pluginname | The name of the default plugin |
Definition at line 349 of file opensync_member.c.
void* osync_member_get_plugindata | ( | OSyncMember * | member | ) |
Returns the custom data set to the OSyncPluginInfo.
You can set custom data to the OSyncPluginInfo struct using info->plugin_data = something; you can then query this data later using this function.
member | The member |
Definition at line 367 of file opensync_member.c.
const char* osync_member_get_configdir | ( | OSyncMember * | member | ) |
Returns the configuration directory where this member is stored.
member | The member |
Definition at line 380 of file opensync_member.c.
void osync_member_set_configdir | ( | OSyncMember * | member, |
const char * | configdir | ||
) |
Sets the directory where a member is supposed to be stored.
member | The member |
configdir | The name of the directory |
Definition at line 392 of file opensync_member.c.
osync_bool osync_member_get_config_or_default | ( | OSyncMember * | member, |
char ** | data, | ||
int * | size, | ||
OSyncError ** | error | ||
) |
Gets the configuration data of this member.
The config file is read in this order:
member | The member |
data | Return location for the data |
size | Return location for the size of the data |
error | Pointer to a error |
Definition at line 437 of file opensync_member.c.
osync_bool osync_member_get_config | ( | OSyncMember * | member, |
char ** | data, | ||
int * | size, | ||
OSyncError ** | error | ||
) |
Gets the configuration data of this member.
The config file is read in this order:
member | The member |
data | Return location for the data |
size | Return location for the size of the data |
error | Pointer to a error |
Definition at line 483 of file opensync_member.c.
void osync_member_set_config | ( | OSyncMember * | member, |
const char * | data, | ||
int | size | ||
) |
Sets the config data for a member.
Note that this does not save the config data
member | The member |
data | The new config data |
size | The size of the data |
Definition at line 538 of file opensync_member.c.
void* osync_member_get_loop | ( | OSyncMember * | member | ) |
Gets the loop in which the member is dispatched.
member | The member |
Definition at line 555 of file opensync_member.c.
void osync_member_set_loop | ( | OSyncMember * | member, |
void * | loop | ||
) |
Sets the loop in which the member is dispatched.
member | The member |
loop | The pointer to the loop |
Definition at line 568 of file opensync_member.c.
osync_bool osync_member_has_configuration | ( | OSyncMember * | member | ) |
Returns if the member has configuation options.
member | The member |
Definition at line 582 of file opensync_member.c.
OSyncMember* osync_member_load | ( | OSyncGroup * | group, |
const char * | path, | ||
OSyncError ** | error | ||
) |
Loads a member from a directory where it has been saved.
group | The group which is the parent |
path | The path of the member |
error | Pointer to a error |
Definition at line 601 of file opensync_member.c.
Referenced by osync_group_load_members().
osync_bool osync_member_save | ( | OSyncMember * | member, |
OSyncError ** | error | ||
) |
Saves a member to it config directory.
member | The member to save |
error | Pointer to a error |
Definition at line 647 of file opensync_member.c.
Referenced by osync_group_save().
long long int osync_member_get_id | ( | OSyncMember * | member | ) |
Gets the unique id of a member.
member | The member |
Definition at line 714 of file opensync_member.c.
Referenced by _new_change_receiver().
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.
A custom function on the plugin must have the form (void *, void *, OSyncError **)
member | The member |
function | The name of the function on the plugin to call |
data | The custom data to pass as the second arg to the function on the plugin |
error | A pointer to a error |
Definition at line 731 of file opensync_member.c.
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.
member | The member |
objtypestr | The name of the object type for which to set slow-sync |
slow_sync | Set to TRUE if you want slow-sync, to FALSE if you want normal fast-sync (or remove slow-sync) |
Definition at line 749 of file opensync_member.c.
Referenced by osync_member_delete_data(), and osync_member_sync_done().
osync_bool osync_member_get_slow_sync | ( | OSyncMember * | member, |
const char * | objtypestr | ||
) |
Returns if slow-sync has been set for a object type.
member | The member |
objtypestr | The name of the object type to look up |
Definition at line 765 of file opensync_member.c.
Referenced by osync_member_delete_data().
void osync_member_request_synchronization | ( | OSyncMember * | member | ) |
Requests synchronization from the sync engine.
member | The member |
Definition at line 783 of file opensync_member.c.
OSyncObjFormatSink* osync_member_make_random_data | ( | OSyncMember * | member, |
OSyncChange * | change, | ||
const char * | objtypename | ||
) |
Makes random data of a object type that could be writen to the given member.
member | The member |
change | The change that will receive the random data |
objtypename | The name of the object type for which to create random data |
Definition at line 806 of file opensync_member.c.
Referenced by osync_member_add_random_data(), and osync_member_modify_random_data().
void* osync_member_get_data | ( | OSyncMember * | member | ) |
Returns the custom data of a member.
member | The member |
Definition at line 875 of file opensync_member.c.
void osync_member_set_data | ( | OSyncMember * | member, |
void * | data | ||
) |
Sets the custom data on a member.
member | The member |
data | The custom data |
Definition at line 887 of file opensync_member.c.
OSyncGroup* osync_member_get_group | ( | OSyncMember * | member | ) |
Gets the group in which the member is stored.
member | The member |
Definition at line 899 of file opensync_member.c.
Referenced by osync_member_get_slow_sync(), and osync_member_set_slow_sync().
OSyncMember* osync_member_from_id | ( | OSyncGroup * | group, |
int | id | ||
) |
Searches for a member by its id.
group | The group in which to search |
id | The id of the member |
Definition at line 912 of file opensync_member.c.
osync_bool osync_member_objtype_enabled | ( | OSyncMember * | member, |
const char * | objtype | ||
) |
Returns if a certain object type is enabled on this member.
member | The member |
objtype | The name of the object type to check |
Definition at line 935 of file opensync_member.c.
Referenced by osync_group_objtype_enabled().
void osync_member_set_objtype_enabled | ( | OSyncMember * | member, |
const char * | objtypestr, | ||
osync_bool | enabled | ||
) |
Enables or disables a object type on a member.
member | The member |
objtypestr | The name of the object type to change |
enabled | Set to TRUE if you want to sync the object type, FALSE otherwise |
Note: this function should be called only after sink information for the member is available (osync_member_require_sink_info())
Definition at line 955 of file opensync_member.c.
Referenced by osync_group_set_objtype_enabled().