man/evs_leave.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_LEAVE 3 2004-08-31 "openais Man Page" "Openais Programmer's Manual"
  35 .SH NAME
  36 evs_leave \- Leave one or more groups in the EVS library
  37 .SH SYNOPSIS
  38 .B #include <openais/evs.h>
  39 .sp
  40 .BI "int evs_leave(evs_handle_t " handle ", evs_group_t *" groups ", int group_entries);
  41 .SH DESCRIPTION
  42 The
  43 .B evs_leave
  44 function is used to leave one or more groups.  The joined groups are used with
  45 .B evs_mcast_joined(3)
  46 function to multicast to the groups joined in the argument
  47 .I handle.
  48 Messages that are sent to any of the joined groups 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.
  54 .PP
  55
  56 The argument
  57 .I groups
  58 is used to specify the groups to leave.  A group is a 32 byte key.  The key is
  59 not a string, hence, the entire key is used when leaveing the channel.  For that reason
  60 the entire group should be initialized.
  61 .PP
  62 The argument
  63 .I group_entries
  64 specifies how many entries are located in the groups argument.
  65
  66 The
  67 .I groups
  68 argument is of the type evs_group_t which is defined by the structure:
  69
  70 .IP
  71 .RS
  72 .ne 18
  73 .nf
  74 .ta 4n 30n 33n
  75 typedef struct {
  76         char key[32];
  77 } evs_groups_t;
  78 .ta
  79 .fi
  80 .RE
  81 .IP
  82 .PP
  83 .SH RETURN VALUE
  84 This call returns the EVS_OK value if successful, otherwise an error is returned.
  85 .PP
  86 .SH ERRORS
  87 The errors are undocumented.
  88 .SH "SEE ALSO"
  89 .BR evs_overview (8),
  90 .BR evs_initialize (3),
  91 .BR evs_finalize (3),
  92 .BR evs_fd_get (3),
  93 .BR evs_dispatch (3),
  94 .BR evs_join (3),
  95 .BR evs_mcast_joined (3),
  96 .BR evs_mcast_groups (3),
  97 .BR evs_mmembership_get (3)
  98 .PP