stun.docs 744 Bytes
Newer Older
1
/**@MODULEPAGE "stun" - STUN Client and Server Module
Pekka Pessi's avatar
Pekka Pessi committed
2 3 4 5 6 7 8 9

@section stun_meta Module Meta Information

The Sofia @b stun module contains macros and functions for STUN server and
client library.

@CONTACT Pekka Pessi <Pekka.Pessi@nokia.com>

10
@STATUS @SofiaSIP Core library
Pekka Pessi's avatar
Pekka Pessi committed
11 12 13

@LICENSE LGPL

14 15 16
@section stun_contents Contents of stun Module

The stun module contains the public header files as follows:
17 18 19
- <sofia-sip/stun.h>        the public API of the module
- <sofia-sip/stun_common.h> low-level functions for parsing and encoding STUN messages
- <sofia-sip/stun_tag.h>    defines the su tags used by stun
20

Pekka Pessi's avatar
Pekka Pessi committed
21 22
@section stun_usage Using Sofia STUN Library

23
To be written. See torture_stun.c and tport/tport.c.
24 25 26

@section todo Todo

27
- none at the moment
Pekka Pessi's avatar
Pekka Pessi committed
28 29

*/