Integer type name change.
[silc.git] / lib / silccore / silcnotify.h
index 64097eadaa69e3eaf4a0c9fefe6d7e7742d848fb..67e8894f34b8ee1f70f19842a56448dda41bea52 100644 (file)
@@ -1,29 +1,29 @@
-/****h* silccore/silcnotify.h
- *
- * NAME
- *
- * silcnotify.h
- *
- * COPYRIGHT
- *
- * Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
- *
- * Copyright (C) 1997 - 2000 Pekka Riikonen
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+/*
+  silcnotify.h
+  Author: Pekka Riikonen <priikone@silcnet.org>
+  Copyright (C) 1997 - 2001 Pekka Riikonen
+  This program is free software; you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation; either version 2 of the License, or
+  (at your option) any later version.
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+*/
+
+/****h* silccore/SilcNotifyAPI
  *
  * DESCRIPTION
  *
  * Implementation of the Notify Payload. Notify Payload is used usually
- * servers to send different kind of important notify messages to other
+ * by servers to send different kind of important notify messages to other
  * servers and to clients.
  *
  ***/
@@ -51,7 +51,7 @@ typedef struct SilcNotifyPayloadStruct *SilcNotifyPayload;
  *
  * NAME
  * 
- *    typedef uint16 SilcNotifyType;
+ *    typedef SilcUInt16 SilcNotifyType;
  *
  * DESCRIPTION
  *
@@ -59,7 +59,7 @@ typedef struct SilcNotifyPayloadStruct *SilcNotifyPayload;
  *
  * SOURCE
  */
-typedef uint16 SilcNotifyType;
+typedef SilcUInt16 SilcNotifyType;
 
 /* SILC notify types. Server may send these notify types to client to
    notify of some action. */
@@ -87,7 +87,9 @@ typedef uint16 SilcNotifyType;
  *
  * SYNOPSIS
  *
- *    SilcNotifyPayload silc_notify_payload_parse(SilcBuffer buffer);
+ *    SilcNotifyPayload 
+ *    silc_notify_payload_parse(const unsigned char *payload,
+ *                              SilcUInt32 payload_len);
  *
  * DESCRIPTION
  *
@@ -95,23 +97,24 @@ typedef uint16 SilcNotifyType;
  *    The `buffer' is the raw payload data.
  *
  ***/
-SilcNotifyPayload silc_notify_payload_parse(SilcBuffer buffer);
+SilcNotifyPayload silc_notify_payload_parse(const unsigned char *payload,
+                                           SilcUInt32 payload_len);
 
 /****f* silccore/SilcNotifyAPI/silc_notify_payload_encode
  *
  * SYNOPSIS
  *
- *    SilcBuffer silc_notify_payload_encode(SilcNotifyType type, uint32 argc, 
+ *    SilcBuffer silc_notify_payload_encode(SilcNotifyType type, SilcUInt32 argc, 
  *                                          va_list ap);
  *
  * DESCRIPTION
  *
  *    Encode notify payload with variable argument list. If `argc' is > 0
  *    argument payloads will be associated to the notify payload. Variable
- *    arguments must be {usigned char *, uint32 (len)}.
+ *    arguments must be {usigned char *, SilcUInt32 (len)}.
  *
  ***/
-SilcBuffer silc_notify_payload_encode(SilcNotifyType type, uint32 argc, 
+SilcBuffer silc_notify_payload_encode(SilcNotifyType type, SilcUInt32 argc, 
                                      va_list ap);
 
 /****f* silccore/SilcNotifyAPI/silc_notify_payload_encode_args
@@ -119,7 +122,7 @@ SilcBuffer silc_notify_payload_encode(SilcNotifyType type, uint32 argc,
  * SYNOPSIS
  *
  *    SilcBuffer silc_notify_payload_encode_args(SilcNotifyType type, 
- *                                               uint32 argc,
+ *                                               SilcUInt32 argc,
  *                                               SilcBuffer args);
  *
  * DESCRIPTION
@@ -129,7 +132,7 @@ SilcBuffer silc_notify_payload_encode(SilcNotifyType type, uint32 argc,
  *
  ***/
 SilcBuffer silc_notify_payload_encode_args(SilcNotifyType type, 
-                                          uint32 argc,
+                                          SilcUInt32 argc,
                                           SilcBuffer args);
 
 /****f* silccore/SilcNotifyAPI/silc_notify_payload_free
@@ -162,14 +165,14 @@ SilcNotifyType silc_notify_get_type(SilcNotifyPayload payload);
  *
  * SYNOPSIS
  *
- *    uint32 silc_notify_get_arg_num(SilcNotifyPayload payload);
+ *    SilcUInt32 silc_notify_get_arg_num(SilcNotifyPayload payload);
  *
  * DESCRIPTION
  *
  *    Return the number of the arguments associated with the Notify Payload.
  *
  ***/
-uint32 silc_notify_get_arg_num(SilcNotifyPayload payload);
+SilcUInt32 silc_notify_get_arg_num(SilcNotifyPayload payload);
 
 /****f* silccore/SilcNotifyAPI/silc_notify_get_args
  *