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
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      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      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @author Markus Teich
  23  * @file auction/auction.h
  24  *
  25  * @brief Common type definitions for the auction service and API.
  26  */
  27 #ifndef AUCTION_H
  28 #define AUCTION_H
  29
  30 #include "gnunet_common.h"
  31
  32 GNUNET_NETWORK_STRUCT_BEGIN
  33
  34 /**
  35  * Auction creation request sent from the client to the service
  36  */
  37 struct GNUNET_AUCTION_ClientCreateMessage
  38 {
  39   /**
  40    * Type: GNUNET_MESSAGE_TYPE_AUCTION_CLIENT_CREATE
  41    */
  42   struct GNUNET_MessageHeader header;
  43
  44   /**
  45    * When should the auction start
  46    */
  47   struct GNUNET_TIME_AbsoluteNBO time_start;
  48
  49   /**
  50    * How long is each round allowed to be maximally
  51    */
  52   struct GNUNET_TIME_RelativeNBO time_round;
  53
  54   /**
  55    * Auction parameter m.
  56    * 0 for first price auctions.
  57    * >0 for M+1st price auctions.
  58    */
  59   uint16_t m GNUNET_PACKED;
  60
  61   /**
  62    * Should the auction outcome be public?
  63    * 0 for private outcome auctions.
  64    * 1 for public outcome auctions.
  65    */
  66   uint16_t outcome_public GNUNET_PACKED;
  67
  68   /**
  69    * TODO: Price mapping.
  70    */
  71
  72   /* DESCRIPTION text copied to end of this message */
  73 };
  74
  75 GNUNET_NETWORK_STRUCT_END
  76
  77 #endif