summaryrefslogtreecommitdiff
path: root/README
blob: 073b340536979b5e4e051e8483a16ad074a6d24a (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

Nice: GLib ICE library
======================

Copyright and license
---------------------

  (C) 2006, 2007 Collabora Ltd.
  (C) 2006, 2007 Nokia Corporation

  This library is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by the
  Free Software Foundation; either version 2.1 of the License, or (at your
  option) any later version.

  This library is distributed in the hope that it will be useful, but WITHOUT
  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
  for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with this library; if not, write to the Free Software Foundation,
  Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

Requirements
------------

 glib >= 2.10
 pkg-config

Limitations
-----------

 - only implements ICE Lite
 - no support for RTCP
 - no support for IPv6

Structure
---------

 address/ - IP address convenience library
 local/   - local address gathering code
 random/  - random number generation
 stun/    - STUN implementation
 udp/     - UDP abstraction layer
 agent/   - ICE agent
 nice/    - libnice

Relevant standards
------------------

These standards are relevant to nice's current implementation.

ICE draft 13
  http://tools.ietf.org/html/draft-ietf-mmusic-ice-13
STUN
  http://tools.ietf.org/html/rfc3489
STUN bis (used by ICE)
  http://tools.ietf.org/html/draft-ietf-behave-rfc3489bis-04
RTP
  http://tools.ietf.org/html/rfc3550
XMPP Jingle ICE transport
  http://www.xmpp.org/extensions/xep-0176.html

In future, nice may additionally support the following standards.

TURN
  http://tools.ietf.org/html/draft-ietf-behave-turn-02
NAT-PMP
  http://files.dns-sd.org/draft-cheshire-nat-pmp.txt
UPnP IGD
  http://www.upnp.org/standardizeddcps/igd.asp