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