Mercurial > pidgin
annotate src/stun.h @ 13545:cfc2f7fcb3dd
[gaim-migrate @ 15922]
Way more changes that I initially thought I was going to make. I apologize
for the commit message spam. These changes bring a lot of consistency to
our capitalization and punctuation, especially of words like "e-mail".
For reference, I've used these rules (after discussing in #gaim):
e-mail, a case of two words joined:
"e-mail" - in the middle of a sentence caps context
"E-mail" - start of text in a sentence caps context
"E-Mail" - in a header (title) caps context
re-enable, a single word, would be:
"re-enable", "Re-enable", and "Re-enable" (respectively)
The reason this changeset exploded is that, as I went through and verified
these changes, I realized we were using improper capitalization (e.g. header
instead of sentence) in a number of dialogs. I fixed a number of these
cases before, and this corrects another pile.
This looks like I've made a LOT of work for the translators, but the impact
is significantly mitigated by three factors: 1) Many of these changes use
strings that already exist, or change one string in many places. 2) I've
used sed to correct the .po files where possible. 3) The actual changes
are extremely trivial.
committer: Tailor Script <tailor@pidgin.im>
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Tue, 21 Mar 2006 04:32:45 +0000 |
parents | 6ef1cdc26b40 |
children |
rev | line source |
---|---|
11225 | 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 | |
28 /**************************************************************************/ | |
29 /** @name STUN API */ | |
30 /**************************************************************************/ | |
12050 | 31 /*@{*/ |
11225 | 32 |
12686
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
33 typedef struct _GaimStunNatDiscovery GaimStunNatDiscovery; |
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
34 |
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
35 typedef enum { |
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
36 GAIM_STUN_STATUS_UNDISCOVERED = -1, |
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
37 GAIM_STUN_STATUS_UNKNOWN, /* no STUN server reachable */ |
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
38 GAIM_STUN_STATUS_DISCOVERING, |
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
39 GAIM_STUN_STATUS_DISCOVERED |
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
40 } GaimStunStatus; |
11829
4669e7461968
[gaim-migrate @ 14120]
Richard Laager <rlaager@wiktel.com>
parents:
11501
diff
changeset
|
41 |
12686
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
42 typedef enum { |
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
43 GAIM_STUN_NAT_TYPE_PUBLIC_IP, |
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
44 GAIM_STUN_NAT_TYPE_UNKNOWN_NAT, |
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
45 GAIM_STUN_NAT_TYPE_FULL_CONE, |
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
46 GAIM_STUN_NAT_TYPE_RESTRICTED_CONE, |
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
47 GAIM_STUN_NAT_TYPE_PORT_RESTRICTED_CONE, |
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
48 GAIM_STUN_NAT_TYPE_SYMMETRIC |
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
49 } GaimStunNatType; |
11829
4669e7461968
[gaim-migrate @ 14120]
Richard Laager <rlaager@wiktel.com>
parents:
11501
diff
changeset
|
50 |
12686
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
51 struct _GaimStunNatDiscovery { |
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
52 GaimStunStatus status; |
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
53 GaimStunNatType type; |
11225 | 54 char publicip[16]; |
12756
6ef1cdc26b40
[gaim-migrate @ 15103]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
12686
diff
changeset
|
55 char *servername; |
6ef1cdc26b40
[gaim-migrate @ 15103]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
12686
diff
changeset
|
56 time_t lookup_time; |
11225 | 57 }; |
12050 | 58 |
12686
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
59 typedef void (*StunCallback) (GaimStunNatDiscovery *); |
11225 | 60 |
61 /** | |
12686
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
62 * Starts a NAT discovery. It returns a GaimStunNatDiscovery if the discovery |
11225 | 63 * is already done. Otherwise the callback is called when the discovery is over |
64 * and NULL is returned. | |
65 * | |
12686
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
66 * @param cb The callback to call when the STUN discovery is finished if the |
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
67 * discovery would block. If the discovery is done, this is NOT |
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
68 * called. |
11225 | 69 * |
12686
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
70 * @return a GaimStunNatDiscovery which includes the public IP and the type |
11225 | 71 * of NAT or NULL is discovery would block |
72 */ | |
12686
5f65a0cca87c
[gaim-migrate @ 15029]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
73 GaimStunNatDiscovery *gaim_stun_discover(StunCallback cb); |
11225 | 74 |
12323
fc464a0abccc
[gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents:
12050
diff
changeset
|
75 void gaim_stun_init(void); |
12050 | 76 |
77 /*@}*/ | |
78 | |
11225 | 79 #endif /* _GAIM_STUN_H_ */ |