Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

confdb_key_iter(3) [debian man page]

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

NAME
confdb_key_iter - Iterate through key/value pairs in the Configuration Database SYNOPSIS
#include <corosync/confdb.h> confdb_error_t confdb_key_iter_start(confdb_handle_t handle, unsigned int parent_object_handle ); confdb_error_t confdb_key_iter(confdb_handle_t handle, unsigned int parent_object_handle, void *key_name, int *key_name_len, void *value, int *value_len ); DESCRIPTION
The confdb_key_iter function repeatedly returns all key/value pairs that are subobjects of the specified parent. You must call confdb_key_iter_start first. This establishes a context for the parent object so that it knows where you are in the list. Then the next call to confdb_key_iter will return the first key/value in the list. Subsequent calls will return any remaining keys. The function returns CONFDB_ERR_ACCESS when the all of the matching keys have been seen. The library holds a seperate context for each parent object, so you can call confdb_key_iter() on several parent objects at the same time and they will not interfere. Nor will they interfere with confdb_object_find or confdb_object_iter calls on the same parent object. RETURN VALUE
This call returns the CONFDB_OK value if successful, otherwise an error is returned. ERRORS
The errors are undocumented. SEE ALSO
confdb_overview(8), confdb_initialize(3), confdb_finalize(3), confdb_dispatch(3), confdb_object_create(3), confdb_object_destroy(3), confdb_object_parent_get(3), confdb_key_create(3), confdb_key_delete(3), confdb_key_get(3), confdb_key_replace(3), confdb_object_find_start(3), confdb_object_find(3), confdb_object_iter_start(3), confdb_object_iter(3), confdb_key_iter_start(3), confdb_key_iter(3), corosync Man Page 2008-04-17 CONFDB_KEY_ITER(3)

Check Out this Related Man Page

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)
Man Page

Featured Tech Videos