Reviewed-by: Steven Dake <sdake@xxxxxxxxxx>
On 01/12/2012 08:17 AM, Fabio M. Di Nitto wrote:
> From: "Fabio M. Di Nitto" <fdinitto@xxxxxxxxxx>
>
> Signed-off-by: Fabio M. Di Nitto <fdinitto@xxxxxxxxxx>
> ---
> :100644 100644 a18e836... b81c6a7... M man/Makefile.am
> :000000 100644 0000000... cb26050... A man/quorum_dispatch.3
> man/Makefile.am | 1 +
> man/quorum_dispatch.3 | 95 +++++++++++++++++++++++++++++++++++++++++++++++++
> 2 files changed, 96 insertions(+), 0 deletions(-)
>
> diff --git a/man/Makefile.am b/man/Makefile.am
> index a18e836..b81c6a7 100644
> --- a/man/Makefile.am
> +++ b/man/Makefile.am
> @@ -97,6 +97,7 @@ dist_man_MANS = \
> quorum_initialize.3 \
> quorum_finalize.3 \
> quorum_fd_get.3 \
> + quorum_dispatch.3 \
> votequorum_dispatch.3 \
> votequorum_fd_get.3 \
> votequorum_context_get.3 \
> diff --git a/man/quorum_dispatch.3 b/man/quorum_dispatch.3
> new file mode 100644
> index 0000000..cb26050
> --- /dev/null
> +++ b/man/quorum_dispatch.3
> @@ -0,0 +1,95 @@
> +.\"/*
> +.\" * Copyright (c) 2012 Red Hat, Inc.
> +.\" *
> +.\" * All rights reserved.
> +.\" *
> +.\" * Author: Fabio M. Di Nitto <fdinitto@xxxxxxxxxx>
> +.\" *
> +.\" * 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 QUORUM_DISPATCH 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
> +.SH NAME
> +quorum_dispatch \- Dispatches callbacks from the quorum service
> +.SH SYNOPSIS
> +.B #include <corosync/quorum.h>
> +.sp
> +.BI "int quorum_dispatch(quorum_handle_t " handle ", quorum_dispatch_t *" dispatch_types ");"
> +.SH DESCRIPTION
> +The
> +.B quorum_dispatch
> +function is used to dispatch configuration changes.
> +.PP
> +Each application may have several connections to the quorum 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
> +} quorum_dispatch_t;
> +.ta
> +.fi
> +.RE
> +.IP
> +.PP
> +.PP
> +The dispatch values have the following meanings:
> +.TP
> +.B CS_DISPATCH_ONE
> +Dispatch at least 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 quorum_dispatch() is called immediately
> +from the created thread to execute callbacks.
> +
> +.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 quorum_initialize (3),
> +.BR quorum_finalize (3),
> +.BR quorum_fd_get (3),
> +
> +.PP
_______________________________________________
discuss mailing list
discuss@xxxxxxxxxxxx
http://lists.corosync.org/mailman/listinfo/discuss
