OpenSync Group Internals

The private API of opensync. More...

Functions
OSyncEnv *	osync_group_get_env (OSyncGroup *group)
	Returns the environment in which a group is registered. More...
void *	osync_group_get_data (OSyncGroup *group)
	Gets the custom data of a group. More...
void	osync_group_set_data (OSyncGroup *group, void *data)
	Sets the custom data of a group. More...
long long int	osync_group_create_member_id (OSyncGroup *group)
	Creates a new unique member if in this group. More...
OSyncFormatEnv *	osync_group_get_format_env (OSyncGroup *group)
	Returns the format environment of a group. More...
osync_bool	osync_group_load_members (OSyncGroup *group, const char *path, OSyncError **error)
	Loads all members of a group. More...

Detailed Description

The private API of opensync.

This gives you an insight in the private API of opensync.

Function Documentation

osync_group_get_env()

OSyncEnv* osync_group_get_env

(

OSyncGroup *

group

)

Returns the environment in which a group is registered.

Parameters

group

The group

Returns

The environment

Definition at line 83 of file opensync_group.c.

osync_group_get_data()

void* osync_group_get_data

(

OSyncGroup *

group

)

Gets the custom data of a group.

Parameters

group

The group

Returns

The custom data of this group

Definition at line 94 of file opensync_group.c.

osync_group_set_data()

void osync_group_set_data	(	OSyncGroup *	group,
		void *	data
	)

Sets the custom data of a group.

Parameters

group	The group
data	The custom data

Definition at line 105 of file opensync_group.c.

Referenced by osengine_new().

osync_group_create_member_id()

long long int osync_group_create_member_id

(

OSyncGroup *

group

)

Creates a new unique member if in this group.

Parameters

group

The group

Returns

A new unique member id

Definition at line 116 of file opensync_group.c.

Referenced by osync_member_save().

osync_group_get_format_env()

OSyncFormatEnv* osync_group_get_format_env

(

OSyncGroup *

group

)

Returns the format environment of a group.

Parameters

group

The group

Returns

The format environment

Definition at line 136 of file opensync_group.c.

Referenced by _new_change_receiver().

osync_group_load_members()

osync_bool osync_group_load_members	(	OSyncGroup *	group,
		const char *	path,
		OSyncError **	error
	)

Loads all members of a group.

Loads all members of a group

Parameters

group	The group
path	The path from which to load the members
error	Pointer to a error

Returns

True if the members were loaded successfully, FALSE otherwise

Definition at line 152 of file opensync_group.c.