updates.

[silc.git] / lib / silcutil / silcsockconn.h

diff --git a/lib/silcutil/silcsockconn.h b/lib/silcutil/silcsockconn.h
index 658c3acda1755f12565d1b2b7f6360c553bd6091..89de51aace822bc5f023e9f77a4013172b85100c 100644 (file)
--- a/lib/silcutil/silcsockconn.h
+++ b/lib/silcutil/silcsockconn.h
@@ -1,24 +1,24 @@
-/****h* silcutil/silcsockconn.h
- *
- * NAME
- *
- * silcsockconn.h
- *
- * COPYRIGHT
- *
- * Author: Pekka Riikonen <priikone@silnet.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.
+/*
+ 
+  silcsockconn.h
+ 
+  Author: Pekka Riikonen <priikone@silnet.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* silcutil/SilcSocketConnectionAPI
  *
  * DESCRIPTION
  *
@@ -333,7 +333,7 @@ typedef void (*SilcSocketConnectionHBCb)(SilcSocketConnection sock,
  *                                   uint32 heartbeat,
  *                                   void *hb_context,
  *                                   SilcSocketConnectionHBCb hb_callback,
- *                                   void *timeout_queue);
+ *                                   SilcSchedule schedule);
  *
  * DESCRIPTION
  *
@@ -343,14 +343,14 @@ typedef void (*SilcSocketConnectionHBCb)(SilcSocketConnection sock,
  *    `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.
+ *    `schedule' is the application's scheduler.
  *
  ***/
 void silc_socket_set_heartbeat(SilcSocketConnection sock, 
                               uint32 heartbeat,
                               void *hb_context,
                               SilcSocketConnectionHBCb hb_callback,
-                              void *timeout_queue);
+                              SilcSchedule schedule);
 
 /****f* silcutil/SilcSocketConnectionAPI/SilcSocketHostLookupCb
  *
@@ -373,9 +373,10 @@ typedef void (*SilcSocketHostLookupCb)(SilcSocketConnection sock,
  * SYNOPSIS
  *
  *    void silc_socket_host_lookup(SilcSocketConnection sock,
+ *                                 bool port_lookup,
  *                                 SilcSocketHostLookupCb callback,
  *                                 void *context,
- *                                 void *timeout_queue);
+ *                                 SilcSchedule schedule);
  *
  * DESCRIPTION
  *
@@ -383,11 +384,11 @@ typedef void (*SilcSocketHostLookupCb)(SilcSocketConnection sock,
  *    specified socket connection. This may be called when the socket
  *    connection is created and the full IP address and fully qualified
  *    domain name information is desired. The `callback' with `context'
- *    will be called after the lookup is performed. The `timeout_queue'
- *    is the application's scheduler timeout queue which the lookup
- *    routine needs. If the socket connection is freed during the
- *    lookup the library will automatically cancel the lookup and
- *    the `callback' will not be called.
+ *    will be called after the lookup is performed. The `schedule'
+ *    is the application's scheduler which the lookup routine needs. 
+ *    If the socket connection is freed during the lookup the library
+ *    will automatically cancel the lookup and the `callback' will not be
+ *    called.
  *
  *    If `port_lookup' is TRUE then the remote port of the socket 
  *    connection is resolved. After the information is resolved they
@@ -401,6 +402,6 @@ void silc_socket_host_lookup(SilcSocketConnection sock,
                             bool port_lookup,
                             SilcSocketHostLookupCb callback,
                             void *context,
-                            void *timeout_queue);
+                            SilcSchedule schedule);
 
 #endif