OpenSync Plugin Info
[OpenSync Public API]

Collaboration diagram for OpenSync Plugin Info:

Functions to get and set information about a plugin. More...

Functions

OSyncPluginInfo * osync_plugin_info_new (OSyncError **error)
 Create a new plugin info object.
OSyncPluginInfo * osync_plugin_info_ref (OSyncPluginInfo *info)
 Increase the reference count on a plugin info object.
void osync_plugin_info_unref (OSyncPluginInfo *info)
 Decrease the reference count on a plugin info object.
void osync_plugin_info_set_loop (OSyncPluginInfo *info, void *loop)
 Set reference to loop for the specific plugin.
void * osync_plugin_info_get_loop (OSyncPluginInfo *info)
 Get loop reference of OSyncPluginInfo object.
void osync_plugin_info_set_config (OSyncPluginInfo *info, OSyncPluginConfig *config)
 Set the plugin configuration data.
OSyncPluginConfig * osync_plugin_info_get_config (OSyncPluginInfo *info)
 Returns the plugin configuration data.
void osync_plugin_info_set_configdir (OSyncPluginInfo *info, const char *configdir)
 Set plugin configuration directory.
const char * osync_plugin_info_get_configdir (OSyncPluginInfo *info)
 Returns the plugin configuration directory.
void osync_plugin_info_set_groupname (OSyncPluginInfo *info, const char *groupname)
 Set Group Name for plugin info object.
const char * osync_plugin_info_get_groupname (OSyncPluginInfo *info)
 Get Group Name of the OSyncPluginInfo object.
OSyncObjTypeSink * osync_plugin_info_find_objtype (OSyncPluginInfo *info, const char *name)
 Find ObjTypeSink of corresponding Object Type in OSyncPluginInfo object.
void osync_plugin_info_add_objtype (OSyncPluginInfo *info, OSyncObjTypeSink *sink)
 Adds an object type (sink) to a plugin.
unsigned int osync_plugin_info_num_objtypes (OSyncPluginInfo *info)
 Returns the number of added object types (sinks).
OSyncObjTypeSink * osync_plugin_info_nth_objtype (OSyncPluginInfo *info, unsigned int nth)
 Returns the nth added object type (sink).
OSyncObjTypeSink * osync_plugin_info_get_main_sink (OSyncPluginInfo *info)
 Returns the Main Sink.
void osync_plugin_info_set_main_sink (OSyncPluginInfo *info, OSyncObjTypeSink *sink)
 Sets the Main Sink.
OSyncObjTypeSink * osync_plugin_info_get_sink (OSyncPluginInfo *info)
 Returns the currently running sink.
void osync_plugin_info_set_sink (OSyncPluginInfo *info, OSyncObjTypeSink *sink)
 Sets the current OSyncObjTypeSink.
OSyncFormatEnv * osync_plugin_info_get_format_env (OSyncPluginInfo *info)
 Returns the plugin format conversion environment.
void osync_plugin_info_set_format_env (OSyncPluginInfo *info, OSyncFormatEnv *env)
 Set Format Environment for OSyncPluginInfo object.
void osync_plugin_info_set_version (OSyncPluginInfo *info, OSyncVersion *version)
 Set OSyncVersion for OSyncPluginInfo object.
OSyncVersion * osync_plugin_info_get_version (OSyncPluginInfo *info)
 Get OSyncVersion of the OSyncPluginInfo object.
void osync_plugin_info_set_capabilities (OSyncPluginInfo *info, OSyncCapabilities *capabilities)
 Set OSyncCapabilities of the OSyncPluginInfo object.
OSyncCapabilities * osync_plugin_info_get_capabilities (OSyncPluginInfo *info)
 Get OSyncCapabilities of the OSyncPluginInfo object.

Detailed Description

Functions to get and set information about a plugin.

Function Documentation

OSyncPluginInfo* osync_plugin_info_new ( OSyncError **  error  ) 

Create a new plugin info object.

Parameters:
error Pointer to an error struct
Returns:
the newly registered plugin info object

Definition at line 45 of file opensync_plugin_info.c.

OSyncPluginInfo* osync_plugin_info_ref ( OSyncPluginInfo *  info  ) 

Increase the reference count on a plugin info object.

Parameters:
info Pointer to the plugin info object

Definition at line 61 of file opensync_plugin_info.c.

void osync_plugin_info_unref ( OSyncPluginInfo *  info  ) 

Decrease the reference count on a plugin info object.

Parameters:
info Pointer to the plugin info object

Definition at line 75 of file opensync_plugin_info.c.

void osync_plugin_info_set_loop ( OSyncPluginInfo *  info,
void *  loop 
)

Set reference to loop for the specific plugin.

Parameters:
info Pointer to the plugin info object
loop Pointer to the loop which get set for specified OSyncPluginInfo object

Definition at line 114 of file opensync_plugin_info.c.

void* osync_plugin_info_get_loop ( OSyncPluginInfo *  info  ) 

Get loop reference of OSyncPluginInfo object.

Parameters:
info Pointer to the plugin info object
Returns:
Reference to the loop of the OSyncPluginInfo object

Definition at line 125 of file opensync_plugin_info.c.

void osync_plugin_info_set_config ( OSyncPluginInfo *  info,
OSyncPluginConfig *  config 
)

Set the plugin configuration data.

Parameters:
info Pointer to the plugin info object
config Plugin configuration

Definition at line 136 of file opensync_plugin_info.c.

OSyncPluginConfig* osync_plugin_info_get_config ( OSyncPluginInfo *  info  ) 

Returns the plugin configuration data.

Parameters:
info Pointer to the plugin info object
Returns:
the plugin configuration data (null-terminated string)

Definition at line 154 of file opensync_plugin_info.c.

void osync_plugin_info_set_configdir ( OSyncPluginInfo *  info,
const char *  configdir 
)

Set plugin configuration directory.

Parameters:
info Pointer to the plugin info object
configdir Configuration directory to set

Definition at line 166 of file opensync_plugin_info.c.

const char* osync_plugin_info_get_configdir ( OSyncPluginInfo *  info  ) 

Returns the plugin configuration directory.

Parameters:
info Pointer to the plugin info object
Returns:
the full path where configuration files for the plugin are stored

Definition at line 180 of file opensync_plugin_info.c.

void osync_plugin_info_set_groupname ( OSyncPluginInfo *  info,
const char *  groupname 
)

Set Group Name for plugin info object.

Parameters:
info Pointer to the plugin info object
groupname Group name

Definition at line 192 of file opensync_plugin_info.c.

const char* osync_plugin_info_get_groupname ( OSyncPluginInfo *  info  ) 

Get Group Name of the OSyncPluginInfo object.

Parameters:
info Pointer to the OSyncPluginInfo object
Returns:
Group Name of the OSyncPluginInfo object

Definition at line 206 of file opensync_plugin_info.c.

OSyncObjTypeSink* osync_plugin_info_find_objtype ( OSyncPluginInfo *  info,
const char *  name 
)

Find ObjTypeSink of corresponding Object Type in OSyncPluginInfo object.

Parameters:
info Pointer to the OSyncPluginInfo object
name Name of the Object Type
Returns:
Pointer to OSyncPluginInfo for searched objtype, NULL if not available

Definition at line 219 of file opensync_plugin_info.c.

void osync_plugin_info_add_objtype ( OSyncPluginInfo *  info,
OSyncObjTypeSink *  sink 
)

Adds an object type (sink) to a plugin.

Parameters:
info Pointer to the plugin info object
sink The sink to add

Definition at line 255 of file opensync_plugin_info.c.

unsigned int osync_plugin_info_num_objtypes ( OSyncPluginInfo *  info  ) 

Returns the number of added object types (sinks).

Parameters:
info Pointer to the plugin info object
Returns:
the number of object types in the plugin info

Definition at line 268 of file opensync_plugin_info.c.

OSyncObjTypeSink* osync_plugin_info_nth_objtype ( OSyncPluginInfo *  info,
unsigned int  nth 
)

Returns the nth added object type (sink).

Parameters:
info Pointer to the plugin info object
nth the index of the object type (sink) to return
Returns:
the object type (sink) at the specified index

Definition at line 281 of file opensync_plugin_info.c.

OSyncObjTypeSink* osync_plugin_info_get_main_sink ( OSyncPluginInfo *  info  ) 

Returns the Main Sink.

Parameters:
info Pointer to the plugin info object
Returns:
the Main Sink

Definition at line 293 of file opensync_plugin_info.c.

void osync_plugin_info_set_main_sink ( OSyncPluginInfo *  info,
OSyncObjTypeSink *  sink 
)

Sets the Main Sink.

Parameters:
info Pointer to the plugin info object
sink The OSyncObjTypeSink which acts as Main Sink

Definition at line 306 of file opensync_plugin_info.c.

OSyncObjTypeSink* osync_plugin_info_get_sink ( OSyncPluginInfo *  info  ) 

Returns the currently running sink.

Parameters:
info Pointer to the plugin info object
Returns:
the current sink

Definition at line 320 of file opensync_plugin_info.c.

void osync_plugin_info_set_sink ( OSyncPluginInfo *  info,
OSyncObjTypeSink *  sink 
)

Sets the current OSyncObjTypeSink.

Parameters:
info Pointer to the plugin info object
sink The OSyncObjTypeSink which should act as current OSyncObjTypeSink

Definition at line 332 of file opensync_plugin_info.c.

OSyncFormatEnv* osync_plugin_info_get_format_env ( OSyncPluginInfo *  info  ) 

Returns the plugin format conversion environment.

Parameters:
info Pointer to the plugin info object
Returns:
the plugin format conversion environment

Definition at line 345 of file opensync_plugin_info.c.

void osync_plugin_info_set_format_env ( OSyncPluginInfo *  info,
OSyncFormatEnv *  env 
)

Set Format Environment for OSyncPluginInfo object.

Parameters:
info Pointer to the plugin info object
env Pointer to Format environment which gets assigned to the OSyncPluginInfo object

Definition at line 357 of file opensync_plugin_info.c.

void osync_plugin_info_set_version ( OSyncPluginInfo *  info,
OSyncVersion *  version 
)

Set OSyncVersion for OSyncPluginInfo object.

Parameters:
info Pointer to the plugin info object
version Pointer to OSyncVersion

Definition at line 370 of file opensync_plugin_info.c.

OSyncVersion* osync_plugin_info_get_version ( OSyncPluginInfo *  info  ) 

Get OSyncVersion of the OSyncPluginInfo object.

Parameters:
info Pointer to the plugin info object
Returns:
Pointer of the OSyncVersion from OSyncPluginInfo object

Definition at line 387 of file opensync_plugin_info.c.

void osync_plugin_info_set_capabilities ( OSyncPluginInfo *  info,
OSyncCapabilities *  capabilities 
)

Set OSyncCapabilities of the OSyncPluginInfo object.

Parameters:
info Pointer to the plugin info object
capabilities Pointer to the capabilities

Definition at line 398 of file opensync_plugin_info.c.

OSyncCapabilities* osync_plugin_info_get_capabilities ( OSyncPluginInfo *  info  ) 

Get OSyncCapabilities of the OSyncPluginInfo object.

Parameters:
info Pointer to the plugin info object
Returns:
OSyncCapabilities of the OSyncPluginInfo object

Definition at line 415 of file opensync_plugin_info.c.

Generated on Wed Nov 26 19:04:23 2008 for OpenSync by  doxygen 1.5.1