updates.

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

diff --git a/lib/silcutil/silcnet.h b/lib/silcutil/silcnet.h
index 949a4a60bd9c5be6da923d384e8dcdeb2885caa5..b9978d6e9a16fd093688d756dba194ad0c76c47c 100644 (file)
--- a/lib/silcutil/silcnet.h
+++ b/lib/silcutil/silcnet.h
@@ -1,24 +1,24 @@
-/****h* silcutil/silcnet.h
- *
- * NAME
- *
- * silcnet.h
- *
- * COPYRIGHT
- *
- * 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.
+/*
+
+  silcnet.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* silcutil/SilcNetAPI
  *
  * DESCRIPTION
  *
@@ -31,7 +31,7 @@
  * calling the silc_net_win32_uninit function. The initializing must be
  * done in order to assure that the SILC Net API works correctly.
  *
- */
+ ***/
 
 #ifndef SILCNET_H
 #define SILCNET_H
@@ -53,7 +53,7 @@
  *    the created socket or -1 on error.
  *
  ***/
-int silc_net_create_server(int port, char *ip_addr);
+int silc_net_create_server(int port, const char *ip_addr);
 
 /****f* silcutil/SilcNetAPI/silc_net_close_server
  *
@@ -72,32 +72,41 @@ void silc_net_close_server(int sock);
  *
  * SYNOPSIS
  *
- *    int silc_net_create_connection(int port, char *host);
+ *    int silc_net_create_connection(const char *local_ip, int port, 
+ *                                   const char *host);
  *
  * DESCRIPTION
  *
  *    Creates a connection (TCP/IP) to a remote host. Returns the connection
  *    socket or -1 on error. This blocks the process while trying to create
- *    the connection.
+ *    the connection. If the `local_ip' is not NULL then this will bind
+ *    the `local_ip' address to a port before creating the connection.  If
+ *    it is NULL then this will directly create the connection.
  *
  ***/
-int silc_net_create_connection(int port, char *host);
+int silc_net_create_connection(const char *localhost, int port, 
+                              const char *host);
 
 /****f* silcutil/SilcNetAPI/silc_net_create_connection_async
  *
  * SYNOPSIS
  *
- *    int silc_net_create_connection_async(int port, char *host);
+ *    int silc_net_create_connection_async(const char *local_ip, int port, 
+ *                                         const char *host);
  *
  * DESCRIPTION
  *
  *    Creates a connection (TCP/IP) to a remote host. Returns the connection
  *    socket or -1 on error. This creates non-blocking socket hence the
  *    connection returns directly. To get the result of the connect() one
- *    must select() the socket and read the result after it's ready.
+ *    must select() the socket and read the result after it's ready. If the
+ *    `local_ip' is not NULL then this will bind the `local_ip' address to
+ *    a port before creating the connection.  If it is NULL then this will
+ *    directly create the connection.
  *
  ***/
-int silc_net_create_connection_async(int port, char *host);
+int silc_net_create_connection_async(const char *local_ip, int port, 
+                                    const char *host);
 
 /****f* silcutil/SilcNetAPI/silc_net_close_connection
  *
@@ -191,11 +200,10 @@ bool silc_net_is_ip(const char *addr);
  * DESCRIPTION
  *
  *    Converts the IP number string from numbers-and-dots notation to
- *    binary form.
+ *    binary form in network byte order.
  *
  ***/
-bool silc_net_addr2bin(const char *addr, unsigned char *bin,
-                      uint32 bin_len);
+bool silc_net_addr2bin(const char *addr, void *bin, uint32 bin_len);
 
 /****f* silcutil/SilcNetAPI/silc_net_check_host_by_sock
  *
@@ -255,7 +263,7 @@ uint16 silc_net_get_local_port(int sock);
  *
  * SYNOPSIS
  *
- *    char *silc_net_localhost();
+ *    char *silc_net_localhost(void);
  *
  * DESCRIPTION
  *
@@ -264,7 +272,20 @@ uint16 silc_net_get_local_port(int sock);
  *    the first found hostname is returned.
  *
  ***/
-char *silc_net_localhost();
+char *silc_net_localhost(void);
+
+/****f* silcutil/SilcNetAPI/silc_net_localip
+ *
+ * SYNOPSIS
+ *
+ *    char *silc_net_localip(void)
+ *
+ * DESCRIPTION
+ *
+ *    Return IP of localhost.  
+ *
+ ***/
+char *silc_net_localip(void);
 
 #ifdef WIN32
 
@@ -301,7 +322,7 @@ bool silc_net_win32_init(void);
  *    this function the SILC Net API routines will not work anymore.
  *
  ***/
-void silc_net_win32_init(void);
+void silc_net_win32_uninit(void);
 
 #endif