summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorYouness Alaoui <youness.alaoui@collabora.co.uk>2010-01-12 19:26:41 -0500
committerYouness Alaoui <youness.alaoui@collabora.co.uk>2010-02-16 17:38:13 -0500
commitd3278562c0b5590383db0a162cdf0f32205605a0 (patch)
tree31b4684f8870c122841147d90615b8863ecbac0e /docs
parent11790aae458a3a890c8964937e15271ef74572a0 (diff)
downloadlibnice-d3278562c0b5590383db0a162cdf0f32205605a0.tar.gz
Add pseudotcp docs and fix a bit the API and test
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/libnice/libnice-docs.sgml10
-rw-r--r--docs/reference/libnice/libnice-sections.txt19
2 files changed, 27 insertions, 2 deletions
diff --git a/docs/reference/libnice/libnice-docs.sgml b/docs/reference/libnice/libnice-docs.sgml
index f53cf1d..c8f3d4e 100644
--- a/docs/reference/libnice/libnice-docs.sgml
+++ b/docs/reference/libnice/libnice-docs.sgml
@@ -39,8 +39,14 @@
</chapter>
</part>
+ <part>
+ <title>Pseudo TCP Socket implementation</title>
+ <chapter>
+ <xi:include href="xml/pseudotcp.xml"/>
+ </chapter>
+ </part>
- <para>The libnice library contains both the ICE library and the
- STUN library.
+ <para>The libnice library contains the ICE library and the
+ STUN library as well as a Pseudo TCP socket implementation.
</para>
</book>
diff --git a/docs/reference/libnice/libnice-sections.txt b/docs/reference/libnice/libnice-sections.txt
index d693620..03aab01 100644
--- a/docs/reference/libnice/libnice-sections.txt
+++ b/docs/reference/libnice/libnice-sections.txt
@@ -219,3 +219,22 @@ stun_usage_bind_process
stun_usage_bind_keepalive
stun_usage_bind_run
</SECTION>
+
+<SECTION>
+<FILE>pseudotcp</FILE>
+<TITLE>Pseudo TCP Socket</TITLE>
+PseudoTcpSocket
+PseudoTcpState
+PseudoTcpWriteResult
+PseudoTcpCallbacks
+pseudo_tcp_socket_new
+pseudo_tcp_socket_connect
+pseudo_tcp_socket_recv
+pseudo_tcp_socket_send
+pseudo_tcp_socket_close
+pseudo_tcp_socket_get_error
+pseudo_tcp_socket_get_next_clock
+pseudo_tcp_socket_notify_clock
+pseudo_tcp_socket_notify_mtu
+pseudo_tcp_socket_notify_packet
+</SECTION>