pidgin/pidgin

closing merged branch
port-changes-from-branch-2.x.y-to-default
14 months ago, Gary Kramlich
2f836435c33c
closing merged branch
/* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#ifndef PURPLE_NETWORK_H
#define PURPLE_NETWORK_H
/**
* SECTION:network
* @section_id: libpurple-network
* @short_description: <filename>network.h</filename>
* @title: Network API
*/
#include <glib.h>
#include <gio/gio.h>
G_BEGIN_DECLS
/**************************************************************************/
/* Network API */
/**************************************************************************/
typedef struct _PurpleNetworkListenData PurpleNetworkListenData;
typedef void (*PurpleNetworkListenCallback) (int listenfd, gpointer data);
/**
* purple_network_set_public_ip:
* @ip: The local IP address.
*
* 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.
*/
void purple_network_set_public_ip(const char *ip);
/**
* purple_network_get_public_ip:
*
* 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.
*
* Returns: The local IP address set in preferences.
*/
const char *purple_network_get_public_ip(void);
/**
* purple_network_get_local_system_ip:
* @fd: The fd to use to help figure out the IP, or else -1.
*
* Returns the IP address of the local system.
*
* You probably want to use purple_network_get_my_ip() 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.
*
* Returns: The local IP address.
*/
const char *purple_network_get_local_system_ip(int fd);
/**
* purple_network_get_all_local_system_ips:
*
* Returns all IP addresses of the local system.
*
* Note: The caller must free this list. If libpurple was built with
* support for it, this function also enumerates IPv6 addresses.
*
* Returns: (element-type utf8) (transfer full): A list of local IP addresses.
*/
GList *purple_network_get_all_local_system_ips(void);
/**
* purple_network_get_my_ip:
* @fd: The fd to use to help figure out the IP, or -1.
*
* 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.
*
* 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.
*
* Returns: The local IP address to be used.
*/
const char *purple_network_get_my_ip(int fd);
/**
* purple_network_get_my_ip_from_gio:
* @sockconn: The socket connection to use to help figure out the IP, or %NULL.
*
* 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_from_gio()
* is returned.
*
* Returns: The local IP address to be used.
*/
gchar *purple_network_get_my_ip_from_gio(GSocketConnection *sockconn);
/**
* purple_network_listen:
* @port: The port number to bind to. Must be greater than 0.
* @socket_family: The protocol family of the socket. This should be
* AF_INET for IPv4 or AF_INET6 for IPv6. IPv6 sockets
* may or may not be able to accept IPv4 connections
* based on the system configuration (use
* purple_socket_speaks_ipv4 to check). If an IPv6
* socket doesn't accept V4-mapped addresses, you will
* need a second listener to support both v4 and v6.
* @socket_type: The type of socket to open for listening.
* This will be either SOCK_STREAM for TCP or SOCK_DGRAM for UDP.
* @map_external: Should the open port be mapped externally using
* NAT-PNP or UPnP? (default should be %TRUE)
* @cb: (scope call): The callback to be invoked when the port to listen on is
* available. The file descriptor of the listening socket will be
* specified in this callback, or -1 if no socket could be established.
* @cb_data: extra data to be returned when cb is called
*
* 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.
*
* Libpurple does not currently do any port mapping (stateful firewall hole
* poking) for IPv6-only listeners (if an IPv6 socket supports v4-mapped
* addresses, a mapping is done).
*
* Returns: (transfer full): A pointer to a data structure that can be used to cancel
* the pending listener, or %NULL if unable to obtain a local
* socket to listen on.
*/
PurpleNetworkListenData *purple_network_listen(unsigned short port,
int socket_family, int socket_type, gboolean map_external,
PurpleNetworkListenCallback cb, gpointer cb_data);
/**
* purple_network_listen_range:
* @start: The port number to bind to, or 0 to pick a random port.
* Users are allowed to override this arg in prefs.
* @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.
* @socket_family: The protocol family of the socket. This should be
* AF_INET for IPv4 or AF_INET6 for IPv6. IPv6 sockets
* may or may not be able to accept IPv4 connections
* based on the system configuration (use
* purple_socket_speaks_ipv4 to check). If an IPv6
* socket doesn't accept V4-mapped addresses, you will
* need a second listener to support both v4 and v6.
* @socket_type: The type of socket to open for listening.
* This will be either SOCK_STREAM for TCP or SOCK_DGRAM for UDP.
* @map_external: Should the open port be mapped externally using
* NAT-PNP or UPnP? (default should be %TRUE)
* @cb: (scope call): The callback to be invoked when the port to listen on is
* available. The file descriptor of the listening socket will be
* specified in this callback, or -1 if no socket could be established.
* @cb_data: extra data to be returned when cb is called
*
* 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.
*
* Libpurple does not currently do any port mapping (stateful firewall hole
* poking) for IPv6-only listeners (if an IPv6 socket supports v4-mapped
* addresses, a mapping is done).
*
* Returns: (transfer full): A pointer to a data structure that can be used to cancel
* the pending listener, or %NULL if unable to obtain a local
* socket to listen on.
*/
PurpleNetworkListenData *purple_network_listen_range(
unsigned short start, unsigned short end, int socket_family,
int socket_type, gboolean map_external,
PurpleNetworkListenCallback cb, gpointer cb_data);
/**
* purple_network_listen_cancel:
* @listen_data: This listener attempt will be cancelled and
* the struct will be freed.
*
* 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().
*/
void purple_network_listen_cancel(PurpleNetworkListenData *listen_data);
/**
* purple_network_get_port_from_fd:
* @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 Purple.
*
* Gets a port number from a file descriptor.
*
* Returns: The port number, in host byte order.
*/
unsigned short purple_network_get_port_from_fd(int fd);
/**
* purple_network_is_available:
*
* Detects if there is an available network connection.
*
* Returns: TRUE if the network is available
*/
gboolean purple_network_is_available(void);
/**
* purple_network_force_online:
*
* Makes purple_network_is_available() always return %TRUE.
*
* This is what backs the --force-online command line argument in Pidgin,
* for example. This is useful for offline testing, especially when
* combined with nullprotocol.
*/
void purple_network_force_online(void);
/**
* purple_network_get_handle:
*
* Get the handle for the network system
*
* Returns: the handle to the network system
*/
void *purple_network_get_handle(void);
/**
* purple_network_set_stun_server:
* @stun_server: The host name of the STUN server to set
*
* Update the STUN server IP given the host name
* Will result in a DNS query being executed asynchronous
*/
void purple_network_set_stun_server(const gchar *stun_server);
/**
* purple_network_get_stun_ip:
*
* Get the IP address of the STUN server as a string representation
*
* Returns: the IP address
*/
const gchar *purple_network_get_stun_ip(void);
/**
* purple_network_set_turn_server:
* @turn_server: The host name of the TURN server to set
*
* Update the TURN server IP given the host name
* Will result in a DNS query being executed asynchronous
*/
void purple_network_set_turn_server(const gchar *turn_server);
/**
* purple_network_get_turn_ip:
*
* Get the IP address of the TURN server as a string representation
*
* Returns: the IP address
*/
const gchar *purple_network_get_turn_ip(void);
/**
* purple_network_remove_port_mapping:
* @fd: Socket to remove the port mapping for
*
* Remove a port mapping (UPnP or NAT-PMP) associated with listening socket
*/
void purple_network_remove_port_mapping(gint fd);
/**
* purple_network_init:
*
* Initializes the network subsystem.
*/
void purple_network_init(void);
/**
* purple_network_uninit:
*
* Shuts down the network subsystem.
*/
void purple_network_uninit(void);
G_END_DECLS
#endif /* PURPLE_NETWORK_H */