man/cpg_membership_get.3

   1 .\"/*
   2 .\" * Copyright (c) 2006 Red Hat, Inc.
   3 .\" *
   4 .\" * All rights reserved.
   5 .\" *
   6 .\" * Author: Patrick Caulfield <pcaulfie@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 CPG_MEMBERSHIP_GET 3 2006-02-06 "openais Man Page" "Openais Programmer's Manual"
  35 .SH NAME
  36 cpg_membership_get \- Returns a list of members of a CPG library group
  37 .SH SYNOPSIS
  38 .B #include <openais/cpg.h>
  39 .sp
  40 .BI "int cpg_membership_get(cpg_handle_t " handle ", struct cpg_name *" groupName ", struct cpg_address *" member_list ", int *" member_list_entries ");
  41 .SH DESCRIPTION
  42 The
  43 .B cpg_membership_get
  44 function is used to determine the current processes in the configuration. You probably will not
  45 need to call this function much as one of the first confchg callbacks you will get will be from
  46 the cpg_join() function containing your process.
  47 .BR
  48 The argument
  49 .I handle
  50 is used to reference the cpg instantiation.
  51 The argument
  52 .I groupName
  53 will return the name of the group
  54 The argument
  55 .I member_list
  56 will return the list of processors in the current membership.
  57 The argument
  58 .I member_list_entries
  59 should be set with the size of member_list and will return the size of the
  60 member_list after return from the function.
  61 .PP
  62 .SH ERRORS
  63 The errors are undocumented.
  64 .SH "SEE ALSO"
  65 .BR cpg_overview (8),
  66 .BR cpg_initialize (3),
  67 .BR cpg_finalize (3),
  68 .BR cpg_fd_get (3),
  69 .BR cpg_dispatch (3),
  70 .BR cpg_leave (3),
  71 .BR cpg_mcast_joined (3),
  72 .BR cpg_membership_get (3)
  73 .PP