OpenSync Member Functions
[OpenSync Public API]

The functions that can be used to access the device that a member represents. More...


Functions

osync_bool osync_member_initialize (OSyncMember *member, OSyncError **error)
 Initialize a member.
void osync_member_finalize (OSyncMember *member)
 Finalizes a plugin.
void osync_member_get_changeinfo (OSyncMember *member, OSyncEngCallback function, void *user_data)
 Queries a plugin for the changed objects since the last sync.
void osync_member_read_change (OSyncMember *member, OSyncChange *change, OSyncEngCallback function, void *user_data)
 Reads a single object by its uid.
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_get_change_data (OSyncMember *member, OSyncChange *change, OSyncEngCallback function, void *user_data)
 Gets the "real" data of a object.
void osync_member_connect (OSyncMember *member, OSyncEngCallback function, void *user_data)
 Connects a member to its device.
void osync_member_disconnect (OSyncMember *member, OSyncEngCallback function, void *user_data)
 Disconnects a member from its device.
void osync_member_sync_done (OSyncMember *member, OSyncEngCallback function, void *user_data)
 Tells the plugin that the sync was successfull.
void osync_member_commit_change (OSyncMember *member, OSyncChange *change, OSyncEngCallback function, void *user_data)
 Commits a change to the device.
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_name (OSyncMember *member, const char *name)
const char * osync_member_get_name (OSyncMember *member)
OSyncChangeosync_member_add_random_data (OSyncMember *member, const char *objtype)
 Adds random data to a member.
osync_bool osync_member_modify_random_data (OSyncMember *member, OSyncChange *change)
 Modifies random data on a member.
osync_bool osync_member_delete_data (OSyncMember *member, OSyncChange *change)
 Deletes data from a device.


Detailed Description

The functions that can be used to access the device that a member represents.

Function Documentation

osync_bool osync_member_initialize ( OSyncMember member,
OSyncError **  error 
)

Initialize a member.

Calls the initialize function on a plugin

Parameters:
member The member
error A pointer to a error
Returns:
TRUE if the plugin initialized successfully, FALSE otherwise

Definition at line 1004 of file opensync_member.c.

void osync_member_finalize ( OSyncMember member  ) 

Finalizes a plugin.

Calls the finalize function on a plugin

Parameters:
member The member

Definition at line 1032 of file opensync_member.c.

void osync_member_get_changeinfo ( OSyncMember member,
OSyncEngCallback  function,
void *  user_data 
)

Queries a plugin for the changed objects since the last sync.

Calls the get_changeinfo function on a plugin

Parameters:
member The member
function The function that will receive the answer to this call
user_data User data that will be passed on to the callback function

Definition at line 1052 of file opensync_member.c.

void osync_member_read_change ( OSyncMember member,
OSyncChange change,
OSyncEngCallback  function,
void *  user_data 
)

Reads a single object by its uid.

Calls the read_change function on the plugin

Parameters:
member The member
change The change to read. The change must have the uid set
function The function that will receive the answer to this call
user_data User data that will be passed on to the callback function

Definition at line 1078 of file opensync_member.c.

osync_bool osync_member_has_read_function ( OSyncMember member,
OSyncObjType objtype 
)

Checks if the member has a read method for the given objtype.

Parameters:
member The member
objtype The objtype for which to check the read methid
Returns:
TRUE if the member has read function, FALSE otherwise

Definition at line 1116 of file opensync_member.c.

Referenced by osengine_mapping_ignore_supported().

void osync_member_get_change_data ( OSyncMember member,
OSyncChange change,
OSyncEngCallback  function,
void *  user_data 
)

Gets the "real" data of a object.

Calls the get_data function on the plugin

Parameters:
member The member
change The change. The must be returned from a call to get_changeinfo
function The function that will receive the answer to this call
user_data User data that will be passed on to the callback function

Definition at line 1138 of file opensync_member.c.

void osync_member_connect ( OSyncMember member,
OSyncEngCallback  function,
void *  user_data 
)

Connects a member to its device.

Calls the connect function on a plugin

Parameters:
member The member
function The function that will receive the answer to this call
user_data User data that will be passed on to the callback function

Definition at line 1159 of file opensync_member.c.

void osync_member_disconnect ( OSyncMember member,
OSyncEngCallback  function,
void *  user_data 
)

Disconnects a member from its device.

Calls the disconnect function on a plugin

Parameters:
member The member
function The function that will receive the answer to this call
user_data User data that will be passed on to the callback function

Definition at line 1184 of file opensync_member.c.

void osync_member_sync_done ( OSyncMember member,
OSyncEngCallback  function,
void *  user_data 
)

Tells the plugin that the sync was successfull.

Calls the sync_done function on a plugin

Parameters:
member The member
function The function that will receive the answer to this call
user_data User data that will be passed on to the callback function

Definition at line 1209 of file opensync_member.c.

void osync_member_commit_change ( OSyncMember member,
OSyncChange change,
OSyncEngCallback  function,
void *  user_data 
)

Commits a change to the device.

Calls the commit_change function on a plugin

Parameters:
member The member
change The change to write
function The function that will receive the answer to this call
user_data User data that will be passed on to the callback function

Definition at line 1235 of file opensync_member.c.

void osync_member_committed_all ( OSyncMember member,
OSyncEngCallback  function,
void *  user_data 
)

Tells the plugin that all changes have been committed.

Calls the committed_all function on a plugin or the batch_commit function depending on which function the plugin wants to use.

Parameters:
member The member
function The callback that will receive the answer
user_data The userdata to pass to the callback

Definition at line 1322 of file opensync_member.c.

OSyncChange* osync_member_add_random_data ( OSyncMember member,
const char *  objtype 
)

Adds random data to a member.

Generates random data and writes it to the plugin. The plugin must support the access function. This function is mainly used for testing plugins.

Parameters:
member The member on which to add random data
objtype The name of the object type to add
Returns:
The change that was added or NULL if adding the data was not successfull

Definition at line 1416 of file opensync_member.c.

osync_bool osync_member_modify_random_data ( OSyncMember member,
OSyncChange change 
)

Modifies random data on a member.

The plugin must support the access function. This function is mainly used for testing plugins.

Parameters:
member The member on which to add random data
change The change that should be modified. It must have the uid set.
Returns:
TRUE if the changes was modified successfully, FALSE otherwise

Definition at line 1452 of file opensync_member.c.

osync_bool osync_member_delete_data ( OSyncMember member,
OSyncChange change 
)

Deletes data from a device.

The plugin must support the access function. This is mainly used for testing plugins.

Parameters:
member The member from which to delete
change The change to delete. The uid must be set
Returns:
TRUE if the change was deleted, FALSE otherwise

Definition at line 1491 of file opensync_member.c.


Generated on Wed Mar 25 15:20:47 2009 for OpenSync by  doxygen 1.5.8