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 5b75297... d23a05e... M man/Makefile.am
> :000000 100644 0000000... 2422a05... A man/quorum_initialize.3
> man/Makefile.am | 1 +
> man/quorum_initialize.3 | 106 +++++++++++++++++++++++++++++++++++++++++++++++
> 2 files changed, 107 insertions(+), 0 deletions(-)
>
> diff --git a/man/Makefile.am b/man/Makefile.am
> index 5b75297..d23a05e 100644
> --- a/man/Makefile.am
> +++ b/man/Makefile.am
> @@ -94,6 +94,7 @@ dist_man_MANS = \
> evs_membership_get.3 \
> evs_context_get.3 \
> evs_context_set.3 \
> + quorum_initialize.3 \
> votequorum_dispatch.3 \
> votequorum_fd_get.3 \
> votequorum_context_get.3 \
> diff --git a/man/quorum_initialize.3 b/man/quorum_initialize.3
> new file mode 100644
> index 0000000..2422a05
> --- /dev/null
> +++ b/man/quorum_initialize.3
> @@ -0,0 +1,106 @@
> +.\"/*
> +.\" * 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_INITIALIZE 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
> +.SH NAME
> +quorum_initialize \- Create a new connection to the Quorum service
> +.SH SYNOPSIS
> +.B #include <corosync/quorum.h>
> +.sp
> +.BI "int quorum_initialize(quorum_handle_t *" handle ", quorum_callbacks_t *" callbacks ", uint32_t *" quorum_type ");
> +.SH DESCRIPTION
> +The
> +.B quorum_initialize
> +function is used to initialize a connection to the quorum API.
> +.PP
> +Each application may have several connections to the quorum API. Each application
> +uses the
> +.I handle
> +argument to uniquely identify the connection. The
> +.I handle
> +argument is then used in other function calls to identify the connection to be used
> +for communication with the quorum service.
> +.PP
> +Every time the voting configuraton changes (eg a node joins or leave the cluster) or the quorum status chnage,
> +the callback is called.
> +The callback function is described by the following type definitions:
> +
> +typedef void (*quorum_notification_fn_t) (
> + quorum_handle_t handle,
> + uint32_t quorate,
> + uint64_t ring_seq,
> + uint32_t view_list_entries,
> + uint32_t *view_list
> + );
> +
> +.ta
> +.fi
> +.RE
> +.IP
> +.PP
> +.PP
> +The
> +.I callbacks
> +argument is of the type:
> +.IP
> +.RS
> +.ne 18
> +.nf
> +.PP
> +typedef struct {
> + quorum_notification_fn_t quorum_notify_fn;
> +} quorum_callbacks_t;
> +
> +.ta
> +.fi
> +.RE
> +.IP
> +.PP
> +When a configuration change occurs, the callback
> +is called from the
> +.B quorum_dispatch()
> +function.
> +.PP
> +.SH RETURN VALUE
> +This call returns the CS_OK value if successful, otherwise an error is returned.
> +.PP
> +.SH BUGS
> +Callbacks are not support at the moment.
> +.PP
> +.SH ERRORS
> +The errors are undocumented.
> +.SH "SEE ALSO"
> +.BR quorum_finalize (3),
> +.BR quorum_fd_get (3),
> +.BR quorum_dispatch (3),
> +.PP
_______________________________________________
discuss mailing list
discuss@xxxxxxxxxxxx
http://lists.corosync.org/mailman/listinfo/discuss
