man/cpg_dispatch.3

   1 .\"/*
   2 .\" * Copyright (c) 2006 Red Hat, Inc.
   3 .\" *
   4 .\" * All rights reserved.
   5 .\" *
   6 .\" * Author: Patrick Caulfield <pcaulfie@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 CPG_DISPATCH 3 2004-08-31 "openais Man Page" "Openais Programmer's Manual"
  35 .SH NAME
  36 cpg_dispatch \- Dispatches callbacks from the CPG service
  37 .SH SYNOPSIS
  38 .B #include <openais/cpg.h>
  39 .sp
  40 .BI "int cpg_dispatch(cpg_handle_t " handle ", cpg_dispatch_t *" dispatch_types ");
  41 .SH DESCRIPTION
  42 The
  43 .B cpg_dispatch
  44 function is used to dispatch configuration changes or messages from the
  45 closed process groups API.
  46 .PP
  47 Each application may have several connections to the CPG API.  Each  application
  48 uses the
  49 .I handle
  50 argument to uniquely identify the connection.
  51 .PP
  52 The
  53 .I dispatch_types
  54 argument is used to identify the type of dispatch to execute.  The possible types are
  55 defined by the structure:
  56
  57 .IP
  58 .RS
  59 .ne 18
  60 .nf
  61 .ta 4n 30n 33n
  62 typedef enum {
  63         CPG_DISPATCH_ONE,
  64         CPG_DISPATCH_ALL,
  65         CPG_DISPATCH_BLOCKING
  66 } cpg_dispatch_t;
  67 .ta
  68 .fi
  69 .RE
  70 .IP
  71 .PP
  72 .PP
  73 The dispatch values have the following meanings:
  74 .TP
  75 .B CPG_DISPATCH_ONE
  76 Dispatch atleast one callback, blocking until the callback is dispatched.
  77 .TP
  78 .B CPG_DISPATCH_ALL
  79 Dispatch all waiting callbacks without blocking to wait for any callbacks.
  80 .TP
  81 .B CPG_DISPATCH_BLOCKING
  82 Dispatch all callbacks blocking indefinately.  This is used in a threaded
  83 program where a thread is created, and then cpg_dispatch() is called immediately
  84 from the created thread to execute callbacks.
  85
  86 .SH RETURN VALUE
  87 This call returns the CPG_OK value if successful, otherwise an error is returned.
  88 .PP
  89 .SH ERRORS
  90 The errors are undocumented.
  91 .SH "SEE ALSO"
  92 .BR cpg_overview (8),
  93 .BR cpg_initialize (3),
  94 .BR cpg_finalize (3),
  95 .BR cpg_fd_get (3),
  96 .BR cpg_join (3),
  97 .BR cpg_leave (3),
  98 .BR cpg_mcast_joined (3),
  99 .BR cpg_membership_get (3)
 100 .PP