X-Git-Url: http://git.silcnet.org/gitweb/?a=blobdiff_plain;f=lib%2Fsilccore%2Fsilcid.h;h=741ad9edb8cf9e884ca0fbf7dc74d280c9c10c94;hb=413da0f8686910f5e627393157566ae729ca99c4;hp=4205ada288dc048dac48aa56884de5d3437afcb8;hpb=7039cf461d3d2951acc2f3e123ccc1d68a55931d;p=silc.git diff --git a/lib/silccore/silcid.h b/lib/silccore/silcid.h index 4205ada2..741ad9ed 100644 --- a/lib/silccore/silcid.h +++ b/lib/silccore/silcid.h @@ -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, @@ -272,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; /***/ @@ -289,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 */ @@ -317,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; /***/ @@ -437,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);