summaryrefslogtreecommitdiff
path: root/docs/reference/libnice/libnice-docs.sgml
blob: 918fcf4489bbe5f1c5c82c0b106fe020046c40fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
  <bookinfo>
    <title>libnice Reference Manual</title>
    <releaseinfo>
      The latest version of this documentation can be found on-line at
      <ulink role="online-location" url="http://nice.freedesktop.org/libnice/index.html">http://nice.freedesktop.org/libnice/</ulink>.
    </releaseinfo>
  </bookinfo>


  <part>
    <title>ICE Library</title>
    <chapter>
      <xi:include href="xml/agent.xml"/>
      <xi:include href="xml/address.xml"/>
      <xi:include href="xml/candidate.xml"/>
    </chapter>
    <chapter>
      <title>Libnice helper functions</title>
      <xi:include href="xml/debug.xml"/>
      <xi:include href="xml/interfaces.xml"/>
    </chapter>
  </part>
  <part>
    <title>STUN Library</title>
    <chapter>
      <xi:include href="xml/stunagent.xml"/>
      <xi:include href="xml/stunmessage.xml"/>
      <xi:include href="xml/stunconstants.xml"/>
   </chapter>
    <chapter>
      <title>STUN usages</title>
      <xi:include href="xml/bind.xml"/>
      <xi:include href="xml/ice.xml"/>
      <xi:include href="xml/turn.xml"/>
      <xi:include href="xml/timer.xml"/>
    </chapter>
  </part>

  <part>
    <title>Pseudo TCP Socket implementation</title>
    <chapter>
      <xi:include href="xml/pseudotcp.xml"/>
    </chapter>
  </part>

  <para>The libnice library contains the ICE library and the
    STUN library as well as a Pseudo TCP socket implementation.
  </para>

  <part>
    <title>Appendices</title>
    <index id="api-index-full">
      <title>API Index</title>
      <xi:include href="xml/api-index-full.xml"><xi:fallback/></xi:include>
    </index>
    <index id="api-index-deprecated">
      <title>Index of deprecated symbols</title>
      <xi:include href="xml/api-index-deprecated.xml"><xi:fallback/></xi:include>
    </index>
    <index role="0.0.4">
      <title>Index of new symbols in 0.0.4</title>
      <xi:include href="xml/api-index-0.0.4.xml"><xi:fallback/></xi:include>
    </index>
    <index role="0.0.6">
      <title>Index of new symbols in 0.0.6</title>
      <xi:include href="xml/api-index-0.0.6.xml"><xi:fallback/></xi:include>
    </index>
    <index role="0.0.7">
      <title>Index of new symbols in 0.0.7</title>
      <xi:include href="xml/api-index-0.0.7.xml"><xi:fallback/></xi:include>
    </index>
    <index role="0.0.9">
      <title>Index of new symbols in 0.0.9</title>
      <xi:include href="xml/api-index-0.0.9.xml"><xi:fallback/></xi:include>
    </index>
    <index role="0.0.10">
      <title>Index of new symbols in 0.0.10</title>
      <xi:include href="xml/api-index-0.0.10.xml"><xi:fallback/></xi:include>
    </index>
    <index role="0.0.11">
      <title>Index of new symbols in 0.0.11</title>
      <xi:include href="xml/api-index-0.0.11.xml"><xi:fallback/></xi:include>
    </index>
    <index role="0.1.4">
      <title>Index of new symbols in 0.1.4</title>
      <xi:include href="xml/api-index-0.1.4.xml"><xi:fallback/></xi:include>
    </index>
    <index role="0.1.5">
      <title>Index of new symbols in 0.1.5</title>
      <xi:include href="xml/api-index-0.1.5.xml"><xi:fallback/></xi:include>
    </index>
    <index role="0.1.6">
      <title>Index of new symbols in 0.1.6</title>
      <xi:include href="xml/api-index-0.1.6.xml"><xi:fallback/></xi:include>
    </index>
    <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
  </part>
</book>