*
* DESCRIPTION
*
- * A callback of this type is returned by silc_net_tcp_create_listener,
- * silc_net_udp_create_listener, silc_net_tcp_connect and
- * silc_net_udp_connect functions. For silc_net_tcp_create_listener
- * and silc_net_udp_create_listener this callback means that new incoming
- * connection was accepted, and the `stream' is the socket stream
- * representing the socket connection.
- *
- * For silc_net_tcp_connect and silc_net_udp_connect 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'.
+ * A callback of this type is returned by silc_net_tcp_create_listener
+ * and silc_net_tcp_connect functions. For silc_net_tcp_create_listener
+ * this callback means that new incoming connection was accepted, and the
+ * `stream' is the socket stream representing the socket connection.
+ *
+ * For silc_net_tcp_connect 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'.
*
***/
typedef void (*SilcNetCallback)(SilcNetStatus status,
*
* SilcNetListener
* silc_net_tcp_create_listener(const char **local_ip_addr,
- * SilcUInt32 local_ip_count,
- * int port, SilcBool require_fqdn,
+ * SilcUInt32 local_ip_count, int port,
+ * SilcBool lookup, SilcBool require_fqdn,
* SilcSchedule schedule,
* SilcNetCallback callback, void *context);
*
* DESCRIPTION
*
- * This function creates TCP listener etc. This is used to create network
+ * 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 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.
* If `require_fqdn' is TRUE the listener will require that the incoming
- * connection has FQDN to be able to connect.
+ * connection has FQDN to be able to connect. If the `lookup' is TRUE
+ * then the incoming connection hostname will be resolved. If the `port'
+ * is zero (0), operating system will define it automatically.
+ *
+ * The `callback' always delivers valid new stream. It is not called
+ * with an error status.
*
***/
SilcNetListener
silc_net_tcp_create_listener(const char **local_ip_addr,
- SilcUInt32 local_ip_count,
- int port, SilcBool require_fqdn,
+ SilcUInt32 local_ip_count, int port,
+ SilcBool lookup, SilcBool require_fqdn,
SilcSchedule schedule,
SilcNetCallback callback, void *context);
+/****f* silcutil/SilcNetAPI/silc_net_listener_get_port
+ *
+ * SYNOPSIS
+ *
+ * SilcUInt16 silc_net_listener_get_port(SilcNetListener listener);
+ *
+ * DESCRIPTION
+ *
+ * Returns the ports to where the `listener' is bound. This can be used
+ * 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.
+ *
+ ***/
+SilcUInt16 *silc_net_listener_get_port(SilcNetListener listener,
+ SilcUInt32 *port_count);
+
/****f* silcutil/SilcNetAPI/silc_net_close_listener
*
* SYNOPSIS
* 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.
+ * connection. This function supports IPv6 if the platform supports it.
*
* 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.
+ * is returned the operation cannot be aborted.
*
*/
SilcAsyncOperation silc_net_tcp_connect(const char *local_ip_addr,
* DESCRIPTION
*
* This function creates UDP stream. The UDP stream is bound to the
- * `local_ip_addr' if it is specified. The `local_port' must always be
- * specified. If the `remote_ip_addr' and `remote_port' is also provided,
- * packets may be sent to that address using silc_stream_write function
- * and packets may be received using silc_stream_read function.
- *
- * If the remote address is not provided then packets may only be received
- * by using silc_net_udp_receive and sent only by using the function
+ * `local_ip_addr' if it is specified. If `local_port' is non-zero the
+ * stream is bound to that port. If the `remote_ip_addr' and `remote_port'
+ * is also provided, packets may be sent to that address using
+ * silc_stream_write function and packets may be received using
+ * silc_stream_read function.
+ *
+ * If the remote address is not provided the stream is in connectionless
+ * state. This means that packets can be received only by using
+ * silc_net_udp_receive and sent only by using the function
* silc_net_udp_send.
*
* To receive packets the silc_stream_set_notifier must be called for the
* 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.
+ *
* EXAMPLE
*
* SilcStream udpstream;
* // Send packet to remote host
* silc_stream_write(udpstream, data, data_len);
*
+ * Create UDP listener:
+ *
+ * udpstream = silc_net_udp_connect("0.0.0.0", 500, NULL, 0, schedule);
+ * silc_stream_set_notifier(udpstream, schedule, receive_callback, context);
+ *
***/
-SilcStream
-silc_net_udp_connect(const char *local_ip_addr, int local_port,
- const char *remote_ip_addr, int remote_port,
- SilcSchedule schedule);
+SilcStream silc_net_udp_connect(const char *local_ip_addr, int local_port,
+ const char *remote_ip_addr, int remote_port,
+ SilcSchedule schedule);
/****f* silcutil/SilcNetAPI/silc_net_udp_receive
*
*
* SYNOPSIS
*
- * void silc_net_udp_send(SilcStream stream,
- * const char *remote_ip_addr, int remote_port,
- * const unsigned char *data, SilcUInt32 data_len);
+ * int silc_net_udp_send(SilcStream stream,
+ * const char *remote_ip_addr, int remote_port,
+ * const unsigned char *data, SilcUInt32 data_len);
*
* DESCRIPTION
*
* used. In those cases, this function must be used. This may also be
* used even if the stream is connected.
*
- * This function always succeeds, however there is no guarantee that the
- * packet is delivered, as UDP is unreliable transport protocol.
+ * 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
+ * notifier callback will later be called with SILC_STREAM_CAN_WRITE
+ * status when stream is again ready for writing.
*
***/
-void silc_net_udp_send(SilcStream stream,
- const char *remote_ip_addr, int remote_port,
- const unsigned char *data, SilcUInt32 data_len);
+int silc_net_udp_send(SilcStream stream,
+ const char *remote_ip_addr, int remote_port,
+ const unsigned char *data, SilcUInt32 data_len);
/****f* silcutil/SilcNetAPI/silc_net_close_connection
*
*
* DESCRIPTION
*
- * Closes the connection by closing the socket connection.
+ * Closes the connection by closing the socket connection. This routine
+ * can only be used with POSIX compliant systems.
*
***/
void silc_net_close_connection(int sock);
*
* DESCRIPTION
*
- * Accepts a connection from a particular socket.
+ * Accepts a connection from a particular socket. This routine can only
+ * be used with POSIX compliant systems. This call is equivalent to
+ * accept(2).
*
***/
int silc_net_accept_connection(int sock);
-/****f* silcutil/SilcNetAPI/silc_net_set_socket_nonblock
- *
- * SYNOPSIS
- *
- * int silc_net_set_socket_nonblock(int sock);
- *
- * DESCRIPTION
- *
- * Sets the socket to non-blocking mode.
- *
- ***/
-int silc_net_set_socket_nonblock(int sock);
-
/****f* silcutil/SilcNetAPI/silc_net_set_socket_opt
*
* SYNOPSIS
*
* Sets a option for a socket. This function can be used to set
* various options for the socket. Some of the options might be
- * system specific.
+ * system specific. This routine can only be used with POSIX compliant
+ * systems. This call is equivalent to setsockopt(2);
*
***/
int silc_net_set_socket_opt(int sock, int level, int option, int on);
*
* DESCRIPTION
*
- * Return socket options to the `optval' and `opt_len'.
+ * Return socket options to the `optval' and `opt_len'. This routine
+ * can only be used with POSIX compliant systems. This call is
+ * equivalent to getsockopt(2).
*
***/
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
+ *
+ * SYNOPSIS
+ *
+ * int silc_net_set_socket_nonblock(SilcSocket sock);
+ *
+ * DESCRIPTION
+ *
+ * Sets the socket `sock' to non-blocking mode.
+ *
+ ***/
+int silc_net_set_socket_nonblock(SilcSocket sock);
+
/****f* silcutil/SilcNetAPI/silc_net_is_ip4
*
* SYNOPSIS
*
* SYNOPSIS
*
- * SilcBool silc_net_addr2bin(const char *addr, void *bin, SilcUInt32 bin_len);
+ * SilcBool silc_net_addr2bin(const char *addr, void *bin,
+ * SilcUInt32 bin_len);
*
* DESCRIPTION
*
*
* SYNOPSIS
*
- * SilcBool silc_net_check_host_by_sock(int sock, char **hostname,
+ * SilcBool silc_net_check_host_by_sock(SilcSocket sock, char **hostname,
* char **ip);
*
* DESCRIPTION
* lookup as well to verify that the IP has FQDN.
*
***/
-SilcBool silc_net_check_host_by_sock(int sock, char **hostname, char **ip);
+SilcBool silc_net_check_host_by_sock(SilcSocket sock, char **hostname,
+ char **ip);
/****f* silcutil/SilcNetAPI/silc_net_check_local_by_sock
*
* SYNOPSIS
*
- * SilcBool silc_net_check_local_by_sock(int sock, char **hostname,
+ * SilcBool silc_net_check_local_by_sock(SilcSocket sock, char **hostname,
* char **ip);
*
* DESCRIPTION
* lookup as well to verify that the IP has FQDN.
*
***/
-SilcBool silc_net_check_local_by_sock(int sock, char **hostname, char **ip);
+SilcBool silc_net_check_local_by_sock(SilcSocket sock, char **hostname,
+ char **ip);
/****f* silcutil/SilcNetAPI/silc_net_get_remote_port
*
* SYNOPSIS
*
- * SilcUInt16 silc_net_get_remote_port(int sock);
+ * SilcUInt16 silc_net_get_remote_port(SilcSocket sock);
*
* DESCRIPTION
*
* Return remote port by socket.
*
***/
-SilcUInt16 silc_net_get_remote_port(int sock);
+SilcUInt16 silc_net_get_remote_port(SilcSocket sock);
/****f* silcutil/SilcNetAPI/silc_net_get_local_port
*
* SYNOPSIS
*
- * SilcUInt16 silc_net_get_local_port(int sock);
+ * SilcUInt16 silc_net_get_local_port(SilcSocket sock);
*
* DESCRIPTION
*
* Return local port by socket.
*
***/
-SilcUInt16 silc_net_get_local_port(int sock);
+SilcUInt16 silc_net_get_local_port(SilcSocket sock);
/****f* silcutil/SilcNetAPI/silc_net_localhost
*
projects / silc.git / blobdiff