Merged silc_1_0_branch to trunk.

[silc.git] / lib / silccore / silcid.h

diff --git a/lib/silccore/silcid.h b/lib/silccore/silcid.h
index 821285ee044408e2ecff05887514d7fdc1107a7f..741ad9edb8cf9e884ca0fbf7dc74d280c9c10c94 100644 (file)
--- a/lib/silccore/silcid.h
+++ b/lib/silccore/silcid.h
@@ -18,7 +18,7 @@
 
 */
 
-/****h* silccore/SilcIDAPI
+/****h* silccore/SILC ID Interface
  *
  * DESCRIPTION
  *
@@ -85,22 +85,6 @@ typedef SilcUInt16 SilcIdType;
  ***/
 typedef struct SilcIDPayloadStruct *SilcIDPayload;
 
-/****s* silccore/SilcIDAPI/SilcArgumentPayload
- *
- * NAME
- * 
- *    typedef struct SilcArgumentPayloadStruct *SilcArgumentPayload;
- *
- * DESCRIPTION
- *
- *    This context is the actual Argument Payload and is allocated
- *    by silc_argument_payload_parse and given as argument usually to
- *    all silc_argument_payload_* functions.  It is freed by the
- *    silc_argument_payload_free function.
- *
- ***/
-typedef struct SilcArgumentPayloadStruct *SilcArgumentPayload;
-
 /* Prototypes */
 
 /****f* silccore/SilcIDAPI/silc_id_payload_parse
@@ -113,7 +97,8 @@ typedef struct SilcArgumentPayloadStruct *SilcArgumentPayload;
  * DESCRIPTION
  *
  *    Parses buffer and return ID payload into payload structure. The
- *    `buffer' is raw payload buffer.
+ *    `buffer' is raw payload buffer.  The caller must free the returned
+ *    payload.
  *
  ***/
 SilcIDPayload silc_id_payload_parse(const unsigned char *payload,
@@ -123,7 +108,9 @@ SilcIDPayload silc_id_payload_parse(const unsigned char *payload,
  *
  * SYNOPSIS
  *
- *    void *silc_id_payload_parse_id(const unsigned char *data, SilcUInt32 len);
+ *    void *silc_id_payload_parse_id(const unsigned char *data, 
+ *                                   SilcUInt32 len,
+ *                                   SilcIdType *type);
  *
  * DESCRIPTION
  *
@@ -131,7 +118,8 @@ SilcIDPayload silc_id_payload_parse(const unsigned char *payload,
  *    caller must free the returned ID.
  *
  ***/
-void *silc_id_payload_parse_id(const unsigned char *data, SilcUInt32 len);
+void *silc_id_payload_parse_id(const unsigned char *data, SilcUInt32 len,
+                              SilcIdType *type);
 
 /****f* silccore/SilcIDAPI/silc_id_payload_encode
  *
@@ -269,8 +257,8 @@ typedef struct {
  */
 typedef struct {
   SilcIDIP ip;                 /* n bit IP address */
-  SilcUInt16 port;                     /* 16 bit port */
-  SilcUInt16 rnd;                      /* 16 bit random number */
+  SilcUInt16 port;             /* 16 bit port */
+  SilcUInt16 rnd;              /* 16 bit random number */
 } SilcServerID;
 /***/
 
@@ -286,7 +274,7 @@ typedef struct {
  *
  *      n bit ServerID IP address [bits 1-32 or bits 1-128]
  *      8 bit random number
- *     88 bit hash value from nickname
+ *     88 bit hash value from lowercase nickname
  *
  * SOURCE
  */
@@ -314,9 +302,9 @@ typedef struct {
  * SOURCE
  */
 typedef struct {
-  SilcIDIP ip;                                 /* n bit IP address */
-  SilcUInt16 port;                                     /* 16 bit port */
-  SilcUInt16 rnd;                                      /* 16 bit random number */
+  SilcIDIP ip;                 /* n bit IP address */
+  SilcUInt16 port;             /* 16 bit port */
+  SilcUInt16 rnd;              /* 16 bit random number */
 } SilcChannelID;
 /***/
 
@@ -434,7 +422,8 @@ typedef struct {
  * DESCRIPTION
  *
  *    Converts an ID of type `type' to data. This can be used to
- *    convert the ID's to data for inclusion in the packets.
+ *    convert the ID's to data for inclusion in the packets.  Use the
+ *    silc_id_get_len to get the length of the ID.
  *
  ***/
 unsigned char *silc_id_id2str(const void *id, SilcIdType type);
@@ -452,7 +441,8 @@ unsigned char *silc_id_id2str(const void *id, SilcIdType type);
  *    ID out of data that has been taken for example from packet.
  *
  ***/
-void *silc_id_str2id(const unsigned char *id, SilcUInt32 id_len, SilcIdType type);
+void *silc_id_str2id(const unsigned char *id, SilcUInt32 id_len,
+                    SilcIdType type);
 
 /****f* silccore/SilcIDAPI/silc_id_get_len
  *