src/include/gnunet_consensus_service.h

   1 /*
   2       This file is part of GNUnet
   3       (C) 2012 Christian Grothoff (and other contributing authors)
   4
   5       GNUnet is free software; you can redistribute it and/or modify
   6       it under the terms of the GNU General Public License as published
   7       by the Free Software Foundation; either version 2, or (at your
   8       option) any later version.
   9
  10       GNUnet is distributed in the hope that it will be useful, but
  11       WITHOUT ANY WARRANTY; without even the implied warranty of
  12       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13       General Public License for more details.
  14
  15       You should have received a copy of the GNU General Public License
  16       along with GNUnet; see the file COPYING.  If not, write to the
  17       Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18       Boston, MA 02111-1307, USA.
  19  */
  20
  21 /**
  22  * @file include/gnunet_consensus_service.h
  23  * @brief multi-peer set reconciliation
  24  * @author Florian Dold
  25  */
  26
  27 #ifndef GNUNET_CONSENSUS_SERVICE_H
  28 #define GNUNET_CONSENSUS_SERVICE_H
  29
  30 #ifdef __cplusplus
  31 extern "C"
  32 {
  33 #if 0                           /* keep Emacsens' auto-indent happy */
  34 }
  35 #endif
  36 #endif
  37
  38 #include "platform.h"
  39 #include "gnunet_common.h"
  40 #include "gnunet_time_lib.h"
  41 #include "gnunet_configuration_lib.h"
  42
  43
  44 /**
  45  * An element of the consensus set.
  46  */
  47 struct GNUNET_CONSENSUS_Element
  48 {
  49   /**
  50    * The actual data of the element.
  51    */
  52    const void *data;
  53
  54    /**
  55     * Size of the element's data.
  56     */
  57    uint16_t size;
  58
  59    /**
  60     * Application specific element type
  61     */
  62    uint16_t type;
  63 };
  64
  65
  66 /**
  67  * Called when a new element was received from another peer, or an error occured.
  68  * May deliver duplicate values.
  69  * Elements given to a consensus operation by the local peer are NOT given
  70  * to this callback.
  71  *
  72  * @param cls closure
  73  * @param element new element, NULL on error
  74  */
  75 typedef void (*GNUNET_CONSENSUS_ElementCallback) (void *cls,
  76                                                  const struct GNUNET_CONSENSUS_Element *element);
  77
  78
  79
  80 /**
  81  * Opaque handle for the consensus service.
  82  */
  83 struct GNUNET_CONSENSUS_Handle;
  84
  85
  86 /**
  87  * Create a consensus session.  The set being reconciled is initially
  88  * empty.  Only reconcile with other peers after
  89  * GNUNET_CONSENSUS_reconcile has been called.
  90  *
  91  * @param cfg
  92  * @param num_peers
  93  * @param peers array of peers participating in this consensus session
  94  *              Inclusion of the local peer is optional.
  95  * @param session_id session identifier
  96  *                   Allows a group of peers to have more than consensus session.
  97  * @param new_element_cb callback, called when a new element is added to the set by
  98  *                    another peer
  99  * @param new_element_cls closure for new_element
 100  * @return handle to use, NULL on error
 101  */
 102 struct GNUNET_CONSENSUS_Handle *
 103 GNUNET_CONSENSUS_create (const struct GNUNET_CONFIGURATION_Handle *cfg,
 104                          unsigned int num_peers,
 105                          const struct GNUNET_PeerIdentity *peers,
 106                          const struct GNUNET_HashCode *session_id,
 107                          GNUNET_CONSENSUS_ElementCallback new_element_cb,
 108                          void *new_element_cls);
 109
 110
 111 /**
 112  * Called when an insertion (transmission to consensus service,
 113  * which does not imply fully consensus on this element with
 114  * all other peers) was successful.
 115  * May not call GNUNET_CONSENSUS_destroy; schedule a task to call
 116  * GNUNET_CONSENSUS_destroy instead.
 117  *
 118  * @param cls
 119  * @param success GNUNET_OK on success, GNUNET_SYSERR if
 120  *        the insertion and thus the consensus failed for good
 121  */
 122 typedef void (*GNUNET_CONSENSUS_InsertDoneCallback) (void *cls,
 123                                                      int success);
 124
 125
 126 /**
 127  * Insert an element in the set being reconsiled.  Only transmit changes to
 128  * other peers if "GNUNET_CONSENSUS_begin" has been called.
 129  * Must not be called after "GNUNET_CONSENSUS_conclude".
 130  * May not call GNUNET_CONSENSUS_destroy; schedule a task to call
 131  * GNUNET_CONSENSUS_destroy instead.
 132  *
 133  * @param consensus handle for the consensus session
 134  * @param element the element to be inserted
 135  * @param idc function called when we are done with this element and it
 136  *            is thus allowed to call GNUNET_CONSENSUS_insert again
 137  * @param idc_cls closure for 'idc'
 138  */
 139 void
 140 GNUNET_CONSENSUS_insert (struct GNUNET_CONSENSUS_Handle *consensus,
 141                          const struct GNUNET_CONSENSUS_Element *element,
 142                          GNUNET_CONSENSUS_InsertDoneCallback idc,
 143                          void *idc_cls);
 144
 145
 146
 147 /**
 148  * Called when a conclusion was successful.
 149  *
 150  * @param cls
 151  */
 152 typedef void (*GNUNET_CONSENSUS_ConcludeCallback) (void *cls);
 153
 154
 155 /**
 156  * We are finished inserting new elements into the consensus;
 157  * try to conclude the consensus within a given time window.
 158  *
 159  * @param consensus consensus session
 160  * @param timeout timeout after which the conculde callback
 161  *                must be called
 162  * @param conclude called when the conclusion was successful
 163  * @param conclude_cls closure for the conclude callback
 164  */
 165 void
 166 GNUNET_CONSENSUS_conclude (struct GNUNET_CONSENSUS_Handle *consensus,
 167                            struct GNUNET_TIME_Relative timeout,
 168                            GNUNET_CONSENSUS_ConcludeCallback conclude,
 169                            void *conclude_cls);
 170
 171
 172 /**
 173  * Destroy a consensus handle (free all state associated with
 174  * it, no longer call any of the callbacks).
 175  *
 176  * @param consensus handle to destroy
 177  */
 178 void
 179 GNUNET_CONSENSUS_destroy (struct GNUNET_CONSENSUS_Handle *consensus);
 180
 181
 182 #if 0                           /* keep Emacsens' auto-indent happy */
 183 {
 184 #endif
 185 #ifdef __cplusplus
 186 }
 187 #endif
 188
 189 #endif