updates.

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

diff --git a/lib/silccore/silcpacket.h b/lib/silccore/silcpacket.h
index f0df279e8b32f6b17f1c0c6b270d705c7b7c790b..87eee1408ae2562b4e36696c9af541b4449cdbc4 100644 (file)
--- a/lib/silccore/silcpacket.h
+++ b/lib/silccore/silcpacket.h
@@ -174,21 +174,21 @@ typedef unsigned char SilcPacketFlags;
  *      Packet flags. Flags are defined above.
  *
  *    unsigned char *src_id
- *    uint16 src_id_len
+ *    uint8 src_id_len
  *    unsigned char src_id_type
  *
  *      Source ID, its length and type. On packet reception retuned ID's
  *      are always the hash values of the ID's from the packet.
  *
  *    unsigned char *dst_id;
- *    uint16 dst_id_len;
+ *    uint8 dst_id_len;
  *    unsigned char src_id_type;
  *
  *      Destination ID, its length and type. On packet reception retuned
  *      ID's are always the hash values of the ID's from the packet.
  *
  *    uint16 truelen
- *    uint16 padlen
+ *    uint8 padlen
  *
  *      The true lenght of the packet and the padded length of the packet.
  *      These may be set by the caller before calling any of the 
@@ -279,7 +279,7 @@ typedef struct {
  *
  * SYNOPSIS
  *
- *    typedef void (*SilcPacketParserCallback)(SilcPacketParserContext 
+ *    typedef bool (*SilcPacketParserCallback)(SilcPacketParserContext 
  *                                             *parse_context);
  *
  * DESCRIPTION
@@ -292,8 +292,16 @@ typedef struct {
  *    context. The application receiving the SilcPacketParserContext
  *    must free it.
  *
+ *    This returns TRUE if the library should continue packet processing
+ *    (assuming there is more data to be processed), and FALSE if the
+ *    upper layer does not want the library to continue but to leave the
+ *    rest of the data is the packet queue untouched.  Application may
+ *    want to do this for example if the cipher is not ready before 
+ *    processing a certain packet.  In this case the application wants
+ *    to recall the processing function with the correct cipher.
+ *
  ***/
-typedef void (*SilcPacketParserCallback)(SilcPacketParserContext 
+typedef bool (*SilcPacketParserCallback)(SilcPacketParserContext 
                                         *parse_context, void *context);
 
 /* Macros */
@@ -495,7 +503,7 @@ int silc_packet_receive(SilcSocketConnection sock);
  *
  * SYNOPSIS
  *
- *    void silc_packet_receive_process(SilcSocketConnection sock,
+ *    bool silc_packet_receive_process(SilcSocketConnection sock,
  *                                     bool local_is_router,
  *                                     SilcCipher cipher, SilcHmac hmac,
  *                                     SilcPacketParserCallback parser,
@@ -503,7 +511,7 @@ int silc_packet_receive(SilcSocketConnection sock);
  *
  * DESCRIPTION
  *
- *    Processes and decrypts the incmoing data, and calls parser callback
+ *    Processes and decrypts the incoming data, and calls parser callback
  *    for each received packet that will handle the actual packet parsing.
  *    If more than one packet was received this calls the parser multiple
  *    times.  The parser callback will get context SilcPacketParserContext
@@ -517,7 +525,7 @@ int silc_packet_receive(SilcSocketConnection sock);
  *    packet was normal or special packet.
  *
  ***/
-void silc_packet_receive_process(SilcSocketConnection sock,
+bool silc_packet_receive_process(SilcSocketConnection sock,
                                 bool local_is_router,
                                 SilcCipher cipher, SilcHmac hmac,
                                 uint32 sequence,