Mercurial > pidgin.yaz
view src/network.h @ 8273:f24172f53650
[gaim-migrate @ 8997]
This is Scott Lamb's eventloop abstraction patch. If it breaks things,
Scott Lamb will be glad to take the punishment. If it doesn't, it should
make integration into other event loops easier. Well, no, not easier,
harder actually, but it'll be done more appropriately and less hackily..
er, hacky. Is hackily a word?
committer: Tailor Script <tailor@pidgin.im>
author | Christian Hammond <chipx86@chipx86.com> |
---|---|
date | Tue, 17 Feb 2004 02:17:48 +0000 |
parents | b248c1f4efbd |
children | beb7be215db3 |
line wrap: on
line source
/** * @file network.h Network API * @ingroup core * * gaim * * Gaim is the legal property of its developers, whose names are too numerous * to list here. Please refer to the COPYRIGHT file distributed with this * source distribution. * * 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. * * 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 * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ #ifndef _GAIM_NETWORK_H_ #define _GAIM_NETWORK_H_ #ifdef __cplusplus extern "C" { #endif /**************************************************************************/ /** @name Network API */ /**************************************************************************/ /*@{*/ /** * Sets the IP address of the local system in preferences. * * @param ip The local IP address. */ void gaim_network_set_local_ip(const char *ip); /** * Returns the IP address of the local system set in preferences. * * This returns the value set via gaim_network_set_local_ip(). * You probably want to use gaim_network_get_ip_for_account() instead. * * @return The local IP address set in preferences. */ const char *gaim_network_get_local_ip(void); /** * Returns the IP address of the local system. * * You probably want to use gaim_network_get_ip_for_account() instead. * * @note The returned string is a pointer to a static buffer. If this * function is called twice, it may be important to make a copy * of the returned string. * * @param fd The fd to use to help figure out the IP, or else -1. * @return The local IP address. */ const char *gaim_network_get_local_system_ip(int fd); /** * Returns the IP address that should be used for the specified account. * * First, if @a account is not @c NULL, the IP associated with @a account * is tried, via a call to gaim_account_get_local_ip(). * * If that IP is not set, the IP set in preferences is tried. * * If that IP is not set, the system's local IP is tried, via a call to * gaim_network_get_local_ip(). * * @note The returned string is a pointer to a static buffer. If this * function is called twice, it may be important to make a copy * of the returned string. * * @param account The account to use. This may be @c NULL, and if so * the first step listed above is skipped. * @param fd The fd to use to help figure out the IP, or -1. * @return The local IP address to be used. */ const char *gaim_network_get_ip_for_account(const GaimAccount *account, int fd); /** * Attempts to open a listening port ONLY on the specified port number. * You probably want to use gaim_network_listen_range() instead of this. * This function is useful, for example, if you wanted to write a telnet * server as a Gaim plugin, and you HAD to listen on port 23. Why anyone * would want to do that is beyond me. * * This opens a listening port. The caller will want to set up a watcher * of type GAIM_INPUT_READ on the returned fd. It will probably call * accept in the callback, and then possibly remove the watcher and close * the listening socket, and add a new watcher on the new socket accept * returned. * * @param port The port number to bind to. Must be greater than 0. * * @return The file descriptor of the listening socket, or -1 if * no socket could be established. */ int gaim_network_listen(unsigned short port); /** * Opens a listening port selected from a range of ports. The range of * ports used is chosen in the following manner: * If a range is specified in preferences, these values are used. * If a non-0 values are passed to the function as parameters, these * values are used. * Otherwise a port is chosen at random by the kernel. * * This opens a listening port. The caller will want to set up a watcher * of type GAIM_INPUT_READ on the returned fd. It will probably call * accept in the callback, and then possibly remove the watcher and close * the listening socket, and add a new watcher on the new socket accept * returned. * * @param start The port number to bind to, or 0 to pick a random port. * Users are allowed to override this arg in prefs. * @param end The highest possible port in the range of ports to listen on, * or 0 to pick a random port. Users are allowed to override this * arg in prefs. * * @return The file descriptor of the listening socket, or -1 if * no socket could be established. */ int gaim_network_listen_range(unsigned short start, unsigned short end); /** * Gets a port number from a file descriptor. * * @param fd The file descriptor. This should be a tcp socket. The current * implementation probably dies on anything but IPv4. Perhaps this * possible bug will inspire new and valuable contributors to Gaim. * @return The port number, in host byte order. */ short gaim_network_get_port_from_fd(int fd); /** * Initializes the network subsystem. */ void gaim_network_init(void); /*@}*/ #ifdef __cplusplus } #endif #endif /* _GAIM_NETWORK_H_ */