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