purple. More...
Go to the source code of this file.
Network API | |
typedef _PurpleNetworkListenData | PurpleNetworkListenData |
typedef void(* | PurpleNetworkListenCallback )(int listenfd, gpointer data) |
const unsigned char * | purple_network_ip_atoi (const char *ip) |
Converts a dot-decimal IP address to an array of unsigned chars. | |
void | purple_network_set_public_ip (const char *ip) |
Sets the IP address of the local system in preferences. | |
const char * | purple_network_get_public_ip (void) |
Returns the IP address of the local system set in preferences. | |
const char * | purple_network_get_local_system_ip (int fd) |
Returns the IP address of the local system. | |
const char * | purple_network_get_my_ip (int fd) |
Returns the IP address that should be used anywhere a public IP addresses is needed (listening for an incoming file transfer, etc). | |
PurpleNetworkListenData * | purple_network_listen (unsigned short port, int socket_type, PurpleNetworkListenCallback cb, gpointer cb_data) |
Attempts to open a listening port ONLY on the specified port number. | |
PurpleNetworkListenData * | purple_network_listen_range (unsigned short start, unsigned short end, int socket_type, PurpleNetworkListenCallback cb, gpointer cb_data) |
Opens a listening port selected from a range of ports. | |
void | purple_network_listen_cancel (PurpleNetworkListenData *listen_data) |
This can be used to cancel any in-progress listener connection by passing in the return value from either purple_network_listen() or purple_network_listen_range(). | |
unsigned short | purple_network_get_port_from_fd (int fd) |
Gets a port number from a file descriptor. | |
gboolean | purple_network_is_available (void) |
Detects if there is an available Internet connection. | |
void * | purple_network_get_handle (void) |
Get the handle for the network system. | |
void | purple_network_init (void) |
Initializes the network subsystem. | |
void | purple_network_uninit (void) |
Shuts down the network subsystem. |
purple.
Purple 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
|
Get the handle for the network system.
|
|
Returns the IP address of the local system. You probably want to use purple_network_get_my_ip() instead.
|
|
Returns the IP address that should be used anywhere a public IP addresses is needed (listening for an incoming file transfer, etc). If the user has manually specified an IP address via preferences, then this IP is returned. Otherwise the IP address returned by purple_network_get_local_system_ip() is returned.
|
|
Gets a port number from a file descriptor.
|
|
Returns the IP address of the local system set in preferences. This returns the value set via purple_network_set_public_ip(). You probably want to use purple_network_get_my_ip() instead.
|
|
Converts a dot-decimal IP address to an array of unsigned chars. For example, converts 192.168.0.1 to a 4 byte array containing 192, 168, 0 and 1.
|
|
Detects if there is an available Internet connection. Note that this call could block for the amount of time specified in inet_detect_timeout, so using it in a UI thread may cause uncomfortableness
|
|
Attempts to open a listening port ONLY on the specified port number. You probably want to use purple_network_listen_range() instead of this. This function is useful, for example, if you wanted to write a telnet server as a Purple 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 PURPLE_INPUT_READ on the fd returned in cb. It will probably call accept in the watcher callback, and then possibly remove the watcher and close the listening socket, and add a new watcher on the new socket accept returned.
|
|
This can be used to cancel any in-progress listener connection by passing in the return value from either purple_network_listen() or purple_network_listen_range().
|
|
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 operating system. This opens a listening port. The caller will want to set up a watcher of type PURPLE_INPUT_READ on the fd returned in cb. It will probably call accept in the watcher callback, and then possibly remove the watcher and close the listening socket, and add a new watcher on the new socket accept returned.
|
|
Sets the IP address of the local system in preferences. This is the IP address that should be used for incoming connections (file transfer, direct IM, etc.) and should therefore be publicly accessible.
|