annotate libpurple/media/candidate.h @ 31004:3cff7a5e0351

Add a function that allows annotating a contact through a SOAP call.
author Elliott Sales de Andrade <qulogic@pidgin.im>
date Sun, 05 Dec 2010 02:40:39 +0000
parents ad765bf47e23
children 02a2e8183b1d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
29142
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
1 /**
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
2 * @file candidate.h Candidate for Media API
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
3 * @ingroup core
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
4 */
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
5
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
6 /* purple
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
7 *
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
8 * Purple is the legal property of its developers, whose names are too numerous
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
9 * to list here. Please refer to the COPYRIGHT file distributed with this
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
10 * source distribution.
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
11 *
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
12 * This program is free software; you can redistribute it and/or modify
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
13 * it under the terms of the GNU General Public License as published by
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
14 * the Free Software Foundation; either version 2 of the License, or
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
15 * (at your option) any later version.
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
16 *
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
17 * This program is distributed in the hope that it will be useful,
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
20 * GNU General Public License for more details.
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
21 *
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
22 * You should have received a copy of the GNU General Public License
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
23 * along with this program; if not, write to the Free Software
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
25 */
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
26
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
27 #ifndef _PURPLE_MEDIA_CANDIDATE_H_
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
28 #define _PURPLE_MEDIA_CANDIDATE_H_
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
29
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
30 #include "enum-types.h"
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
31
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
32 #include <glib-object.h>
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
33
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
34 G_BEGIN_DECLS
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
35
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
36 #define PURPLE_TYPE_MEDIA_CANDIDATE (purple_media_candidate_get_type())
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
37 #define PURPLE_IS_MEDIA_CANDIDATE(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), PURPLE_TYPE_MEDIA_CANDIDATE))
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
38 #define PURPLE_IS_MEDIA_CANDIDATE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_MEDIA_CANDIDATE))
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
39 #define PURPLE_MEDIA_CANDIDATE(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), PURPLE_TYPE_MEDIA_CANDIDATE, PurpleMediaCandidate))
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
40 #define PURPLE_MEDIA_CANDIDATE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_MEDIA_CANDIDATE, PurpleMediaCandidate))
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
41 #define PURPLE_MEDIA_CANDIDATE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_MEDIA_CANDIDATE, PurpleMediaCandidate))
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
42
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
43 /** An opaque structure representing a network candidate (IP Address and port pair). */
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
44 typedef struct _PurpleMediaCandidate PurpleMediaCandidate;
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
45
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
46 /**
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
47 * Gets the type of the media candidate structure.
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
48 *
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
49 * @return The media canditate's GType
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
50 *
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
51 * @since 2.6.0
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
52 */
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
53 GType purple_media_candidate_get_type(void);
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
54
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
55 /**
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
56 * Creates a PurpleMediaCandidate instance.
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
57 *
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
58 * @param foundation The foundation of the candidate.
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
59 * @param component_id The component this candidate is for.
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
60 * @param type The type of candidate.
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
61 * @param proto The protocol this component is for.
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
62 * @param ip The IP address of this component.
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
63 * @param port The network port.
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
64 *
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
65 * @return The newly created PurpleMediaCandidate instance.
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
66 *
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
67 * @since 2.6.0
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
68 */
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
69 PurpleMediaCandidate *purple_media_candidate_new(
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
70 const gchar *foundation, guint component_id,
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
71 PurpleMediaCandidateType type,
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
72 PurpleMediaNetworkProtocol proto,
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
73 const gchar *ip, guint port);
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
74
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
75 /**
29164
ec069900bf96 Add purple_media_candidate_copy to the public API.
maiku@pidgin.im
parents: 29142
diff changeset
76 * Copies a PurpleMediaCandidate.
ec069900bf96 Add purple_media_candidate_copy to the public API.
maiku@pidgin.im
parents: 29142
diff changeset
77 *
ec069900bf96 Add purple_media_candidate_copy to the public API.
maiku@pidgin.im
parents: 29142
diff changeset
78 * @param candidate The candidate to copy.
ec069900bf96 Add purple_media_candidate_copy to the public API.
maiku@pidgin.im
parents: 29142
diff changeset
79 *
ec069900bf96 Add purple_media_candidate_copy to the public API.
maiku@pidgin.im
parents: 29142
diff changeset
80 * @return The copy of the PurpleMediaCandidate.
ec069900bf96 Add purple_media_candidate_copy to the public API.
maiku@pidgin.im
parents: 29142
diff changeset
81 *
ec069900bf96 Add purple_media_candidate_copy to the public API.
maiku@pidgin.im
parents: 29142
diff changeset
82 * @since 2.7.0
ec069900bf96 Add purple_media_candidate_copy to the public API.
maiku@pidgin.im
parents: 29142
diff changeset
83 */
ec069900bf96 Add purple_media_candidate_copy to the public API.
maiku@pidgin.im
parents: 29142
diff changeset
84 PurpleMediaCandidate *purple_media_candidate_copy(
ec069900bf96 Add purple_media_candidate_copy to the public API.
maiku@pidgin.im
parents: 29142
diff changeset
85 PurpleMediaCandidate *candidate);
ec069900bf96 Add purple_media_candidate_copy to the public API.
maiku@pidgin.im
parents: 29142
diff changeset
86
ec069900bf96 Add purple_media_candidate_copy to the public API.
maiku@pidgin.im
parents: 29142
diff changeset
87 /**
29142
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
88 * Copies a GList of PurpleMediaCandidate and its contents.
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
89 *
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
90 * @param candidates The list of candidates to be copied.
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
91 *
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
92 * @return The copy of the GList.
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
93 *
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
94 * @since 2.6.0
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
95 */
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
96 GList *purple_media_candidate_list_copy(GList *candidates);
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
97
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
98 /**
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
99 * Frees a GList of PurpleMediaCandidate and its contents.
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
100 *
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
101 * @param candidates The list of candidates to be freed.
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
102 *
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
103 * @since 2.6.0
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
104 */
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
105 void purple_media_candidate_list_free(GList *candidates);
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
106
29242
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
107 /**
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
108 * Gets the foundation (identifier) from the candidate.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
109 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
110 * @param candidate The candidate to get the foundation from.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
111 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
112 * @return The foundation.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
113 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
114 * @since 2.6.0
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
115 */
29142
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
116 gchar *purple_media_candidate_get_foundation(PurpleMediaCandidate *candidate);
29242
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
117
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
118 /**
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
119 * Gets the component id (rtp or rtcp)
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
120 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
121 * @param candidate The candidate to get the compnent id from.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
122 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
123 * @return The component id.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
124 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
125 * @since 2.6.0
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
126 */
29142
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
127 guint purple_media_candidate_get_component_id(PurpleMediaCandidate *candidate);
29242
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
128
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
129 /**
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
130 * Gets the IP address.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
131 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
132 * @param candidate The candidate to get the IP address from.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
133 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
134 * @return The IP address.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
135 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
136 * @since 2.6.0
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
137 */
29142
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
138 gchar *purple_media_candidate_get_ip(PurpleMediaCandidate *candidate);
29242
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
139
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
140 /**
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
141 * Gets the port.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
142 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
143 * @param candidate The candidate to get the port from.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
144 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
145 * @return The port.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
146 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
147 * @since 2.6.0
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
148 */
29142
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
149 guint16 purple_media_candidate_get_port(PurpleMediaCandidate *candidate);
29242
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
150
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
151 /**
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
152 * Gets the base (internal) IP address.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
153 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
154 * This can be NULL.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
155 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
156 * @param candidate The candidate to get the base IP address from.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
157 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
158 * @return The base IP address.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
159 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
160 * @since 2.6.0
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
161 */
29142
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
162 gchar *purple_media_candidate_get_base_ip(PurpleMediaCandidate *candidate);
29242
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
163
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
164 /**
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
165 * Gets the base (internal) port.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
166 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
167 * Invalid if the base IP is NULL.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
168 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
169 * @param candidate The candidate to get the base port.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
170 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
171 * @return The base port.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
172 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
173 * @since 2.6.0
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
174 */
29142
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
175 guint16 purple_media_candidate_get_base_port(PurpleMediaCandidate *candidate);
29242
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
176
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
177 /**
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
178 * Gets the protocol (TCP or UDP).
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
179 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
180 * @param candidate The candidate to get the protocol from.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
181 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
182 * @return The protocol.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
183 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
184 * @since 2.6.0
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
185 */
29142
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
186 PurpleMediaNetworkProtocol purple_media_candidate_get_protocol(
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
187 PurpleMediaCandidate *candidate);
29242
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
188
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
189 /**
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
190 * Gets the priority.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
191 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
192 * @param candidate The candidate to get the priority from.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
193 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
194 * @return The priority.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
195 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
196 * @since 2.6.0
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
197 */
29142
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
198 guint32 purple_media_candidate_get_priority(PurpleMediaCandidate *candidate);
29242
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
199
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
200 /**
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
201 * Gets the candidate type.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
202 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
203 * @param candidate The candidate to get the candidate type from.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
204 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
205 * @return The candidate type.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
206 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
207 * @since 2.6.0
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
208 */
29142
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
209 PurpleMediaCandidateType purple_media_candidate_get_candidate_type(
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
210 PurpleMediaCandidate *candidate);
29242
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
211
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
212 /**
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
213 * Gets the username.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
214 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
215 * This can be NULL. It depends on the transmission type.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
216 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
217 * @param The candidate to get the username from.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
218 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
219 * @return The username.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
220 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
221 * @since 2.6.0
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
222 */
29142
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
223 gchar *purple_media_candidate_get_username(PurpleMediaCandidate *candidate);
29242
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
224
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
225 /**
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
226 * Gets the password.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
227 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
228 * This can be NULL. It depends on the transmission type.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
229 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
230 * @param The candidate to get the password from.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
231 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
232 * @return The password.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
233 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
234 * @since 2.6.0
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
235 */
29142
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
236 gchar *purple_media_candidate_get_password(PurpleMediaCandidate *candidate);
29242
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
237
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
238 /**
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
239 * Gets the TTL.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
240 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
241 * @param The candidate to get the TTL from.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
242 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
243 * @return The TTL.
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
244 *
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
245 * @since 2.6.0
ad765bf47e23 Document the remaining functions.
maiku@pidgin.im
parents: 29164
diff changeset
246 */
29142
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
247 guint purple_media_candidate_get_ttl(PurpleMediaCandidate *candidate);
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
248
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
249 G_END_DECLS
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
250
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
251 #endif /* _PURPLE_MEDIA_CANDIDATE_H_ */
f585e10f156b Split out PurpleMediaCandidate into its own file.
maiku@pidgin.im
parents:
diff changeset
252