man/evs_initialize.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_INITIALIZE 3 2004-08-31 "openais Man Page" "Openais Programmer's Manual"
  35 .SH NAME
  36 evs_initialize \- Create a new connection to the EVS service
  37 .SH SYNOPSIS
  38 .B #include <openais/evs.h>
  39 .sp
  40 .BI "int evs_initialize(evs_handle_t *" handle ", evs_callbacks_t *" callbacks ");
  41 .SH DESCRIPTION
  42 The
  43 .B evs_initialize
  44 function is used to initialize a connection to the extended virtual synchrony API.
  45 .PP
  46 Each application may have several connections to the EVS API.  Each  application
  47 uses the
  48 .I handle
  49 argument to uniquely identify the connection.  The
  50 .I handle
  51 argument is then used in other function calls to identify the connection to be used
  52 for communication with the EVS service.
  53 .PP
  54 Every time an EVS event occurs, one of the callbacks specified by the argument
  55 .I callbacks
  56 is called.  The callback functions are described by the following type definitions:
  57 .PP
  58 .IP
  59 .RS
  60 .ne 18
  61 .nf
  62 .ta 4n 20n 32n
  63 typedef void (*evs_deliver_fn_t) (
  64         struct evs_address source_addr,
  65         void *msg,
  66         int msg_len);
  67
  68 typedef void (*evs_confchg_fn_t) (
  69         struct evs_address *member_list, int member_list_entries,
  70         struct evs_address *left_list, int left_list_entries,
  71         struct evs_address *joined_list, int joined_list_entries);
  72 .ta
  73 .fi
  74 .RE
  75 .IP
  76 .PP
  77 .PP
  78 The
  79 .I callbacks
  80 argument is of the type:
  81 .IP
  82 .RS
  83 .ne 18
  84 .nf
  85 .PP
  86 typedef struct {
  87         evs_deliver_fn_t evs_deliver_fn;
  88         evs_confchg_fn_t evs_confchg_fn;
  89 } evs_callbacks_t;
  90 .ta
  91 .fi
  92 .RE
  93 .IP
  94 .PP
  95 When a configuration change occurs or a message is to be delivered one of the callbacks
  96 is called from the
  97 .B evs_dispatch()
  98 function.  If a configuration change occurs,
  99 .I evs_confchg_fn
 100 is called.  If a delivery of a message occurs,
 101 .I evs_deliver_fn
 102 is called.
 103
 104 The
 105 .I evs_address
 106 structure is defined
 107 .IP
 108 .RS
 109 .ne 18
 110 .nf
 111 .PP
 112 struct evs_address {
 113         unsigned int nodeid;
 114         unsigned short family;
 115         unsigned char addr[TOTEMIP_ADDRLEN];
 116 };
 117 .ta
 118 .fi
 119 .RE
 120 .IP
 121 .PP
 122 where nodeid is a 32 bit unique node identifier, family is of the value AF_INET  for an IPV4 network, or AF_INET6 for an IPV6 network, and addr is a 32 bit address for an IPV4 network, or 128 bit address for an IPV6 network.
 123
 124
 125 .SH RETURN VALUE
 126 This call returns the EVS_OK value if successful, otherwise an error is returned.
 127 .PP
 128 .SH ERRORS
 129 The errors are undocumented.
 130 .SH "SEE ALSO"
 131 .BR evs_overview (8),
 132 .BR evs_finalize (3),
 133 .BR evs_fd_get (3),
 134 .BR evs_dispatch (3),
 135 .BR evs_join (3),
 136 .BR evs_leave (3),
 137 .BR evs_mcast_joined (3),
 138 .BR evs_mcast_groups (3),
 139 .BR evs_mmembership_get (3)
 140 .PP