man/evs_mcast_groups.3

   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_MCAST_GROUPS 3 2004-08-31 "openais Man Page" "Openais Programmer's Manual"
  35 .SH NAME
  36 evs_join \- Multicast a message to selected groups
  37 .SH SYNOPSIS
  38 .B #include <sys/uio.h>
  39 .B #include <openais/evs.h>
  40 .sp
  41 .BI "int evs_mcast_gruops(evs_handle_t " handle ", evs_guraantee_t " guarantee ", evs_group_t *" groups ", int group_entries, struct iovec *" iovec ", int " iov_len ");
  42 .SH DESCRIPTION
  43 The
  44 .B evs_mcast_groups(3)
  45 function multicasts a message to all the groups specified in the arguemnt
  46 .I groups.
  47 Messages are delivered to all processors in the system that are described by the current
  48 configuration.
  49 .PP
  50 The argument
  51 .I handle
  52 describes a handle created with
  53 .B evs_initialize(3).
  54 .PP
  55 The argument
  56 .I guarantee
  57 requests a delivery guarantee for the message to be sent.  The evs_guarantee_t type is
  58 defined by:
  59 .IP
  60 .RS
  61 .ne 18
  62 .nf
  63 .ta 4n 30n 33n
  64 typedef enum {
  65         EVS_TYPE_UNORDERED,     /* not implemented */
  66         EVS_TYPE_FIFO,          /* same as agreed */
  67         EVS_TYPE_AGREED,        /* implemented */
  68         EVS_TYPE_SAFE           /* not implemented */
  69 } evs_guarantee_t;
  70 .ta
  71 .fi
  72 .RE
  73 .IP
  74 .PP
  75 .PP
  76 The meanings of the evs_gaurantee_t typedef are:
  77 .TP
  78 .B EVS_GUARANTEE_UNORDERED
  79 Messages are guaranteed to be delivered, but with no particular order.  This
  80 mode is unimplemented in the EVS library.
  81 .TP
  82 .B EVS_GUARANTEE_FIFO
  83 Messages are guaranteed to be delivered in first sent first delivery order
  84 from one one.  In fact, this guarantee is actually the AGREED guarantee.
  85 .TP
  86 .B EVS_GUARANTEE_AGREED
  87 All processors must agree on the order of delivery.  If a message is sent
  88 from two or more processors at about the same time, the delivery will occur
  89 in the same order to all processors.
  90 .TP
  91 .B EVS_GUARANTEE_SAFE
  92 All processors must agree on the order of delivery.  Further all processors
  93 must have a copy of the message before any delivery takes place.  This mode is
  94 unimplemented in the EVS library.
  95 .PP
  96 The
  97 .I groups
  98 argument is of the type evs_group_t which is defined by the structure:
  99
 100 .IP
 101 .RS
 102 .ne 18
 103 .nf
 104 .ta 4n 30n 33n
 105 typedef struct {
 106         char key[32];
 107 } evs_groups_t;
 108 .ta
 109 .fi
 110 .RE
 111 .IP
 112 .PP
 113 .PP
 114 The
 115 .I group_entries
 116 argument describes the number of entries in the
 117 .I group
 118 argument.
 119 .PP
 120
 121 The
 122 .I iovec
 123 argument describes the scatter/gather list which is used to transmit a message.  This
 124 is a standard socket structure described by:
 125 .IP
 126 .RS
 127 .ne 18
 128 .nf
 129 .ta 4n 30n 33n
 130 struct iovec
 131 {
 132         void *iov_base;     /* Pointer to data.  */
 133         size_t iov_len;     /* Length of data.  */
 134 };
 135 .ta
 136 .fi
 137 .RE
 138 .IP
 139 .PP
 140 .PP
 141 The
 142 .I iovlen
 143 argument describes the number of entires in the
 144 .I iovec
 145 argument.
 146
 147 .SH RETURN VALUE
 148 This call returns the EVS_OK value if successful, otherwise an error is returned.
 149 .PP
 150 .SH ERRORS
 151 The errors are undocumented.
 152 .SH "SEE ALSO"
 153 .BR evs_overview (8),
 154 .BR evs_initialize (3),
 155 .BR evs_finalize (3),
 156 .BR evs_fd_get (3),
 157 .BR evs_dispatch (3),
 158 .BR evs_leave (3),
 159 .BR evs_join (3),
 160 .BR evs_mcast_joined (3),
 161 .BR evs_mmembership_get (3)
 162 .PP