src/auction/auction.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2001-2011 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your 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      Affero General Public License for more details.
  14 */
  15
  16 /**
  17  * @author Markus Teich
  18  * @file auction/auction.h
  19  *
  20  * @brief Common type definitions for the auction service and API.
  21  */
  22 #ifndef AUCTION_H
  23 #define AUCTION_H
  24
  25 #include "gnunet_common.h"
  26
  27 GNUNET_NETWORK_STRUCT_BEGIN
  28
  29 /**
  30  * Auction creation request sent from the client to the service
  31  */
  32 struct GNUNET_AUCTION_ClientCreateMessage
  33 {
  34   /**
  35    * Type: GNUNET_MESSAGE_TYPE_AUCTION_CLIENT_CREATE
  36    */
  37   struct GNUNET_MessageHeader header;
  38
  39   /**
  40    * When should the auction start
  41    */
  42   struct GNUNET_TIME_AbsoluteNBO time_start;
  43
  44   /**
  45    * How long is each round allowed to be maximally
  46    */
  47   struct GNUNET_TIME_RelativeNBO time_round;
  48
  49   /**
  50    * Auction parameter m.
  51    * 0 for first price auctions.
  52    * >0 for M+1st price auctions.
  53    */
  54   uint16_t m GNUNET_PACKED;
  55
  56   /**
  57    * Should the auction outcome be public?
  58    * 0 for private outcome auctions.
  59    * 1 for public outcome auctions.
  60    */
  61   uint16_t outcome_public GNUNET_PACKED;
  62
  63   /**
  64    * TODO: Price mapping.
  65    */
  66
  67   /* DESCRIPTION text copied to end of this message */
  68 };
  69
  70 GNUNET_NETWORK_STRUCT_END
  71
  72 #endif