Allow make from the exec directory.
[openais.git] / man / cpg_overview.8
blob9dc0885bf64a1d6e4cb14ab6fd2a5bddca8033c9
1 .\"/*
2 .\" * Copyright (c) 2006 Red Hat, Inc.
3 .\" *
4 .\" * All rights reserved.
5 .\" *
6 .\" * Author: Patrick Caulfield <pcaulfie@redhat.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 CPG_OVERVIEW 8 2006-03-06 "openais Man Page" "Openais Programmer's Manual"
35 .SH OVERVIEW
36 The CPG library is delivered with the openais project.  This library is used
37 to create distributed applications that operate properly during partitions, merges,
38 and faults.
39 .PP
40 The library provides a mechanism to:
41 * handle abstraction for multiple instances of an CPG library in one application
42 * join one or more groups
43 * leave one or more groups
44 * Deliver messages to members of that group
45 * Deliver configuration changes
46 .PP
47 .SH SECURITY
48 The CPG library encrypts all messages sent over the network using the SOBER-128
49 stream cipher.  The EVS library uses HMAC and SHA1 to authenticate all messages.
50 The CPG library uses SOBER-128 as a pseudo random number generator.  TheCPG
51 library feeds the PRNG using the /dev/random Linux device.
52 .SH BUGS
53 This software is not yet production, so there may still be some bugs.
54 .SH "SEE ALSO"
55 .BR cpg_initialize (3),
56 .BR cpg_finalize (3),
57 .BR cpg_fd_get (3),
58 .BR cpg_dispatch (3),
59 .BR cpg_join (3),
60 .BR cpg_leave (3),
61 .BR cpg_mcast_joined (3),
62 .BR cpg_membership_get (3)
64 .PP