man/evs_join.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_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_join(evs_handle_t " handle ", evs_group_t *" groups ", int " group_entries ");
  41 .SH DESCRIPTION
  42 The
  43 .B evs_join
  44 function is used to join one or more groups.  When a group is joined, using the
  45 .B evs_mcast_joined(3)
  46 function will multicast to the groups joined in the argument
  47 .I handle.
  48 Messages that are sent to any of the groups joined to the parameter
  49 .I handle
  50 will be delivered by
  51 .B evs_dispatch(3).
  52 .PP
  53 This call may be used more then once on a handle, in which case the joined groups will
  54 be all of the groups passed to the
  55 .B evs_join(3)
  56 function during the lifecycle of the parameter
  57 .I handle.
  58 .PP
  59
  60 The argument
  61 .I groups
  62 is used to specify the groups to join.  A group is a 32 byte key.  The key is
  63 not a string, hence, the entire key is used when joining the channel.  For that reason
  64 the entire group should be initialized.
  65 .PP
  66 The argument
  67 .I group_entries
  68 specifies how many entries are located in the groups argument.
  69
  70 The
  71 .I groups
  72 argument is of the type evs_group_t which is defined by the structure:
  73
  74 .IP
  75 .RS
  76 .ne 18
  77 .nf
  78 .ta 4n 30n 33n
  79 typedef struct {
  80         char key[32];
  81 } evs_groups_t;
  82 .ta
  83 .fi
  84 .RE
  85 .IP
  86 .PP
  87 .PP
  88 .SH RETURN VALUE
  89 This call returns the EVS_OK value if successful, otherwise an error is returned.
  90 .PP
  91 .SH ERRORS
  92 The errors are undocumented.
  93 .SH "SEE ALSO"
  94 .BR evs_overview (8),
  95 .BR evs_initialize (3),
  96 .BR evs_finalize (3),
  97 .BR evs_fd_get (3),
  98 .BR evs_dispatch (3),
  99 .BR evs_leave (3),
 100 .BR evs_mcast_joined (3),
 101 .BR evs_mcast_groups (3),
 102 .BR evs_mmembership_get (3)
 103 .PP