Watcher list support added.
[silc.git] / lib / silccore / silcprivate.h
index f8beca27e4c418f96b6e1486aa4311b9abb1df5f..bede78e2f3dd23d388175672223fa48be2c8fae7 100644 (file)
@@ -18,7 +18,7 @@
 
 */
 
-/****h* silccore/SilcPrivateAPI
+/****h* silccore/SILC Private Message Interface
  *
  * DESCRIPTION
  *
@@ -56,7 +56,7 @@ typedef struct SilcPrivateMessagePayloadStruct *SilcPrivateMessagePayload;
  *
  *    SilcPrivateMessagePayload 
  *    silc_private_message_payload_parse(unsigned char *payload,
- *                                       uint32 payload_len,
+ *                                       SilcUInt32 payload_len,
  *                                       SilcCipher cipher);
  *
  * DESCRIPTION
@@ -67,29 +67,32 @@ typedef struct SilcPrivateMessagePayloadStruct *SilcPrivateMessagePayload;
  ***/
 SilcPrivateMessagePayload 
 silc_private_message_payload_parse(unsigned char *payload,
-                                  uint32 payload_len,
+                                  SilcUInt32 payload_len,
                                   SilcCipher cipher);
 
 /****f* silccore/SilcPrivateAPI/silc_private_message_payload_encode
  *
  * SYNOPSIS
  *
- *    SilcBuffer silc_private_message_payload_encode(uint16 flags,
- *                                                   uint16 data_len,
+ *    SilcBuffer silc_private_message_payload_encode(SilcUInt16 flags,
+ *                                                   SilcUInt16 data_len,
  *                                                   const unsigned char *data,
- *                                                   SilcCipher cipher);
+ *                                                   SilcCipher cipher,
+ *                                                   SilcRng rng);
  *
  * DESCRIPTION
  *
  *    Encodes private message payload into a buffer and returns it.  If
  *    the cipher is provided the packet is also encrypted here.  It is provided
- *    if the private message private keys are used.
+ *    if the private message private keys are used.  If the `rng' is NULL
+ *    then global RNG is used, if non-NULL then `rng' is used.
  *
  ***/
-SilcBuffer silc_private_message_payload_encode(uint16 flags,
-                                              uint16 data_len,
+SilcBuffer silc_private_message_payload_encode(SilcUInt16 flags,
+                                              SilcUInt16 data_len,
                                               const unsigned char *data,
-                                              SilcCipher cipher);
+                                              SilcCipher cipher,
+                                              SilcRng rng);
 
 /****f* silccore/SilcPrivateAPI/silc_private_message_payload_free
  *
@@ -109,7 +112,7 @@ void silc_private_message_payload_free(SilcPrivateMessagePayload payload);
  *
  * SYNOPSIS
  *
- *    uint16 
+ *    SilcUInt16 
  *    silc_private_message_get_flags(SilcPrivateMessagePayload payload);
  *
  * DESCRIPTION
@@ -119,7 +122,7 @@ void silc_private_message_payload_free(SilcPrivateMessagePayload payload);
  *    channel message flags.
  *
  ***/
-uint16 
+SilcUInt16 
 silc_private_message_get_flags(SilcPrivateMessagePayload payload);
 
 /****f* silccore/SilcPrivateAPI/silc_private_message_get_message
@@ -127,8 +130,8 @@ silc_private_message_get_flags(SilcPrivateMessagePayload payload);
  * SYNOPSIS
  *
  *    unsigned char *
- *    silc_private_message_get_nickname(SilcPrivateMessagePayload payload,
- *                                      uint32 *nickname_len);
+ *    silc_private_message_get_message(SilcPrivateMessagePayload payload,
+ *                                     SilcUInt32 *message_len);
  *
  * DESCRIPTION
  *
@@ -137,6 +140,6 @@ silc_private_message_get_flags(SilcPrivateMessagePayload payload);
  ***/
 unsigned char *
 silc_private_message_get_message(SilcPrivateMessagePayload payload,
-                                uint32 *message_len);
+                                SilcUInt32 *message_len);
 
 #endif