Page Menu
Home
ClusterLabs Projects
Search
Configure Global Search
Log In
Files
F3154620
No One
Temporary
Actions
View File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Flag For Later
Award Token
Size
73 KB
Referenced Files
None
Subscribers
None
View Options
diff --git a/man/Makefile.am b/man/Makefile.am
index 18329b25..d5091d42 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -1,181 +1,177 @@
# Copyright (c) 2004 MontaVista Software, Inc.
# Copyright (c) 2009, 2012 Red Hat, Inc.
#
# Authors: Steven Dake (sdake@redhat.com)
# Fabio M. Di Nitto (fdinitto@redhat.com)
#
# All rights reserved.
#
# 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.
MAINTAINERCLEANFILES = Makefile.in
if INSTALL_XMLCONF
xml_man = corosync-xmlproc.8 \
corosync.xml.5
endif
INDEX_HTML = index.html
autogen_man = cpg_context_get.3 \
cpg_context_set.3 \
cpg_dispatch.3 \
cpg_fd_get.3 \
cpg_finalize.3 \
cpg_initialize.3 \
cpg_join.3 \
cpg_leave.3 \
cpg_local_get.3 \
cpg_mcast_joined.3 \
cpg_model_initialize.3 \
cpg_zcb_mcast_joined.3 \
cpg_zcb_alloc.3 \
cpg_zcb_free.3 \
cpg_membership_get.3 \
evs_dispatch.3 \
evs_fd_get.3 \
evs_finalize.3 \
evs_initialize.3 \
evs_join.3 \
evs_leave.3 \
evs_mcast_groups.3 \
evs_mcast_joined.3 \
evs_membership_get.3 \
evs_context_get.3 \
evs_context_set.3 \
quorum_initialize.3 \
quorum_finalize.3 \
quorum_fd_get.3 \
quorum_dispatch.3 \
quorum_context_get.3 \
quorum_context_set.3 \
quorum_getquorate.3 \
quorum_trackstart.3 \
quorum_trackstop.3 \
votequorum_dispatch.3 \
votequorum_fd_get.3 \
votequorum_context_get.3 \
votequorum_context_set.3 \
votequorum_finalize.3 \
votequorum_getinfo.3 \
votequorum_initialize.3 \
- votequorum_qdevice_getinfo.3 \
- votequorum_qdevice_poll.3 \
- votequorum_qdevice_register.3 \
- votequorum_qdevice_unregister.3 \
votequorum_setexpected.3 \
votequorum_setvotes.3 \
votequorum_trackstart.3 \
votequorum_trackstop.3 \
sam_data_getsize.3 \
sam_data_restore.3 \
sam_data_store.3 \
sam_finalize.3 \
sam_hc_callback_register.3 \
sam_hc_send.3 \
sam_initialize.3 \
sam_mark_failed.3 \
sam_register.3 \
sam_start.3 \
sam_stop.3 \
sam_warn_signal_set.3 \
cmap_context_get.3 \
cmap_dec.3 \
cmap_iter_init.3 \
cmap_get.3 \
cmap_inc.3 \
cmap_set.3 \
cmap_iter_next.3 \
cmap_delete.3 \
cmap_iter_finalize.3 \
cmap_finalize.3 \
cmap_dispatch.3 \
cmap_initialize.3 \
cmap_track_add.3 \
cmap_context_set.3 \
cmap_fd_get.3 \
cmap_track_delete.3
autogen_common = ipc_common.sh.errors
EXTRA_DIST = $(INDEX_HTML) \
$(xml_man) \
$(autogen_man:%=%.in) \
$(autogen_common)
man_MANS = $(autogen_man)
dist_man_MANS = $(xml_man) \
corosync.conf.5 \
votequorum.5 \
corosync.8 \
corosync-cmapctl.8 \
corosync-blackbox.8 \
corosync-keygen.8 \
corosync-cfgtool.8 \
corosync-cpgtool.8 \
corosync-fplay.8 \
corosync-pload.8 \
corosync-notifyd.8 \
corosync-quorumtool.8 \
corosync_overview.8 \
cpg_overview.8 \
evs_overview.8 \
quorum_overview.8 \
votequorum_overview.8 \
sam_overview.8 \
cmap_overview.8
HTML_DOCS = $(dist_man_MANS:%=%.html) $(man_MANS:%=%.html)
# developer man page generation
%.3: %.3.in $(autogen_common) $(top_srcdir)/build-aux/genman
@echo Generating $@ man page && \
rm -f $@-t $@ && \
$(top_srcdir)/build-aux/genman \
$(srcdir)/$@.in \
$(builddir)/$@-t \
$(srcdir)/$(autogen_common) && \
mv $@-t $@
clean-local:
rm -rf $(HTML_DOCS) $(autogen_man)
if BUILD_HTML_DOCS
%.html: %
$(GROFF) -mandoc -Thtml $^ > $@
install-data-local:
$(INSTALL) -d $(DESTDIR)/${docdir}/html
$(INSTALL) -m644 ${srcdir}/$(INDEX_HTML) $(HTML_DOCS) $(DESTDIR)/${docdir}/html/
uninstall-local:
cd $(DESTDIR)/${docdir}/html && rm -f $(INDEX_HTML) $(HTML_DOCS)
rmdir $(DESTDIR)/${docdir}/html 2> /dev/null || :
all-local: $(HTML_DOCS)
endif
diff --git a/man/index.html b/man/index.html
index d569ff55..0ead1991 100644
--- a/man/index.html
+++ b/man/index.html
@@ -1,325 +1,325 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<html lang="en" dir="ltr">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-15">
<meta name="keywords" content="corosync, documentation, manual">
<meta name="author" content="many">
<meta name="copyright" content="© 2009 Red Hat, Inc.">
<!-- meta http-equiv="Content-Style-Type" content="text/css" -->
<meta name="date" content="2009-03-17T13:50:00+01:00">
<title>Corosync Documentation</title>
</head>
<body>
<h1>Welcome to the corosync project's manual pages.</h1>
<p>
<h2>Daemon, tools and configuration</h2>
<a href="corosync_overview.8.html">corosync_overview(8)</a>:
Overview of the corosync system.
<br>
<a href="corosync.conf.5.html">corosync.conf(5)</a>:
Description of configuration options for corosync.
<br>
<a href="corosync.xml.5.html">corosync.xml(5)</a>:
Description of configuration options for corosync xml config format.
<br>
<a href="votequorum.5.html">votequorum(5)</a>:
Description of configuration options for votequorum module in corosync.conf
<br>
<a href="corosync.8.html">corosync(8)</a>:
Description of corosync daemon.
<br>
<a href="corosync-blackbox.8.html">corosync-blackbox(8)</a>:
Description of corosync-blackbox tool.
<br>
<a href="corosync-cfgtool.8.html">corosync-cfgtool(8)</a>:
Description of corosync-cfgtool tool.
<br>
<a href="corosync-cpgtool.8.html">corosync-cpgtool(8)</a>:
Description of corosync-cpgtool tool.
<br>
<a href="corosync-fplay.8.html">corosync-fplay(8)</a>:
Description of corosync-fplay tool.
<br>
<a href="corosync-keygen.8.html">corosync-keygen(8)</a>:
Description of corosync-keygen tool.
<br>
<a href="corosync-notifyd.8.html">corosync-notifyd(8)</a>:
Description of corosync-notifyd tool.
<br>
<a href="corosync-cmapctl.8.html">corosync-cmapctl(8)</a>:
Description of corosync-cmapctl tool.
<br>
<a href="corosync-pload.8.html">corosync-pload(8)</a>:
Description of corosync-pload tool.
<br>
<a href="corosync-quorumtool.8.html">corosync-quorumtool(8)</a>:
Description of corosync-quorumtool tool.
<br>
<a href="corosync-xmlproc.8.html">corosync-xmlproc(8)</a>:
Description of corosync-xmlproc tool.
<br>
</p>
<p>
<h2>Developers API references</h2>
<h3>CPG service</h3>
<a href="cpg_overview.8.html">cpg_overview(8)</a>:
Overview of the cpg extended virtual synchrony group
communication toolkit.
<br>
<a href="cpg_initialize.3.html">cpg_initialize(3)</a>:
Description of the cpg_initialize interface.
<br>
<a href="cpg_finalize.3.html">cpg_finalize(3)</a>:
Description of the cpg_finalize interface.
<br>
<a href="cpg_dispatch.3.html">cpg_dispatch(3)</a>:
Description of the cpg_dispatch interface.
<br>
<a href="cpg_fd_get.3.html">cpg_fd_get(3)</a>:
Description of the cpg_fd_get interface.
<br>
<a href="cpg_join.3.html">cpg_join(3)</a>:
Description of the cpg_join interface.
<br>
<a href="cpg_leave.3.html">cpg_leave(3)</a>:
Description of the cpg_leave interface.
<br>
<a href="cpg_mcast_joined.3.html">cpg_mcast_joined(3)</a>:
Description of the cpg_mcast_joined interface.
<br>
<a href="cpg_membership_get.3.html">cpg_membership_get(3)</a>:
Description of the cpg_membership_get interface.
<br>
<a href="cpg_local_get.3.html">cpg_local_get(3)</a>:
Description of the cpg_local_get interface.
<br>
<a href="cpg_groups_get.3.html">cpg_local_get(3)</a>:
Description of the cpg_groups_get interface.
<br>
<h3>EVS service</h3>
<a href="evs_overview.8.html">evs_overview(8)</a>:
Overview of the evs extended virtual synchrony group
communication toolkit.
<br>
<a href="evs_initialize.3.html">evs_initialize(3)</a>:
Description of the evs_initialize interface.
<br>
<a href="evs_finalize.3.html">evs_finalize(3)</a>:
Description of the evs_finalize interface.
<br>
<a href="evs_dispatch.3.html">evs_dispatch(3)</a>:
Description of the evs_dispatch interface.
<br>
<a href="evs_fd_get.3.html">evs_fd_get(3)</a>:
Description of the evs_fd_get interface.
<br>
<a href="evs_join.3.html">evs_join(3)</a>:
Description of the evs_join interface.
<br>
<a href="evs_leave.3.html">evs_leave(3)</a>:
Description of the evs_leave interface.
<br>
<a href="evs_mcast_groups.3.html">evs_mcast_groups(3)</a>:
Description of the evs_mcast_groups interface.
<br>
<a href="evs_mcast_joined.3.html">evs_mcast_joined(3)</a>:
Description of the evs_mcast_joined interface.
<br>
<a href="evs_membership_get.3.html">evs_membership_get(3)</a>:
Description of the evs_membership_get interface.
<br>
<h3>SAM service</h3>
<a href="sam_overview.8.html">sam_overview(8)</a>:
Description of sam_overview interface.
<br>
<a href="sam_data_getsize.3.html">sam_data_getsize(3)</a>:
Description of sam_data_getsize interface.
<br>
<a href="sam_data_restore.3.html">sam_data_restore(3)</a>:
Description of sam_data_restore interface.
<br>
<a href="sam_data_store.3.html">sam_data_store(3)</a>:
Description of sam_data_store interface.
<br>
<a href="sam_finalize.3.html">sam_finalize(3)</a>:
Description of sam_finalize interface.
<br>
<a href="sam_hc_callback_register.3.html">sam_hc_callback_register(3)</a>:
Description of sam_hc_callback_register interface.
<br>
<a href="sam_hc_send.3.html">sam_hc_send(3)</a>:
Description of sam_hc_send interface.
<br>
<a href="sam_initialize.3.html">sam_initialize(3)</a>:
Description of sam_initialize interface.
<br>
<a href="sam_mark_failed.3.html">sam_mark_failed(3)</a>:
Description of sam_mark_failed interface.
<br>
<a href="sam_register.3.html">sam_register(3)</a>:
Description of sam_register interface.
<br>
<a href="sam_start.3.html">sam_start(3)</a>:
Description of sam_start interface.
<br>
<a href="sam_stop.3.html">sam_stop(3)</a>:
Description of sam_stop interface.
<br>
<a href="sam_warn_signal_set.3.html">sam_warn_signal_set(3)</a>:
Description of sam_warn_signal_set interface.
<br>
<h3>QUORUM service</h3>
<a href="quorum_overview.8.html">quorum_overview(8)</a>:
An overview of the quorum service
<br>
<a href="quorum_initialize.3.html">quorum_initialize(3)</a>:
Description of quorum_initialize interface.
<br>
<a href="quorum_finalize.3.html">quorum_finalize(3)</a>:
Description of quorum_finalize interface.
<br>
<a href="quorum_getquorate.3.html">quorum_getquorate(3)</a>:
Description of quorum_getquorate interface.
<br>
<a href="quorum_trackstart.3.html">quorum_trackstart(3)</a>:
Description of quorum_trackstart interface.
<br>
<a href="quorum_trackstop.3.html">quorum_trackstop(3)</a>:
Description of quorum_trackstop interface.
<br>
<a href="quorum_fd_get.3.html">quorum_fd_get(3)</a>:
Description of quorum_fd_get interface.
<br>
<a href="quorum_dispatch.3.html">quorum_dispatch(3)</a>:
Description of quorum_dispatch interface.
<br>
<a href="quorum_context_set.3.html">quorum_context_set(3)</a>:
Description of quorum_context_set interface.
<br>
<a href="quorum_context_get.3.html">quorum_context_get(3)</a>:
Description of quorum_context_get interface.
<br>
<h3>VOTEQUORUM service</h3>
<a href="votequorum_overview.8.html">votequorum_overview(8)</a>:
An overview of the vote-based quorum service
<br>
<a href="votequorum_initialize.3.html">votequorum_initialize(3)</a>:
- Description of the votequorum interface.
+ Description of the votequorum_initialize interface.
<br>
<a href="votequorum_finalize.3.html">votequorum_finalize(3)</a>:
- Description of the votequorum interface.
+ Description of the votequorum_finalize interface.
<br>
- <a href="votequorum_fd_get.3.html">votequorum_fd_get(3)</a>:
- Description of the votequorum interface.
+ <a href="votequorum_getinfo.3.html">votequorum_getinfo(3)</a>:
+ Description of the votequorum_getinfo interface.
<br>
- <a href="votequorum_getinfo.3.html">votequorum_getinfo(3)</a>:
- Description of the votequorum interface.
+ <a href="votequorum_trackstart.3.html">votequorum_trackstart(3)</a>:
+ Description of the votequorum_trackstart interface.
<br>
- <a href="votequorum_setexpected.3.html">votequorum_setexpected(3)</a>:
- Description of the votequorum interface.
+ <a href="votequorum_trackstop.3.html">votequorum_trackstop(3)</a>:
+ Description of the votequorum_trackstop interface.
<br>
- <a href="votequorum_setvotes.3.html">votequorum_setvotes(3)</a>:
- Description of the votequorum interface.
+ <a href="votequorum_fd_get.3.html">votequorum_fd_get(3)</a>:
+ Description of the votequorum_fd_get interface.
<br>
- <a href="votequorum_qdevice_register.3.html">
- votequorum_qdevice_register(3)</a>:
- Description of the votequorum interface.
+ <a href="votequorum_dispatch.3.html">votequorum_dispatch(3)</a>:
+ Description of the votequorum_dispatch interface.
<br>
- <a href="votequorum_qdevice_unregister.3.html">
- votequorum_qdevice_unregister(3)</a>:
- Description of the votequorum interface.
+ <a href="votequorum_context_set.3.html">votequorum_context_set(3)</a>:
+ Description of the votequorum_context_set interface.
<br>
- <a href="votequorum_qdevice_poll.3.html">
- votequorum_qdevice_poll(3)</a>:
+ <a href="votequorum_context_get.3.html">votequorum_context_get(3)</a>:
+ Description of the votequorum_context_get interface.
+ <br>
+
+ <a href="votequorum_setexpected.3.html">votequorum_setexpected(3)</a>:
Description of the votequorum interface.
<br>
- <a href="votequorum_qdevice_getinfo.3.html">
- votequorum_qdevice_getinfo(3)</a>:
+ <a href="votequorum_setvotes.3.html">votequorum_setvotes(3)</a>:
Description of the votequorum interface.
<br>
</p>
</body>
</html>
diff --git a/man/votequorum_context_get.3.in b/man/votequorum_context_get.3.in
index 07955f46..df203857 100644
--- a/man/votequorum_context_get.3.in
+++ b/man/votequorum_context_get.3.in
@@ -1,58 +1,64 @@
.\"/*
.\" * Copyright (c) 2007,2012 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 VOTEQUORUM_CONTEXT_GET 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
.SH NAME
votequorum_context_get \- Gets the context variable for a VOTEQUORUM instance
.SH SYNOPSIS
.B #include <corosync/votequorum.h>
.sp
-.BI "int votequorum_context_get(votequorum_handle_t " handle ", void **" context ");
+.BI "int votequorum_context_get(votequorum_handle_t " handle ", void **" context ");"
.SH DESCRIPTION
The
.B votequorum_context_get
function is used to retrieve the context variable previously stored using
.B votequorum_context_set(3)
.SH RETURN VALUE
This call returns the CS_OK value if successful, otherwise an error is returned.
.PP
.SH ERRORS
@COMMONIPCERRORS@
.SH "SEE ALSO"
+.BR votequorum_overview (8),
.BR votequorum_initialize (3),
.BR votequorum_finalize (3),
+.BR votequorum_getinfo (3),
+.BR votequorum_trackstart (3),
+.BR votequorum_trackstop (3),
.BR votequorum_fd_get (3),
.BR votequorum_dispatch (3),
-.BR votequorum_context_get (3),
.BR votequorum_context_set (3),
+.BR votequorum_context_get (3),
+.BR votequorum_setexpected (3),
+.BR votequorum_setvotes (3)
.PP
diff --git a/man/votequorum_context_set.3.in b/man/votequorum_context_set.3.in
index 4be9145d..df3af2b3 100644
--- a/man/votequorum_context_set.3.in
+++ b/man/votequorum_context_set.3.in
@@ -1,60 +1,66 @@
.\"/*
.\" * Copyright (c) 2007,2012 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 VOTEQUORUM_CONTEXT_SET 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
.SH NAME
votequorum_context_set \- Sets the context variable for a VOTEQUORUM instance
.SH SYNOPSIS
.B #include <corosync/votequorum.h>
.sp
-.BI "int votequorum_context_set(votequorum_handle_t " handle ", void *" context ");
+.BI "int votequorum_context_set(votequorum_handle_t " handle ", void *" context ");"
.SH DESCRIPTION
The
.B votequorum_context_set
function is used to set the context variable for a votequorum instance. It has no
meaning insire libvotequorum itself and will not be touched by the library. It can
be retrieved using
.B votequorum_context_get(3)
.SH RETURN VALUE
This call returns the CS_OK value if successful, otherwise an error is returned.
.PP
.SH ERRORS
@COMMONIPCERRORS@
.SH "SEE ALSO"
+.BR votequorum_overview (8),
.BR votequorum_initialize (3),
.BR votequorum_finalize (3),
+.BR votequorum_getinfo (3),
+.BR votequorum_trackstart (3),
+.BR votequorum_trackstop (3),
.BR votequorum_fd_get (3),
.BR votequorum_dispatch (3),
-.BR votequorum_context_get (3),
.BR votequorum_context_set (3),
+.BR votequorum_context_get (3),
+.BR votequorum_setexpected (3),
+.BR votequorum_setvotes (3)
.PP
diff --git a/man/votequorum_dispatch.3.in b/man/votequorum_dispatch.3.in
index c443796b..38677b4f 100644
--- a/man/votequorum_dispatch.3.in
+++ b/man/votequorum_dispatch.3.in
@@ -1,100 +1,99 @@
.\"/*
.\" * Copyright (c) 2009,2012 Red Hat, Inc.
.\" *
.\" * All rights reserved.
.\" *
.\" * Author: Christine Caulfield <ccaulfie@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 VOTEQUORUM_DISPATCH 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
.SH NAME
votequorum_dispatch \- Dispatches callbacks from the votequorum service
.SH SYNOPSIS
.B #include <corosync/votequorum.h>
.sp
-.BI "int votequorum_dispatch(votequorum_handle_t " handle ", votequorum_dispatch_t *" dispatch_types ");"
+.BI "int votequorum_dispatch(votequorum_handle_t " handle ", cs_dispatch_flags_t *" dispatch_types ");"
.SH DESCRIPTION
The
.B votequorum_dispatch
function is used to dispatch configuration changes.
.PP
Each application may have several connections to the votequorum 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
-} votequorum_dispatch_t;
-.ta
+ CS_DISPATCH_ONE = 1,
+ CS_DISPATCH_ALL = 2,
+ CS_DISPATCH_BLOCKING = 3,
+ CS_DISPATCH_ONE_NONBLOCKING = 4
+} cs_dispatch_flags_t;
.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 votequorum_dispatch() is called immediately
+program where a thread is created, and then quorum_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
@COMMONIPCERRORS@
.SH "SEE ALSO"
.BR votequorum_overview (8),
.BR votequorum_initialize (3),
.BR votequorum_finalize (3),
+.BR votequorum_getinfo (3),
+.BR votequorum_trackstart (3),
+.BR votequorum_trackstop (3),
.BR votequorum_fd_get (3),
-
+.BR votequorum_context_set (3),
+.BR votequorum_context_get (3),
+.BR votequorum_setexpected (3),
+.BR votequorum_setvotes (3)
.PP
diff --git a/man/votequorum_fd_get.3.in b/man/votequorum_fd_get.3.in
index 4bbb0929..b375e9f4 100644
--- a/man/votequorum_fd_get.3.in
+++ b/man/votequorum_fd_get.3.in
@@ -1,64 +1,70 @@
.\"/*
.\" * Copyright (c) 2009,2012 Red Hat, Inc.
.\" *
.\" * All rights reserved.
.\" *
.\" * Author: Christine Caulfield <ccaulfie@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 VOTEQUORUM_FD_GET 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
.SH NAME
votequorum_fd_get \- Dispatches callbacks from the votequorum service
.SH SYNOPSIS
.B #include <corosync/votequorum.h>
.sp
.BI "int votequorum_fd_get(votequorum_handle_t " handle ", int *" fd ");"
.SH DESCRIPTION
The
.B votequorum_fd_get
function is used to retrieve the file descriptor that may be used with the poll
system call to determine when
.B votequorum_dispatch(3)
won't block. The
.I handle
argument may not be used directly with
.B poll
because it is not the file descriptor, but instead an internal identifier used
by the votequorum library.
.SH RETURN VALUE
This call returns the CS_OK value if successful, otherwise an error is returned.
.PP
.SH ERRORS
@COMMONIPCERRORS@
.SH "SEE ALSO"
.BR votequorum_overview (8),
.BR votequorum_initialize (3),
.BR votequorum_finalize (3),
+.BR votequorum_getinfo (3),
+.BR votequorum_trackstart (3),
+.BR votequorum_trackstop (3),
.BR votequorum_dispatch (3),
-.BR votequorum_fd_get (3),
+.BR votequorum_context_set (3),
+.BR votequorum_context_get (3),
+.BR votequorum_setexpected (3),
+.BR votequorum_setvotes (3)
.PP
diff --git a/man/votequorum_finalize.3.in b/man/votequorum_finalize.3.in
index 424f233e..0164f594 100644
--- a/man/votequorum_finalize.3.in
+++ b/man/votequorum_finalize.3.in
@@ -1,61 +1,67 @@
.\"/*
.\" * Copyright (c) 2009,2012 Red Hat, Inc.
.\" *
.\" * All rights reserved.
.\" *
.\" * Author: Christine Caulfield <ccaulfie@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 VOTEQUORUM_FINALIZE 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
.SH NAME
votequorum_finalize \- Terminate a connection to the votequorum service
.SH SYNOPSIS
.B #include <corosync/votequorum.h>
.sp
.BI "int votequorum_finalize(votequorum_handle_t " handle ");"
.SH DESCRIPTION
The
.B votequorum_finalize
function is used to close a connection to the configuration dabatase API.
Once the connection is finalized, the handle may not be used again by applications.
No more callbacks will be dispatched from the
-.B votequorum_dispatch function.
+.B votequorum_dispatch
+function.
.PP
.SH RETURN VALUE
This call returns the CS_OK value if successful, otherwise an error is returned.
.PP
.SH ERRORS
@COMMONIPCERRORS@
.SH "SEE ALSO"
.BR votequorum_overview (8),
.BR votequorum_initialize (3),
-.BR votequorum_finalize (3),
-.BR votequorum_dispatch (3),
+.BR votequorum_getinfo (3),
+.BR votequorum_trackstart (3),
+.BR votequorum_trackstop (3),
.BR votequorum_fd_get (3),
-
+.BR votequorum_dispatch (3),
+.BR votequorum_context_set (3),
+.BR votequorum_context_get (3),
+.BR votequorum_setexpected (3),
+.BR votequorum_setvotes (3)
.PP
diff --git a/man/votequorum_getinfo.3.in b/man/votequorum_getinfo.3.in
index 61a6003a..d50af490 100644
--- a/man/votequorum_getinfo.3.in
+++ b/man/votequorum_getinfo.3.in
@@ -1,90 +1,87 @@
.\"/*
.\" * Copyright (c) 2009,2012 Red Hat, Inc.
.\" *
.\" * All rights reserved.
.\" *
.\" * Author: Christine Caulfield <ccaulfie@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 VOTEQUORUM_GETINFO 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
.SH NAME
votequorum_getinfo \- Get information about the VoteQuorum service
.SH SYNOPSIS
.B #include <corosync/votequorum.h>
.sp
-.BI "int votequorum_getinfo(votequorum_handle_t *" handle ", unsigned int " nodeid ", struct votequorum_info *" info ");
+.BI "int votequorum_getinfo(votequorum_handle_t *" handle ", unsigned int " nodeid ", struct votequorum_info *" info ");"
.SH DESCRIPTION
The
.B votequorum_getinfo
-function is used to get information about the voteing system and its nodes.
+function is used to get information about the voting system and its nodes.
The votequorum_info structure is defined as follows:
-.PP
-.PP
-.IP
-.RS
-.ne 18
+
.nf
-.ta 4n 20n 32n
struct votequorum_info {
- unsigned int node_id;
- unsigned int node_votes;
- unsigned int node_expected_votes;
- unsigned int highest_expected;
- unsigned int total_votes;
- unsigned int quorum;
- unsigned int flags;
+ unsigned int node_id;
+ unsigned int node_votes;
+ unsigned int node_expected_votes;
+ unsigned int highest_expected;
+ unsigned int total_votes;
+ unsigned int quorum;
+ unsigned int flags;
};
#define VOTEQUORUM_INFO_FLAG_TWONODE 1
#define VOTEQUORUM_INFO_FLAG_QUORATE 2
#define VOTEQUORUM_INFO_WAIT_FOR_ALL 4
#define VOTEQUORUM_INFO_LAST_MAN_STANDING 8
#define VOTEQUORUM_INFO_AUTO_TIE_BREAKER 16
#define VOTEQUORUM_INFO_LEAVE_REMOVE 32
-
-.ta
.fi
-.RE
-.IP
-.PP
.PP
The members starting node_ hold information specific to the requested nodeid, the other are
general to the voting system.
.SH RETURN VALUE
This call returns the CS_OK value if successful, otherwise an error is returned.
.PP
.SH ERRORS
@COMMONIPCERRORS@
.SH "SEE ALSO"
.BR votequorum_overview (8),
+.BR votequorum_initialize (3),
.BR votequorum_finalize (3),
+.BR votequorum_trackstart (3),
+.BR votequorum_trackstop (3),
.BR votequorum_fd_get (3),
.BR votequorum_dispatch (3),
+.BR votequorum_context_set (3),
+.BR votequorum_context_get (3),
+.BR votequorum_setexpected (3),
+.BR votequorum_setvotes (3)
.PP
diff --git a/man/votequorum_initialize.3.in b/man/votequorum_initialize.3.in
index 2a92756e..64b78ded 100644
--- a/man/votequorum_initialize.3.in
+++ b/man/votequorum_initialize.3.in
@@ -1,102 +1,110 @@
.\"/*
.\" * Copyright (c) 2009,2012 Red Hat, Inc.
.\" *
.\" * All rights reserved.
.\" *
.\" * Author: Christine Caulfield <ccaulfie@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 VOTEQUORUM_INITIALIZE 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
.SH NAME
votequorum_initialize \- Create a new connection to the VoteQuorum service
.SH SYNOPSIS
.B #include <corosync/votequorum.h>
.sp
-.BI "int votequorum_initialize(votequorum_handle_t *" handle ", votequorum_callbacks_t *" callbacks ");
+.BI "int votequorum_initialize(votequorum_handle_t *" handle ", votequorum_callbacks_t *" callbacks ");"
.SH DESCRIPTION
The
.B votequorum_initialize
function is used to initialize a connection to the vote-based quorum database API.
.PP
Each application may have several connections to the votequorum 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 votequorum service.
.PP
Every time the voting configuraton changes (eg a node joins or leave the cluster), the callback is called.
The callback function is described by the following type definitions:
+.nf
typedef void (*votequorum_notification_fn_t) (
votequorum_handle_t handle,
uint64_t context,
uint32_t quorate,
uint32_t node_list_entries,
votequorum_node_t node_list[]
);
-.ta
.fi
-.RE
-.IP
.PP
+Every time the expected votes are changed, the callback is called.
+The expected votes callback function is described by the following type definitions:
+
+.nf
+typedef void (*votequorum_expectedvotes_notification_fn_t) (
+ votequorum_handle_t handle,
+ uint64_t context,
+ uint32_t expected_votes);
+.fi
.PP
The
.I callbacks
argument is of the type:
-.IP
-.RS
-.ne 18
+
.nf
-.PP
typedef struct {
votequorum_notification_fn_t votequorum_notify_fn;
+ votequorum_expectedvotes_notification_fn_t votequorum_expectedvotes_notify_fn;
} votequorum_callbacks_t;
-
-.ta
.fi
-.RE
-.IP
.PP
When a configuration change occurs, the callback
is called from the
.B votequorum_dispatch()
function.
.PP
.SH RETURN VALUE
This call returns the CS_OK value if successful, otherwise an error is returned.
.SH ERRORS
@COMMONIPCERRORS@
.SH "SEE ALSO"
.BR votequorum_overview (8),
.BR votequorum_finalize (3),
+.BR votequorum_getinfo (3),
+.BR votequorum_trackstart (3),
+.BR votequorum_trackstop (3),
.BR votequorum_fd_get (3),
.BR votequorum_dispatch (3),
+.BR votequorum_context_set (3),
+.BR votequorum_context_get (3),
+.BR votequorum_setexpected (3),
+.BR votequorum_setvotes (3)
.PP
diff --git a/man/votequorum_overview.8 b/man/votequorum_overview.8
index 0149ffbe..bad4ecb7 100644
--- a/man/votequorum_overview.8
+++ b/man/votequorum_overview.8
@@ -1,77 +1,75 @@
.\"/*
.\" * Copyright (c) 2008, 2012 Red Hat, Inc.
.\" *
.\" * All rights reserved.
.\" *
.\" * Authors: Christine Caulfield <ccaulfie@redhat.com>
.\" * Fabio M. Di Nitto <fdinitto@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 VOTEQUORUM_OVERVIEW 8 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
.SH NAME
votequorum_overview \- Votequorum Library Overview
.SH OVERVIEW
The votequorum library is delivered with the corosync project. It is the external interface to
the vote-based quorum service. This service is optionally loaded into all nodes in a corosync cluster
to avoid split-brain situations. It does this by having a number of votes assigned to each system
in the cluster and ensuring that only when a majority of the votes are present, cluster operations are
allowed to proceed.
.PP
The library provides a mechanism to:
.PP
* Query the quorum status
.PP
* Get a list of nodes known to the quorum service
.PP
* Receive notifications of quorum state changes
.PP
* Change the number of votes assigned to a node
.PP
* Change the number of expected votes for a cluster to be quorate
.PP
* Connect an additional quorum device to allow small clusters to remain quorate during node outages.
.PP
.SH BUGS
No known bugs at the time of writing. The authors are from outerspace. Deal with it.
.SH "SEE ALSO"
.BR corosync-quorumtool (8),
.BR votequorum (5),
-.BR votequorum_context_get (3),
-.BR votequorum_context_set (3),
-.BR votequorum_dispatch (3),
-.BR votequorum_fd_get (3),
+.BR votequorum_initialize (3),
.BR votequorum_finalize (3),
.BR votequorum_getinfo (3),
-.BR votequorum_initialize (3),
-.BR votequorum_qdevice_getinfo (3),
-.BR votequorum_qdevice_poll (3),
-.BR votequorum_qdevice_register (3),
-.BR votequorum_qdevice_unregister (3),
+.BR votequorum_trackstart (3),
+.BR votequorum_trackstop (3),
+.BR votequorum_fd_get (3),
+.BR votequorum_dispatch (3),
+.BR votequorum_context_set (3),
+.BR votequorum_context_get (3),
.BR votequorum_setexpected (3),
.BR votequorum_setvotes (3)
.PP
diff --git a/man/votequorum_qdevice_getinfo.3.in b/man/votequorum_qdevice_getinfo.3.in
index 04904121..ec7c1f2b 100644
--- a/man/votequorum_qdevice_getinfo.3.in
+++ b/man/votequorum_qdevice_getinfo.3.in
@@ -1,80 +1,74 @@
.\"/*
.\" * Copyright (c) 2009,2012 Red Hat, Inc.
.\" *
.\" * All rights reserved.
.\" *
.\" * Author: Christine Caulfield <ccaulfie@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 VOTEQUORUM_QDEVICE_GETINFO 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
.SH NAME
votequorum_qdevice_getinfo \- Get details of the quorum device
.SH SYNOPSIS
.B #include <corosync/votequorum.h>
.sp
.BI "int votequorum_qdevice_getinfo(votequorum_handle_t " handle ", struct votequorum_qdevice_info " *info ");"
.SH DESCRIPTION
The
.B votequorum_qdevice_getinfo
Returns information about the quorum device in the following structure:
-.PP
-.PP
-.IP
-.RS
-.ne 18
-.nf
-.ta 4n 20n 32n
+.nf
struct votequorum_qdevice_info {
- unsigned int votes;
- unsigned int state;
- char name[VOTEQUORUM_MAX_QDEVICE_NAME_LEN];
+ unsigned int votes;
+ unsigned int state;
+ char name[VOTEQUORUM_MAX_QDEVICE_NAME_LEN];
};
-
-.ta
.fi
-.RE
-.IP
-.PP
-.PP
-
.SH RETURN VALUE
This call returns the CS_OK value if successful, otherwise an error is returned.
.PP
.SH ERRORS
@COMMONIPCERRORS@
.SH "SEE ALSO"
.BR votequorum_overview (8),
.BR votequorum_initialize (3),
.BR votequorum_finalize (3),
-.BR votequorum_dispatch (3),
+.BR votequorum_getinfo (3),
+.BR votequorum_trackstart (3),
+.BR votequorum_trackstop (3),
.BR votequorum_fd_get (3),
-.BR votequorum_qdevice_poll (3),
+.BR votequorum_dispatch (3),
+.BR votequorum_context_set (3),
+.BR votequorum_context_get (3),
+.BR votequorum_setexpected (3),
+.BR votequorum_setvotes (3),
+.BR votequorum_qdevice_register (3),
.BR votequorum_qdevice_unregister (3),
-.BR votequorum_qdevice_getinfo (3),
+.BR votequorum_qdevice_poll (3)
.PP
diff --git a/man/votequorum_qdevice_poll.3.in b/man/votequorum_qdevice_poll.3.in
index b560b536..f626a59a 100644
--- a/man/votequorum_qdevice_poll.3.in
+++ b/man/votequorum_qdevice_poll.3.in
@@ -1,69 +1,76 @@
.\"/*
.\" * Copyright (c) 2009,2012 Red Hat, Inc.
.\" *
.\" * All rights reserved.
.\" *
.\" * Author: Christine Caulfield <ccaulfie@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 VOTEQUORUM_QDEVICE_POLL 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
.SH NAME
votequorum_qdevice_poll \- Tells votequorum the result of the quorum device poll
.SH SYNOPSIS
.B #include <corosync/votequorum.h>
.sp
.BI "int votequorum_qdevice_poll(votequorum_handle_t " handle ", unsigned int " state ");"
.SH DESCRIPTION
The
.B votequorum_qdevice_poll
is called by the quorum device subsystem (not provided as part of votequorum) to tell
-the voting system if the qurum device is present/active or not. If
+the voting system if the quorum device is present/active or not. If
.B state
is 1 then the votes for the device are included in the quorum calculation, otherwise not.
This routine should be called at regular intervals to ensure that the device status
is always known to votequorum. If
.B votequorum_qdevice_poll
is not called after (default) 10 seconds then the device will be deeded to be dead and
its votes removed from the cluster. This does not unregister the device.
The default poll time can be changed by setting the object database variable
quorum.quorumdev_poll.
.SH RETURN VALUE
This call returns the CS_OK value if successful, otherwise an error is returned.
.PP
.SH ERRORS
@COMMONIPCERRORS@
.SH "SEE ALSO"
.BR votequorum_overview (8),
.BR votequorum_initialize (3),
.BR votequorum_finalize (3),
-.BR votequorum_dispatch (3),
+.BR votequorum_getinfo (3),
+.BR votequorum_trackstart (3),
+.BR votequorum_trackstop (3),
.BR votequorum_fd_get (3),
+.BR votequorum_dispatch (3),
+.BR votequorum_context_set (3),
+.BR votequorum_context_get (3),
+.BR votequorum_setexpected (3),
+.BR votequorum_setvotes (3),
.BR votequorum_qdevice_register (3),
.BR votequorum_qdevice_unregister (3),
-.BR votequorum_qdevice_getinfo (3),
+.BR votequorum_qdevice_get_info (3)
.PP
diff --git a/man/votequorum_qdevice_register.3.in b/man/votequorum_qdevice_register.3.in
index 9bc1c054..8628d83a 100644
--- a/man/votequorum_qdevice_register.3.in
+++ b/man/votequorum_qdevice_register.3.in
@@ -1,68 +1,75 @@
.\"/*
.\" * Copyright (c) 2009,2012 Red Hat, Inc.
.\" *
.\" * All rights reserved.
.\" *
.\" * Author: Christine Caulfield <ccaulfie@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 VOTEQUORUM_QDEVICE_REGISTER 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
.SH NAME
votequorum_qdevice_register \- Registers a new quorum device
.SH SYNOPSIS
.B #include <corosync/votequorum.h>
.sp
.BI "int votequorum_qdevice_register(votequorum_handle_t " handle ", char * " name ", unsigned int " votes ");"
.SH DESCRIPTION
The
.B votequorum_qdevice_register
is used to register a new quorum device. A quorum device is an external way of adding votes to a small
cluster. The quorum device is, in effect, a pseudo node in the cluster that provide votes based on some
external device, usually a shared disk partition or perhaps a network router.
.br
This call creates the device but does not mark it active.
.B votequorum_qdevice_poll
must be called for the votes to be included in the quorum calculation.
-.br
+.BR
Note that it is the responsibility of the quorum device subsystem (not provided as part of votequorum)
to keep all nodes informed of the quorum device status.
.SH RETURN VALUE
This call returns the CS_OK value if successful, otherwise an error is returned.
.PP
.SH ERRORS
@COMMONIPCERRORS@
.SH "SEE ALSO"
.BR votequorum_overview (8),
.BR votequorum_initialize (3),
.BR votequorum_finalize (3),
-.BR votequorum_dispatch (3),
+.BR votequorum_getinfo (3),
+.BR votequorum_trackstart (3),
+.BR votequorum_trackstop (3),
.BR votequorum_fd_get (3),
-.BR votequorum_qdevice_poll (3),
+.BR votequorum_dispatch (3),
+.BR votequorum_context_set (3),
+.BR votequorum_context_get (3),
+.BR votequorum_setexpected (3),
+.BR votequorum_setvotes (3),
.BR votequorum_qdevice_unregister (3),
-.BR votequorum_qdevice_getinfo (3),
+.BR votequorum_qdevice_poll (3),
+.BR votequorum_qdevice_get_info (3)
.PP
diff --git a/man/votequorum_qdevice_unregister.3.in b/man/votequorum_qdevice_unregister.3.in
index 553cca96..8ea15148 100644
--- a/man/votequorum_qdevice_unregister.3.in
+++ b/man/votequorum_qdevice_unregister.3.in
@@ -1,60 +1,67 @@
.\"/*
.\" * Copyright (c) 2009,2012 Red Hat, Inc.
.\" *
.\" * All rights reserved.
.\" *
.\" * Author: Christine Caulfield <ccaulfie@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 VOTEQUORUM_QDEVICE_UNREGISTER 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
.SH NAME
votequorum_qdevice_unregister \- Unregisters a new quorum device
.SH SYNOPSIS
.B #include <corosync/votequorum.h>
.sp
.BI "int votequorum_qdevice_unregister(votequorum_handle_t " handle ");"
.SH DESCRIPTION
The
.B votequorum_qdevice_unregister
-unregisters a quorum device. Any votes it had will be removed from the cluster. Not that this could
+unregisters a quorum device. Any votes it had will be removed from the cluster. NOTE that this could
make the cluster inquorate.
.SH RETURN VALUE
This call returns the CS_OK value if successful, otherwise an error is returned.
.PP
.SH ERRORS
@COMMONIPCERRORS@
.SH "SEE ALSO"
.BR votequorum_overview (8),
.BR votequorum_initialize (3),
.BR votequorum_finalize (3),
-.BR votequorum_dispatch (3),
+.BR votequorum_getinfo (3),
+.BR votequorum_trackstart (3),
+.BR votequorum_trackstop (3),
.BR votequorum_fd_get (3),
-.BR votequorum_qdevice_poll (3),
+.BR votequorum_dispatch (3),
+.BR votequorum_context_set (3),
+.BR votequorum_context_get (3),
+.BR votequorum_setexpected (3),
+.BR votequorum_setvotes (3),
.BR votequorum_qdevice_register (3),
-.BR votequorum_qdevice_getinfo (3),
+.BR votequorum_qdevice_poll (3),
+.BR votequorum_qdevice_get_info (3)
.PP
diff --git a/man/votequorum_setexpected.3.in b/man/votequorum_setexpected.3.in
index 8aca3b93..0784a6eb 100644
--- a/man/votequorum_setexpected.3.in
+++ b/man/votequorum_setexpected.3.in
@@ -1,60 +1,66 @@
.\"/*
.\" * Copyright (c) 2009,2012 Red Hat, Inc.
.\" *
.\" * All rights reserved.
.\" *
.\" * Author: Christine Caulfield <ccaulfie@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 VOTEQUORUM_SETEXPECTED 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
.SH NAME
votequorum_setexpected \- Sets the expected votes for the cluster
.SH SYNOPSIS
.B #include <corosync/votequorum.h>
.sp
.BI "int votequorum_setexpected(votequorum_handle_t " handle ", int " expected_votes ");"
.SH DESCRIPTION
The
.B votequorum_setexpected
function is used to change the expected votes in the cluster. Expected votes is used to calculate
quorum and should normally be the total number of votes that will exist when all the expected nodes
are joined. Quorum will usually be half of this (rounded up).
-.br
+.BR
It is not possible to set expected votes up so that it makes the cluster inquorate using this command.
.SH RETURN VALUE
This call returns the CS_OK value if successful, otherwise an error is returned.
.PP
.SH ERRORS
@COMMONIPCERRORS@
.SH "SEE ALSO"
.BR votequorum_overview (8),
.BR votequorum_initialize (3),
.BR votequorum_finalize (3),
-.BR votequorum_dispatch (3),
+.BR votequorum_getinfo (3),
+.BR votequorum_trackstart (3),
+.BR votequorum_trackstop (3),
.BR votequorum_fd_get (3),
+.BR votequorum_dispatch (3),
+.BR votequorum_context_set (3),
+.BR votequorum_context_get (3),
+.BR votequorum_setvotes (3)
.PP
diff --git a/man/votequorum_setvotes.3.in b/man/votequorum_setvotes.3.in
index 48ecf07d..2f687166 100644
--- a/man/votequorum_setvotes.3.in
+++ b/man/votequorum_setvotes.3.in
@@ -1,57 +1,63 @@
.\"/*
.\" * Copyright (c) 2009,2012 Red Hat, Inc.
.\" *
.\" * All rights reserved.
.\" *
.\" * Author: Christine Caulfield <ccaulfie@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 VOTEQUORUM_VOTES 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
.SH NAME
votequorum_setvotes \- Sets the number of votes for a node
.SH SYNOPSIS
.B #include <corosync/votequorum.h>
.sp
.BI "int votequorum_setexpected(votequorum_handle_t " handle ", unsigned int " nodeid ", int " votes ");"
.SH DESCRIPTION
The
.B votequorum_setvotes
is used to change the number of votes that a node has. Note that it is not possible, using this function,
to change the number of node votes such that the cluster goes inquorate.
.SH RETURN VALUE
This call returns the CS_OK value if successful, otherwise an error is returned.
.PP
.SH ERRORS
@COMMONIPCERRORS@
.SH "SEE ALSO"
.BR votequorum_overview (8),
.BR votequorum_initialize (3),
.BR votequorum_finalize (3),
-.BR votequorum_dispatch (3),
+.BR votequorum_getinfo (3),
+.BR votequorum_trackstart (3),
+.BR votequorum_trackstop (3),
.BR votequorum_fd_get (3),
+.BR votequorum_dispatch (3),
+.BR votequorum_context_set (3),
+.BR votequorum_context_get (3),
+.BR votequorum_setexpected (3)
.PP
diff --git a/man/votequorum_trackstart.3.in b/man/votequorum_trackstart.3.in
index 460df53e..34f38163 100644
--- a/man/votequorum_trackstart.3.in
+++ b/man/votequorum_trackstart.3.in
@@ -1,64 +1,83 @@
.\"/*
.\" * Copyright (c) 2012 Red Hat, Inc.
.\" *
.\" * All rights reserved.
.\" *
.\" * Author: Fabio M. Di Nitto <fdinitto@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 VOTEQUORUM_TRACKSTART 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
.SH NAME
votequorum_trackstart \- Enable callbacks notification.
.SH SYNOPSIS
.B #include <corosync/votequorum.h>
.sp
-.BI "int votequorum_trackstart(votequorum_handle_t *" handle ", uint64_t " context ", unsigned int " flags ");
+.BI "int votequorum_trackstart(votequorum_handle_t *" handle ", uint64_t " context ", unsigned int " flags ");"
.SH DESCRIPTION
The
.B votequorum_trackstart
function is used to enable callbacks notification from the votequorum API.
.PP
Every time the voting configuraton changes (eg a node joins or leave the cluster)
or the quorum status change or the expected votes changes, the notification is queued.
.PP
The notification is dispatched via
.B votequorum_dispatch()
function that will execute the callback.
.PP
+The
+.I context
+option allows to set a tracking context.
+.PP
+The
+.I flags
+argument is defined by one or more of the following values and values can be bitwise-or'd
+
+.nf
+#define CS_TRACK_CURRENT 0x01
+#define CS_TRACK_CHANGES 0x02
+#define CS_TRACK_CHANGES_ONLY 0x04
+.fi
.SH RETURN VALUE
This call returns the CS_OK value if successful, otherwise an error is returned.
.PP
.SH ERRORS
@COMMONIPCERRORS@
.SH "SEE ALSO"
+.BR votequorum_overview (8),
.BR votequorum_initialize (3),
.BR votequorum_finalize (3),
+.BR votequorum_getinfo (3),
+.BR votequorum_trackstop (3),
.BR votequorum_fd_get (3),
.BR votequorum_dispatch (3),
-.BR votequorum_trackstop (3),
+.BR votequorum_context_set (3),
+.BR votequorum_context_get (3),
+.BR votequorum_setexpected (3),
+.BR votequorum_setvotes (3)
.PP
diff --git a/man/votequorum_trackstop.3.in b/man/votequorum_trackstop.3.in
index aeebb17a..7f014dfb 100644
--- a/man/votequorum_trackstop.3.in
+++ b/man/votequorum_trackstop.3.in
@@ -1,57 +1,63 @@
.\"/*
.\" * Copyright (c) 2012 Red Hat, Inc.
.\" *
.\" * All rights reserved.
.\" *
.\" * Author: Fabio M. Di Nitto <fdinitto@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 VOTEQUORUM_TRACKSTOP 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
.SH NAME
votequorum_trackstop \- Disable callbacks notification.
.SH SYNOPSIS
.B #include <corosync/votequorum.h>
.sp
-.BI "int votequorum_trackstart(votequorum_handle_t *" handle ");
+.BI "int votequorum_trackstart(votequorum_handle_t *" handle ");"
.SH DESCRIPTION
The
.B votequorum_trackstop
function is used to disable callbacks notification from the votequorum API.
.PP
.SH RETURN VALUE
This call returns the CS_OK value if successful, otherwise an error is returned.
.PP
.SH ERRORS
@COMMONIPCERRORS@
.SH "SEE ALSO"
+.BR votequorum_overview (8),
.BR votequorum_initialize (3),
.BR votequorum_finalize (3),
+.BR votequorum_getinfo (3),
+.BR votequorum_trackstart (3),
.BR votequorum_fd_get (3),
.BR votequorum_dispatch (3),
-.BR votequorum_trackstart (3),
+.BR votequorum_context_set (3),
+.BR votequorum_context_get (3),
+.BR votequorum_setexpected (3),
+.BR votequorum_setvotes (3)
.PP
File Metadata
Details
Attached
Mime Type
text/x-diff
Expires
Wed, Feb 26, 3:00 PM (13 h, 54 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
1465467
Default Alt Text
(73 KB)
Attached To
Mode
rC Corosync
Attached
Detach File
Event Timeline
Log In to Comment