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