man/confdb_initialize.3

   1 .\"/*
   2 .\" * Copyright (c) 2008 Red Hat, Inc.
   3 .\" *
   4 .\" * All rights reserved.
   5 .\" *
   6 .\" * Author: Christine Caulfield <ccaulfie@redhat.com>
   7 .\" *
   8 .\" * This software licensed under BSD license, the text of which follows:
   9 .\" *
  10 .\" * Redistribution and use in source and binary forms, with or without
  11 .\" * modification, are permitted provided that the following conditions are met:
  12 .\" *
  13 .\" * - Redistributions of source code must retain the above copyright notice,
  14 .\" *   this list of conditions and the following disclaimer.
  15 .\" * - Redistributions in binary form must reproduce the above copyright notice,
  16 .\" *   this list of conditions and the following disclaimer in the documentation
  17 .\" *   and/or other materials provided with the distribution.
  18 .\" * - Neither the name of the MontaVista Software, Inc. nor the names of its
  19 .\" *   contributors may be used to endorse or promote products derived from this
  20 .\" *   software without specific prior written permission.
  21 .\" *
  22 .\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  23 .\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  26 .\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27 .\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28 .\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29 .\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30 .\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  32 .\" * THE POSSIBILITY OF SUCH DAMAGE.
  33 .\" */
  34 .TH CONFDB_INITIALIZE 3 2004-08-31 "openais Man Page" "Openais Programmer's Manual"
  35 .SH NAME
  36 confdb_initialize \- Create a new connection to the ConfDb service
  37 .SH SYNOPSIS
  38 .B #include <openais/confdb.h>
  39 .sp
  40 .BI "int confdb_initialize(confdb_handle_t *" handle ", confdb_callbacks_t *" callbacks ");
  41 .SH DESCRIPTION
  42 The
  43 .B confdb_initialize
  44 function is used to initialize a connection to the configuration database API.
  45 .PP
  46 Each application may have several connections to the CONFDB API.  Each  application
  47 uses the
  48 .I handle
  49 argument to uniquely identify the connection.  The
  50 .I handle
  51 argument is then used in other function calls to identify the connection to be used
  52 for communication with the CONFDB service.
  53 .PP
  54 Every time the configuration database is updated, the callback is called.
  55 The callback function is described by the following type definitions:
  56 .PP
  57 .PP
  58 .IP
  59 .RS
  60 .ne 18
  61 .nf
  62 .ta 4n 20n 32n
  63
  64 typedef void (*confdb_change_notify_fn_t) (
  65         confdb_handle_t handle,
  66         unsigned int parent_object_handle,
  67         unsigned int object_handle,
  68         void *object_name,
  69         int  object_name_len,
  70         void *key_name,
  71         int key_name_len,
  72         void *key_value,
  73         int key_value_len);
  74
  75 .ta
  76 .fi
  77 .RE
  78 .IP
  79 .PP
  80 .PP
  81 The
  82 .I callbacks
  83 argument is of the type:
  84 .IP
  85 .RS
  86 .ne 18
  87 .nf
  88 .PP
  89 typedef struct {
  90         confdb_change_notify_fn_t confdb_change_notify_fn;
  91 } confdb_callbacks_t;
  92 .ta
  93 .fi
  94 .RE
  95 .IP
  96 .PP
  97 When a configuration change occurs, the callback
  98 is called from the
  99 .B confdb_dispatch()
 100 function.
 101 .PP
 102 .SH RETURN VALUE
 103 This call returns the CONFDB_OK value if successful, otherwise an error is returned.
 104 .PP
 105 .SH BUGS
 106 Callbacks are not support at the moment.
 107 .PP
 108 .SH ERRORS
 109 The errors are undocumented.
 110 .SH "SEE ALSO"
 111 .BR confdb_overview (8),
 112 .BR confdb_finalize (3),
 113 .BR confdb_fd_get (3),
 114 .BR confdb_dispatch (3),
 115 .PP