man/cpg_mcast_joined.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_MCAST_JOINED 3 3004-08-31 "openais Man Page" "Openais Programmer's Manual"
  35 .SH NAME
  36 cpg_mcast_joined \- Multicasts to all groups joined to a handle
  37 .SH SYNOPSIS
  38 .B #include <sys/uio.h>
  39 .B #include <openais/cpg.h>
  40 .sp
  41 .BI "int cpg_mcast_joined(cpg_handle_t " handle ", cpg_gurantee_t " guarantee ", struct iovec *" iovec ", int " iov_len ");
  42 .SH DESCRIPTION
  43 The
  44 .B cpg_mcast_joined
  45 function will multicast a message to all the processes that have been joined with the
  46 .B cpg_join(3)
  47 funtion for the same group name.
  48 Messages that are sent to any of the groups joined to the parameter
  49 .I handle
  50 will be delivered to all subscribed processes in the system.
  51 .PP
  52 The argument
  53 .I guarantee
  54 requests a delivery guarantee for the message to be sent.  The cpg_guarantee_t type is
  55 defined by:
  56 .IP
  57 .RS
  58 .ne 18
  59 .nf
  60 .ta 4n 30n 33n
  61 typedef enum {
  62         CPG_TYPE_UNORDERED,     /* not implemented */
  63         CPG_TYPE_FIFO,          /* same as agreed */
  64         CPG_TYPE_AGREED,        /* implemented */
  65         CPG_TYPE_SAFE           /* not implemented */
  66 } cpg_guarantee_t;
  67 .ta
  68 .fi
  69 .RE
  70 .IP
  71 .PP
  72 .PP
  73 The meanings of the cpg_gaurantee_t typedef are:
  74 .TP
  75 .B CPG_TYPE_UNORDERED
  76 Messages are guaranteed to be delivered, but with no particular order.  This
  77 mode is unimplemented in the CPG library.
  78 .TP
  79 .B CPG_TYPE_FIFO
  80 Messages are guaranteed to be delivered in first sent first delivery order.
  81 In fact, this guarantee is equivalent to the CPG_TYPE_AGREED guarantee.
  82 .TP
  83 .B CPG_TYPE_AGREED
  84 All processors must agree on the order of delivery.  If a message is sent
  85 from two or more processors at about the same time, the delivery will occur
  86 in the same order to all processors.
  87 .TP
  88 .B CPG_TYPE_SAFE
  89 All processors must agree on the order of delivery.  Further all processors
  90 must have a copy of the message before any delivery takes place.  This mode is
  91 unimplemented in the CPG library.
  92 .PP
  93 The
  94 .I iovec
  95 argument describes the scatter/gather list which is used to transmit a message.  This
  96 is a standard socket structure described by:
  97 .IP
  98 .RS
  99 .ne 18
 100 .nf
 101 .ta 4n 30n 33n
 102 struct iovec
 103 {
 104         void *iov_base;     /* Pointer to data.  */
 105         size_t iov_len;     /* Length of data.  */
 106 };
 107 .ta
 108 .fi
 109 .RE
 110 .IP
 111 .PP
 112 .PP
 113 The
 114 .I iov_len
 115 argument describes the number of entires in the
 116 .I iovec
 117 argument.
 118
 119 .SH RETURN VALUE
 120 This call returns the CPG_OK value if successful, otherwise an error is returned.
 121 .PP
 122 .SH ERRORS
 123 The errors are undocumented.
 124 .SH "SEE ALSO"
 125 .BR cpg_overview (8),
 126 .BR cpg_initialize (3),
 127 .BR cpg_finalize (3),
 128 .BR cpg_fd_get (3),
 129 .BR cpg_dispatch (3),
 130 .BR cpg_leave (3),
 131 .BR cpg_join (3),
 132 .BR cpg_membership_get (3)
 133 .PP