OpenSync  0.22
Data Fields
OSyncPluginFunctions Struct Reference

The functions that can be called on a plugin. More...

#include <opensync_plugin.h>

Data Fields

osync_bool(* get_config )(char *, char **, int *)
 
osync_bool(* store_config )(char *, const char *, int)
 
osync_bool(* is_available )(OSyncError **)
 
void *(* initialize )(OSyncMember *, OSyncError **)
 
void(* finalize )(void *)
 
void(* connect )(OSyncContext *)
 
void(* sync_done )(OSyncContext *ctx)
 
void(* disconnect )(OSyncContext *)
 
void(* get_changeinfo )(OSyncContext *)
 
void(* get_data )(OSyncContext *, OSyncChange *)
 

Detailed Description

The functions that can be called on a plugin.

Definition at line 5 of file opensync_plugin.h.

Field Documentation

osync_bool(* OSyncPluginFunctions::get_config)(char *, char **, int *)

The function that gets a configuration file for this plugin (optional)

Definition at line 7 of file opensync_plugin.h.

osync_bool(* OSyncPluginFunctions::store_config)(char *, const char *, int)

The function that stores the configuration file for this plugin (optional)

Definition at line 9 of file opensync_plugin.h.

Referenced by osync_member_save().

osync_bool(* OSyncPluginFunctions::is_available)(OSyncError **)

A function to check if the backend is available. (optional)

Definition at line 11 of file opensync_plugin.h.

void*(* OSyncPluginFunctions::initialize)(OSyncMember *, OSyncError **)

The function to initialize the plugin.

Definition at line 13 of file opensync_plugin.h.

Referenced by osync_member_initialize().

void(* OSyncPluginFunctions::finalize)(void *)

The function to finalize the plugin. The input will be the output of the initialize function

Definition at line 15 of file opensync_plugin.h.

Referenced by osync_member_finalize().

void(* OSyncPluginFunctions::connect)(OSyncContext *)

Make a connection to your device here

Definition at line 17 of file opensync_plugin.h.

Referenced by osync_member_connect().

void(* OSyncPluginFunctions::sync_done)(OSyncContext *ctx)

This function gets called if the sync was successfull (Optional)

Definition at line 19 of file opensync_plugin.h.

Referenced by osync_member_sync_done().

void(* OSyncPluginFunctions::disconnect)(OSyncContext *)

Disconnect from the device

Definition at line 21 of file opensync_plugin.h.

Referenced by osync_member_disconnect().

void(* OSyncPluginFunctions::get_changeinfo)(OSyncContext *)

Get all available changes here.

Definition at line 23 of file opensync_plugin.h.

Referenced by osync_member_get_changeinfo().

void(* OSyncPluginFunctions::get_data)(OSyncContext *, OSyncChange *)

Get the data for a change here (Optional)

Definition at line 25 of file opensync_plugin.h.

Referenced by osync_member_get_change_data().


The documentation for this struct was generated from the following file: