src/arm/arm.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2009 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 Christian Grothoff
  23  * @file arm/arm.h
  24  */
  25 #ifndef ARM_H
  26 #define ARM_H
  27
  28 #include "gnunet_common.h"
  29
  30 /**
  31  * This option will turn on the DEBUG loglevel for
  32  * all processes controlled by this ARM!
  33  */
  34 #define DEBUG_ARM GNUNET_EXTRA_LOGGING
  35
  36 GNUNET_NETWORK_STRUCT_BEGIN
  37
  38 /**
  39  * Status update from ARM to client.
  40  */
  41 struct GNUNET_ARM_StatusMessage
  42 {
  43
  44   /**
  45    * Reply to client, of type is #GNUNET_MESSAGE_TYPE_ARM_STATUS.
  46    */
  47   struct GNUNET_MessageHeader header;
  48
  49   /**
  50    * Status from the 'enum GNUNET_ARM_ServiceStatus'
  51    */
  52   uint32_t status;
  53
  54   /* followed by a 0-terminated service name */
  55 };
  56
  57 struct GNUNET_ARM_Message
  58 {
  59   /**
  60    * Reply to client, type is #GNUNET_MESSAGE_TYPE_ARM_RESULT or
  61    * #GNUNET_MESSAGE_TYPE_ARM_LIST_RESULT.
  62    * OR
  63    * Request from client, type is #GNUNET_MESSAGE_TYPE_ARM_START or
  64    * #GNUNET_MESSAGE_TYPE_ARM_STOP.
  65    */
  66   struct GNUNET_MessageHeader header;
  67
  68   /**
  69    * For alignment.
  70    */
  71   uint32_t reserved;
  72
  73   /**
  74    * ID of a request that is being replied to.
  75    * OR
  76    * ID of a request that is being sent.
  77    */
  78   uint64_t request_id;
  79
  80   /* For requests - followed by a 0-terminated service name */
  81 };
  82
  83
  84 /**
  85  * Reply from ARM to client.
  86  */
  87 struct GNUNET_ARM_ResultMessage
  88 {
  89
  90   /**
  91    * Reply to client, of type is #GNUNET_MESSAGE_TYPE_ARM_RESULT, with an ID.
  92    */
  93   struct GNUNET_ARM_Message arm_msg;
  94
  95   /**
  96    * Result from the `enum GNUNET_ARM_Result`
  97    */
  98   uint32_t result;
  99 };
 100
 101 /**
 102  * Reply from ARM to client for the
 103  * #GNUNET_MESSAGE_TYPE_ARM_LIST request followed by count
 104  * '\0' terminated strings. header->size contains the
 105  * total size (including all strings).
 106  */
 107 struct GNUNET_ARM_ListResultMessage
 108 {
 109   /**
 110    * Reply to client, of type is #GNUNET_MESSAGE_TYPE_ARM_LIST_RESULT,
 111    * with an ID.
 112    */
 113   struct GNUNET_ARM_Message arm_msg;
 114
 115   /**
 116    * Number of '\0' terminated strings that follow
 117    * this message.
 118    */
 119   uint16_t count;
 120 };
 121
 122 GNUNET_NETWORK_STRUCT_END
 123
 124 #endif