diff options
Diffstat (limited to 'brandt.h')
-rw-r--r-- | brandt.h | 34 |
1 files changed, 17 insertions, 17 deletions
@@ -26,7 +26,7 @@ | |||
26 | #include <stdint.h> | 26 | #include <stdint.h> |
27 | 27 | ||
28 | /** | 28 | /** |
29 | * FIXME. | 29 | * \todo. |
30 | */ | 30 | */ |
31 | struct BRANDT_Auction; | 31 | struct BRANDT_Auction; |
32 | 32 | ||
@@ -34,7 +34,7 @@ struct BRANDT_Auction; | |||
34 | * Functions of this type are called by libbrandt to broadcast messages to the | 34 | * Functions of this type are called by libbrandt to broadcast messages to the |
35 | * blackboard of a specific auction. | 35 | * blackboard of a specific auction. |
36 | * | 36 | * |
37 | * TODO: how must the message be handled? (encryption, auth, reliability, …) | 37 | * \todo: how must the message be handled? (encryption, auth, reliability, …) |
38 | * | 38 | * |
39 | * @param[in] auction_closure Closure pointer representing the respective | 39 | * @param[in] auction_closure Closure pointer representing the respective |
40 | * auction. This is the Pointer given to BRANDT_join(). | 40 | * auction. This is the Pointer given to BRANDT_join(). |
@@ -53,7 +53,7 @@ typedef int | |||
53 | * Functions of this type are called by libbrandt to unicast messages to the | 53 | * Functions of this type are called by libbrandt to unicast messages to the |
54 | * seller of a specific auction. | 54 | * seller of a specific auction. |
55 | * | 55 | * |
56 | * TODO: how must the message be handled? (encryption, auth, reliability, …) | 56 | * \todo: how must the message be handled? (encryption, auth, reliability, …) |
57 | * | 57 | * |
58 | * @param[in] auction_closure Closure pointer representing the respective | 58 | * @param[in] auction_closure Closure pointer representing the respective |
59 | * auction. This is the Pointer given to BRANDT_join(). | 59 | * auction. This is the Pointer given to BRANDT_join(). |
@@ -71,8 +71,8 @@ typedef int | |||
71 | * Functions of this type are called by libbrandt to report the auction outcome | 71 | * Functions of this type are called by libbrandt to report the auction outcome |
72 | * or malicious/erroneous participants. | 72 | * or malicious/erroneous participants. |
73 | * | 73 | * |
74 | * TODO: update price type. | 74 | * \todo: update price type. |
75 | * TODO: export proof of erroneous behaviour. | 75 | * \todo: export proof of erroneous behaviour. |
76 | * | 76 | * |
77 | * @param[in] auction_closure Closure pointer representing the respective | 77 | * @param[in] auction_closure Closure pointer representing the respective |
78 | * auction. This is the Pointer given to BRANDT_join() / BRANDT_new(). | 78 | * auction. This is the Pointer given to BRANDT_join() / BRANDT_new(). |
@@ -115,16 +115,16 @@ BRANDT_join (BRANDT_BroadcastCallback broadcast, | |||
115 | const void * auction_closure, | 115 | const void * auction_closure, |
116 | const void * auction_data, | 116 | const void * auction_data, |
117 | size_t auction_data_len); | 117 | size_t auction_data_len); |
118 | /* FIXME: where do I specify my bid? */ | 118 | /* \todo: where do I specify my bid? */ |
119 | 119 | ||
120 | 120 | ||
121 | /* FIXME: Distinguish handles for seller/buyers */ | 121 | /* \todo: Distinguish handles for seller/buyers */ |
122 | /* FIXME: have cancellation (BRANDT_join_cancel()) */ | 122 | /* \todo: have cancellation (BRANDT_join_cancel()) */ |
123 | /* FIXME: provide means to extract a hash from auction data to */ | 123 | /* \todo: provide means to extract a hash from auction data to */ |
124 | /* tie cryptographic operations to application-readable proposal */ | 124 | /* tie cryptographic operations to application-readable proposal */ |
125 | /* FIXME: have separate function to export 'out' variables */ | 125 | /* \todo: have separate function to export 'out' variables */ |
126 | /* FIXME: might want to specify timeout? How do we deal with time? */ | 126 | /* \todo: might want to specify timeout? How do we deal with time? */ |
127 | /* FIXME: separate creating an auction from starting it; initial */ | 127 | /* \todo: separate creating an auction from starting it; initial */ |
128 | /* setup needs more auction proposal details (hash, timeout, */ | 128 | /* setup needs more auction proposal details (hash, timeout, */ |
129 | /* bid structure), later we need to know # participants */ | 129 | /* bid structure), later we need to know # participants */ |
130 | /** | 130 | /** |
@@ -140,15 +140,15 @@ BRANDT_join (BRANDT_BroadcastCallback broadcast, | |||
140 | * @param[out] auction_data_len The length in bytes of the @a auction_data | 140 | * @param[out] auction_data_len The length in bytes of the @a auction_data |
141 | * structure. Will be filled by BRANDT_new(). | 141 | * structure. Will be filled by BRANDT_new(). |
142 | * @param[in] num_prices The amount of possible valuations for the sold item(s). | 142 | * @param[in] num_prices The amount of possible valuations for the sold item(s). |
143 | * If 0, a default of 256 will be used. TODO: what about 1, does it work with | 143 | * If 0, a default of 256 will be used. \todo: what about 1, does it work with |
144 | * second price auctions? | 144 | * second price auctions? |
145 | * @param[in] m The mode of the auction. If 0, it will be a first price auction | 145 | * @param[in] m The mode of the auction. If 0, it will be a first price auction |
146 | * where the winner has to pay the price of his bid. If >0 it will be a second | 146 | * where the winner has to pay the price of his bid. If >0 it will be a second |
147 | * price auction selling exactly that amount of items and each winner has to pay | 147 | * price auction selling exactly that amount of items and each winner has to pay |
148 | * the price of the highest loosing bid. TODO: what if bidders < m? | 148 | * the price of the highest loosing bid. \todo: what if bidders < m? |
149 | * @param[in] outcome_public If 1, the auction winner and price will be public | 149 | * @param[in] outcome_public If 1, the auction winner and price will be public |
150 | * to all participants, if 0, this information will only be revealed to the | 150 | * to all participants, if 0, this information will only be revealed to the |
151 | * winner and the seller. => FIXME: Turn into AuctionMode bit flag! | 151 | * winner and the seller. => \todo: Turn into AuctionMode bit flag! |
152 | * @return A pointer, which should only be remembered and passed to | 152 | * @return A pointer, which should only be remembered and passed to |
153 | * libbrandt functions when the client needs to refer to this auction. This is a | 153 | * libbrandt functions when the client needs to refer to this auction. This is a |
154 | * black-box pointer, do NOT access/change it or the data it points to! | 154 | * black-box pointer, do NOT access/change it or the data it points to! |
@@ -185,7 +185,7 @@ BRANDT_got_broadcast (struct BRANDT_Auction *auction, | |||
185 | * @a msg was received. | 185 | * @a msg was received. |
186 | * @param[in] msg The message that was received. | 186 | * @param[in] msg The message that was received. |
187 | * @param[in] msg_len The length in bytes of @a msg. | 187 | * @param[in] msg_len The length in bytes of @a msg. |
188 | * TODO: how to link message to sender id within auction? | 188 | * \todo: how to link message to sender id within auction? |
189 | * ANSWER: on start, know that we have 'n' participants, here give | 189 | * ANSWER: on start, know that we have 'n' participants, here give |
190 | * participant number (1..n) | 190 | * participant number (1..n) |
191 | */ | 191 | */ |
@@ -195,6 +195,6 @@ BRANDT_got_unicast (struct BRANDT_Auction *auction, | |||
195 | size_t msg_len); | 195 | size_t msg_len); |
196 | 196 | ||
197 | 197 | ||
198 | /**TODO: Error handling functions? */ | 198 | /**\todo: Error handling functions? */ |
199 | 199 | ||
200 | #endif /* ifndef _BRANDT_BRANDT_H */ | 200 | #endif /* ifndef _BRANDT_BRANDT_H */ |