*/
-/****h* silccore/SilcIDAPI
+/****h* silccore/SILC ID Interface
*
* DESCRIPTION
*
*
* NAME
*
- * typedef uint16 SilcIdType;
+ * typedef SilcUInt16 SilcIdType;
*
* DESCRIPTION
*
*
* SOURCE
*/
-typedef uint16 SilcIdType;
+typedef SilcUInt16 SilcIdType;
/* The SILC ID Types */
#define SILC_ID_NONE 0
***/
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
* SYNOPSIS
*
* SilcIDPayload silc_id_payload_parse(const unsigned char *payload,
- * uint32 payload_len);
+ * SilcUInt32 payload_len);
*
* 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,
- uint32 payload_len);
+ SilcUInt32 payload_len);
/****f* silccore/SilcIDAPI/silc_id_payload_parse_id
*
* SYNOPSIS
*
- * void *silc_id_payload_parse_id(const unsigned char *data, uint32 len);
+ * void *silc_id_payload_parse_id(const unsigned char *data,
+ * SilcUInt32 len,
+ * SilcIdType *type);
*
* DESCRIPTION
*
* caller must free the returned ID.
*
***/
-void *silc_id_payload_parse_id(const unsigned char *data, uint32 len);
+void *silc_id_payload_parse_id(const unsigned char *data, SilcUInt32 len,
+ SilcIdType *type);
/****f* silccore/SilcIDAPI/silc_id_payload_encode
*
*
***/
SilcBuffer silc_id_payload_encode_data(const unsigned char *id,
- uint32 id_len, SilcIdType type);
+ SilcUInt32 id_len, SilcIdType type);
/****f* silccore/SilcIDAPI/silc_id_payload_free
*
*
* SYNOPSIS
*
- * uint32 silc_id_payload_get_len(SilcIDPayload payload);
+ * SilcUInt32 silc_id_payload_get_len(SilcIDPayload payload);
*
* DESCRIPTION
*
* Returns the length of the ID in the ID Payload.
*
***/
-uint32 silc_id_payload_get_len(SilcIDPayload payload);
+SilcUInt32 silc_id_payload_get_len(SilcIDPayload payload);
/****s* silccore/SilcIDAPI/SilcIDIP
*
*/
typedef struct {
unsigned char data[16]; /* IP data (in MSB first order) */
- uint8 data_len; /* Length of the data (4 or 16) */
+ SilcUInt8 data_len; /* Length of the data (4 or 16) */
} SilcIDIP;
/***/
*/
typedef struct {
SilcIDIP ip; /* n bit IP address */
- uint16 port; /* 16 bit port */
- uint16 rnd; /* 16 bit random number */
+ SilcUInt16 port; /* 16 bit port */
+ SilcUInt16 rnd; /* 16 bit random number */
} SilcServerID;
/***/
*
* 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
*/
* SOURCE
*/
typedef struct {
- SilcIDIP ip; /* n bit IP address */
- uint16 port; /* 16 bit port */
- uint16 rnd; /* 16 bit random number */
+ SilcIDIP ip; /* n bit IP address */
+ SilcUInt16 port; /* 16 bit port */
+ SilcUInt16 rnd; /* 16 bit random number */
} SilcChannelID;
/***/
* 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);
*
* SYNOPSIS
*
- * void *silc_id_str2id(const unsigned char *id, uint32 id_len,
+ * void *silc_id_str2id(const unsigned char *id, SilcUInt32 id_len,
* SilcIdType type);
*
* DESCRIPTION
* ID out of data that has been taken for example from packet.
*
***/
-void *silc_id_str2id(const unsigned char *id, uint32 id_len, SilcIdType type);
+void *silc_id_str2id(const unsigned char *id, SilcUInt32 id_len,
+ SilcIdType type);
/****f* silccore/SilcIDAPI/silc_id_get_len
*
* SYNOPSIS
*
- * uint32 silc_id_get_len(const void *id, SilcIdType type);
+ * SilcUInt32 silc_id_get_len(const void *id, SilcIdType type);
*
* DESCRIPTION
*
* Returns the true length of the ID of the type `type'.
*
***/
-uint32 silc_id_get_len(const void *id, SilcIdType type);
+SilcUInt32 silc_id_get_len(const void *id, SilcIdType type);
/****f* silccore/SilcIDAPI/silc_id_dup
*