From: Pekka Riikonen <priikone@silcnet.org>
Date: Fri, 16 Feb 2001 10:43:38 +0000 (+0000)
Subject: 	update
X-Git-Tag: SILC.0.1~218
X-Git-Url: http://git.silcnet.org/gitweb/?a=commitdiff_plain;h=77319506629cc4adb03af69774aba1de3bc26a5b;p=silc.git

	update
---

diff --git a/lib/silccore/silcsockconn.c b/lib/silccore/silcsockconn.c
index 4f5e60d2..a701da5c 100644
--- a/lib/silccore/silcsockconn.c
+++ b/lib/silccore/silcsockconn.c
@@ -79,7 +79,12 @@ SILC_TASK_CALLBACK(silc_socket_heartbeat)
 }
 
 /* Sets the heartbeat timeout and prepares the socket for performing
-   heartbeat in `heartbeat' intervals (seconds). */
+   heartbeat in `heartbeat' intervals (seconds). The `hb_context' is
+   allocated by the application and will be sent as argument to the
+   `hb_callback' function that is called when the `heartbeat' timeout
+   expires.  The callback `hb_context' won't be touched by the library
+   but will be freed automatically when calling silc_socket_free.  The
+   `timeout_queue' is the application's scheduler timeout queue. */
 
 void silc_socket_set_heartbeat(SilcSocketConnection sock, 
 			       unsigned long heartbeat,