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      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 */
  18
  19 /**
  20  * @author Markus Teich
  21  * @file auction/auction.h
  22  *
  23  * @brief Common type definitions for the auction service and API.
  24  */
  25 #ifndef AUCTION_H
  26 #define AUCTION_H
  27
  28 #include "gnunet_common.h"
  29
  30 GNUNET_NETWORK_STRUCT_BEGIN
  31
  32 /**
  33  * Auction creation request sent from the client to the service
  34  */
  35 struct GNUNET_AUCTION_ClientCreateMessage
  36 {
  37   /**
  38    * Type: GNUNET_MESSAGE_TYPE_AUCTION_CLIENT_CREATE
  39    */
  40   struct GNUNET_MessageHeader header;
  41
  42   /**
  43    * When should the auction start
  44    */
  45   struct GNUNET_TIME_AbsoluteNBO time_start;
  46
  47   /**
  48    * How long is each round allowed to be maximally
  49    */
  50   struct GNUNET_TIME_RelativeNBO time_round;
  51
  52   /**
  53    * Auction parameter m.
  54    * 0 for first price auctions.
  55    * >0 for M+1st price auctions.
  56    */
  57   uint16_t m GNUNET_PACKED;
  58
  59   /**
  60    * Should the auction outcome be public?
  61    * 0 for private outcome auctions.
  62    * 1 for public outcome auctions.
  63    */
  64   uint16_t outcome_public GNUNET_PACKED;
  65
  66   /**
  67    * TODO: Price mapping.
  68    */
  69
  70   /* DESCRIPTION text copied to end of this message */
  71 };
  72
  73 GNUNET_NETWORK_STRUCT_END
  74
  75 #endif