aboutsummaryrefslogtreecommitdiff
path: root/brandt.h
diff options
context:
space:
mode:
Diffstat (limited to 'brandt.h')
-rw-r--r--brandt.h17
1 files changed, 4 insertions, 13 deletions
diff --git a/brandt.h b/brandt.h
index 8b518a8..3029031 100644
--- a/brandt.h
+++ b/brandt.h
@@ -175,15 +175,7 @@ BRANDT_join (BRANDT_CbResult result,
175 uint16_t bid); 175 uint16_t bid);
176 176
177 177
178/* \todo: Distinguish handles for seller/buyers */
179/* \todo: have cancellation (BRANDT_join_cancel()) */ 178/* \todo: have cancellation (BRANDT_join_cancel()) */
180/* \todo: provide means to extract a hash from auction data to */
181/* tie cryptographic operations to application-readable proposal */
182/* \todo: have separate function to export 'out' variables */
183/* \todo: might want to specify timeout? How do we deal with time? */
184/* \todo: separate creating an auction from starting it; initial */
185/* setup needs more auction proposal details (hash, timeout, */
186/* bid structure), later we need to know # participants */
187/** 179/**
188 * Create a new auction described by the @a auction_desc parameter as seller. 180 * Create a new auction described by the @a auction_desc parameter as seller.
189 * 181 *
@@ -201,12 +193,11 @@ BRANDT_join (BRANDT_CbResult result,
201 * until then to register. 193 * until then to register.
202 * @param[in] time_round The maximum duration of each round in the protocol. 194 * @param[in] time_round The maximum duration of each round in the protocol.
203 * @param[in] num_prices The amount of possible valuations for the sold item(s). 195 * @param[in] num_prices The amount of possible valuations for the sold item(s).
204 * If 0, a default of 256 will be used. \todo: what about 1, does it work with 196 * Must be > 0.
205 * second price auctions?
206 * @param[in] m The mode of the auction. If 0, it will be a first price auction 197 * @param[in] m The mode of the auction. If 0, it will be a first price auction
207 * where the winner has to pay the price of his bid. If >0 it will be a second 198 * where the winner has to pay the price of his bid. If >0 it will be a second
208 * price auction selling exactly that amount of items and each winner has to pay 199 * price auction selling exactly that amount of items and each winner has to pay
209 * the price of the highest loosing bid. \todo: what if bidders < m? 200 * the price of the highest loosing bid.
210 * @param[in] outcome_public If 1, the auction winner and price will be public 201 * @param[in] outcome_public If 1, the auction winner and price will be public
211 * to all participants, if 0, this information will only be revealed to the 202 * to all participants, if 0, this information will only be revealed to the
212 * winner and the seller. 203 * winner and the seller.
@@ -248,11 +239,10 @@ BRANDT_bidder_start (struct BRANDT_Auction *auction,
248 * Clean up this auction on shutdown. 239 * Clean up this auction on shutdown.
249 * 240 *
250 * @param[in] auction The pointer returned by BRANDT_join() or BRANDT_new(). 241 * @param[in] auction The pointer returned by BRANDT_join() or BRANDT_new().
251 * \todo: implement (de)serialization */ 242 */
252void 243void
253BRANDT_destroy (struct BRANDT_Auction *auction); 244BRANDT_destroy (struct BRANDT_Auction *auction);
254 245
255
256/** 246/**
257 * Receive a message related to a specific auction. 247 * Receive a message related to a specific auction.
258 * 248 *
@@ -274,5 +264,6 @@ BRANDT_got_message (struct BRANDT_Auction *auction,
274 264
275 265
276/**\todo: Error handling functions? */ 266/**\todo: Error handling functions? */
267/* \todo: implement (de)serialization / persistent caching on disk */
277 268
278#endif /* ifndef _BRANDT_BRANDT_H */ 269#endif /* ifndef _BRANDT_BRANDT_H */