Expose confdb write to the library.
[openais.git] / man / evs_membership_get.3
blobb6b4bb8f48b3af656055282f56388e0b1288744b
1 .\"/*
2 .\" * Copyright (c) 2004 MontaVista Software, Inc.
3 .\" *
4 .\" * All rights reserved.
5 .\" *
6 .\" * Author: Steven Dake (sdake@mvista.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 EVS_JOIN 3 2004-08-31 "openais Man Page" "Openais Programmer's Manual"
35 .SH NAME
36 evs_join \- Joins one or more groups in the EVS library
37 .SH SYNOPSIS
38 .B #include <openais/evs.h>
39 .sp
40 .BI "int evs_membership_get(evs_handle_t " handle ", struct evs_address *" local_addr ", struct evs_address *" member_list ", int *" member_list_entries ");
41 .SH DESCRIPTION
42 The
43 .B evs_membership_get
44 function is used to determine the current processors in the configuration and also
45 the local processor identifier.
46 The argument
47 .I handle
48 is used to reference the evs instantiation.
49 The argument 
50 .I local_addr
51 will return the local address of the processor.
52 The argument
53 .I member_list
54 will return the list of processors in the current membership.
55 The argument
56 .I member_list_entries
57 should be set with the size of member_list and will return the size of the
58 member_list after return from the function.
59 .PP
60 .SH ERRORS
61 The errors are undocumented.
62 .SH "SEE ALSO"
63 .BR evs_overview (8),
64 .BR evs_initialize (3),
65 .BR evs_finalize (3),
66 .BR evs_fd_get (3),
67 .BR evs_dispatch (3),
68 .BR evs_leave (3),
69 .BR evs_mcast_joined (3),
70 .BR evs_mcast_groups (3),
71 .BR evs_mmembership_get (3)
72 .PP