~ubuntu-branches/ubuntu/precise/corosync/precise-proposed

« back to all changes in this revision

Viewing changes to man/votequorum_fd_get.3

  • Committer: Bazaar Package Importer
  • Author(s): Ante Karamatic
  • Date: 2009-08-21 09:29:56 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20090821092956-w9qxxxx3zeoh8dem
Tags: 1.0.0-4ubuntu2
* debian/control:
  - 'Ubuntu Developers' instead of 'Ubuntu Core Developers'
    as maintainer
  - Bump debhelper dependecy to 7

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\"/*
 
2
.\" * Copyright (c) 2009 Red Hat, Inc.
 
3
.\" *
 
4
.\" * All rights reserved.
 
5
.\" *
 
6
.\" * Author: Christine Caulfield <ccaulfie@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 VOTEQUORUM_FD_GET 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 
35
.SH NAME
 
36
votequorum_fd_get \- Dispatches callbacks from the votequorum service
 
37
.SH SYNOPSIS
 
38
.B #include <corosync/votequorum.h>
 
39
.sp
 
40
.BI "int votequorum_fd_get(votequorum_handle_t " handle ", int *" fd ");"
 
41
.SH DESCRIPTION
 
42
The
 
43
.B votequorum_fd_get
 
44
function is used to retrieve the file descriptor that may be used with the poll
 
45
system call to determine when
 
46
.B votequorum_dispatch(3)
 
47
won't block.  The
 
48
.I handle
 
49
argument may not be used directly with
 
50
.B poll
 
51
because it is not the file descriptor, but instead an internal identifier used
 
52
by the votequorum library.
 
53
.SH RETURN VALUE
 
54
This call returns the CS_OK value if successful, otherwise an error is returned.
 
55
.PP
 
56
.SH ERRORS
 
57
The errors are undocumented.
 
58
.SH "SEE ALSO"
 
59
.BR votequorum_overview (8),
 
60
.BR votequorum_initialize (3),
 
61
.BR votequorum_finalize (3),
 
62
.BR votequorum_dispatch (3),
 
63
.BR votequorum_fd_get (3),
 
64
.PP