consensus: destroy set handles
[oweals/gnunet.git] / src / psyc / psyc.h
index 1ffda5d082e85bf6894bcdefc6690a910607926c..c1ce466a939ee9377b664e296c6ea4f05263dc58 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * This file is part of GNUnet
- * (C) 2013 Christian Grothoff (and other contributing authors)
+ * Copyright (C) 2013 GNUnet e.V.
  *
  * GNUnet is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published
@@ -14,8 +14,8 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with GNUnet; see the file COPYING.  If not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
  */
 
 /**
@@ -32,7 +32,8 @@
 
 
 int
-GNUNET_PSYC_check_message_parts (uint16_t data_size, const char *data);
+GNUNET_PSYC_check_message_parts (uint16_t data_size, const char *data,
+                                 uint16_t *first_ptype, uint16_t *last_ptype);
 
 void
 GNUNET_PSYC_log_message (enum GNUNET_ErrorType kind,
@@ -41,84 +42,30 @@ GNUNET_PSYC_log_message (enum GNUNET_ErrorType kind,
 
 enum MessageState
 {
-  MSG_STATE_START = 0,
-  MSG_STATE_HEADER = 1,
-  MSG_STATE_METHOD = 2,
+  MSG_STATE_START    = 0,
+  MSG_STATE_HEADER   = 1,
+  MSG_STATE_METHOD   = 2,
   MSG_STATE_MODIFIER = 3,
   MSG_STATE_MOD_CONT = 4,
-  MSG_STATE_DATA = 5,
-  MSG_STATE_END = 6,
-  MSG_STATE_CANCEL = 7,
+  MSG_STATE_DATA     = 5,
+  MSG_STATE_END      = 6,
+  MSG_STATE_CANCEL   = 7,
+  MSG_STATE_ERROR    = 8,
 };
 
 
-GNUNET_NETWORK_STRUCT_BEGIN
-
-/**** service -> library ****/
-
-/**
- * Answer from service to client about last operation.
- */
-struct OperationResult
+enum MessageFragmentState
 {
-  /**
-   * Type: GNUNET_MESSAGE_TYPE_PSYCSTORE_RESULT_CODE
-   */
-  struct GNUNET_MessageHeader header;
-
-  /**
-   * Operation ID.
-   */
-  uint32_t op_id GNUNET_PACKED;
-
-  /**
-   * Status code for the operation.
-   */
-  int64_t result_code GNUNET_PACKED;
-
-  /* followed by NUL-terminated error message (on error) */
+  MSG_FRAG_STATE_START    = 0,
+  MSG_FRAG_STATE_HEADER   = 1,
+  MSG_FRAG_STATE_DATA     = 2,
+  MSG_FRAG_STATE_END      = 3,
+  MSG_FRAG_STATE_CANCEL   = 4,
+  MSG_FRAG_STATE_DROP     = 5,
 };
 
 
-struct CountersResult
-{
-  /**
-   * Type: GNUNET_MESSAGE_TYPE_PSYC_RESULT_COUNTERS
-   */
-  struct GNUNET_MessageHeader header;
-
-  /**
-   * Status code for the operation.
-   */
-  int32_t result_code GNUNET_PACKED;
-
-  uint64_t max_message_id;
-};
-
-
-#if REMOVE
-/**
- * Transmit acknowledgment.
- *
- * Sent after the last GNUNET_PSYC_MessageModifier and after each
- * GNUNET_PSYC_MessageData.
- *
- * This message acknowledges previously received messages and asks for the next
- * fragment of data.
- */
-struct TransmitAck
-{
-  /**
-   * Type: GNUNET_MESSAGE_TYPE_PSYC_TRANSMIT_ACK
-   */
-  struct GNUNET_MessageHeader header;
-
-  /**
-   * Buffer space available for the next data fragment.
-   */
-  uint16_t buf_avail;
-};
-#endif
+GNUNET_NETWORK_STRUCT_BEGIN
 
 
 /**** library -> service ****/
@@ -131,9 +78,9 @@ struct MasterStartRequest
    */
   struct GNUNET_MessageHeader header;
 
-  struct GNUNET_CRYPTO_EddsaPrivateKey channel_key;
-
   uint32_t policy GNUNET_PACKED;
+
+  struct GNUNET_CRYPTO_EddsaPrivateKey channel_key;
 };
 
 
@@ -146,97 +93,86 @@ struct SlaveJoinRequest
 
   uint32_t relay_count GNUNET_PACKED;
 
-  struct GNUNET_CRYPTO_EddsaPublicKey channel_key;
+  struct GNUNET_CRYPTO_EddsaPublicKey channel_pub_key;
 
-  struct GNUNET_CRYPTO_EddsaPrivateKey slave_key;
+  struct GNUNET_CRYPTO_EcdsaPrivateKey slave_key;
 
   struct GNUNET_PeerIdentity origin;
 
+  uint32_t flags GNUNET_PACKED;
+
   /* Followed by struct GNUNET_PeerIdentity relays[relay_count] */
+
+  /* Followed by struct GNUNET_MessageHeader join_msg */
 };
 
 
-struct ChannelSlaveAdd
+struct ChannelMembershipStoreRequest
 {
   /**
-   * Type: GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_SLAVE_ADD
+   * Type: GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_MEMBERSHIP_STORE
    */
   struct GNUNET_MessageHeader header;
 
-  uint32_t reserved;
-
-  struct GNUNET_CRYPTO_EddsaPublicKey *slave_key;
+  uint32_t reserved GNUNET_PACKED;
 
-  uint64_t announced_at;
+  uint64_t op_id GNUNET_PACKED;
 
-  uint64_t effective_since;
-};
-
-
-struct ChannelSlaveRemove
-{
-  /**
-   * Type: GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_SLAVE_RM
-   */
-  struct GNUNET_MessageHeader header;
+  struct GNUNET_CRYPTO_EcdsaPublicKey slave_pub_key;
 
-  uint32_t reserved;
+  uint64_t announced_at GNUNET_PACKED;
 
-  struct GNUNET_CRYPTO_EddsaPublicKey *slave_key;
+  uint64_t effective_since GNUNET_PACKED;
 
-  uint64_t announced_at;
+  uint8_t did_join;
 };
 
 
-struct StoryRequest
+struct HistoryRequest
 {
   /**
-   * Type: GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_STORY_REQUEST
+   * Type: GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_HISTORY_REQUEST
    */
   struct GNUNET_MessageHeader header;
 
-  uint64_t op_id;
+  uint32_t reserved GNUNET_PACKED;
 
-  uint64_t start_message_id;
-
-  uint64_t end_message_id;
-};
-
-
-struct StateQuery
-{
   /**
-   * Type: GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_STATE_QUERY
+   * ID for this operation.
    */
-  struct GNUNET_MessageHeader header;
+  uint64_t op_id GNUNET_PACKED;
 
-  uint64_t op_id;
+  uint64_t start_message_id GNUNET_PACKED;
 
-  /* Followed by NUL-terminated name. */
+  uint64_t end_message_id GNUNET_PACKED;
+
+  uint64_t message_limit GNUNET_PACKED;
 };
 
 
-struct StateResult
+struct StateRequest
 {
   /**
-   * Type: GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_STATE_RESULT
+   * Types:
+   * - GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_STATE_GET
+   * - GNUNET_MESSAGE_TYPE_PSYC_CHANNEL_STATE_GET_PREFIX
    */
   struct GNUNET_MessageHeader header;
 
-  /**
-   * Size of name, including NUL terminator.
-   */
-  uint16_t name_size GNUNET_PACKED;
+  uint32_t reserved GNUNET_PACKED;
 
   /**
-   * OR'd StateOpFlags
+   * ID for this operation.
    */
-  uint8_t flags;
+  uint64_t op_id GNUNET_PACKED;
 
-  /* Followed by NUL-terminated name, then the value. */
+  /* Followed by NUL-terminated name. */
 };
 
 
+/**** service -> library ****/
+
+
 GNUNET_NETWORK_STRUCT_END
 
 #endif