1
/* $Id: doc_samples.h 3553 2011-05-05 06:14:19Z nanang $ */
3
* Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
5
* This program is free software; you can redistribute it and/or modify
6
* it under the terms of the GNU General Public License as published by
7
* the Free Software Foundation; either version 2 of the License, or
8
* (at your option) any later version.
10
* This program is distributed in the hope that it will be useful,
11
* but WITHOUT ANY WARRANTY; without even the implied warranty of
12
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
* GNU General Public License for more details.
15
* You should have received a copy of the GNU General Public License
16
* along with this program; if not, write to the Free Software
17
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22
@addtogroup samples_page
24
Several samples that are included in the PJSIP distributions. The screenshots
25
below were taken on a Windows machine, but the library is very portable and
26
it is known to run on platforms such as Linux, MacOS X, Windows Mobile,
29
- @ref ice_demo_sample\n
30
This sample demonstrates how to use \ref PJNATH_ICE_STREAM_TRANSPORT
31
<b>without</b> using signaling protocol such as <b>SIP</b>. It provides
32
interactive user interface to create and manage the ICE sessions as well
33
as to exchange SDP with another ice_demo instance.\n\n
34
\image html ice_demo.jpg "ice_demo on WinXP"
36
- @ref turn_client_sample\n
37
This sample demonstrates how to use \ref PJNATH_TURN_SOCK
38
and also \ref PJNATH_STUN_SOCK. It provides interactive
39
user interface to manage allocation, permissions, and
41
\image html pjturn_client.jpg "pjturn_client on WinXP"
43
- TURN server sample\n
44
This is a simple sample TURN server application, which
45
we mainly use for testing (as back then there is no TURN
47
The source code for this application are in <tt><b>pjnath/src/pjturn-srv</b></tt>
54
\page turn_client_sample pjturn-client, a sample TURN client
56
This is a simple, interactive TURN client application, with the
59
- TCP connection to TURN server
60
- Optional fingerprint
62
This file is pjnath/src/pjturn-client/client_main.c.
64
Screenshot on WinXP: \image html pjturn_client.jpg "pjturn_client on WinXP"
66
\includelineno client_main.c.
71
\page ice_demo_sample ice_demo, an interactive ICE endpoint
73
This sample demonstrates how to use \ref PJNATH_ICE_STREAM_TRANSPORT
74
<b>without</b> using signaling protocol such as SIP. It provides
75
interactive user interface to create and manage the ICE sessions as well
76
as to exchange SDP with another ice_demo instance.
78
Features of the demo application:
79
- supports host, STUN, and TURN candidates
80
- disabling of host candidates
81
- DNS SRV resolution for STUN and TURN servers
82
- TCP connection to TURN server
83
- Optional use of fingerprint for TURN
84
- prints and parse SDP containing ICE infos
85
- exchange SDP with copy/paste
87
This file is pjsip-apps/src/samples/icedemo.c
89
Screenshot on WinXP: \image html ice_demo.jpg "ice_demo on WinXP"
91
\includelineno icedemo.c.