Author: Pekka Riikonen <priikone@silcnet.org>
- Copyright (C) 1997 - 2007 Pekka Riikonen
+ Copyright (C) 1997 - 2008 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
*/
-/****h* silcutil/SILC Net Interface
+/****h* silcutil/Network Interface
*
* DESCRIPTION
*
- * SILC Net API provides various network routines for applications. It
- * can be used to create TCP/IP and UDP/IP connections and listeners.
- * Various utility functions for resolving various information is also
- * provided.
+ * SILC Net API provides various network routines for applications. It can
+ * be used to create TCP/IP and UDP/IP connections and listeners. Various
+ * utility functions for resolving various information is also provided.
+ * The interface supports both IPv4 and IPv6.
+ *
+ * EXAMPLE
+ *
+ * // Create TCP connection to example.com at port 25
+ * silc_net_tcp_connect(NULL, "example.com", 25, schedule, connected_cb, ctx);
+ *
+ * // Create UDP listener on local interface 10.2.1.7 on port 500
+ * SilcStream udpstream;
+ *
+ * udpstream = silc_net_udp_connect("10.2.1.7", 500, NULL, 0, schedule);
+ * silc_stream_set_notifier(udpstream, schedule, receive_callback, ctx);
*
***/
/* Prototypes */
-/****s* silcutil/SilcNetAPI/SilcNetListener
+/****s* silcutil/SilcNetListener
*
* NAME
*
***/
typedef struct SilcNetListenerStruct *SilcNetListener;
-/****f* silcutil/SilcNetAPI/SilcNetCallback
+/****f* silcutil/SilcNetCallback
*
* SYNOPSIS
*
typedef void (*SilcNetCallback)(SilcResult status,
SilcStream stream, void *context);
-/****f* silcutil/SilcNetAPI/silc_net_tcp_create_listener
+/****f* silcutil/silc_net_tcp_create_listener
*
* SYNOPSIS
*
SilcSchedule schedule,
SilcNetCallback callback, void *context);
-/****f* silcutil/SilcNetAPI/silc_net_tcp_create_listener2
+/****f* silcutil/silc_net_tcp_create_listener2
*
* SYNOPSIS
*
SilcSchedule schedule,
SilcNetCallback callback, void *context);
-/****f* silcutil/SilcNetAPI/silc_net_listener_get_port
+/****f* silcutil/silc_net_listener_get_port
*
* SYNOPSIS
*
- * SilcUInt16 silc_net_listener_get_port(SilcNetListener listener);
+ * SilcUInt16 *silc_net_listener_get_port(SilcNetListener listener,
+ * SilcUInt32 *port_count);
*
* DESCRIPTION
*
* 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 ports provided in silc_net_tcp_create_listener2.
+ * or 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
+/****f* silcutil/silc_net_listener_get_ip
*
* SYNOPSIS
*
* 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
+ * of IP addresses of size of `ip_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
+/****f* silcutil/silc_net_listener_get_hostname
*
* SYNOPSIS
*
* 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.
+ * array of hostnames of size of `hostname_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
+/****f* silcutil/silc_net_close_listener
*
* SYNOPSIS
*
***/
void silc_net_close_listener(SilcNetListener listener);
-/****f* silcutil/SilcNetAPI/silc_net_tcp_connect
+/****f* silcutil/silc_net_tcp_connect
*
* SYNOPSIS
*
SilcNetCallback callback,
void *context);
-/****f* silcutil/SilcNetAPI/silc_net_udp_connect
+/****f* silcutil/silc_net_udp_connect
*
* SYNOPSIS
*
*
* To receive packets the silc_stream_set_notifier must be called for the
* returned SilcStream. The packets are always received in the notifier
- * callback when the SILC_STREAM_CAN_READ is returned to the callback
- * To read the packet use silc_stream_read if the remote address was
+ * callback when the SILC_STREAM_CAN_READ is returned to the callback.
+ * To read the packet use silc_stream_read if the `remote_ip_addr' was
* provided, and silc_net_udp_receive if it was not.
*
* Supports IPv6 if the platform supports it. If `schedule' is NULL this
const char *remote_ip_addr, int remote_port,
SilcSchedule schedule);
-/****f* silcutil/SilcNetAPI/silc_net_udp_receive
+/****f* silcutil/silc_net_udp_receive
*
* SYNOPSIS
*
* pointer. The packet data is returned into the `ret_data' buffer.
*
* Returns the length of the packet, or -1 on error or 0 in case of EOF.
+ * In case of error the silc_errno will indicate the error. If the
+ * error is SILC_ERR_WOULD_BLOCK data is not currently available from the
+ * `stream'.
*
***/
int silc_net_udp_receive(SilcStream stream, char *remote_ip_addr,
SilcUInt32 remote_ip_addr_size, int *remote_port,
unsigned char *ret_data, SilcUInt32 data_size);
-/****f* silcutil/SilcNetAPI/silc_net_udp_send
+/****f* silcutil/silc_net_udp_send
*
* SYNOPSIS
*
*
* Sends an UDP packet to remote host `remote_ip_addr' on `remote_port'.
* This may be used with UDP streams that are not connected to any
- * specific remote host. With those stream silc_stream_write cannot be
- * used. In those cases, this function must be used. This may also be
- * used even if the stream is connected.
+ * specific remote host. With those streams silc_stream_write cannot be
+ * used. In those cases, this function must be used. However, this may
+ * also be used even if the stream is in connected state.
+ *
+ * You can create the `stream' by calling silc_net_udp_connect.
*
* Returns the amount of data written, -1 if data could not be written
* at this moment, or -2 if error occurred. If -1 is returned the
const char *remote_ip_addr, int remote_port,
const unsigned char *data, SilcUInt32 data_len);
-/****f* silcutil/SilcNetAPI/silc_net_close_connection
+/****f* silcutil/silc_net_close_connection
*
* SYNOPSIS
*
***/
void silc_net_close_connection(int sock);
-/****f* silcutil/SilcNetAPI/silc_net_accept_connection
+/****f* silcutil/silc_net_accept_connection
*
* SYNOPSIS
*
***/
int silc_net_accept_connection(int sock);
-/****f* silcutil/SilcNetAPI/silc_net_set_socket_opt
+/****f* silcutil/silc_net_set_socket_opt
*
* SYNOPSIS
*
***/
int silc_net_set_socket_opt(int sock, int level, int option, int on);
-/****f* silcutil/SilcNetAPI/silc_net_get_socket_opt
+/****f* silcutil/silc_net_get_socket_opt
*
* SYNOPSIS
*
int silc_net_get_socket_opt(int sock, int level, int option,
void *optval, int *opt_len);
-/****f* silcutil/SilcNetAPI/silc_net_set_socket_nonblock
+/****f* silcutil/silc_net_set_socket_nonblock
*
* SYNOPSIS
*
***/
int silc_net_set_socket_nonblock(SilcSocket sock);
-/****f* silcutil/SilcNetAPI/silc_net_is_ip4
+/****f* silcutil/silc_net_is_ip4
*
* SYNOPSIS
*
***/
SilcBool silc_net_is_ip4(const char *addr);
-/****f* silcutil/SilcNetAPI/silc_net_is_ip6
+/****f* silcutil/silc_net_is_ip6
*
* SYNOPSIS
*
***/
SilcBool silc_net_is_ip6(const char *addr);
-/****f* silcutil/SilcNetAPI/silc_net_is_ip
+/****f* silcutil/silc_net_is_ip
*
* SYNOPSIS
*
***/
SilcBool silc_net_is_ip(const char *addr);
-/****f* silcutil/SilcNetAPI/silc_net_addr2bin
+/****f* silcutil/silc_net_addr2bin
*
* SYNOPSIS
*
***/
SilcBool silc_net_addr2bin(const char *addr, void *bin, SilcUInt32 bin_len);
-/****f* silcutil/SilcNetAPI/SilcNetResolveCallback
+/****f* silcutil/SilcNetResolveCallback
*
* SYNOPSIS
*
***/
typedef void (*SilcNetResolveCallback)(const char *result, void *context);
-/****f* silcutil/SilcNetAPI/silc_net_gethostbyname
+/****f* silcutil/silc_net_gethostbyname
*
* SYNOPSIS
*
SilcBool silc_net_gethostbyname(const char *name, SilcBool prefer_ipv6,
char *address, SilcUInt32 address_len);
-/****f* silcutil/SilcNetAPI/silc_net_gethostbyname_async
+/****f* silcutil/silc_net_gethostbyname_async
*
* SYNOPSIS
*
SilcNetResolveCallback completion,
void *context);
-/****f* silcutil/SilcNetAPI/silc_net_gethostbyaddr
+/****f* silcutil/silc_net_gethostbyaddr
*
* SYNOPSIS
*
SilcBool silc_net_gethostbyaddr(const char *addr, char *name,
SilcUInt32 name_len);
-/****f* silcutil/SilcNetAPI/silc_net_gethostbyaddr_async
+/****f* silcutil/silc_net_gethostbyaddr_async
*
* SYNOPSIS
*
SilcNetResolveCallback completion,
void *context);
-/****f* silcutil/SilcNetAPI/silc_net_check_host_by_sock
+/****f* silcutil/silc_net_check_host_by_sock
*
* SYNOPSIS
*
SilcBool silc_net_check_host_by_sock(SilcSocket sock, char **hostname,
char **ip);
-/****f* silcutil/SilcNetAPI/silc_net_check_local_by_sock
+/****f* silcutil/silc_net_check_local_by_sock
*
* SYNOPSIS
*
SilcBool silc_net_check_local_by_sock(SilcSocket sock, char **hostname,
char **ip);
-/****f* silcutil/SilcNetAPI/silc_net_get_remote_port
+/****f* silcutil/silc_net_get_remote_port
*
* SYNOPSIS
*
***/
SilcUInt16 silc_net_get_remote_port(SilcSocket sock);
-/****f* silcutil/SilcNetAPI/silc_net_get_local_port
+/****f* silcutil/silc_net_get_local_port
*
* SYNOPSIS
*
***/
SilcUInt16 silc_net_get_local_port(SilcSocket sock);
-/****f* silcutil/SilcNetAPI/silc_net_localhost
+/****f* silcutil/silc_net_localhost
*
* SYNOPSIS
*
***/
char *silc_net_localhost(void);
-/****f* silcutil/SilcNetAPI/silc_net_localip
+/****f* silcutil/silc_net_localip
*
* SYNOPSIS
*
projects / runtime.git / blobdiff