X-Git-Url: http://git.silcnet.org/gitweb/?a=blobdiff_plain;f=lib%2Fsilcutil%2Fsilcnet.h;h=3bbc40ab665501b7b3c34625d347afcb8408b7a0;hb=52e57c880aba9c5e89f59d962eb9af75670b76e0;hp=6e7d35ed9836781de8f5281ca07382be7508aaef;hpb=e9f2575973091102bedbd22ebf243122b4b25ed8;p=silc.git diff --git a/lib/silcutil/silcnet.h b/lib/silcutil/silcnet.h index 6e7d35ed..3bbc40ab 100644 --- a/lib/silcutil/silcnet.h +++ b/lib/silcutil/silcnet.h @@ -4,7 +4,7 @@ Author: Pekka Riikonen - Copyright (C) 1997 - 2006 Pekka Riikonen + Copyright (C) 1997 - 2007 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 @@ -118,13 +118,17 @@ typedef void (*SilcNetCallback)(SilcNetStatus status, * * 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. * 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. + * 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 @@ -134,6 +138,58 @@ silc_net_tcp_create_listener(const char **local_ip_addr, 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_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 @@ -167,14 +223,14 @@ void silc_net_close_listener(SilcNetListener listener); * 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. * - */ + ***/ SilcAsyncOperation silc_net_tcp_connect(const char *local_ip_addr, const char *remote_ip_addr, int remote_port, @@ -200,8 +256,9 @@ SilcAsyncOperation silc_net_tcp_connect(const char *local_ip_addr, * 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 + * 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 @@ -210,6 +267,8 @@ 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. + * * EXAMPLE * * SilcStream udpstream; @@ -222,6 +281,11 @@ SilcAsyncOperation silc_net_tcp_connect(const char *local_ip_addr, * // 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, @@ -253,9 +317,9 @@ int silc_net_udp_receive(SilcStream stream, char *remote_ip_addr, * * 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 * @@ -265,52 +329,57 @@ int silc_net_udp_receive(SilcStream stream, char *remote_ip_addr, * 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 +/****f* silcutil/SilcNetAPI/silc_net_get_error_string * * SYNOPSIS * - * void silc_net_close_connection(int sock); + * const char silc_net_get_error_string(SilcNetStatus error); * * DESCRIPTION * - * Closes the connection by closing the socket connection. + * Return `error' as a string. * ***/ -void silc_net_close_connection(int sock); +const char *silc_net_get_error_string(SilcNetStatus error); -/****f* silcutil/SilcNetAPI/silc_net_accept_connection +/****f* silcutil/SilcNetAPI/silc_net_close_connection * * SYNOPSIS * - * int silc_net_accept_connection(int sock); + * void silc_net_close_connection(int sock); * * DESCRIPTION * - * Accepts a connection from a particular socket. + * Closes the connection by closing the socket connection. This routine + * can only be used with POSIX compliant systems. * ***/ -int silc_net_accept_connection(int sock); +void silc_net_close_connection(int sock); -/****f* silcutil/SilcNetAPI/silc_net_set_socket_nonblock +/****f* silcutil/SilcNetAPI/silc_net_accept_connection * * SYNOPSIS * - * int silc_net_set_socket_nonblock(int sock); + * int silc_net_accept_connection(int sock); * * DESCRIPTION * - * Sets the socket to non-blocking mode. + * 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_set_socket_nonblock(int sock); +int silc_net_accept_connection(int sock); /****f* silcutil/SilcNetAPI/silc_net_set_socket_opt * @@ -322,7 +391,8 @@ int silc_net_set_socket_nonblock(int sock); * * 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); @@ -336,12 +406,27 @@ 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 @@ -386,7 +471,8 @@ SilcBool silc_net_is_ip(const char *addr); * * 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 * @@ -418,7 +504,7 @@ typedef void (*SilcNetResolveCallback)(const char *result, void *context); * SYNOPSIS * * SilcBool silc_net_gethostbyname(const char *name, SilcBool prefer_ipv6, - * char *address, SilcUInt32 address_len); + * char *address, SilcUInt32 address_len); * * DESCRIPTION * @@ -467,9 +553,9 @@ void silc_net_gethostbyname_async(const char *name, * 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, @@ -506,7 +592,7 @@ void silc_net_gethostbyaddr_async(const char *addr, * * 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 @@ -515,13 +601,14 @@ void silc_net_gethostbyaddr_async(const char *addr, * 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 @@ -530,33 +617,34 @@ SilcBool silc_net_check_host_by_sock(int sock, char **hostname, char **ip); * 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 * @@ -587,49 +675,6 @@ char *silc_net_localhost(void); ***/ 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 */