Mercurial > pidgin
annotate libgaim/stun.h @ 14956:0b98802a97cf
[gaim-migrate @ 17735]
(09:35:51) Alver: http://studwww.ugent.be/~lvalboom/zephyr.patch
(09:36:03) LSchiere2: how many do you have?
(09:36:14) Alver: That's all so far
committer: Tailor Script <tailor@pidgin.im>
author | Luke Schierer <lschiere@pidgin.im> |
---|---|
date | Fri, 10 Nov 2006 14:38:08 +0000 |
parents | 500a8f54354e |
children |
rev | line source |
---|---|
14192 | 1 /** |
2 * @file stun.h STUN 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 #ifndef _GAIM_STUN_H_ | |
26 #define _GAIM_STUN_H_ | |
27 | |
14926
500a8f54354e
[gaim-migrate @ 17698]
Richard Laager <rlaager@wiktel.com>
parents:
14192
diff
changeset
|
28 #ifdef __cplusplus |
500a8f54354e
[gaim-migrate @ 17698]
Richard Laager <rlaager@wiktel.com>
parents:
14192
diff
changeset
|
29 extern "C" { |
500a8f54354e
[gaim-migrate @ 17698]
Richard Laager <rlaager@wiktel.com>
parents:
14192
diff
changeset
|
30 #endif |
500a8f54354e
[gaim-migrate @ 17698]
Richard Laager <rlaager@wiktel.com>
parents:
14192
diff
changeset
|
31 |
14192 | 32 /**************************************************************************/ |
33 /** @name STUN API */ | |
34 /**************************************************************************/ | |
35 /*@{*/ | |
36 | |
37 typedef struct _GaimStunNatDiscovery GaimStunNatDiscovery; | |
38 | |
39 typedef enum { | |
40 GAIM_STUN_STATUS_UNDISCOVERED = -1, | |
41 GAIM_STUN_STATUS_UNKNOWN, /* no STUN server reachable */ | |
42 GAIM_STUN_STATUS_DISCOVERING, | |
43 GAIM_STUN_STATUS_DISCOVERED | |
44 } GaimStunStatus; | |
45 | |
46 typedef enum { | |
47 GAIM_STUN_NAT_TYPE_PUBLIC_IP, | |
48 GAIM_STUN_NAT_TYPE_UNKNOWN_NAT, | |
49 GAIM_STUN_NAT_TYPE_FULL_CONE, | |
50 GAIM_STUN_NAT_TYPE_RESTRICTED_CONE, | |
51 GAIM_STUN_NAT_TYPE_PORT_RESTRICTED_CONE, | |
52 GAIM_STUN_NAT_TYPE_SYMMETRIC | |
53 } GaimStunNatType; | |
54 | |
55 struct _GaimStunNatDiscovery { | |
56 GaimStunStatus status; | |
57 GaimStunNatType type; | |
58 char publicip[16]; | |
59 char *servername; | |
60 time_t lookup_time; | |
61 }; | |
62 | |
63 typedef void (*StunCallback) (GaimStunNatDiscovery *); | |
64 | |
65 /** | |
66 * Starts a NAT discovery. It returns a GaimStunNatDiscovery if the discovery | |
67 * is already done. Otherwise the callback is called when the discovery is over | |
68 * and NULL is returned. | |
69 * | |
70 * @param cb The callback to call when the STUN discovery is finished if the | |
71 * discovery would block. If the discovery is done, this is NOT | |
72 * called. | |
73 * | |
74 * @return a GaimStunNatDiscovery which includes the public IP and the type | |
75 * of NAT or NULL is discovery would block | |
76 */ | |
77 GaimStunNatDiscovery *gaim_stun_discover(StunCallback cb); | |
78 | |
79 void gaim_stun_init(void); | |
80 | |
81 /*@}*/ | |
82 | |
14926
500a8f54354e
[gaim-migrate @ 17698]
Richard Laager <rlaager@wiktel.com>
parents:
14192
diff
changeset
|
83 #ifdef __cplusplus |
500a8f54354e
[gaim-migrate @ 17698]
Richard Laager <rlaager@wiktel.com>
parents:
14192
diff
changeset
|
84 } |
500a8f54354e
[gaim-migrate @ 17698]
Richard Laager <rlaager@wiktel.com>
parents:
14192
diff
changeset
|
85 #endif |
500a8f54354e
[gaim-migrate @ 17698]
Richard Laager <rlaager@wiktel.com>
parents:
14192
diff
changeset
|
86 |
14192 | 87 #endif /* _GAIM_STUN_H_ */ |