* Various utility functions for resolving various information is also
* provided.
*
- * On WIN32 systems the SILC Net API must initialized by calling the
- * silc_net_win32_init and uninitialized when the application ends by
- * 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
***/
typedef struct SilcNetListenerStruct *SilcNetListener;
-/****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
*
- * typedef void (*SilcNetCallback)(SilcNetStatus status,
+ * typedef void (*SilcNetCallback)(SilcResult status,
* SilcStream stream, void *context);
*
* DESCRIPTION
* the `stream'.
*
***/
-typedef void (*SilcNetCallback)(SilcNetStatus status,
+typedef void (*SilcNetCallback)(SilcResult status,
SilcStream stream, void *context);
/****f* silcutil/SilcNetAPI/silc_net_tcp_create_listener
*
* This function creates TCP listener. 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
+ * everytime new connection is received. If `local_ip_addr' is NULL 'any'
* address is used. If provided it can be used bind the listener to
* `local_ip_count' many IP addresses provided in `local_ip_addr' table.
* On success returns the SilcNetListener context, or NULL on error.
* is zero (0), operating system will define it automatically.
*
* The `callback' always delivers valid new stream. It is not called
- * with an error status.
+ * with an error status. If `schedule' is NULL this will call
+ * silc_schedule_get_global to try to get global scheduler.
*
***/
SilcNetListener
SilcSchedule schedule,
SilcNetCallback callback, void *context);
+/****f* silcutil/SilcNetAPI/silc_net_tcp_create_listener2
+ *
+ * SYNOPSIS
+ *
+ * SilcNetListener
+ * silc_net_tcp_create_listener2(const char *local_ip_addr, int *ports,
+ * SilcUInt32 port_count,
+ * SilcBool ignore_port_error,
+ * SilcBool lookup, SilcBool require_fqdn,
+ * SilcSchedule schedule,
+ * SilcNetCallback callback, void *context);
+ *
+ * DESCRIPTION
+ *
+ * This function creates TCP listener. 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 `ports' is NULL or it contains a zero (0) port,
+ * operating system will define it automatically. This function can be
+ * used to bind to many ports at the same time. If `ignore_port_error'
+ * is TRUE this won't return NULL if at least one of the ports could
+ * be bound. Otherwise, NULL will be returned on error.
+ *
+ * If `require_fqdn' is TRUE the listener will require that the incoming
+ * connection has FQDN to be able to connect. If the `lookup' is TRUE
+ * then the incoming connection hostname will be resolved.
+ *
+ * The `callback' always delivers valid new stream. It is not called
+ * with an error status. If `schedule' is NULL this will call
+ * silc_schedule_get_global to try to get global scheduler.
+ *
+ ***/
+SilcNetListener
+silc_net_tcp_create_listener2(const char *local_ip_addr, int *ports,
+ SilcUInt32 port_count,
+ SilcBool ignore_port_error,
+ SilcBool lookup, SilcBool require_fqdn,
+ SilcSchedule schedule,
+ SilcNetCallback callback, void *context);
+
/****f* silcutil/SilcNetAPI/silc_net_listener_get_port
*
* SYNOPSIS
* to get the port if none was specified in silc_net_tcp_create_listener.
* Returns an array of ports of size of `port_count'. The caller must
* free the array with silc_free. There are as many ports in the array
- * as there were IP addresses provided in silc_net_tcp_create_listener.
+ * as there were IP addresses provided in silc_net_tcp_create_listener,
+ * as there were ports provided in silc_net_tcp_create_listener2.
*
***/
SilcUInt16 *silc_net_listener_get_port(SilcNetListener listener,
SilcUInt32 *port_count);
+/****f* silcutil/SilcNetAPI/silc_net_listener_get_ip
+ *
+ * SYNOPSIS
+ *
+ * char **silc_net_listener_get_ip(SilcNetListener listener,
+ * SilcUInt32 *ip_count);
+ *
+ * DESCRIPTION
+ *
+ * Returns the IP's to where the `listener' is bound. Returns an array
+ * of IP addresses of size of `port_count'. The caller must free the
+ * array and its strings with silc_free.
+ *
+ ***/
+char **silc_net_listener_get_ip(SilcNetListener listener,
+ SilcUInt32 *ip_count);
+
+/****f* silcutil/SilcNetAPI/silc_net_listener_get_hostname
+ *
+ * SYNOPSIS
+ *
+ * char **silc_net_listener_get_hostname(SilcNetListener listener,
+ * SilcUInt32 *hostname_count);
+ *
+ * DESCRIPTION
+ *
+ * Returns the hostnames to where the `listener' is bound. Returns an
+ * array of hostnames of size of `port_count'. The caller must free the
+ * array and its strings with silc_free.
+ *
+ ***/
+char **silc_net_listener_get_hostname(SilcNetListener listener,
+ SilcUInt32 *hostname_count);
+
/****f* silcutil/SilcNetAPI/silc_net_close_listener
*
* SYNOPSIS
* 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.
+ * is returned the operation cannot be aborted. If `schedule' is NULL
+ * this will call silc_schedule_get_global to try to get global scheduler.
*
***/
SilcAsyncOperation silc_net_tcp_connect(const char *local_ip_addr,
* To read the packet use silc_stream_read if the remote address was
* provided, and silc_net_udp_receive if it was not.
*
- * Supports IPv6 if the platform supports it.
+ * Supports IPv6 if the platform supports it. If `schedule' is NULL this
+ * will call silc_schedule_get_global to try to get global scheduler.
*
* EXAMPLE
*
* SYNOPSIS
*
* SilcBool silc_net_gethostbyname(const char *name, SilcBool prefer_ipv6,
- * char *address, SilcUInt32 address_len);
+ * char *address, SilcUInt32 address_len);
*
* 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.
+ * completed. If `schedule' is NULL this will call silc_schedule_get_global
+ * to try to get global scheduler.
*
* 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
* SYNOPSIS
*
* SilcBool silc_net_gethostbyaddr(const char *addr, char *name,
- * SilcUInt32 name_len);
+ * SilcUInt32 name_len);
*
- * DESCRIPTION
+x * DESCRIPTION
*
* Resolves the hostname for the IP address indicated by the `addr'
* This returns TRUE and the resolved hostname to the `name' buffer,
* 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.
+ * completed. If `schedule' is NULL this will call silc_schedule_get_global
+ * to try to get global scheduler.
*
***/
void silc_net_gethostbyaddr_async(const char *addr,
***/
char *silc_net_localip(void);
-/****f* silcutil/SilcNetAPI/silc_net_win32_init
- *
- * SYNOPSIS
- *
- * SilcBool silc_net_win32_init(void);
- *
- * DESCRIPTION
- *
- * This is WIN32 system specific function and is used to initialize
- * the network. This must be called by all WIN32 applications. It
- * is usually called at the application's main() or WinMain() before
- * calling any other SILC routine. The application must also call
- * the silc_net_win32_uninit when exiting the application. Returns
- * FALSE on error. The network will not work if this function returns
- * FALSE.
- *
- * NOTES
- *
- * This routines is available only on Win32 platform.
- *
- ***/
-SilcBool silc_net_win32_init(void);
-
-/****f* silcutil/SilcNetAPI/silc_net_win32_uninit
- *
- * SYNOPSIS
- *
- * void silc_net_win32_init(void);
- *
- * DESCRIPTION
- *
- * This is WIN32 system specific function and is used to uninitialize
- * the network. This must be called by all WIN32 applications. It
- * 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);
-
#include "silcnet_i.h"
#endif /* SILCNET_H */
projects / silc.git / blobdiff