Comments fixes.
authorPekka Riikonen <priikone@silcnet.org>
Sun, 20 Oct 2002 11:59:54 +0000 (11:59 +0000)
committerPekka Riikonen <priikone@silcnet.org>
Sun, 20 Oct 2002 11:59:54 +0000 (11:59 +0000)
lib/silcclient/client_ops_example.c
lib/silcclient/silcclient.h

index 32debf66de2333e99cb8bf4050d73add3690725b..b5f5c2684030c2fc45d20037b992f329e7f19a4e 100644 (file)
@@ -11,7 +11,7 @@
 /* Message sent to the application by library. `conn' associates the
    message to a specific connection.  `conn', however, may be NULL.
    The `type' indicates the type of the message sent by the library.
-   The applicationi can for example filter the message according the
+   The application can for example filter the message according the
    type. */
 
 static void
@@ -23,8 +23,10 @@ silc_say(SilcClient client, SilcClientConnection conn,
 
 
 /* Message for a channel. The `sender' is the sender of the message
-   The `channel' is the channel. The `msg' is the message.  Note that
-   `msg' maybe NULL. */
+   The `channel' is the channel. The `message' is the message.  Note
+   that `message' maybe NULL.  The `flags' indicates message flags
+   and it is used to determine how the message can be interpreted
+   (like it may tell the message is multimedia message). */
 
 static void
 silc_channel_message(SilcClient client, SilcClientConnection conn,
@@ -37,7 +39,10 @@ silc_channel_message(SilcClient client, SilcClientConnection conn,
 
 
 /* Private message to the client. The `sender' is the sender of the
-   message. */
+   message. The message is `message'and maybe NULL.  The `flags'  
+   indicates message flags  and it is used to determine how the message
+   can be interpreted (like it may tell the message is multimedia
+   message). */
 
 static void
 silc_private_message(SilcClient client, SilcClientConnection conn,
@@ -154,8 +159,9 @@ silc_get_auth_method(SilcClient client, SilcClientConnection conn,
 
 /* Verifies received public key. The `conn_type' indicates which entity
    (server, client etc.) has sent the public key. If user decides to trust
-   the key may be saved as trusted public key for later use. The
-   `completion' must be called after the public key has been verified. */
+   the application may save the key as trusted public key for later
+   use. The `completion' must be called after the public key has been
+   verified. */
 
 static void
 silc_verify_public_key(SilcClient client, SilcClientConnection conn,
@@ -204,7 +210,7 @@ silc_failure(SilcClient client, SilcClientConnection conn,
    silc_client_perform_key_agreement). If TRUE is returned also the
    `completion' and `context' arguments must be set by the application. */
 
-static int
+static bool
 silc_key_agreement(SilcClient client, SilcClientConnection conn,
                   SilcClientEntry client_entry, const char *hostname,
                   SilcUInt16 port, SilcKeyAgreementCallback *completion,
index e42ec1fe4c529a47bd0e3b23deeb3d0be9757432..bf46038cd1cd1862ecf4bcedcc784a1ad3c77867 100644 (file)
@@ -297,14 +297,16 @@ typedef struct {
   /* Message sent to the application by library. `conn' associates the
      message to a specific connection.  `conn', however, may be NULL. 
      The `type' indicates the type of the message sent by the library.
-     The applicationi can for example filter the message according the
+     The application can for example filter the message according the
      type. */
   void (*say)(SilcClient client, SilcClientConnection conn, 
              SilcClientMessageType type, char *msg, ...);
 
   /* Message for a channel. The `sender' is the sender of the message 
-     The `channel' is the channel. The `msg' is the message.  Note that
-     `msg' maybe NULL. */
+     The `channel' is the channel. The `message' is the message.  Note 
+     that `message' maybe NULL.  The `flags' indicates message flags 
+     and it is used to determine how the message can be interpreted
+     (like it may tell the message is multimedia message). */
   void (*channel_message)(SilcClient client, SilcClientConnection conn, 
                          SilcClientEntry sender, SilcChannelEntry channel, 
                          SilcMessageFlags flags,
@@ -312,7 +314,10 @@ typedef struct {
                          SilcUInt32 message_len);
 
   /* Private message to the client. The `sender' is the sender of the
-     message. */
+     message. The message is `message'and maybe NULL.  The `flags' 
+     indicates message flags  and it is used to determine how the message 
+     can be interpreted (like it may tell the message is multimedia 
+     message). */
   void (*private_message)(SilcClient client, SilcClientConnection conn,
                          SilcClientEntry sender, SilcMessageFlags flags,
                          const unsigned char *message,
@@ -394,8 +399,9 @@ typedef struct {
 
   /* Verifies received public key. The `conn_type' indicates which entity
      (server, client etc.) has sent the public key. If user decides to trust
-     the key may be saved as trusted public key for later use. The 
-     `completion' must be called after the public key has been verified. */
+     the application may save the key as trusted public key for later 
+     use. The `completion' must be called after the public key has been 
+     verified. */
   void (*verify_public_key)(SilcClient client, SilcClientConnection conn,
                            SilcSocketType conn_type, unsigned char *pk, 
                            SilcUInt32 pk_len, SilcSKEPKType pk_type,
@@ -425,10 +431,10 @@ typedef struct {
      desired (application may start it later by calling the function
      silc_client_perform_key_agreement). If TRUE is returned also the
      `completion' and `context' arguments must be set by the application. */
-  int (*key_agreement)(SilcClient client, SilcClientConnection conn,
-                      SilcClientEntry client_entry, const char *hostname,
-                      SilcUInt16 port, SilcKeyAgreementCallback *completion,
-                      void **context);
+  bool (*key_agreement)(SilcClient client, SilcClientConnection conn,
+                       SilcClientEntry client_entry, const char *hostname,
+                       SilcUInt16 port, SilcKeyAgreementCallback *completion,
+                       void **context);
 
   /* Notifies application that file transfer protocol session is being
      requested by the remote client indicated by the `client_entry' from