Mercurial > pidgin.yaz
annotate src/upnp.h @ 11361:e4868370c433
[gaim-migrate @ 13585]
cleaning out my tree
committer: Tailor Script <tailor@pidgin.im>
author | Nathan Walp <nwalp@pidgin.im> |
---|---|
date | Mon, 29 Aug 2005 04:53:17 +0000 |
parents | ff728e84d59a |
children | d3755a7ddd82 |
rev | line source |
---|---|
11195 | 1 /** |
2 * @file upnp.h Universal Plug N Play API | |
3 * @ingroup core | |
4 * | |
5 * gaim | |
6 * | |
7 * Gaim is the legal property of its developers, whose names are too numerous | |
8 * to list here. Please refer to the COPYRIGHT file distributed with this | |
9 * source distribution. | |
10 * | |
11 * This program is free software; you can redistribute it and/or modify | |
12 * it under the terms of the GNU General Public License as published by | |
13 * the Free Software Foundation; either version 2 of the License, or | |
14 * (at your option) any later version. | |
15 * | |
16 * This program is distributed in the hope that it will be useful, | |
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 * GNU General Public License for more details. | |
20 * | |
21 * You should have received a copy of the GNU General Public License | |
22 * along with this program; if not, write to the Free Software | |
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
24 */ | |
25 | |
26 #ifndef _GAIM_UPNP_H_ | |
27 #define _GAIM_UPNP_H_ | |
28 | |
29 #ifdef __cplusplus | |
30 extern "C" { | |
31 #endif | |
32 | |
33 /**************************************************************************/ | |
34 /** @name UPnP API */ | |
35 /**************************************************************************/ | |
36 /*@{*/ | |
37 | |
38 /** | |
39 * Sends a discovery request to search for a UPnP enabled IGD that | |
40 * contains the WANIPConnection service that will allow us to recieve the | |
41 * public IP address of the IGD, and control it for forwarding ports. | |
42 * | |
43 * @param void | |
44 * | |
45 * @return The control URL for the IGD we'll use to use the IGD services | |
46 */ | |
11208
0a3a85452896
[gaim-migrate @ 13339]
Richard Laager <rlaager@wiktel.com>
parents:
11199
diff
changeset
|
47 char* gaim_upnp_discover(void); |
11195 | 48 |
49 | |
11213 | 50 |
11195 | 51 /** |
52 * Gets the IP address from a UPnP enabled IGD that sits on the local | |
53 * network, so when getting the network IP, instead of returning the | |
54 * local network IP, the public IP is retrieved. | |
55 * | |
56 * @param controlURL The control URL retrieved from gaim_upnp_discover. | |
57 * | |
58 * @return The IP address of the network, or NULL if something went wrong | |
59 */ | |
11208
0a3a85452896
[gaim-migrate @ 13339]
Richard Laager <rlaager@wiktel.com>
parents:
11199
diff
changeset
|
60 char* gaim_upnp_get_public_ip(const char* controlURL); |
11195 | 61 |
62 | |
63 /** | |
64 * Maps Ports in a UPnP enabled IGD that sits on the local network to | |
65 * this gaim client. Essentially, this function takes care of the port | |
66 * forwarding so things like file transfers can work behind NAT firewalls | |
67 * | |
68 * @param controlURL The control URL retrieved from gaim_upnp_discover. | |
69 * @param portMap The port to map to this client | |
70 * @param protocol The protocol to map, either "TCP" or "UDP" | |
71 * | |
72 * @return TRUE if success, FALSE if something went wrong. | |
73 */ | |
74 gboolean gaim_upnp_set_port_mapping(const char* controlURL, | |
75 unsigned short portMap, | |
11196 | 76 const char* protocol); |
11195 | 77 |
78 /** | |
79 * Deletes a port mapping in a UPnP enabled IGD that sits on the local network | |
80 * to this gaim client. Essentially, this function takes care of deleting the | |
81 * port forwarding after they have completed a connection so another client on | |
82 * the local network can take advantage of the port forwarding | |
83 * | |
84 * @param controlURL The control URL retrieved from gaim_upnp_discover. | |
85 * @param portMap The port to delete the mapping for | |
86 * @param protocol The protocol to map to. Either "TCP" or "UDP" | |
87 * | |
88 * @return TRUE if success, FALSE if something went wrong. | |
89 */ | |
90 gboolean | |
91 gaim_upnp_remove_port_mapping(const char* controlURL, unsigned short portMap, | |
92 const char* protocol); | |
93 /*@}*/ | |
94 | |
95 | |
96 #ifdef __cplusplus | |
97 } | |
98 #endif | |
99 | |
100 #endif /* _GAIM_UPNP_H_ */ |