version: Add NICE_CHECK_VERSION to the documentation
[platform/upstream/libnice.git] / docs / reference / libnice / libnice-sections.txt
1 <SECTION>
2 <FILE>agent</FILE>
3 <TITLE>NiceAgent</TITLE>
4 NiceAgent
5 NiceComponentState
6 NiceComponentType
7 NiceProxyType
8 NiceNominationMode
9 NiceCompatibility
10 NiceAgentRecvFunc
11 NiceInputMessage
12 NiceOutputMessage
13 NICE_AGENT_MAX_REMOTE_CANDIDATES
14 nice_agent_new
15 nice_agent_new_reliable
16 nice_agent_new_full
17 NiceAgentOption
18 nice_agent_add_local_address
19 nice_agent_set_port_range
20 nice_agent_add_stream
21 nice_agent_remove_stream
22 nice_agent_set_relay_info
23 nice_agent_forget_relays
24 nice_agent_gather_candidates
25 nice_agent_set_remote_credentials
26 nice_agent_get_local_credentials
27 nice_agent_set_local_credentials
28 nice_agent_set_remote_candidates
29 nice_agent_get_remote_candidates
30 nice_agent_get_local_candidates
31 nice_agent_get_selected_pair
32 nice_agent_peer_candidate_gathering_done
33 nice_agent_send
34 nice_agent_send_messages_nonblocking
35 nice_agent_recv
36 nice_agent_recv_messages
37 nice_agent_recv_nonblocking
38 nice_agent_recv_messages_nonblocking
39 nice_agent_attach_recv
40 nice_agent_set_selected_pair
41 nice_agent_set_selected_remote_candidate
42 nice_agent_set_stream_tos
43 nice_agent_set_software
44 nice_agent_restart
45 nice_agent_restart_stream
46 nice_agent_set_stream_name
47 nice_agent_get_stream_name
48 nice_agent_get_default_local_candidate
49 nice_agent_generate_local_sdp
50 nice_agent_generate_local_stream_sdp
51 nice_agent_generate_local_candidate_sdp
52 nice_agent_parse_remote_sdp
53 nice_agent_parse_remote_stream_sdp
54 nice_agent_parse_remote_candidate_sdp
55 nice_agent_get_io_stream
56 nice_agent_get_selected_socket
57 nice_agent_get_sockets
58 nice_agent_get_component_state
59 nice_agent_close_async
60 nice_agent_consent_lost
61 nice_component_state_to_string
62 NICE_CHECK_VERSION
63 <SUBSECTION Standard>
64 NICE_AGENT
65 NICE_IS_AGENT
66 NICE_TYPE_AGENT
67 nice_agent_get_type
68 NICE_AGENT_CLASS
69 NICE_IS_AGENT_CLASS
70 NICE_AGENT_GET_CLASS
71 NICE_TYPE_AGENT_OPTION
72 NICE_TYPE_COMPATIBILITY
73 NICE_TYPE_COMPONENT_STATE
74 NICE_TYPE_COMPONENT_TYPE
75 NICE_TYPE_NOMINATION_MODE
76 NICE_TYPE_PROXY_TYPE
77 nice_agent_option_get_type
78 nice_compatibility_get_type
79 nice_component_state_get_type
80 nice_component_type_get_type
81 nice_nomination_mode_get_type
82 nice_proxy_type_get_type
83 <SUBSECTION Private>
84 NiceAgentClass
85 </SECTION>
86
87 <SECTION>
88 <FILE>candidate</FILE>
89 <TITLE>NiceCandidate</TITLE>
90 NiceCandidate
91 NiceCandidateType
92 NiceCandidateTransport
93 NiceRelayType
94 NICE_CANDIDATE_MAX_FOUNDATION
95 NICE_CANDIDATE_MAX_TURN_SERVERS
96 NICE_CANDIDATE_MAX_LOCAL_ADDRESSES
97 nice_candidate_new
98 nice_candidate_free
99 nice_candidate_copy
100 nice_candidate_equal_target
101 nice_candidate_transport_to_string
102 nice_candidate_type_to_string
103 nice_candidate_relay_address
104 nice_candidate_stun_server_address
105 <SUBSECTION Standard>
106 NICE_TYPE_CANDIDATE
107 nice_candidate_get_type
108 nice_candidate_transport_get_type
109 nice_candidate_type_get_type
110 nice_relay_type_get_type
111 NICE_TYPE_RELAY_TYPE
112 NICE_TYPE_CANDIDATE_TRANSPORT
113 NICE_TYPE_CANDIDATE_TYPE
114 <SUBSECTION Private>
115 NICE_CANDIDATE_TYPE_PREF_HOST
116 NICE_CANDIDATE_TYPE_PREF_PEER_REFLEXIVE
117 NICE_CANDIDATE_TYPE_PREF_SERVER_REFLEXIVE
118 NICE_CANDIDATE_TYPE_PREF_RELAYED
119 NICE_CANDIDATE_TYPE_PREF_NAT_ASSISTED
120 NICE_CANDIDATE_TYPE_PREF_UDP_TUNNELED
121 NICE_CANDIDATE_TYPE_PREF_RELAYED_UDP
122 NICE_CANDIDATE_DIRECTION_MS_PREF_ACTIVE
123 NICE_CANDIDATE_DIRECTION_MS_PREF_PASSIVE
124 NICE_CANDIDATE_TRANSPORT_MS_PREF_TCP
125 NICE_CANDIDATE_TRANSPORT_MS_PREF_UDP
126 TurnServer
127 </SECTION>
128
129 <SECTION>
130 <FILE>address</FILE>
131 <TITLE>NiceAddress</TITLE>
132 NiceAddress
133 NICE_ADDRESS_STRING_LEN
134 nice_address_init
135 nice_address_new
136 nice_address_free
137 nice_address_dup
138 nice_address_set_ipv4
139 nice_address_set_ipv6
140 nice_address_set_port
141 nice_address_get_port
142 nice_address_set_from_string
143 nice_address_set_from_sockaddr
144 nice_address_copy_to_sockaddr
145 nice_address_equal
146 nice_address_equal_no_port
147 nice_address_to_string
148 nice_address_is_private
149 nice_address_is_linklocal
150 nice_address_is_valid
151 nice_address_ip_version
152 <SUBSECTION Standard>
153 NICE_TYPE_ADDRESS
154 nice_address_get_type
155 </SECTION>
156
157
158 <SECTION>
159 <FILE>debug</FILE>
160 <TITLE>Debug messages</TITLE>
161 nice_debug_enable
162 nice_debug_disable
163 </SECTION>
164
165 <SECTION>
166 <FILE>interfaces</FILE>
167 <TITLE>Network interfaces discovery</TITLE>
168 nice_interfaces_get_ip_for_interface
169 nice_interfaces_get_local_interfaces
170 nice_interfaces_get_local_ips
171 </SECTION>
172
173 <SECTION>
174 <FILE>stunagent</FILE>
175 <TITLE>StunAgent</TITLE>
176 StunAgent
177 StunCompatibility
178 StunAgentUsageFlags
179 StunValidationStatus
180 StunMessageIntegrityValidate
181 StunDefaultValidaterData
182 StunDebugHandler
183 stun_agent_init
184 stun_agent_validate
185 stun_agent_default_validater
186 stun_agent_init_request
187 stun_agent_init_indication
188 stun_agent_init_response
189 stun_agent_init_error
190 stun_agent_build_unknown_attributes_error
191 stun_agent_finish_message
192 stun_agent_forget_transaction
193 stun_agent_set_software
194 stun_debug_enable
195 stun_debug_disable
196 stun_set_debug_handler
197 <SUBSECTION Private>
198 StunAgentSavedIds
199 stun_debug
200 stun_debug_bytes
201 stun_agent_t
202 </SECTION>
203
204
205 <SECTION>
206 <FILE>stunmessage</FILE>
207 <TITLE>StunMessage</TITLE>
208 StunMessage
209 StunClass
210 StunMethod
211 StunAttribute
212 StunTransactionId
213 StunError
214 StunMessageReturn
215 STUN_MESSAGE_BUFFER_INCOMPLETE
216 STUN_MESSAGE_BUFFER_INVALID
217 stun_message_init
218 stun_message_length
219 stun_message_find
220 stun_message_find_flag
221 stun_message_find32
222 stun_message_find64
223 stun_message_find_string
224 stun_message_find_addr
225 stun_message_find_xor_addr
226 stun_message_find_xor_addr_full
227 stun_message_find_error
228 stun_message_append
229 stun_message_append_bytes
230 stun_message_append_flag
231 stun_message_append32
232 stun_message_append64
233 stun_message_append_string
234 stun_message_append_addr
235 stun_message_append_xor_addr
236 stun_message_append_xor_addr_full
237 stun_message_append_error
238 stun_message_validate_buffer_length
239 StunInputVector
240 stun_message_validate_buffer_length_fast
241 stun_message_id
242 stun_message_get_class
243 stun_message_get_method
244 stun_message_has_attribute
245 stun_message_has_cookie
246 stun_optional
247 stun_strerror
248 </SECTION>
249
250 <SECTION>
251 <FILE>stunconstants</FILE>
252 <TITLE>STUN Constants</TITLE>
253 STUN_AGENT_MAX_SAVED_IDS
254 STUN_AGENT_MAX_UNKNOWN_ATTRIBUTES
255 STUN_ATTRIBUTE_HEADER_LENGTH
256 STUN_ATTRIBUTE_LENGTH_LEN
257 STUN_ATTRIBUTE_LENGTH_POS
258 STUN_ATTRIBUTE_TYPE_LEN
259 STUN_ATTRIBUTE_TYPE_POS
260 STUN_ATTRIBUTE_VALUE_POS
261 STUN_ID_LEN
262 STUN_MAGIC_COOKIE
263 STUN_MAX_MESSAGE_SIZE
264 STUN_MAX_MESSAGE_SIZE_IPV4
265 STUN_MAX_MESSAGE_SIZE_IPV6
266 STUN_MESSAGE_ATTRIBUTES_POS
267 STUN_MESSAGE_HEADER_LENGTH
268 STUN_MESSAGE_LENGTH_LEN
269 STUN_MESSAGE_LENGTH_POS
270 STUN_MESSAGE_TRANS_ID_LEN
271 STUN_MESSAGE_TRANS_ID_POS
272 STUN_MESSAGE_TYPE_LEN
273 STUN_MESSAGE_TYPE_POS
274 TURN_MAGIC_COOKIE
275 </SECTION>
276
277 <SECTION>
278 <FILE>turn</FILE>
279 <TITLE>TURN</TITLE>
280 StunUsageTurnCompatibility
281 StunUsageTurnRequestPorts
282 StunUsageTurnReturn
283 stun_usage_turn_create
284 stun_usage_turn_create_refresh
285 stun_usage_turn_process
286 stun_usage_turn_refresh_process
287 stun_usage_turn_create_permission
288 </SECTION>
289
290 <SECTION>
291 <FILE>ice</FILE>
292 <TITLE>ICE</TITLE>
293 StunUsageIceCompatibility
294 StunUsageIceReturn
295 stun_usage_ice_conncheck_create
296 stun_usage_ice_conncheck_process
297 stun_usage_ice_conncheck_create_reply
298 stun_usage_ice_conncheck_priority
299 stun_usage_ice_conncheck_use_candidate
300 </SECTION>
301
302 <SECTION>
303 <FILE>timer</FILE>
304 <TITLE>Timer</TITLE>
305 StunTimer
306 StunUsageTimerReturn
307 STUN_TIMER_DEFAULT_MAX_RETRANSMISSIONS
308 STUN_TIMER_DEFAULT_RELIABLE_TIMEOUT
309 STUN_TIMER_DEFAULT_TIMEOUT
310 stun_timer_start
311 stun_timer_start_reliable
312 stun_timer_refresh
313 stun_timer_remainder
314 <SUBSECTION Private>
315 stun_timer_s
316 </SECTION>
317
318 <SECTION>
319 <FILE>bind</FILE>
320 <TITLE>Bind</TITLE>
321 StunUsageBindReturn
322 stun_usage_bind_create
323 stun_usage_bind_process
324 stun_usage_bind_keepalive
325 stun_usage_bind_run
326 </SECTION>
327
328 <SECTION>
329 <FILE>pseudotcp</FILE>
330 <TITLE>Pseudo TCP Socket</TITLE>
331 PseudoTcpSocket
332 PseudoTcpState
333 PseudoTcpWriteResult
334 PseudoTcpCallbacks
335 PseudoTcpDebugLevel
336 PseudoTcpShutdown
337 pseudo_tcp_socket_new
338 pseudo_tcp_socket_connect
339 pseudo_tcp_socket_recv
340 pseudo_tcp_socket_send
341 pseudo_tcp_socket_close
342 pseudo_tcp_socket_shutdown
343 pseudo_tcp_socket_is_closed
344 pseudo_tcp_socket_is_closed_remotely
345 pseudo_tcp_socket_get_error
346 pseudo_tcp_socket_get_next_clock
347 pseudo_tcp_socket_notify_clock
348 pseudo_tcp_socket_notify_mtu
349 pseudo_tcp_socket_notify_packet
350 pseudo_tcp_set_debug_level
351 pseudo_tcp_socket_get_available_bytes
352 pseudo_tcp_socket_can_send
353 pseudo_tcp_socket_get_available_send_space
354 pseudo_tcp_socket_notify_message
355 pseudo_tcp_socket_set_time
356 <SUBSECTION Standard>
357 pseudo_tcp_socket_get_type
358 PseudoTcpSocketClass
359 PSEUDOTCP_SOCKET_GET_CLASS
360 PSEUDO_TCP_SOCKET
361 PSEUDO_TCP_SOCKET_CLASS
362 PSEUDO_TCP_SOCKET_TYPE
363 IS_PSEUDO_TCP_SOCKET
364 IS_PSEUDO_TCP_SOCKET_CLASS
365 pseudo_tcp_debug_level_get_type
366 pseudo_tcp_shutdown_get_type
367 pseudo_tcp_state_get_type
368 pseudo_tcp_write_result_get_type
369 NICE_TYPE_TCP_DEBUG_LEVEL
370 NICE_TYPE_TCP_SHUTDOWN
371 NICE_TYPE_TCP_STATE
372 NICE_TYPE_TCP_WRITE_RESULT
373 <SUBSECTION Private>
374 PseudoTcpSocketPrivate
375 ECONNRESET
376 EMSGSIZE
377 ENOTCONN
378 ETIMEDOUT
379 EWOULDBLOCK
380 </SECTION>