src/psyc/psyc.h

   1 /*
   2  * This file is part of GNUnet
   3  * Copyright (C) 2013 Christian Grothoff (and other contributing authors)
   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  * @file psyc/psyc.h
  23  * @brief Common type definitions for the PSYC service and API.
  24  * @author Gabor X Toth
  25  */
  26
  27 #ifndef PSYC_H
  28 #define PSYC_H
  29
  30 #include "platform.h"
  31 #include "gnunet_psyc_service.h"
  32
  33
  34 int
  35 GNUNET_PSYC_check_message_parts (uint16_t data_size, const char *data,
  36                                  uint16_t *first_ptype, uint16_t *last_ptype);
  37
  38 void
  39 GNUNET_PSYC_log_message (enum GNUNET_ErrorType kind,
  40                          const struct GNUNET_MessageHeader *msg);
  41
  42
  43 enum MessageState
  44 {
  45   MSG_STATE_START    = 0,
  46   MSG_STATE_HEADER   = 1,
  47   MSG_STATE_METHOD   = 2,
  48   MSG_STATE_MODIFIER = 3,
  49   MSG_STATE_MOD_CONT = 4,
  50   MSG_STATE_DATA     = 5,
  51   MSG_STATE_END      = 6,
  52   MSG_STATE_CANCEL   = 7,
  53   MSG_STATE_ERROR    = 8,
  54 };
  55
  56
  57 enum MessageFragmentState
  58 {
  59   MSG_FRAG_STATE_START    = 0,
  60   MSG_FRAG_STATE_HEADER   = 1,
  61   MSG_FRAG_STATE_DATA     = 2,
  62   MSG_FRAG_STATE_END      = 3,
  63   MSG_FRAG_STATE_CANCEL   = 4,
  64   MSG_FRAG_STATE_DROP     = 5,
  65 };
  66
  67
  68 GNUNET_NETWORK_STRUCT_BEGIN
  69
  70
  71 /**** library -> service ****/
  72
  73
  74 struct MasterStartRequest
  75 {
  76   /**
  77    * Type: GNUNET_MESSAGE_TYPE_PSYC_MASTER_START
  78    */
  79   struct GNUNET_MessageHeader header;
  80
  81   uint32_t policy GNUNET_PACKED;
  82
  83   struct GNUNET_CRYPTO_EddsaPrivateKey channel_key;
  84 };
  85
  86
  87 struct SlaveJoinRequest
  88 {
  89   /**
  90    * Type: GNUNET_MESSAGE_TYPE_PSYC_SLAVE_JOIN
  91    */
  92   struct GNUNET_MessageHeader header;
  93
  94   uint32_t relay_count GNUNET_PACKED;
  95
  96   struct GNUNET_CRYPTO_EddsaPublicKey channel_key;
  97
  98   struct GNUNET_CRYPTO_EcdsaPrivateKey slave_key;
  99
 100   struct GNUNET_PeerIdentity origin;
 101
 102   /* Followed by struct GNUNET_PeerIdentity relays[relay_count] */
 103
 104   /* Followed by struct GNUNET_MessageHeader join_msg */
 105 };
 106
 107
 108 struct ChannelMembershipStoreRequest
 109 {
 110   /**
 111    * Type: GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_MEMBERSHIP_STORE
 112    */
 113   struct GNUNET_MessageHeader header;
 114
 115   uint32_t reserved GNUNET_PACKED;
 116
 117   uint64_t op_id GNUNET_PACKED;
 118
 119   struct GNUNET_CRYPTO_EcdsaPublicKey slave_key;
 120
 121   uint64_t announced_at GNUNET_PACKED;
 122
 123   uint64_t effective_since GNUNET_PACKED;
 124
 125   uint8_t did_join;
 126 };
 127
 128
 129 struct HistoryRequest
 130 {
 131   /**
 132    * Type: GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_HISTORY_REQUEST
 133    */
 134   struct GNUNET_MessageHeader header;
 135
 136   uint32_t reserved GNUNET_PACKED;
 137
 138   /**
 139    * ID for this operation.
 140    */
 141   uint64_t op_id GNUNET_PACKED;
 142
 143   uint64_t start_message_id GNUNET_PACKED;
 144
 145   uint64_t end_message_id GNUNET_PACKED;
 146
 147   uint64_t message_limit GNUNET_PACKED;
 148 };
 149
 150
 151 struct StateRequest
 152 {
 153   /**
 154    * Types:
 155    * - GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_STATE_GET
 156    * - GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_STATE_GET_PREFIX
 157    */
 158   struct GNUNET_MessageHeader header;
 159
 160   uint32_t reserved GNUNET_PACKED;
 161
 162   /**
 163    * ID for this operation.
 164    */
 165   uint64_t op_id GNUNET_PACKED;
 166
 167   /* Followed by NUL-terminated name. */
 168 };
 169
 170
 171 /**** service -> library ****/
 172
 173
 174 GNUNET_NETWORK_STRUCT_END
 175
 176 #endif