/*
silcnet.h
-
+
Author: Pekka Riikonen <priikone@silcnet.org>
-
- Copyright (C) 1997 - 2001 Pekka Riikonen
-
+
+ Copyright (C) 1997 - 2005 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.
-
+ the Free Software Foundation; version 2 of the License.
+
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
*/
-/****h* silcutil/SilcNetAPI
+/****h* silcutil/SILC Net Interface
*
* DESCRIPTION
*
/* Prototypes */
-/****f* silcutil/SilcNetAPI/silc_net_create_server
+/****s* silcutil/SilcNetAPI/SilcNetServer
*
- * SYNOPSIS
+ * NAME
*
- * int silc_net_create_server(int port, char *ip_addr);
+ * typedef struct SilcNetServerStruct *SilcNetServer;
*
* DESCRIPTION
*
- * This function creates server or daemon or listener or what ever. This
- * does not fork a new process, it must be done by the caller if caller
- * wants to create a child process. This is used by the SILC server.
- * If argument `ip_addr' is NULL `any' address will be used. Returns
- * the created socket or -1 on error.
+ * The network server (daemon, listener, etc.) context. This context
+ * is created with the silc_net_create_server function and destroyed
+ * with silc_net_close_server function.
*
***/
-int silc_net_create_server(int port, char *ip_addr);
+typedef struct SilcNetServerStruct *SilcNetServer;
-/****f* silcutil/SilcNetAPI/silc_net_close_server
+/****d* silcutil/SilcNetAPI/SilcNetStatus
+ *
+ * NAME
+ *
+ * typedef enum { ... } SilcNetStatus;
+ *
+ * DESCRIPTION
+ *
+ * Status to indicate the result of the network operation creation. This
+ * type is returned in the SilcNetCallback callback function.
+ *
+ * SOURCE
+ */
+typedef enum {
+ SILC_NET_OK, /* Everything Ok */
+ SILC_NET_UNKNOWN_IP, /* Unknown IP address */
+ SILC_NET_UNKNOWN_HOST, /* Unknown hostname */
+ SILC_NET_HOST_UNREACHABLE, /* Destination unreachable */
+ SILC_NET_CONNECTION_REFUSED, /* Connection refused */
+ SILC_NET_CONNECTION_TIMEOUT, /* Connection timedout */
+ SILC_NET_NO_MEMORY, /* System out of memory */
+ SILC_NET_ERROR, /* Unknown error */
+} SilcNetStatus;
+/***/
+
+/****f* silcutil/SilcNetAPI/SilcNetCallback
*
* SYNOPSIS
*
- * void silc_net_close_server(int sock);
+ * typedef void (*SilcNetCallback)(SilcNetStatus status,
+ * SilcStream stream, void *context);
*
* DESCRIPTION
*
- * Closes the server by closing the socket connection.
+ * A callback function of this type is returned by silc_net_create_server
+ * and silc_net_connect_async functions. For silc_net_create_server this
+ * callback means that new incoming connection was accepted, and the
+ * `stream' is the socket stream representing the socket connection.
+ *
+ * For silc_net_connect_async this means that we have connected to the
+ * remote host and the `stream' is the socket stream for the socket
+ * connection. The SILC Stream API (such as silc_stream_read, etc.)
+ * can be used to read and write to the stream. The created stream
+ * is socket stream so various SilcSocketStream API functions can be
+ * used with the `stream'.
*
***/
-void silc_net_close_server(int sock);
+typedef void (*SilcNetCallback)(SilcNetStatus status,
+ SilcStream stream, void *context);
-/****f* silcutil/SilcNetAPI/silc_net_create_connection
+/****f* silcutil/SilcNetAPI/silc_net_create_server
*
* SYNOPSIS
*
- * int silc_net_create_connection(const char *local_ip, int port,
- * const char *host);
+ * SilcNetServer
+ * silc_net_create_server(const char **local_ip_addr,
+ * SilcUInt32 local_ip_count,
+ * int port, bool require_fqdn,
+ * SilcSchedule schedule,
+ * SilcNetCallback callback, void *context);
*
* 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. 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.
+ * This function creates server or daemon or listener etc. This is used
+ * to create network listener for incoming connections, and `callback'
+ * will be called everytime new connection is received. If `local_ip_addr'
+ * is NULL any address is used. If provided it can be used bind the
+ * server to `local_ip_count' many IP addresses provided in `local_ip_addr'
+ * table. On success returns the SilcNetServer context, or NULL on error.
+ * If `require_fqdn' is TRUE the server will require that the incoming
+ * connection has FQDN to be able to connect.
*
***/
-int silc_net_create_connection(const char *localhost, int port,
- const char *host);
+SilcNetServer
+silc_net_create_server(const char **local_ip_addr, SilcUInt32 local_ip_count,
+ int port, bool require_fqdn, SilcSchedule schedule,
+ SilcNetCallback callback, void *context);
-/****f* silcutil/SilcNetAPI/silc_net_create_connection_async
+/****f* silcutil/SilcNetAPI/silc_net_close_server
*
* SYNOPSIS
*
- * int silc_net_create_connection_async(const char *local_ip, int port,
- * const char *host);
+ * void silc_net_close_server(SilcNetServer server);
*
* 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. 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.
+ * Closes the network server listener indicated by `server'.
*
***/
-int silc_net_create_connection_async(const char *local_ip, int port,
- const char *host);
+void silc_net_close_server(SilcNetServer server);
+
+/****f* silcutil/SilcNetAPI/silc_net_connect
+ *
+ * SYNOPSIS
+ *
+ * SilcAsyncOperation silc_net_tcp_connect(const char *local_ip_addr,
+ * const char *remote_ip_addr,
+ * int remote_port,
+ * SilcSchedule schedule,
+ * SilcNetCallback callback,
+ * void *context);
+ *
+ * DESCRIPTION
+ *
+ * Creates TCP/IP connection to the remote host indicated by `remote_host'
+ * which may be hostname or IP address, on the port indicated by
+ * `remote_port'. If the `local_ip_addr' is provided the local host is
+ * bound to that address before creating the connection. This is
+ * asynchronous call, and this function returns before the connection is
+ * actually established. The `callback' will be called after the
+ * connection is created to deliver the SilcStream for the created
+ * connection.
+ *
+ * The returned SilcAsyncOperation context can be used to control the
+ * asynchronous connecting, such as to abort it. If it is aborted
+ * using silc_async_abort the `callback' will not be called. If NULL
+ * is returned the operation cannot be aborted and the `callback' will
+ * be called eventually.
+ *
+ */
+SilcAsyncOperation silc_net_tcp_connect(const char *local_ip_addr,
+ const char *remote_ip_addr,
+ int remote_port,
+ SilcSchedule schedule,
+ SilcNetCallback callback,
+ void *context);
+
+SilcAsyncOperation silc_net_udp_connect(const char *local_ip_addr,
+ const char *remote_ip_addr,
+ int remote_port,
+ SilcSchedule schedule,
+ SilcNetCallback callback,
+ void *context);
/****f* silcutil/SilcNetAPI/silc_net_close_connection
*
*
* SYNOPSIS
*
- * int silc_net_get_socket_opt(int sock, int level, int option,
+ * int silc_net_get_socket_opt(int sock, int level, int option,
* void *optval, int *opt_len);
*
* DESCRIPTION
* Return socket options to the `optval' and `opt_len'.
*
***/
-int silc_net_get_socket_opt(int sock, int level, int option,
+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, uint32 bin_len);
+bool silc_net_addr2bin(const char *addr, void *bin, SilcUInt32 bin_len);
-/****f* silcutil/SilcNetAPI/silc_net_addr2bin_ne
+/****f* silcutil/SilcNetAPI/SilcNetResolveCallback
*
* SYNOPSIS
*
- * bool silc_net_addr2bin_ne(const char *addr, unsigned char *bin,
- * uint32 bin_len);
+ * typedef void (*SilcNetResolveCallback)(const char *result,
+ * void *context);
*
* DESCRIPTION
*
- * Converts the IP number string from numbers-and-dots notation to
- * binary form in network byte order.
+ * 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.
*
***/
-bool silc_net_addr2bin_ne(const char *addr, unsigned char *bin,
- uint32 bin_len);
+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_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
*
*
* Return name of localhost. This will also attempt to resolve
* the real hostname by the local host's IP address. If unsuccessful
- * the first found hostname is returned.
+ * the first found hostname is returned. The caller must free
+ * returned hostname.
*
***/
char *silc_net_localhost(void);
*
* DESCRIPTION
*
- * Return IP of localhost.
+ * Return IP of localhost. The caller must free the returned IP.
*
***/
char *silc_net_localip(void);
-#ifdef WIN32
-
/****f* silcutil/SilcNetAPI/silc_net_win32_init
*
* SYNOPSIS
* FALSE on error. The network will not work if this function returns
* FALSE.
*
+ * NOTES
+ *
+ * This routines is available only on Win32 platform.
+ *
***/
bool silc_net_win32_init(void);
* is usually called when the application is exiting. After calling
* this function the SILC Net API routines will not work anymore.
*
+ * NOTES
+ *
+ * This routines is available only on Win32 platform.
+ *
***/
void silc_net_win32_uninit(void);
-#endif
+#include "silcnet_i.h"
-#endif
+#endif /* SILCNET_H */
projects / silc.git / blobdiff