mirror of
https://git.proxmox.com/git/mirror_corosync
synced 2025-10-31 14:31:46 +00:00
b539b225e3
tidy up man/Makefile.am a bit in the process Signed-off-by: Fabio M. Di Nitto <fdinitto@redhat.com> Reviewed-by: Steven Dake <sdake@redhat.com>
112 lines
3.7 KiB
Groff
112 lines
3.7 KiB
Groff
.\"/*
|
|
.\" * Copyright (c) 2006 Red Hat, Inc.
|
|
.\" *
|
|
.\" * All rights reserved.
|
|
.\" *
|
|
.\" * Author: Patrick Caulfield <pcaulfie@redhat.com>
|
|
.\" *
|
|
.\" * This software licensed under BSD license, the text of which follows:
|
|
.\" *
|
|
.\" * Redistribution and use in source and binary forms, with or without
|
|
.\" * modification, are permitted provided that the following conditions are met:
|
|
.\" *
|
|
.\" * - Redistributions of source code must retain the above copyright notice,
|
|
.\" * this list of conditions and the following disclaimer.
|
|
.\" * - Redistributions in binary form must reproduce the above copyright notice,
|
|
.\" * this list of conditions and the following disclaimer in the documentation
|
|
.\" * and/or other materials provided with the distribution.
|
|
.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its
|
|
.\" * contributors may be used to endorse or promote products derived from this
|
|
.\" * software without specific prior written permission.
|
|
.\" *
|
|
.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
|
|
.\" * THE POSSIBILITY OF SUCH DAMAGE.
|
|
.\" */
|
|
.TH CPG_DISPATCH 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
|
|
.SH NAME
|
|
cpg_dispatch \- Dispatches callbacks from the CPG service
|
|
.SH SYNOPSIS
|
|
.B #include <corosync/cpg.h>
|
|
.sp
|
|
.BI "int cpg_dispatch(cpg_handle_t " handle ", cpg_dispatch_t *" dispatch_types ");
|
|
.SH DESCRIPTION
|
|
The
|
|
.B cpg_dispatch
|
|
function is used to dispatch configuration changes or messages from the
|
|
closed process groups API.
|
|
.PP
|
|
Each application may have several connections to the CPG API. Each application
|
|
uses the
|
|
.I handle
|
|
argument to uniquely identify the connection.
|
|
.PP
|
|
The
|
|
.I dispatch_types
|
|
argument is used to identify the type of dispatch to execute. The possible types are
|
|
defined by the structure:
|
|
|
|
.IP
|
|
.RS
|
|
.ne 18
|
|
.nf
|
|
.ta 4n 30n 33n
|
|
typedef enum {
|
|
CS_DISPATCH_ONE,
|
|
CS_DISPATCH_ALL,
|
|
CS_DISPATCH_BLOCKING
|
|
} cpg_dispatch_t;
|
|
.ta
|
|
.fi
|
|
.RE
|
|
.IP
|
|
.PP
|
|
.PP
|
|
The dispatch values have the following meanings:
|
|
.TP
|
|
.B CS_DISPATCH_ONE
|
|
Dispatch atleast one callback, blocking until the callback is dispatched.
|
|
.TP
|
|
.B CS_DISPATCH_ALL
|
|
Dispatch all waiting callbacks without blocking to wait for any callbacks.
|
|
.TP
|
|
.B CS_DISPATCH_BLOCKING
|
|
Dispatch all callbacks, blocking indefinitely. This is used in a threaded
|
|
program where a thread is created, and then cpg_dispatch() is called immediately
|
|
from the created thread to execute callbacks.
|
|
.TP
|
|
.B CS_DISPATCH_ONE_NONBLOCKING
|
|
Dispatch at most one callback. If there is no pending callback,
|
|
CS_ERR_TRY_AGAIN is returned.
|
|
|
|
.SH RETURN VALUE
|
|
This call returns the CS_OK value if successful, otherwise an error is returned.
|
|
.PP
|
|
.SH ERRORS
|
|
The errors are undocumented.
|
|
.SH "SEE ALSO"
|
|
.BR cpg_overview (8),
|
|
.BR cpg_initialize (3),
|
|
.BR cpg_finalize (3),
|
|
.BR cpg_fd_get (3),
|
|
.BR cpg_dispatch (3),
|
|
.BR cpg_join (3),
|
|
.BR cpg_leave (3),
|
|
.BR cpg_mcast_joined (3),
|
|
.BR cpg_membership_get (3)
|
|
.BR cpg_zcb_alloc (3)
|
|
.BR cpg_zcb_free (3)
|
|
.BR cpg_zcb_mcast_joined (3)
|
|
.BR cpg_context_get (3)
|
|
.BR cpg_context_set (3)
|
|
.BR cpg_local_get (3)
|
|
.PP
|