README 1.31 KB
Newer Older
1 2

Nice: GLib ICE library
3
======================
4

Dafydd Harries's avatar
Dafydd Harries committed
5 6
Copyright
---------
7

Dafydd Harries's avatar
Dafydd Harries committed
8 9
 (C) 2006, 2007 Collabora Ltd.
 (C) 2006, 2007 Nokia Corporation
10

Dafydd Harries's avatar
Dafydd Harries committed
11 12
License
-------
13

Dafydd Harries's avatar
Dafydd Harries committed
14
See the file COPYING.
15

16 17
Requirements
------------
18 19

 glib >= 2.10
20
 pkg-config
21

22 23
Limitations
-----------
24

25
 - only implements ICE Lite
26 27 28
 - no support for RTCP
 - no support for IPv6

29 30 31
Structure
---------

32
 docs/    - design documentation
33 34 35 36 37 38 39
 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
40

41 42 43 44 45
Relevant standards
------------------

These standards are relevant to nice's current implementation.

46 47
ICE draft 15
  http://tools.ietf.org/wg/mmusic/draft-ietf-mmusic-ice/
48 49 50
STUN
  http://tools.ietf.org/html/rfc3489
STUN bis (used by ICE)
51 52 53
  http://tools.ietf.org/wg/behave/draft-ietf-behave-rfc3489bis/
TURN 
  http://tools.ietf.org/wg/behave/draft-ietf-behave-turn/
54 55 56 57 58 59 60 61 62 63 64 65 66 67
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