oec/libbrandt
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

cleanup todos in brandt.h

Browse Source
This commit is contained in:
Markus Teich 2016-12-02 11:04:45 +01:00
parent 209f0162fc
commit fa086e2d4f
1 changed files with 4 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
brandt.h
View File

@ -175,15 +175,7 @@ BRANDT_join (BRANDT_CbResult result,
uint16_t bid); uint16_t bid);
/* \todo: Distinguish handles for seller/buyers */
/* \todo: have cancellation (BRANDT_join_cancel()) */ /* \todo: have cancellation (BRANDT_join_cancel()) */
/* \todo: provide means to extract a hash from auction data to */
/* tie cryptographic operations to application-readable proposal */
/* \todo: have separate function to export 'out' variables */
/* \todo: might want to specify timeout? How do we deal with time? */
/* \todo: separate creating an auction from starting it; initial */
/* setup needs more auction proposal details (hash, timeout, */
/* bid structure), later we need to know # participants */
/** /**
* Create a new auction described by the @a auction_desc parameter as seller. * Create a new auction described by the @a auction_desc parameter as seller.
* *
@ -201,12 +193,11 @@ BRANDT_join (BRANDT_CbResult result,
* until then to register. * until then to register.
* @param[in] time_round The maximum duration of each round in the protocol. * @param[in] time_round The maximum duration of each round in the protocol.
* @param[in] num_prices The amount of possible valuations for the sold item(s). * @param[in] num_prices The amount of possible valuations for the sold item(s).
* If 0, a default of 256 will be used. \todo: what about 1, does it work with * Must be > 0.
* second price auctions?
* @param[in] m The mode of the auction. If 0, it will be a first price auction * @param[in] m The mode of the auction. If 0, it will be a first price auction
* where the winner has to pay the price of his bid. If >0 it will be a second * where the winner has to pay the price of his bid. If >0 it will be a second
* price auction selling exactly that amount of items and each winner has to pay * price auction selling exactly that amount of items and each winner has to pay
* the price of the highest loosing bid. \todo: what if bidders < m? * the price of the highest loosing bid.
* @param[in] outcome_public If 1, the auction winner and price will be public * @param[in] outcome_public If 1, the auction winner and price will be public
* to all participants, if 0, this information will only be revealed to the * to all participants, if 0, this information will only be revealed to the
* winner and the seller. * winner and the seller.
@ -248,11 +239,10 @@ BRANDT_bidder_start (struct BRANDT_Auction *auction,
* Clean up this auction on shutdown. * Clean up this auction on shutdown.
* *
* @param[in] auction The pointer returned by BRANDT_join() or BRANDT_new(). * @param[in] auction The pointer returned by BRANDT_join() or BRANDT_new().
* \todo: implement (de)serialization */ */
void void
BRANDT_destroy (struct BRANDT_Auction *auction); BRANDT_destroy (struct BRANDT_Auction *auction);
/** /**
* Receive a message related to a specific auction. * Receive a message related to a specific auction.
* *
@ -274,5 +264,6 @@ BRANDT_got_message (struct BRANDT_Auction *auction,
/**\todo: Error handling functions? */ /**\todo: Error handling functions? */
/* \todo: implement (de)serialization / persistent caching on disk */
#endif /* ifndef _BRANDT_BRANDT_H */ #endif /* ifndef _BRANDT_BRANDT_H */