-improve UDP logging
[oweals/gnunet.git] / src / scalarproduct / scalarproduct.h
index 5d6b82a35bcd75c803f3ca0f331e623abd2313b3..91821a64431607ed1a99e43ade79b9c2939c0944 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2009, 2010, 2011, 2012, 2013 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2009, 2010, 2011, 2012, 2013 Christian Grothoff (and other contributing authors)
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
      Boston, MA 02111-1307, USA.
 */
-
 /**
  * @file   scalarproduct.h
  * @brief  Scalar Product Message Types
  * @author Christian M. Fuchs
- *
- * Created on September 2, 2013, 3:43 PM
  */
-
 #ifndef SCALARPRODUCT_H
 #define        SCALARPRODUCT_H
 
-#ifdef __cplusplus
-extern "C"
-{
-#endif
+GNUNET_NETWORK_STRUCT_BEGIN
+
+/**
+ * Log an error message at log-level 'level' that indicates
+ * a failure of the command 'cmd' with the message given
+ * by gcry_strerror(rc).
+ */
+#define LOG_GCRY(level, cmd, rc) do { LOG(level, _("`%s' failed at %s:%d with error: %s\n"), cmd, __FILE__, __LINE__, gcry_strerror(rc)); } while(0)
 
-///////////////////////////////////////////////////////////////////////////////
-//                     Scalar Product Message Types
-///////////////////////////////////////////////////////////////////////////////
 
 /**
- * Message type passed from client to service 
+ * Message type passed from client to service
  * to initiate a request or responder role
  */
-struct GNUNET_SCALARPRODUCT_client_request
+struct AliceComputationMessage
 {
   /**
-   * GNUNET message header
+   * GNUNET message header with type
+   * #GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_TO_ALICE
    */
   struct GNUNET_MessageHeader header;
 
   /**
    * how many elements the vector in payload contains
    */
-  uint16_t element_count GNUNET_PACKED;
+  uint32_t element_count_total GNUNET_PACKED;
+
+  /**
+   * contained elements the vector in payload contains
+   */
+  uint32_t element_count_contained GNUNET_PACKED;
 
   /**
-   * how many bytes the mask has
+   * Always zero.
    */
-  uint16_t mask_length GNUNET_PACKED;
+  uint32_t reserved GNUNET_PACKED;
 
   /**
    * the transaction/session key used to identify a session
    */
-  struct GNUNET_HashCode key;
+  struct GNUNET_HashCode session_key;
 
   /**
    * the identity of a remote peer we want to communicate with
@@ -70,85 +73,75 @@ struct GNUNET_SCALARPRODUCT_client_request
   struct GNUNET_PeerIdentity peer;
 
   /**
-   * followed by long vector[element_count] | [unsigned char mask[mask_bytes]]
+   * followed by struct GNUNET_SCALARPRODUCT_Element[]
    */
 };
-  
+
+
 /**
- * Message type passed from requesting service Alice to responding service Bob
- * to initiate a request and make bob participate in our protocol
+ * Message type passed from client to service
+ * to initiate a request or responder role
  */
-struct GNUNET_SCALARPRODUCT_service_request {
+struct BobComputationMessage
+{
   /**
-   * GNUNET message header
+   * GNUNET message header with type
+   * #GNUNET_MESSAGE_TYPE_SCALARPRODUCT_CLIENT_TO_BOB
    */
   struct GNUNET_MessageHeader header;
 
   /**
-   * how many bytes the mask has
-   */
-  uint16_t mask_length GNUNET_PACKED;
-
-  /**
-   * the length of the publickey contained within this message
+   * how many elements the vector in payload contains
    */
-  uint16_t pk_length GNUNET_PACKED;
+  uint32_t element_count_total GNUNET_PACKED;
 
   /**
-   * the transaction/session key used to identify a session
+   * contained elements the vector in payload contains
    */
-  struct GNUNET_HashCode key;
+  uint32_t element_count_contained GNUNET_PACKED;
 
   /**
-   * how many elements the vector in payload contains
+   * Always zero.
    */
-  uint16_t element_count GNUNET_PACKED;
+  uint32_t reserved GNUNET_PACKED;
 
   /**
-   * how many elements are actually included after the mask was applied.
+   * the transaction/session key used to identify a session
    */
-  uint16_t used_element_count GNUNET_PACKED;
+  struct GNUNET_HashCode session_key;
 
   /**
-   * followed by mask | public_key | vector[used_element_count]
+   * followed by struct GNUNET_SCALARPRODUCT_Element[]
    */
 };
 
+
 /**
- * Message type passed from responding service Bob to responding service Alice
- * to complete a request and allow Alice to compute the result
+ * multipart messages following `struct ComputationMessage`
  */
-struct GNUNET_SCALARPRODUCT_service_response {
+struct ComputationBobCryptodataMultipartMessage
+{
   /**
    * GNUNET message header
    */
   struct GNUNET_MessageHeader header;
 
   /**
-   * how many elements the vector in payload contains
-   */
-  uint16_t element_count GNUNET_PACKED;
-
-  /**
-   * how many elements are actually included after the mask was applied.
-   */
-  uint16_t used_element_count GNUNET_PACKED;
-
-  /**
-   * the transaction/session key used to identify a session
+   * contained elements the vector in payload contains
    */
-  struct GNUNET_HashCode key;
+  uint32_t element_count_contained GNUNET_PACKED;
 
   /**
-   * followed by s | s' | kp[] | kq[]
+   * followed by struct GNUNET_SCALARPRODUCT_Element[]
    */
 };
 
+
 /**
  * Message type passed from service client
  * to finalize a session as requester or responder
  */
-struct GNUNET_SCALARPRODUCT_client_response
+struct ClientResponseMessage
 {
   /**
    * GNUNET message header
@@ -161,28 +154,22 @@ struct GNUNET_SCALARPRODUCT_client_response
   uint32_t product_length GNUNET_PACKED;
 
   /**
-   * the transaction/session key used to identify a session
-   */
-  struct GNUNET_HashCode key;
-
-  /**
-   * the identity of a remote peer we want to communicate with
+   * Status information about the outcome of this session,
+   * An `enum GNUNET_SCALARPRODUCT_ResponseStatus` (in NBO).
    */
-  struct GNUNET_PeerIdentity peer;
+  uint32_t status GNUNET_PACKED;
 
   /**
    * Workaround for libgcrypt: -1 if negative, 0 if zero, else 1
    */
-  int8_t range;
+  int32_t range GNUNET_PACKED;
 
   /**
    * followed by product of length product_length (or nothing)
    */
 };
-  
-#ifdef __cplusplus
-}
-#endif
+
+GNUNET_NETWORK_STRUCT_END
 
 #endif /* SCALARPRODUCT_H */