man/confdb_dispatch.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_DISPATCH 3 2004-08-31 "openais Man Page" "Openais Programmer's Manual"
  35 .SH NAME
  36 confdb_dispatch \- Dispatches callbacks from the CONFDB service
  37 .SH SYNOPSIS
  38 .B #include <openais/confdb.h>
  39 .sp
  40 .BI "int confdb_dispatch(confdb_handle_t " handle ", confdb_dispatch_t *" dispatch_types ");"
  41 .SH DESCRIPTION
  42 The
  43 .B confdb_dispatch
  44 function is used to dispatch configuration changes.
  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.
  50 .PP
  51 The
  52 .I dispatch_types
  53 argument is used to identify the type of dispatch to execute.  The possible types are
  54 defined by the structure:
  55
  56 .IP
  57 .RS
  58 .ne 18
  59 .nf
  60 .ta 4n 30n 33n
  61 typedef enum {
  62         CONFDB_DISPATCH_ONE,
  63         CONFDB_DISPATCH_ALL,
  64         CONFDB_DISPATCH_BLOCKING
  65 } confdb_dispatch_t;
  66 .ta
  67 .fi
  68 .RE
  69 .IP
  70 .PP
  71 .PP
  72 The dispatch values have the following meanings:
  73 .TP
  74 .B CONFDB_DISPATCH_ONE
  75 Dispatch at least one callback, blocking until the callback is dispatched.
  76 .TP
  77 .B CONFDB_DISPATCH_ALL
  78 Dispatch all waiting callbacks without blocking to wait for any callbacks.
  79 .TP
  80 .B CONFDB_DISPATCH_BLOCKING
  81 Dispatch all callbacks blocking indefinitely.  This is used in a threaded
  82 program where a thread is created, and then confdb_dispatch() is called immediately
  83 from the created thread to execute callbacks.
  84
  85 .SH RETURN VALUE
  86 This call returns the CONFDB_OK value if successful, otherwise an error is returned.
  87 .PP
  88 .SH ERRORS
  89 The errors are undocumented.
  90 .SH "SEE ALSO"
  91 .BR confdb_overview (8),
  92 .BR confdb_initialize (3),
  93 .BR confdb_finalize (3),
  94 .BR confdb_fd_get (3),
  95 .BR confdb_object_create (3),
  96 .BR confdb_object_destroy (3),
  97 .BR confdb_object_parent_get (3),
  98 .BR confdb_key_create (3),
  99 .BR confdb_key_delete (3),
 100 .BR confdb_key_get (3),
 101 .BR confdb_key_replace (3),
 102 .BR confdb_object_find_start (3),
 103 .BR confdb_object_find (3),
 104 .BR confdb_object_iter_start (3),
 105 .BR confdb_object_iter (3),
 106 .BR confdb_key_iter_start (3),
 107 .BR confdb_key_iter (3),
 108
 109 .PP