really make GNUNET_SCHEDULER_run_from_driver more graceful (must have been late)
[oweals/gnunet.git] / src / identity / identity.h
index 063391c1e00be547a8aa82be3ebc3f5c6f7a6f37..aae650a79f36c4f1df4c466ed987c5a8c75d6b85 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 Liceidentity as published
@@ -14,8 +14,8 @@
 
      You should have received a copy of the GNU General Public Liceidentity
      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.
 */
 
 /**
@@ -39,15 +39,16 @@ GNUNET_NETWORK_STRUCT_BEGIN
  * GET_DEFAULT maybe answered with this message on failure;
  * CREATE and RENAME will always be answered with this message.
  */
-struct GNUNET_IDENTITY_ResultCodeMessage
+struct ResultCodeMessage
 {
   /**
-   * Type: GNUNET_MESSAGE_TYPE_IDENTITY_RESULT_CODE
+   * Type: #GNUNET_MESSAGE_TYPE_IDENTITY_RESULT_CODE
    */
   struct GNUNET_MessageHeader header;
 
   /**
    * Status code for the last operation, in NBO.
+   * (currently not used).
    */
   uint32_t result_code GNUNET_PACKED;
 
@@ -59,30 +60,30 @@ struct GNUNET_IDENTITY_ResultCodeMessage
 /**
  * Service informs client about status of a pseudonym.
  */
-struct GNUNET_IDENTITY_UpdateMessage
+struct UpdateMessage
 {
   /**
-   * Type: GNUNET_MESSAGE_TYPE_IDENTITY_UPDATE
+   * Type: #GNUNET_MESSAGE_TYPE_IDENTITY_UPDATE
    */
   struct GNUNET_MessageHeader header;
 
   /**
-   * Number of bytes in identity name string including 0-termination, in NBO;
-   * 0 if the identity was deleted.
+   * Number of bytes in ego name string including 0-termination, in NBO;
+   * 0 if the ego was deleted.
    */
   uint16_t name_len GNUNET_PACKED;
 
   /**
-   * Always zero.
+   * Usually #GNUNET_NO, #GNUNET_YES to signal end of list.
    */
-  uint16_t reserved GNUNET_PACKED;
+  uint16_t end_of_list GNUNET_PACKED;
 
   /**
-   * Public key of the identity that we provide an update about.
+   * The private key
    */
-  struct GNUNET_CRYPTO_EccPrivateKeyBinaryEncoded private_key;
+  struct GNUNET_CRYPTO_EcdsaPrivateKey private_key;
 
-  /* followed by 0-terminated identity name */
+  /* followed by 0-terminated ego name */
 
 };
 
@@ -92,10 +93,10 @@ struct GNUNET_IDENTITY_UpdateMessage
  * Client requests knowledge about default identity for
  * a subsystem from identity service.
  */
-struct GNUNET_IDENTITY_GetDefaultMessage
+struct GetDefaultMessage
 {
   /**
-   * Type: GNUNET_MESSAGE_TYPE_IDENTITY_GET_DEFAULT
+   * Type: #GNUNET_MESSAGE_TYPE_IDENTITY_GET_DEFAULT
    */
   struct GNUNET_MessageHeader header;
 
@@ -119,10 +120,10 @@ struct GNUNET_IDENTITY_GetDefaultMessage
  * Used from service to client as a result to the GET_DEFAULT
  * message, used from client to service to SET_DEFAULT.
  */
-struct GNUNET_IDENTITY_SetDefaultMessage
+struct SetDefaultMessage
 {
   /**
-   * Type: GNUNET_MESSAGE_TYPE_IDENTITY_SET_DEFAULT
+   * Type: #GNUNET_MESSAGE_TYPE_IDENTITY_SET_DEFAULT
    */
   struct GNUNET_MessageHeader header;
 
@@ -137,9 +138,9 @@ struct GNUNET_IDENTITY_SetDefaultMessage
   uint16_t reserved GNUNET_PACKED;
 
   /**
-   * Public key of the identity to use.
+   * The private key
    */
-  struct GNUNET_CRYPTO_EccPrivateKeyBinaryEncoded private_key;
+  struct GNUNET_CRYPTO_EcdsaPrivateKey private_key;
 
   /* followed by 0-terminated service name */
 
@@ -148,12 +149,12 @@ struct GNUNET_IDENTITY_SetDefaultMessage
 
 /**
  * Client requests creation of an identity.  Service
- * will respond with a result code.  
+ * will respond with a result code.
  */
-struct GNUNET_IDENTITY_CreateRequestMessage
+struct CreateRequestMessage
 {
   /**
-   * Type: GNUNET_MESSAGE_TYPE_IDENTITY_CREATE
+   * Type: #GNUNET_MESSAGE_TYPE_IDENTITY_CREATE
    */
   struct GNUNET_MessageHeader header;
 
@@ -168,9 +169,9 @@ struct GNUNET_IDENTITY_CreateRequestMessage
   uint16_t reserved GNUNET_PACKED;
 
   /**
-   * Public key of the identity to use.
+   * The private key
    */
-  struct GNUNET_CRYPTO_EccPrivateKeyBinaryEncoded private_key;
+  struct GNUNET_CRYPTO_EcdsaPrivateKey private_key;
 
   /* followed by 0-terminated identity name */
 
@@ -181,10 +182,10 @@ struct GNUNET_IDENTITY_CreateRequestMessage
  * Client requests renaming of an identity.  Service
  * will respond with a result code.
  */
-struct GNUNET_IDENTITY_RenameMessage
+struct RenameMessage
 {
   /**
-   * Type: GNUNET_MESSAGE_TYPE_IDENTITY_RENAME
+   * Type: #GNUNET_MESSAGE_TYPE_IDENTITY_RENAME
    */
   struct GNUNET_MessageHeader header;
 
@@ -207,10 +208,10 @@ struct GNUNET_IDENTITY_RenameMessage
  * Client requests deletion of an identity.  Service
  * will respond with a result code.
  */
-struct GNUNET_IDENTITY_DeleteMessage
+struct DeleteMessage
 {
   /**
-   * Type: GNUNET_MESSAGE_TYPE_IDENTITY_DELETE
+   * Type: #GNUNET_MESSAGE_TYPE_IDENTITY_DELETE
    */
   struct GNUNET_MessageHeader header;