debian man page for confdb_initialize

CONFDB_INITIALIZE(3)				    Corosync Cluster Engine Programmer's Manual 			      CONFDB_INITIALIZE(3)

NAME
       confdb_initialize - Create a new connection to the ConfDb service

SYNOPSIS
       #include <corosync/confdb.h>

       int confdb_initialize(confdb_handle_t *handle, confdb_callbacks_t *callbacks);

DESCRIPTION
       The confdb_initialize function is used to initialize a connection to the configuration database API.

       Each  application may have several connections to the CONFDB API.  Each	application uses the handle argument to uniquely identify the con-
       nection.  The handle argument is then used in other function calls to identify the connection to be used for communication with the  CONFDB
       service.

       Every time the configuration database is updated, the callback is called.  The callback function is described by the following type defini-
       tions:

	      typedef void (*confdb_change_notify_fn_t) (
		  confdb_handle_t handle,
		  unsigned int parent_object_handle,
		  unsigned int object_handle,
		  void *object_name,
		  int  object_name_len,
		  void *key_name,
		  int key_name_len,
		  void *key_value,
		  int key_value_len);

       The callbacks argument is of the type:

	      typedef struct {
	      confdb_change_notify_fn_t confdb_change_notify_fn;
	      } confdb_callbacks_t;

       When a configuration change occurs, the callback is called from the confdb_dispatch() function.

RETURN VALUE
       This call returns the CONFDB_OK value if successful, otherwise an error is returned.

BUGS
       Callbacks are not support at the moment.

ERRORS
       The errors are undocumented.

SEE ALSO
       confdb_overview(8), confdb_finalize(3), confdb_fd_get(3), confdb_dispatch(3),

corosync Man Page						    2004-08-31						      CONFDB_INITIALIZE(3)