-/****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
*
* 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
* 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
*
*
* 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
*
int silc_net_get_socket_opt(int sock, int level, int option,
void *optval, int *opt_len);
+/****f* silcutil/SilcNetAPI/silc_net_is_ip4
+ *
+ * SYNOPSIS
+ *
+ * bool silc_net_is_ip4(const char *addr);
+ *
+ * DESCRIPTION
+ *
+ * Checks whether IP address sent as argument is valid IPv4 address.
+ *
+ ***/
+bool silc_net_is_ip4(const char *addr);
+
+/****f* silcutil/SilcNetAPI/silc_net_is_ip6
+ *
+ * SYNOPSIS
+ *
+ * bool silc_net_is_ip6(const char *addr);
+ *
+ * DESCRIPTION
+ *
+ * Checks whether IP address sent as argument is valid IPv6 address.
+ *
+ ***/
+bool silc_net_is_ip6(const char *addr);
+
/****f* silcutil/SilcNetAPI/silc_net_is_ip
*
* SYNOPSIS
* DESCRIPTION
*
* Checks whether IP address sent as argument is valid IP address.
+ * This supports both IPv4 and IPv6 addresses.
*
***/
bool silc_net_is_ip(const char *addr);
*
* SYNOPSIS
*
- * bool silc_net_addr2bin(const char *addr, unsigned char *bin,
- * uint32 bin_len);
+ * bool silc_net_addr2bin(const char *addr, void *bin, SilcUInt32 bin_len);
*
* DESCRIPTION
*
* Converts the IP number string from numbers-and-dots notation to
- * binary form.
+ * binary form in network byte order. The address can be either
+ * IPv4 or IPv6 address.
+ *
+ ***/
+bool silc_net_addr2bin(const char *addr, void *bin, SilcUInt32 bin_len);
+
+/****f* silcutil/SilcNetAPI/SilcNetResolveCallback
+ *
+ * SYNOPSIS
+ *
+ * typedef void (*SilcNetResolveCallback)(const char *result,
+ * void *context);
+ *
+ * DESCRIPTION
+ *
+ * A callback function of this type is called after the asynchronous
+ * resolving operation has been completed. This callback is used
+ * when asynchronously resolving IP addresses and hostnames.
+ *
+ ***/
+typedef void (*SilcNetResolveCallback)(const char *result, void *context);
+
+/****f* silcutil/SilcNetAPI/silc_net_gethostbyname
+ *
+ * SYNOPSIS
+ *
+ * bool silc_net_gethostbyname(const char *name, bool prefer_ipv6,
+ * char *address, SilcUInt32 address_len);
+ *
+ * DESCRIPTION
+ *
+ * Resolves the IP address of the hostname indicated by the `name'.
+ * This returns TRUE and the IP address of the host to the `address'
+ * buffer, or FALSE if the address could not be resolved. This is
+ * synchronous function and will block the calling process. If the
+ * `prefer_ipv6' is TRUE then this will return IPv6 address if it
+ * finds. If FALSE if returns IPv4 address even if it found IPv6
+ * address also.
+ *
+ ***/
+bool silc_net_gethostbyname(const char *name, bool prefer_ipv6, char *address,
+ SilcUInt32 address_len);
+
+/****f* silcutil/SilcNetAPI/silc_net_gethostbyname_async
+ *
+ * SYNOPSIS
+ *
+ * void silc_net_gethostbyname_async(const char *name,
+ * bool prefer_ipv6,
+ * SilcSchedule schedule,
+ * SilcNetResolveCallback completion,
+ * void *context)
+ *
+ * DESCRIPTION
+ *
+ * Asynchronously resolves the IP address of the hostname indicated
+ * by the `name'. This function returns immediately, and the
+ * `completion' callback will be called after the resolving is
+ * completed.
+ *
+ * If the `prefer_ipv6' is TRUE then this will return IPv6 address if it
+ * finds. If FALSE if returns IPv4 address even if it found IPv6
+ * address also.
+ *
+ ***/
+void silc_net_gethostbyname_async(const char *name,
+ bool prefer_ipv6,
+ SilcSchedule schedule,
+ SilcNetResolveCallback completion,
+ void *context);
+
+/****f* silcutil/SilcNetAPI/silc_net_gethostbyaddr
+ *
+ * SYNOPSIS
+ *
+ * bool silc_net_gethostbyaddr(const char *addr, char *name,
+ * SilcUInt32 name_len);
+ *
+ * DESCRIPTION
+ *
+ * Resolves the hostname for the IP address indicated by the `addr'
+ * This returns TRUE and the resolved hostname to the `name' buffer,
+ * or FALSE on error. The `addr' may be either IPv4 or IPv6 address.
+ * This is synchronous function and will block the calling process.
*
***/
-bool silc_net_addr2bin(const char *addr, unsigned char *bin,
- uint32 bin_len);
+bool silc_net_gethostbyaddr(const char *addr, char *name, SilcUInt32 name_len);
+
+/****f* silcutil/SilcNetAPI/silc_net_gethostbyaddr_async
+ *
+ * SYNOPSIS
+ *
+ * void silc_net_gethostbyaddr_async(const char *addr,
+ * SilcSchedule schedule,
+ * SilcNetResolveCallback completion,
+ * void *context)
+ *
+ * DESCRIPTION
+ *
+ * Asynchronously resolves the hostname for the IP address indicated
+ * by the `addr'. This function returns immediately, and the
+ * `completion' callback will be called after the resolving is
+ * completed.
+ *
+ ***/
+void silc_net_gethostbyaddr_async(const char *addr,
+ SilcSchedule schedule,
+ SilcNetResolveCallback completion,
+ void *context);
/****f* silcutil/SilcNetAPI/silc_net_check_host_by_sock
*
*
* SYNOPSIS
*
- * uint16 silc_net_get_remote_port(int sock);
+ * SilcUInt16 silc_net_get_remote_port(int sock);
*
* DESCRIPTION
*
* Return remote port by socket.
*
***/
-uint16 silc_net_get_remote_port(int sock);
+SilcUInt16 silc_net_get_remote_port(int sock);
/****f* silcutil/SilcNetAPI/silc_net_get_local_port
*
* SYNOPSIS
*
- * uint16 silc_net_get_local_port(int sock);
+ * SilcUInt16 silc_net_get_local_port(int sock);
*
* DESCRIPTION
*
* Return local port by socket.
*
***/
-uint16 silc_net_get_local_port(int sock);
+SilcUInt16 silc_net_get_local_port(int sock);
/****f* silcutil/SilcNetAPI/silc_net_localhost
*
* SYNOPSIS
*
- * char *silc_net_localhost();
+ * char *silc_net_localhost(void);
*
* DESCRIPTION
*
* 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
* this function the SILC Net API routines will not work anymore.
*
***/
-void silc_net_win32_init(void);
+void silc_net_win32_uninit(void);
#endif
projects / silc.git / blobdiff