| Alexandre Lision | 67916dd | 2014-01-24 13:33:04 -0500 | [diff] [blame] | 1 | /* $Id$ */ |
| 2 | /* |
| 3 | * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com) |
| 4 | * |
| 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. |
| 9 | * |
| 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. |
| 14 | * |
| 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 |
| 18 | */ |
| 19 | |
| 20 | |
| 21 | /** |
| 22 | @addtogroup samples_page |
| 23 | |
| 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, |
| 27 | Symbian, and so on. |
| 28 | |
| 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" |
| 35 | |
| 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 |
| 40 | channel bindings.\n\n |
| 41 | \image html pjturn_client.jpg "pjturn_client on WinXP" |
| 42 | |
| 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 |
| 46 | server available).\n |
| 47 | The source code for this application are in <tt><b>pjnath/src/pjturn-srv</b></tt> |
| 48 | directory. |
| 49 | |
| 50 | */ |
| 51 | |
| 52 | |
| 53 | /** |
| 54 | \page turn_client_sample pjturn-client, a sample TURN client |
| 55 | |
| 56 | This is a simple, interactive TURN client application, with the |
| 57 | following features: |
| 58 | - DNS SRV resolution |
| 59 | - TCP connection to TURN server |
| 60 | - Optional fingerprint |
| 61 | |
| 62 | This file is pjnath/src/pjturn-client/client_main.c. |
| 63 | |
| 64 | Screenshot on WinXP: \image html pjturn_client.jpg "pjturn_client on WinXP" |
| 65 | |
| 66 | \includelineno client_main.c. |
| 67 | */ |
| 68 | |
| 69 | |
| 70 | /** |
| 71 | \page ice_demo_sample ice_demo, an interactive ICE endpoint |
| 72 | |
| 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. |
| 77 | |
| 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 |
| 86 | |
| 87 | This file is pjsip-apps/src/samples/icedemo.c |
| 88 | |
| 89 | Screenshot on WinXP: \image html ice_demo.jpg "ice_demo on WinXP" |
| 90 | |
| 91 | \includelineno icedemo.c. |
| 92 | */ |
| 93 | |