Menu
▾
▴
[Sipp-commits] SF.net SVN: sipp:[624] doc/trunk/src/documentation
|
From: <arc...@us...> - 2013-01-13 23:45:35
|
Revision: 624
http://sourceforge.net/p/sipp/code/624
Author: arcady-91
Date: 2013-01-13 23:45:32 +0000 (Sun, 13 Jan 2013)
Log Message:
-----------
Updating documentation and site for v3.3
Modified Paths:
--------------
doc/trunk/src/documentation/content/xdocs/doc/license.xml
doc/trunk/src/documentation/content/xdocs/doc/reference.xml
doc/trunk/src/documentation/content/xdocs/index.xml
doc/trunk/src/documentation/content/xdocs/site.xml
doc/trunk/src/documentation/content/xdocs/tabs.xml
doc/trunk/src/documentation/skinconf.xml
Added Paths:
-----------
doc/trunk/src/documentation/content/xdocs/doc3.2/
doc/trunk/src/documentation/content/xdocs/doc3.2/faq.xml
doc/trunk/src/documentation/content/xdocs/doc3.2/index.xml
doc/trunk/src/documentation/content/xdocs/doc3.2/license.xml
doc/trunk/src/documentation/content/xdocs/doc3.2/reference.xml
Modified: doc/trunk/src/documentation/content/xdocs/doc/license.xml
===================================================================
--- doc/trunk/src/documentation/content/xdocs/doc/license.xml 2013-01-13 22:30:13 UTC (rev 623)
+++ doc/trunk/src/documentation/content/xdocs/doc/license.xml 2013-01-13 23:45:32 UTC (rev 624)
@@ -8,11 +8,62 @@
<body>
<section>
<title>License</title>
- <p>SIPp is under <a href="#gpl">GNU General Public License</a>.</p>
- <p>send_packets.c and send_packets.h share source from tcpreplay
-tools by Aaron Turner
-<a href="http://tcpreplay.sourceforge.net/">http://tcpreplay.sourceforge.net/</a> and are under <a href="#bsd">BSD license</a></p>
- </section>
+ <p>SIPp as a whole is licensed under <a href="#gpl">the GNU General Public License</a>, version 2 or any later version (copy below).</p>
+ <p>send_packets.c, send_packets.h, md5.c and md5.h have separate copyright
+ licenses, which apply only to those files. </p>
+ <p>The following license applies to send_packets.c and send_packets.h only:</p>
+ <source>
+ * Copyright (c) 2001-2004 Aaron Turner.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * 3. Neither the names of the copyright owners nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+ * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
+ * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+ * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ </source>
+ <p>The following license applies to md5.c and md5.h only:</p>
+ <source>
+ /*
+ Copyright (C) 1999, 2000, 2002 Aladdin Enterprises. All rights reserved.
+ This software is provided 'as-is', without any express or implied
+ warranty. In no event will the authors be held liable for any damages
+ arising from the use of this software.
+ Permission is granted to anyone to use this software for any purpose,
+ including commercial applications, and to alter it and redistribute it
+ freely, subject to the following restrictions:
+ 1. The origin of this software must not be misrepresented; you must not
+ claim that you wrote the original software. If you use this software
+ in a product, an acknowledgment in the product documentation would be
+ appreciated but is not required.
+ 2. Altered source versions must be plainly marked as such, and must not be
+ misrepresented as being the original software.
+ 3. This notice may not be removed or altered from any source distribution.
+ L. Peter Deutsch
+ gh...@al...
+ */
+ </source>
+ <p>All other parts of SIPp are under the following license (or, at your option, any later version of the GNU GPL):</p>
+ </section>
<anchor id="gpl" /><section>
<title>GNU GENERAL PUBLIC LICENSE</title>
<source>
@@ -297,38 +348,6 @@
END OF TERMS AND CONDITIONS </source>
</section>
- <anchor id="bsd" /><section>
- <title>Copyright notice for send_packets.c and send_packets.h</title>
- <source>
- Copyright (c) 2001-2004 Aaron Turner.
- All rights reserved.
-
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions
- are met:
-
- 1. Redistributions of source code must retain the above copyright
- notice, this list of conditions and the following disclaimer.
- 2. Redistributions in binary form must reproduce the above copyright
- notice, this list of conditions and the following disclaimer in the
- documentation and/or other materials provided with the distribution.
- 3. Neither the names of the copyright owners nor the names of its
- contributors may be used to endorse or promote products derived from
- this software without specific prior written permission.
-
- THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
- WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
- MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
- IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
- DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
- GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
- IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
- OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
- ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-</source>
- </section>
</body>
</document>
Modified: doc/trunk/src/documentation/content/xdocs/doc/reference.xml
===================================================================
--- doc/trunk/src/documentation/content/xdocs/doc/reference.xml 2013-01-13 22:30:13 UTC (rev 623)
+++ doc/trunk/src/documentation/content/xdocs/doc/reference.xml 2013-01-13 23:45:32 UTC (rev 624)
@@ -7,6 +7,7 @@
<authors>
<person name="Richard GAYRAUD [initial code]" email="ric...@us..."/>
<person name="Olivier JACQUES [code/documentation]" email="oja...@us..."/>
+ <person name="Robert Day [code/documentation]" email="rk...@rk..."/>
<person name="Charles P. Wright [code]" email="cha...@us..."/>
<person name="Many contributors [code]" email="no...@em..."/>
</authors>
@@ -14,6 +15,7 @@
<body>
<section>
<title>Foreword</title>
+ <warning>This version of the documentation is for SIPp 3.3 branch and describes some features not present in earlier versions. See the sidebar to access documentation for previous versions.</warning>
<p>SIPp is a performance testing tool for the SIP protocol. It includes a
few basic SipStone user agent scenarios (UAC and UAS) and establishes and
releases multiple calls with the INVITE and BYE methods. It can also reads
@@ -38,10 +40,9 @@
<title>Getting SIPp</title>
<p>SIPp is released under the
<a href="http://www.gnu.org/copyleft/gpl.html">GNU GPL license</a>.
- All the terms of the license apply. It is provided to the SIP
+ All the terms of the license apply. It was originally created and provided to the SIP
community by <a href="http://www.hp.com">Hewlett-Packard</a>
- engineers in hope it can be useful.</p> <p>We receive some support
- from our company to work on this tool freely, but <strong>HP does not
+ engineers in hope it can be useful, but <strong>HP does not
provide any support nor warranty concerning SIPp.</strong></p>
</section>
<section><title>Stable release</title>
@@ -58,85 +59,87 @@
<section><title>Unstable release</title>
<p>Unstable release: all new features and bug fixes are checked in
<a href="http://sipp.svn.sourceforge.net/viewvc/sipp/sipp/trunk/">SIPp's
- SVN</a> repository as soon as they are available. Every night, an
- automatic extraction is done and the source code of this release is
- made available. </p>
+ SVN</a> repository as soon as they are available.</p>
<note> Use the unstable release if you absolutely need a bug fix or
a feature that is not in the stable release. </note>
- <p><a href="http://sipp.sourceforge.net/snapshots/">SIPp "unstable" download page</a></p>
</section>
<section><title>Available platforms</title>
<p>SIPp is available on almost all UNIX platforms: HPUX, Tru64,
Linux (RedHat, Debian, FreeBSD), Solaris/SunOS.</p>
<p>A Windows port has been contributed. You can now compile SIPp under
- Cygwin. A binary package with a Windows installer is also available.
- Check <a href="http://sourceforge.net/project/showfiles.php?group_id=104305">the
- download page</a> to download it and run SIPp under Windows.</p>
- <note>SIPp works only over Windows XP and will not
- work on Win2000. This is because of IPv6 support. The Windows installer
- should prevent someone to install SIPp on Win2000.</note>
+ Cygwin.</p>
+ <note>SIPp works only on Windows XP and later versions and will not
+ work on Win2000. This is because of IPv6 support.</note>
</section>
<anchor id="installing" /><section><title>Installing SIPp</title>
<ul>
<li>On Linux, SIPp is provided in the form of source code. You will need to
compile SIPp to actually use it.</li>
- <li>Pre-requisites to compile SIPp are (see <a href="http://sipp.sourceforge.net/wiki/index.php/Compilation" >Compilation tips</a>):
+ <li>Pre-requisites to compile SIPp are <!--(see <a href="http://sipp.sourceforge.net/wiki/index.php/Compilation" >Compilation tips</a>)-->:
<ul>
<li>C++ Compiler</li>
<li>curses or ncurses library</li>
- <li>For authentication and TLS support: OpenSSL >= 0.9.8</li>
+ <li>For TLS support: OpenSSL >= 0.9.8</li>
<li>For pcap play support: libpcap and libnet</li>
+ <li>For SCTP support: lksctp-tools</li>
<li>For distributed pauses: <a href="http://www.gnu.org/software/gsl/">Gnu Scientific Libraries</a></li>
</ul>
</li>
<li>You have four options to compile SIPp:
<ul>
- <li><strong>Without TLS (Transport Layer Security) and authentication support</strong>:
- This is the recommended setup if you don't need to handle SIP authentication
- and/or TLS. In this case, there are <strong>no depencies to install</strong> before
- building SIPp. It is straight forward:
-<source># gunzip sipp-xxx.tar.gz
-# tar -xvf sipp-xxx.tar
+ <li><strong>Without TLS (Transport Layer Security), SCTP or PCAP support</strong>:
+ This is the recommended setup if you don't need to handle SCTP, TLS or PCAP. In this case, there are <strong>no dependencies to install</strong> before building SIPp. It is straightforward:
+<source># tar -xvzf sipp-xxx.tar
# cd sipp
+# autoreconf -ivf
+# ./configure
# make
</source></li>
- <li><strong>With TLS and <a href="#authentication">authentication</a> support</strong>, you must have
+ <li><strong>With TLS support</strong>, you must have
installed <a href="http://www.openssl.org/">OpenSSL library</a> (>=0.9.8)
- (which may come with your system). Building SIPp consist only in adding
- the "ossl" option to the make command:
-<source># gunzip sipp-xxx.tar.gz
-# tar -xvf sipp-xxx.tar
+ (which may come with your system). Building SIPp consists only in adding
+ the "--with-openssl" option to the configure command:
+<source># tar -xvzf sipp-xxx.tar.gz
# cd sipp
-# make ossl
+# autoreconf -ivf
+# ./configure --with-openssl
+# make
</source></li>
- <li><strong>With <a href="#pcapplay">PCAP play</a> and without <a href="#authentication">authentication</a> support</strong>:
-<source># gunzip sipp-xxx.tar.gz
-# tar -xvf sipp-xxx.tar
+ <li><strong>With <a href="#pcapplay">PCAP play</a> support</strong>:
+ <source># tar -xvzf sipp-xxx.tar.gz
# cd sipp
-# make pcapplay
+# autoreconf -ivf
+# ./configure --with-pcap
+# make
</source></li>
- <li><strong>With <a href="#pcapplay">PCAP play</a> and <a href="#authentication">authentication</a> support</strong>:
-<source># gunzip sipp-xxx.tar.gz
-# tar -xvf sipp-xxx.tar
+ <li><strong>With <a href="#sctp">SCTP</a> support</strong>:
+ <source># tar -xvzf sipp-xxx.tar.gz
# cd sipp
-# make pcapplay_ossl
-</source></li>
-
+# autoreconf -ivf
+# ./configure --with-sctp
+# make
+</source></li>
+ <li><strong>You can also combine these various options, e.g.:</strong>:
+ <source># tar -xvzf sipp-xxx.tar.gz
+# cd sipp
+# autoreconf -ivf
+# ./configure --with-sctp --with-pcap --with-openssl
+# make
+</source></li>
</ul>
<anchor id="gsl"/><note>To enable <a href="http://www.gnu.org/software/gsl/">GSL</a> at compile time,
you must install GSL and its include files, as well as un-comment
the lines in the local.mk file of SIPp distribution. Then, re-compile SIPp.</note>
</li>
- <li>On Windows, SIPp is provided both with the source and the pre-compiled
- executable. Just execute the installer to have SIPp installed.
- <warning>SIPp compiles under CYGWIN, provided that you installed IPv6
+ <li>
+ <warning>SIPp compiles under CYGWIN on Windows, provided that you installed IPv6
extension for CYGWIN (<a href="http://win6.jp/Cygwin/">http://win6.jp/Cygwin/</a>),
- as well as OpenSSL and libncurses.</warning></li>
+ as well as libncurses and (optionally OpenSSL and WinPcap). SCTP is not currently supported.</warning></li>
<li>To compile SIPp on Windows with pcap (media support), you must:
<ul>
<li>Copy the <a href="http://www.winpcap.org/devel.htm">WinPcap developer package</a> to "C:\cygwin\lib\WpdPack"</li>
<li>Remove or rename "pthread.h" in "C:\cygwin\lib\WpdPack\Include", as it interfers with pthread.h from cygwin</li>
- <li>Compile using either "make pcapplay_cygwin" or "pcapplay_ossl_cygwin"</li>
+ <li>Compile according to the instructions above.</li>
</ul>
</li>
</ul>
@@ -511,7 +514,7 @@
<tr><td>3</td><td>Display the repartition screen</td></tr>
<tr><td>4</td><td>Display the variable screen</td></tr>
<tr><td>5</td><td>Display the TDM screen</td></tr>
- <tr><td>6-9</td><td>Display the second tdrough fifth repartition screen.</td></tr>
+ <tr><td>6-9</td><td>Display the second through fifth repartition screen.</td></tr>
</table>
<p>In command mode, you can type a single line command that instructs
@@ -1215,7 +1218,7 @@
<td>-</td>
<td>Used to put the authentication header. This field can have parameters, in the following form:
[authentication username=myusername password=mypassword]. If no username is provided,
- the value from -s command line parameter (service) is used. If no password is provided, the value
+ the value from the -au (authentication username) or -s (service) command line parameter is used. If no password is provided, the value
from -ap command line parameter is used. See "<a href="#authentication">Authentication</a>" section</td>
</tr>
<tr>
@@ -1564,7 +1567,8 @@
</ul>
<note>The action is non-blocking. SIPp will start a light-weight thread to play the file
and the scenario with continue immediately. If needed, you will need to add a pause
- to wait for the end of the pcap play.</note></p>
+ to wait for the end of the pcap play.</note>
+ <warning>A known bug means that starting a pcap_play_audio command will end any pcap_play_video command, and vice versa; you cannot play both audio and video streams at once.</warning></p>
<p>Example that plays a pre-recorded RTP stream:</p>
<source><![CDATA[<nop>
<action>
@@ -1765,7 +1769,10 @@
<setdest host="[$host]" port="[$port]" protocol="[$transport]" />
</action>
</nop>
-]]></source></section>
+ ]]></source>
+ <warning>If you are using setdest with IPv6, you must not use square brackets around the address. These have a special meaning to SIPp, and it will try to interpret your IPv6 address as a variable.<br/>
+ Since the port is specified separately, square brackets are never necessary.</warning>
+ </section>
<anchor id="action_verifyauth" /><section><title>verifyauth</title>
@@ -2056,9 +2063,6 @@
<anchor id="authentication"/><section><title>SIP authentication</title>
<p>SIPp supports SIP authentication. Two authentication algorithm are supported: Digest/MD5 ("algorithm="MD5"")
and Digest/AKA ("algorithm="AKAv1-MD5"", as specified by 3GPP for IMS).</p>
- <warning>To enable authentication support, SIPp must be compiled in a
- special way. See <a href="#installing">SIPp installation</a>
- for details</warning>
<p>Enabling authentication is simple. When receiving a 401 (Unauthorized)
or a 407 (Proxy Authentication Required), you must add auth="true"
in the <![CDATA[<recv>]]> command to take the challenge into account.
@@ -2072,7 +2076,7 @@
<ul>
<li>Digest/MD5 (example: [authentication username=joe password=schmo])
<ul>
- <li><strong>username</strong>: username: if no username is specified, the username is taken from the '-s' (service) command
+ <li><strong>username</strong>: username: if no username is specified, the username is taken from the '-au' (authentication username) or '-s' (service) command
line parameter</li>
<li><strong>password</strong>: password: if no password is specified, the password is taken from the '-ap' (authentication
password) command line parameter</li>
@@ -2080,7 +2084,7 @@
</li>
<li>Digest/AKA: (example: [authentication username=HappyFeet aka_OP=0xCDC202D5123E20F62B6D676AC72CB318 aka_K=0x465B5CE8B199B49FAA5F0A2EE238A6BC aka_AMF=0xB9B9])
<ul>
- <li><strong>username</strong>: username: if no username is specified, the username is taken from the '-s' (service) command
+ <li><strong>username</strong>: username: if no username is specified, the username is taken from the '-au' (authentication username) or '-s' (service) command
line parameter</li>
<li><strong>aka_K</strong>: Permanent secret key. If no aka_K is provided, the "password" attributed is used as aka_K.</li>
<li><strong>aka_OP</strong>: OPerator variant key</li>
@@ -2296,6 +2300,18 @@
one secured TLS (Transport Layer Security) socket is opened for each new call between SIPp and the remote.</p>
<p>This mode is generally used for emulating user agents calling a SIP server.</p>
</section>
+ <anchor id="sctp" /><section><title>SCTP mono socket</title>
+ <p>In SCTP mono socket mode (<code>-t s1</code> command line parameter),
+ one SCTP (Stream Transmission Control Protocol) socket is opened between SIPp and the remote. All calls
+ are placed using this socket.</p>
+ <p>This mode is generally used for emulating a relation between 2 SIP servers.</p>
+ <p>The <code>-multihome, -heartbeat, -assocmaxret, -pathmaxret, -pmtu </code> and <code>-gracefulclose</code> command-line arguments allow control over specific features of the SCTP protocol, but are usually not necessary.</p>
+ </section>
+ <section><title>SCTP multi socket</title>
+ <p>In SCTP multi socket mode (<code>-t sn</code> command line parameter),
+ one SCTP socket is opened for each new call between SIPp and the remote.</p>
+ <p>This mode is generally used for emulating user agents calling a SIP server.</p>
+ </section>
<anchor id="ipv6" /><section><title>IPv6 support</title>
<p>SIPp includes IPv6 support. To use IPv6, just specify the local
IP address (-i command line parameter) to be an IPv6 IP address.</p>
@@ -2348,7 +2364,7 @@
Depending on the system settings, you might need to be root to allow this. Please
check "man 3 pthread_setschedparam" man page for details</warning>
<p>More details on the possible PCAP play actions can be found in the <a href="#action_exec">action reference section</a>.</p>
- <p>The latest info on this feature, tips and tricks can be found on <a href="http://sipp.sourceforge.net/wiki/index.php/Pcapplay" >SIPp wiki</a>.</p>
+ <!--<p>The latest info on this feature, tips and tricks can be found on <a href="http://sipp.sourceforge.net/wiki/index.php/Pcapplay" >SIPp wiki</a>.</p>-->
</section>
</section>
<section><title>Exit codes</title>
@@ -2570,7 +2586,8 @@
<section><title>Online help (-h)</title>
<p>The online help, available through the -h option is duplicated here for your
convenience</p>
- <source><![CDATA[Usage:
+ <source><![CDATA[
+ Usage:
sipp remote_host[:remote_port] [options]
@@ -2585,6 +2602,12 @@
By default, the URI is composed of
remote_ip:remote_port.
+ -au : Set authorization username for authentication challenges.
+ Default is taken from -s argument
+
+ -ap : Set the password for authentication challenges. Default
+ is 'password'
+
-base_cseq : Start value of [cseq] for each call.
-bg : Launch SIPp in background mode.
@@ -2618,11 +2641,11 @@
-default_behaviors: Set the default behaviors that SIPp will use. Possbile
values are:
- - all Use all default behaviors
- - none Use no default behaviors
- - bye Send byes for aborted calls
- - abortunexp Abort calls on unexpected messages
- - pingreply Reply to ping requests
+ - all Use all default behaviors
+ - none Use no default behaviors
+ - bye Send byes for aborted calls
+ - abortunexp Abort calls on unexpected messages
+ - pingreply Reply to ping requests
If a behavior is prefaced with a -, then it is turned
off. Example: all,-bye
@@ -2747,6 +2770,8 @@
-periodic_rtd : Reset response time partition counters each logging
interval.
+ -plugin : Load a plugin.
+
-r : Set the call rate (in calls per seconds). This value can
bechanged during test by pressing '+','_','*' or '/'.
Default is 10.
@@ -2879,6 +2904,8 @@
- tn: TCP with one socket per call,
- l1: TLS with one socket,
- ln: TLS with one socket per call,
+ - s1: SCTP with one socket (default),
+ - sn: SCTP with one socket per call,
- c1: u1 + compression (only if compression plugin
loaded),
- cn: un + compression (only if compression plugin
@@ -2898,6 +2925,8 @@
usage.If the compression is on, the value is set to
50ms. The default value is 10ms.
+ -T2 : Global T2-timer in milli seconds
+
-sendbuffer_warn : Produce warnings instead of errors on SendBuffer
failures.
@@ -2908,9 +2937,9 @@
<scenario file name>_<pid>_shortmessages.log
-trace_screen : Dump statistic screens in the
- <scenario_name>_<pid>_cenaris.log file when quitting
- SIPp. Useful to get a final status report in background
- mode (-bg option).
+ <scenario_name>_<pid>_screens.log file when
+ quitting SIPp. Useful to get a final status report in
+ background mode (-bg option).
-trace_err : Trace all unexpected messages in <scenario file
name>_<pid>_errors.log.
@@ -2951,9 +2980,6 @@
-watchdog_minor_maxtriggers: How many times the minor watchdog timer can be tripped
before the test is terminated. Default is 120.
- -ap : Set the password for authentication challenges. Default
- is 'password
-
-tls_cert : Set the name for TLS Certificate file. Default is
'cacert.pem
@@ -2988,6 +3014,30 @@
Set the global variable parameter named "variable" to
"value".
+ -multihome : Set multihome address for SCTP
+
+ -heartbeat : Set heartbeat interval in ms for SCTP
+
+ -assocmaxret : Set association max retransmit counter for SCTP
+
+ -pathmaxret : Set path max retransmit counter for SCTP
+
+ -pmtu : Set path MTU for SCTP
+
+ -gracefulclose : If true, SCTP association will be closed with SHUTDOWN
+ (default).
+ If false, SCTP association will be closed by ABORT.
+
+
+ -dynamicStart : variable value
+ Set the start offset of dynamic_id varaiable
+
+ -dynamicMax : variable value
+ Set the maximum of dynamic_id variable
+
+ -dynamicStep : variable value
+ Set the increment of dynamic_id variable
+
Signal handling:
SIPp can be controlled using posix signals. The following signals
@@ -3011,6 +3061,7 @@
97: exit on internal command. Calls may have been processed
99: Normal exit without calls processed
-1: Fatal error
+ -2: Fatal error binding a socket
Example:
@@ -3022,7 +3073,7 @@
]]>
</source>
- </section>
+ </section>
</section>
<anchor id="perf" /><section><title>Performance testing with SIPp</title>
<section><title>Advices to run performance tests with SIPp</title>
Added: doc/trunk/src/documentation/content/xdocs/doc3.2/faq.xml
===================================================================
(Binary files differ)
Index: doc/trunk/src/documentation/content/xdocs/doc3.2/faq.xml
===================================================================
--- doc/trunk/src/documentation/content/xdocs/doc3.2/faq.xml 2013-01-13 22:30:13 UTC (rev 623)
+++ doc/trunk/src/documentation/content/xdocs/doc3.2/faq.xml 2013-01-13 23:45:32 UTC (rev 624)
Property changes on: doc/trunk/src/documentation/content/xdocs/doc3.2/faq.xml
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/xml
\ No newline at end of property
Added: doc/trunk/src/documentation/content/xdocs/doc3.2/index.xml
===================================================================
(Binary files differ)
Index: doc/trunk/src/documentation/content/xdocs/doc3.2/index.xml
===================================================================
--- doc/trunk/src/documentation/content/xdocs/doc3.2/index.xml 2013-01-13 22:30:13 UTC (rev 623)
+++ doc/trunk/src/documentation/content/xdocs/doc3.2/index.xml 2013-01-13 23:45:32 UTC (rev 624)
Property changes on: doc/trunk/src/documentation/content/xdocs/doc3.2/index.xml
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/xml
\ No newline at end of property
Added: doc/trunk/src/documentation/content/xdocs/doc3.2/license.xml
===================================================================
(Binary files differ)
Index: doc/trunk/src/documentation/content/xdocs/doc3.2/license.xml
===================================================================
--- doc/trunk/src/documentation/content/xdocs/doc3.2/license.xml 2013-01-13 22:30:13 UTC (rev 623)
+++ doc/trunk/src/documentation/content/xdocs/doc3.2/license.xml 2013-01-13 23:45:32 UTC (rev 624)
Property changes on: doc/trunk/src/documentation/content/xdocs/doc3.2/license.xml
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/xml
\ No newline at end of property
Added: doc/trunk/src/documentation/content/xdocs/doc3.2/reference.xml
===================================================================
(Binary files differ)
Index: doc/trunk/src/documentation/content/xdocs/doc3.2/reference.xml
===================================================================
--- doc/trunk/src/documentation/content/xdocs/doc3.2/reference.xml 2013-01-13 22:30:13 UTC (rev 623)
+++ doc/trunk/src/documentation/content/xdocs/doc3.2/reference.xml 2013-01-13 23:45:32 UTC (rev 624)
Property changes on: doc/trunk/src/documentation/content/xdocs/doc3.2/reference.xml
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/xml
\ No newline at end of property
Modified: doc/trunk/src/documentation/content/xdocs/index.xml
===================================================================
--- doc/trunk/src/documentation/content/xdocs/index.xml 2013-01-13 22:30:13 UTC (rev 623)
+++ doc/trunk/src/documentation/content/xdocs/index.xml 2013-01-13 23:45:32 UTC (rev 624)
@@ -13,7 +13,7 @@
<p>SIPp is a free Open Source test tool / traffic generator for the SIP protocol.
It includes a few basic <a href="http://www.sipstone.org">SipStone</a>
user agent scenarios (UAC and UAS) and establishes and releases multiple calls with
- the INVITE and BYE methods. It can also reads
+ the INVITE and BYE methods. It can also reads
<a href="doc/uac.xml.html">custom XML</a> scenario files describing
from very simple to <a href="doc/reference.html#3PCC">complex</a> call flows.
It features the <a href="doc/reference.html#stat_screen">dynamic display</a> of
@@ -23,7 +23,7 @@
retransmission management and <a href="doc/reference.html#traffic_control">dynamically
adjustable</a> call rates.</p>
<p>Other advanced features include support of <a href="doc/reference.html#ipv6">IPv6</a>,
- <a href="doc/reference.html#tls">TLS</a>, SIP <a href="doc/reference.html#authentication">authentication</a>,
+ <a href="doc/reference.html#tls">TLS</a>, SCTP, SIP <a href="doc/reference.html#authentication">authentication</a>,
<a href="doc/reference.html#branching">conditional scenarios</a>, UDP retransmissions,
<a href="doc/reference.html#Error+handling">error robustness</a> (call
timeout, protocol defense), call specific variable, Posix <a href="doc/reference.html#action_regexp">regular expression</a>
@@ -31,12 +31,12 @@
(log, system command exec, call stop)
on message receive, field injection from <a href="doc/reference.html#inffile">external CSV</a> file to emulate live users.</p>
<p>SIPp can also send media (RTP) traffic through <a href="doc/reference.html#RTP+echo">RTP echo</a> and
- <a href="doc/reference.html#PCAP+Play">RTP / pcap</a> replay. Media can be audio or audio+video.</p>
+ <a href="doc/reference.html#PCAP+Play">RTP / pcap</a> replay. Media can be audio or video.</p>
<p>While optimized for traffic, stress and performance testing, SIPp can be used to
run one single call and exit, providing a <a href="doc/reference.html#Exit+codes">passed/failed</a> verdict.</p>
<p>Last, but not least, SIPp has a <a href="doc/reference.html" >comprehensive documentation</a> available
both in HTML and PDF format.</p>
- <p>SIPp can be used to test many real SIP equipements like SIP proxies,
+ <p>SIPp can be used to test various real SIP equipment like SIP proxies,
B2BUAs, SIP media servers, SIP/x gateways, SIP PBX, ...
It is also very useful to emulate thousands of user agents calling your SIP system.</p>
<p>Here is a screenshot:</p>
Modified: doc/trunk/src/documentation/content/xdocs/site.xml
===================================================================
--- doc/trunk/src/documentation/content/xdocs/site.xml 2013-01-13 22:30:13 UTC (rev 623)
+++ doc/trunk/src/documentation/content/xdocs/site.xml 2013-01-13 23:45:32 UTC (rev 624)
@@ -31,10 +31,15 @@
<license label='License' href='license.html' />
</doc>
- <doc2 label="Doc (3.0)" href="doc3.0/" tab="doc3.0">
+ <doc2 label="Doc (3.2)" href="doc3.2/" tab="doc3.2">
+ <refdoc label='Ref doc 3.2 [html]' href='reference.html' />
+ <refdoc_PDF label="Ref doc 3.2 [pdf]" href="reference.pdf"/>
+ </doc2>
+
+ <doc3 label="Doc (3.0)" href="doc3.0/" tab="doc3.0">
<refdoc label='Ref doc 3.0 [html]' href='reference.html' />
<refdoc_PDF label="Ref doc 3.0 [pdf]" href="reference.pdf"/>
- </doc2>
+ </doc3>
<ims_bench label="IMS Bench" href="ims_bench/" tab="ims_bench">
<refdoc label='Ref doc [html]' href='reference.html' />
Modified: doc/trunk/src/documentation/content/xdocs/tabs.xml
===================================================================
--- doc/trunk/src/documentation/content/xdocs/tabs.xml 2013-01-13 22:30:13 UTC (rev 623)
+++ doc/trunk/src/documentation/content/xdocs/tabs.xml 2013-01-13 23:45:32 UTC (rev 624)
@@ -15,8 +15,9 @@
-->
<tab id="home" label="Home" dir="" indexfile="index.html"/>
+ <tab id="doc" label="Documentation (current)" dir="doc" indexfile="reference.html"/>
+ <tab id="doc3.2" label="Documentation (3.2)" dir="doc3.2" indexfile="reference.html"/>
<tab id="doc3.0" label="Documentation (3.0)" dir="doc3.0" indexfile="reference.html"/>
- <tab id="doc" label="Documentation (current)" dir="doc" indexfile="reference.html"/>
<tab id="ims_bench" label="IMS Bench SIPp" dir="ims_bench" indexfile="index.html"/>
<tab id="web_frontend" label="Web frontend" dir="web_frontend" indexfile="index.html"/>
<!-- Add new tabs here, eg:
Modified: doc/trunk/src/documentation/skinconf.xml
===================================================================
--- doc/trunk/src/documentation/skinconf.xml 2013-01-13 22:30:13 UTC (rev 623)
+++ doc/trunk/src/documentation/skinconf.xml 2013-01-13 23:45:32 UTC (rev 624)
@@ -57,12 +57,12 @@
<project-logo>images/project-logo.gif</project-logo> -->
<!-- optional group logo
- skin: forrest-site renders it at the top-left corner -->
+ skin: forrest-site renders it at the top-left corner
<group-name>hp invent</group-name>
<group-description>Hewlett-Packard</group-description>
<group-url>http://www.hp.com</group-url>
<group-logo>images/hplogo.png</group-logo>
-
+ -->
<!-- optional host logo (e.g. sourceforge logo)
default skin: renders it at the bottom-left corner -->
@@ -113,8 +113,8 @@
feedback link in the footer with the page pathname appended:
<a href="@href">{@to}</a>
-->
- <feedback to="Olivier"
- href="mailto:oli...@hp...?subject=SIPp Feedback " >
+ <feedback to="Rob Day"
+ href="mailto:rk...@rk...?subject=SIPp Feedback " >
Send feedback about the website to:
</feedback>
<!--
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|