From: <sri...@us...> - 2009-03-03 04:50:42
|
Revision: 571 http://sipp.svn.sourceforge.net/sipp/?rev=571&view=rev Author: srivanuj Date: 2009-03-03 04:50:32 +0000 (Tue, 03 Mar 2009) Log Message: ----------- Addition of SippWebfrontend, submitted by Michael Hirschbichler Modified Paths: -------------- doc/trunk/src/documentation/content/xdocs/tabs.xml Added Paths: ----------- doc/trunk/src/documentation/content/xdocs/web_frontend/ doc/trunk/src/documentation/content/xdocs/web_frontend/index.xml doc/trunk/src/documentation/resources/images/Thumbs.db doc/trunk/src/documentation/resources/images/webfrontend_addcall.gif doc/trunk/src/documentation/resources/images/webfrontend_addcalls.gif doc/trunk/src/documentation/resources/images/webfrontend_commandflow.gif doc/trunk/src/documentation/resources/images/webfrontend_createscenario.gif doc/trunk/src/documentation/resources/images/webfrontend_createtest.gif doc/trunk/src/documentation/resources/images/webfrontend_er.gif doc/trunk/src/documentation/resources/images/webfrontend_exec.gif doc/trunk/src/documentation/resources/images/webfrontend_managescenarios.gif doc/trunk/src/documentation/resources/images/webfrontend_managetests.gif doc/trunk/src/documentation/resources/images/webfrontend_runs.gif doc/trunk/src/documentation/resources/images/webfrontend_states.gif doc/trunk/src/documentation/resources/images/webfrontend_sysinfo.gif doc/trunk/src/documentation/resources/images/webfrontend_version.gif Modified: doc/trunk/src/documentation/content/xdocs/tabs.xml =================================================================== --- doc/trunk/src/documentation/content/xdocs/tabs.xml 2009-01-27 03:04:52 UTC (rev 570) +++ doc/trunk/src/documentation/content/xdocs/tabs.xml 2009-03-03 04:50:32 UTC (rev 571) @@ -18,6 +18,7 @@ <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: <tab label="How-Tos" dir="community/howto/"/> <tab label="XML Site" dir="xml-site/"/> Added: doc/trunk/src/documentation/content/xdocs/web_frontend/index.xml =================================================================== --- doc/trunk/src/documentation/content/xdocs/web_frontend/index.xml (rev 0) +++ doc/trunk/src/documentation/content/xdocs/web_frontend/index.xml 2009-03-03 04:50:32 UTC (rev 571) @@ -0,0 +1,233 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd"> +<document> + <header> + <title>SIPp web frontend</title> + <subtitle>SIPp web frontend 1.2 reference documentation</subtitle> + <authors> + <person name="Mario SMERITSCHNIG [code/documentation]" email="ma...@po..."/> + </authors> + </header> + <body> + <section> + <title>Description</title> + <p>With SIPp web frontend you can</p> + <ul> + <li>upload XML templates (SIPp scenarios) and CSV injection files</li> + <li>create and modify test processes using these files</li> + <li>manage test versions</li> + <li>run created test processes</li> + <li>display realtime feedback during test runs</li> + <li>store created test information in a database</li> + </ul> + </section> + <section> + <title>Terms and definitions</title> + <ul> + <li>Scenario<br/>A user can upload XML files containing SIP call flows, named scenario files. Optionally, one can upload a CSV field injection file. These files are stored along with a scenario name and a description. There are also some standard scenarios, that cannot be modified (from the command line parameter <code>-sn</code>, e.g., <code>uac</code>, <code>uas</code>, <code>regexp</code>, ...)</li> + <li>Call<br />A call consists of all information necessary to run one instance of SIPp. Thus a SIPp executable, a scenario, and a collection of parameters (e.g., destination ip-address).</li> + <li>Call sequence<br />In some test scenarios it is not enough to run only one call. For example in a first call SIP user agents get registered at a SIP proxy, in a second call those user agents communicate with a server, and in a last call the registrations are removed again. Thus a call sequence is an ordered list of calls, that can be executed automatically one by one.</li> + <li>Call sequence pair / call parties<br />SIPp webfrontend has the capability to execute two calls in a test simultaneously. This is useful for example if you want to simulate a server and a client communicating with each other. In this case two call sequences can be defined each in a separate party (<i>A party</i> and <i>B party</i>).</li> + <li>Test<br />A test can be a call, a call sequence or a call sequence pair. There also may be several versions of a test that can be executed.</li> + <li>Run<br />After a test has been executed, collected information (e.g., about the progress, test parameters, date and time, log files...) is stored as a run for further processing.</li> + </ul> + </section> + <section> + <title>Admin guide</title> + <section> + <title>Installation instructions</title> + <p>For detailed installation instructions refer to the file <code>INSTALL.TXT</code> shipped with the SIPp webfrontend package.</p> + </section> + <section> + <title>Login</title> + <p>In order to act as an admin, you first need to login to the admin section by entering the correct password, defined in the config file <code>config.ini.php</code> with the parameter <code>admin_pwd</code>. If you want everybody to be admin, assign <code>admin_pwd</code> an empty password (<code>admin_pwd=""</code>).</p> + </section> + <section> + <anchor id="managescenarios" /> + <title>Manage scenarios</title> + <p>There is a list of scenarios available for creating tests in the <i>manage scenarios</i> tab. Scenarios tagged with the word <i>default</i> are SIPp default scenarios, and cannot be modified or removed. Change the order of the scenarios by using the arrow up and the arrow down buttons, or remove a scenario by pressing the red <i>X</i> button. To modify a scenario, just click the row of the scenario, and to create a new scenario use the <i>create new scenario</i> link.<br /> + <img alt="Manage scenarios tab" src="images/webfrontend_managescenarios.gif"></img></p> + <section> + <title>Create / modify a scenario</title> + <p>To create a scenario, a name has to be specified and a XML scenario file has to be given (upload the file by pressing the corresponding <i>Browse...</i> button). Optionally the user can enter a description, upload a CSV injection file and enter a <i>bind_local</i> ip address to instruct a server to listen only to the given address instead to all available (see <code>sipp -h</code> for more details).</p> + <img alt="Create a scenario" src="images/webfrontend_createscenario.gif"></img> + <p>After you have created a scenario, you can modify it any time if you want. You can even remove a CSV file or replace the XML file. + <note>When you modify a scenario, you do not implicitly modify all tests using the scenario. Tests use copies of the scenarios to stay consistent with test runs.</note></p> + </section> + </section> + + <section> + <title>Manage tests</title> + <p>Open the <i>Manage tests</i> tab to get a list of available tests.</p> + <ul> + <li>to completely delete a test press the red <i>X</i> button</li> + <li>to modify a test, click on the corresponding table row</li> + <li>to create a new test, use the <i>create new test</i> link</li> + </ul> + <img alt="Manage scenarios tab" src="images/webfrontend_managescenarios.gif"></img> + <p>For more information about this window see section <a href="#managetests">Manage tests</a> in the User guide.</p> + <section> + <title>Create a test</title> + <p>To create a test + <ul> + <li>enter a test title into the <i>name</i> field</li> + <li>optionally enter a test description into the <i>description</i> field</li> + <li>click on the <i>save test</i> link</li> + </ul> + </p> + <img alt="Create a test" src="images/webfrontend_createtest.gif"></img> + <p>After an empty test is created, it is in its version 1. Now calls can be added. A call is an instruction to SIPp, so a test is an instruction set. There are two parties the calls can be added, the <i>A party</i> and the <i>B party</i>. The calls in a party are executed one by one like in a queue, but the two parties are executed simultaneously. With this the parties can communicate with each other.</p> + <p>Sometimes the <i>A party</i> and the <i>B party</i> should not begin the execution at the same time (e.g., the client waits for the server to start). In this case a party can be delayed using the corresponding <i>delay</i> dropdown field.</p> + <img alt="Add calls to parties" src="images/webfrontend_addcalls.gif"></img> + <p>The test screen is split in 3 areas. In the first (upper) one, the test name and description can be modified, and the entire test can be duplicated or removed. In the second (middle) area calls can be added, removed or reordered. The third (lower) area shows the test-runs that has been done with the current version.</p> + </section> + <section> + <title>Adding calls to a test</title> + <p>To add a call, use the <i>add a call</i> link of the corresponding party (see in the figure above) and get to the <i>Create new call</i> screen.</p> + <img alt="Add a call" src="images/webfrontend_addcall.gif"></img> + <p>Here the command line parameters to pass to SIPp can be set up (the corresponding parameters are stated in round brackets, e.g., <code>-timeout</code>) or (<code>-m</code>), but first + <ul> + <li>choose an <i>Executable</i> (the version of SIPp you want to use, defined in <code>config.ini.php</code>. See section <a href="#configfile">Config file</a> for more details).</li> + <li>choose a <i>Scenario</i> defined earlier in the <i>Manage scenarios</i> tab (Section <a href="#managescenarios">Manage scenarios</a>).</li> + <li>if a client scenario is used, enter a <i>Remote host</i>. This is where SIPp addresses its messages to.</li> + <li>check the <i>Monitor call</i> checkbox, if during the test execution realtime feedback of the test progress should be displayed. In that case the tester can also influence the test by pausing it, or by adjusting the packet rate (See section <h href="#runatest">Run a test</h> for more details).</li> + <li>check the <i>Log</i> checkbox, if log files (<code>-trace_err, -trace_logs, -trace_rtt, -trace_stat</code>) should be stored in the database.</li> + </ul></p> + <p>If the given configuration options are not enough, the <i>Extended parameters</i> text field can be used to pass any command line parameters to SIPp. The <i>Extended parameters</i> are not evaluated or modified in any way. It is up to the administrator to use a correct syntax. There may be some command line options that do not work, or even cause SIPp to hang (i.e. <code>-bg</code>).</p> + <p>If a parameter is specified in the form and also as <i>extended parameter</i>, the <i>extended parameter</i> has the higher priority, and overwrites the other.</p> + <p>Global parameters (applied to any call) can be defined in the <code>AVP Section</code> of the <code>config.ini.php</code>. These have the lowest priority.</p> + </section> + <section> + <title>Modify a test / create a new test version</title> + <p>Tests and calls can be modified at any time. If a test has already runs, a crucial modification of the test would mean that test information belonging to these runs is lost, and thus the run is not reproducible anymore. To avoid this, a new version is created automatically.</p> + <p>Simply switch between the versions of a test by clicking the version numbers. A version can even be deleted by using the <i>remove this version</i> link, but then all its runs are lost too.</p> + <img alt="Test versions" src="images/webfrontend_version.gif"></img> + </section> + <section> + <title>Duplicate a test</title> + <p>If a test is duplicated using the <i>duplicate test</i> link, the currently displayed version of the test is copied into version 1 of the duplicate. The new name of the duplicate is composed with the original name followed by the word <i>copy</i>. A duplicate initially has no runs.</p> + </section> + </section> + <section> + <title>System information</title> + <p>In the <i>System information</i> tab, the page is split in 3 areas. First a list of currently running SIPp instances is displayed. Then the available free disk space is stated. Finally there is a list with the versions of SIPp that are defined in the <code>config.ini.php</code> file, along with their verbose screens.</p> + <img alt="System information tab" src="images/webfrontend_sysinfo.gif"></img> + <section> + <title>Kill a hanging SIPp instance</title> + <p>An admin can try to kill an instance of SIPp by pressing the corresponding red <i>X</i> button in the list of currently running SIPp instances. Although SIPp runs that are not started through the web frontend are also in the list, they cannot be killed.</p> + </section> + </section> + <section> + <anchor id="configfile" /> + <title>Config file</title> + <p>A line in the config file with a leading ; is a comment and has no effect to the configuration.<br /> + The configuration file is divided in three sections respectively tagged with<br /> + <code>[EXECUTABLES], [AVP], and [CONFIG]</code>.</p> + <ul> + <li>In the <code>[EXECUTABLES]</code>-section SIPp executables and their versions can be specified. At least one executable is mandatory.</li> + <li>In the <code>[AVP]</code>-section global command line parameters for SIPp can be specified in form of attribute-value pairs (<code>attribute = value</code>). <br /> + I.e. most parameters of SIPp (without the leading -) will be accepted (see <code>sipp -h</code> for more details).<br /> + These parameters can be overwritten in each individual call by using the <i>Extended parameters</i> textarea in the web tool. Take care that you only use parameters that work with every version of SIPp you are using with this tool. If a attribute has no value, but is a switch, use TRUE as a value (e.g., <code>aa = TRUE</code>). If a value contains non-alphanumeric characters it needs to be enclosed in double-quotes (").<br /><br /> + Parameters not allowed are:<br /> + <code>i, m, nd, nr, t, p, r, timeout, pause_msg_ign, v, bind_local, inf, sd, sf, sn, stf, trace_msg, trace_shortmsg, trace_screen, trace_err, linebreak trace_timeout, trace_stat, trace_rtt, trace_logs</code></li> + <li>In the <code>[CONFIG]</code>-section you will find program specific parameters, like admin password or MySQL-database connection information...</li> + </ul> + <p>Refer to the config file <code>config.ini.php</code> to get more detailed information about the specific parameters.</p> + </section> + </section> + <section> + <title>User guide</title> + <anchor id="managetests" /> + <section> + <title>Manage tests</title> + <p>There is a list of available tests in the <i>Manage tests</i>. If there are many tests, it may be useful to sort the tests by clicking one of the column headings.</p> + </section> + <section> + <anchor id="runatest" /> + <title>Run a test</title> + <p>Click on a test to get a more detailed view. There choose a version and click on the <i>run this version</i> link to open the test popup.</p> + <img alt="Execute test screen" src="images/webfrontend_exec.gif"></img> + <p>Click on <i>Run test now</i> to begin testing. Both parties start to process their queues. On the left hand side of each call there is a small image showing the actual state of the call.</p> + <img alt="Call state icons" src="images/webfrontend_states.gif"></img> + <section> + <title>Key commands</title> + <p>If monitoring is turned on, the test progress can be influenced by using key commands (this is the same as in the command line). First set the focus to the corresponding monitoring screen by clicking on it. When the border of the screen turns red, use the key commands on your keyboard. + <ul> + <li><i>0-9</i> to switch between screens</li> + <li><i>+ , - , * , /</i> to adjust packet rate</li> + <li><i>q</i> to soft exit</li> + <li><i>p</i> to pause/resume execution</li> + </ul> + </p> + </section> + <section> + <title>Abort a call / test</title> + <p>Never close the test window without the test finished, because there may reside SIPp processes running on the server. If for some reason a call does not terminate by itself, there are three possibilities to finish the test anyway: + <ul> + <li>If the call has monitoring turned on, try to end the call with the key command <i>q</i> (soft exit).</li> + <li>A call that hangs can be terminated by pressing the red <i>X</i> on its right hand side.</li> + <li>The whole test can be stopped with the <i>Abort test</i> link at the top of the window.</li> + </ul> + </p> + </section> + </section> + <section> + <title>Runs</title> + <p>After a test has finished, the test window is closed automatically and the created run is displayed. The <i>exit</i> and the <i>std error</i> column may contain important information (roll the mouse over the columns for more details in a tooltip box). Click the grey eye buttons to download the log files created during the test.</p> + <img alt="Runs screen" src="images/webfrontend_runs.gif"></img> + <p>It is possible to return to this page, or to another run, any time. Just navigate to the corresponding test in the <i>Manage tests</i> tab, choose the right version and click on a run at the bottom of the page.</p> + </section> + </section> + <section> + <title>Programming guide</title> + <section> + <title>Database (ER Diagram)</title> + <img alt="Entity Relationship diagram" src="images/webfrontend_er.gif"></img> + </section> + <section> + <title>Files</title> + <ul> + <li><code>add_call.php</code> is responsible for the <i>add/modify call</i> screen. Adds/modifies calls in the database.</li> + <li><code>authentication.php</code>: checks if admin is logged in. It is included everywhere, where admin should have special permissions.</li> + <li><code>Call_Data.php</code>: class Call_Data: contains call specific data (process-id, log filenames...) of a currently running call. It has methods to store log files in the database, delete the log files and determine the exit code after execution. When a call is about to be executed, an object of this class is generated and stored in a session variable.</li> + <li><code>config.ini.php</code>: configuration file</li> + <li><code>create_run.php</code>: is called from run_progress.php via ajax. It creates a run in the database with the current timestamp.</li> + <li><code>dbHelper.php</code>: is where the SQL happens. For each table in the database, there is a corresponding class that handles database communication.</li> + <li><code>db.php</code>: generates the MySQL database connection object.</li> + <li><code>exec_call.php</code>: is called from <code>run_progress.php</code> via ajax. The basic function of this file is to build up the command line, create the XML-scenario file and the CSV-injection file in the system's temporary folder, execute the call and return its process id (pid).</li> + <li><code>garbagecollector.php</code>: removes all SIPp directories in the system's temp folder that have not been modified for a specific time (defined in <code>config.ini.php</code>). Further all SIPp processes older than a specific time get killed.</li> + <li><code>get_screen.php</code>: During execution of a call this file is requested periodically via ajax. Here the actual monitor-screen is extracted from the screen file, and returned to <code>status_screen.php</code> (if monitoring is turned on). Further this file checks if the SIPp process is still running, and if not, it returns exit-code and standard-error to <code>status_screen.php</code>.</li> + <li><code>helper.php</code>: just some useful functions.</li> + <li><code>index.php</code>: redirect to <code>tests.php</code>.</li> + <li><code>info.php</code>: represents the <i>System information</i> tab.</li> + <li><code>kill_process.php</code>: is called from <code>run_progress.php</code> via ajax, if the user wants to kill a SIPp process.</li> + <li><code>read_config.php</code>: reads the config file in the three arrays <code>$executables, $avp,</code> and <code>$config</code>. Default values are set if necessary, and there is a function <code>getConfig-Parameters</code> that assembles command line parameters from the <code>AVP</code> section.</li> + <li><code>run_detail.php</code>: represents the <i>show run</i> page.</li> + <li><code>run_progress.php</code>: represents the <i>run test</i> popup. This is where all the ajax happens. Refer to the file itself for detailed information.</li> + <li><code>scenario_detail.php</code>: represents the <i>create/modify scenario</i> screen. Inserts or updates scenario data in the database.</li> + <li><code>scenarios.php</code>: represents the <i>Manage scenarios</i> tab.</li> + <li><code>send_key.php</code>: is called via ajax from <code>status_screen.php</code> when the user presses a key on the keyboard.</li> + <li><code>status_screen.php</code>: is displayed in a iframe in <code>run_progress.php</code> during test. Here the status monitor screen of a running SIPp instance is displayed by polling it from the server frequently. Further, keyboard action is sent to <code>send_key.php</code>, that forwards it to the running SIPp instance.</li> + <li><code>stop_sipp.php</code>: has a function that tries to stop a running SIPp instance. It takes care that the pid belongs to a SIPp process.</li> + <li><code>sys_get_temp_dir.php</code>: provides functions that determine the working directory and the systems temp directory.</li> + <li><code>test_detail.php</code>: represents the <i>create/modify test</i> screen.</li> + <li><code>tests.php</code>: represents the <i>Manage tests</i> tab.</li> + <li><code>view_csv.php</code>: is for downloading CSV files (log files etc.) that are stored in the database.</li> + <li><code>view_messages.php</code>: is for downloading the file created by the command line option <code>-trace_messages</code>. The trace_messages file is not stored in the database because it may be very large, but it is left for a short time in the systems temp folder until the garbage collector removes it.</li> + <li><code>view_text.php</code>: is for downloading text files (log files etc.) that are stored in the database.</li> + <li><code>view_xml.php</code>: is for downloading XML files (scenario files) that are stored in the database.</li> + <li><code>/js/ajaxConnection.js</code>: crossbrowser function to create an ajax request object in javascript.</li> + <li><code>/js/helper.js</code>: some useful javascript functions.</li> + <li><code>/js/run.js</code>: opens a window for a test run.</li> + <li><code>/js/tooltip.js</code>: provides functions to display tooltip texts.</li> + <li><code>/navigation/pagehead.php</code>: If you want to add a new tab to the navigation, do it here.</li> + <li><code>/navigation/register.php</code>: Here the navigation of the webfrontend is created.</li> + </ul> + </section> + <section> + <title>Command flow during test process</title> + <img alt="Command flow" src="images/webfrontend_commandflow.gif"></img> + </section> + </section> + </body> +</document> Added: doc/trunk/src/documentation/resources/images/Thumbs.db =================================================================== (Binary files differ) Property changes on: doc/trunk/src/documentation/resources/images/Thumbs.db ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: doc/trunk/src/documentation/resources/images/webfrontend_addcall.gif =================================================================== (Binary files differ) Property changes on: doc/trunk/src/documentation/resources/images/webfrontend_addcall.gif ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: doc/trunk/src/documentation/resources/images/webfrontend_addcalls.gif =================================================================== (Binary files differ) Property changes on: doc/trunk/src/documentation/resources/images/webfrontend_addcalls.gif ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: doc/trunk/src/documentation/resources/images/webfrontend_commandflow.gif =================================================================== (Binary files differ) Property changes on: doc/trunk/src/documentation/resources/images/webfrontend_commandflow.gif ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: doc/trunk/src/documentation/resources/images/webfrontend_createscenario.gif =================================================================== (Binary files differ) Property changes on: doc/trunk/src/documentation/resources/images/webfrontend_createscenario.gif ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: doc/trunk/src/documentation/resources/images/webfrontend_createtest.gif =================================================================== (Binary files differ) Property changes on: doc/trunk/src/documentation/resources/images/webfrontend_createtest.gif ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: doc/trunk/src/documentation/resources/images/webfrontend_er.gif =================================================================== (Binary files differ) Property changes on: doc/trunk/src/documentation/resources/images/webfrontend_er.gif ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: doc/trunk/src/documentation/resources/images/webfrontend_exec.gif =================================================================== (Binary files differ) Property changes on: doc/trunk/src/documentation/resources/images/webfrontend_exec.gif ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: doc/trunk/src/documentation/resources/images/webfrontend_managescenarios.gif =================================================================== (Binary files differ) Property changes on: doc/trunk/src/documentation/resources/images/webfrontend_managescenarios.gif ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: doc/trunk/src/documentation/resources/images/webfrontend_managetests.gif =================================================================== (Binary files differ) Property changes on: doc/trunk/src/documentation/resources/images/webfrontend_managetests.gif ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: doc/trunk/src/documentation/resources/images/webfrontend_runs.gif =================================================================== (Binary files differ) Property changes on: doc/trunk/src/documentation/resources/images/webfrontend_runs.gif ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: doc/trunk/src/documentation/resources/images/webfrontend_states.gif =================================================================== (Binary files differ) Property changes on: doc/trunk/src/documentation/resources/images/webfrontend_states.gif ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: doc/trunk/src/documentation/resources/images/webfrontend_sysinfo.gif =================================================================== (Binary files differ) Property changes on: doc/trunk/src/documentation/resources/images/webfrontend_sysinfo.gif ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: doc/trunk/src/documentation/resources/images/webfrontend_version.gif =================================================================== (Binary files differ) Property changes on: doc/trunk/src/documentation/resources/images/webfrontend_version.gif ___________________________________________________________________ Added: svn:mime-type + application/octet-stream This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <arc...@us...> - 2013-01-13 22:30:15
|
Revision: 623 http://sourceforge.net/p/sipp/code/623 Author: arcady-91 Date: 2013-01-13 22:30:13 +0000 (Sun, 13 Jan 2013) Log Message: ----------- Fixed XML errors which prevented reference.pdf from building Modified Paths: -------------- doc/trunk/src/documentation/content/xdocs/doc/reference.xml doc/trunk/src/documentation/skinconf.xml Modified: doc/trunk/src/documentation/content/xdocs/doc/reference.xml =================================================================== --- doc/trunk/src/documentation/content/xdocs/doc/reference.xml 2013-01-10 23:02:21 UTC (rev 622) +++ doc/trunk/src/documentation/content/xdocs/doc/reference.xml 2013-01-13 22:30:13 UTC (rev 623) @@ -893,9 +893,8 @@ <td><code><pause variable="1" /></code> pauses for the number of milliseconds specified by call variable 1.</td> </tr> <tr> - <anchor id="pause_distributions" /> <td></td> - <td>distribution</td> + <td><anchor id="pause_distributions" />distribution</td> <td>Indicates which statistical distribution to use to determine the length of the pause. Without GSL, you may use <code>uniform</code> or <code>fixed</code>. With GSL, normal, exponential, gamma, lambda, lognormal, negbin, (negative binomial), pareto, and weibull are available. Depending on the distribution you select, you must also supply distribution specific parameters.</td> <td> The following examples show the various types of distributed pauses: @@ -2548,26 +2547,22 @@ the command line parameter <code>-trace_err</code>.</li> <li>You can trace the counts from the main scenario screen in <name_of_the_scenario>_<pid>_counts.csv by using the command line parameter <code>-trace_counts</code>.</li> - <li>You can trace the messages and state transitions of - failed calls in <name_of_the_scenario>_<pid>_calldebug.log using - the <code>-trace_calldebug</code> command line parameter. This is useful, - because it has less overhead than <code>-trace_msg</code> yet allows you to - debug call flows that were not completed successfully.</li>. + <li>You can trace the messages and state transitions of + failed calls in <name_of_the_scenario>_<pid>_calldebug.log using + the <code>-trace_calldebug</code> command line parameter. This is useful, + because it has less overhead than <code>-trace_msg</code> yet allows you to + debug call flows that were not completed successfully.</li> <li>You can save in a file the statistics screens, as displayed in the interface. This is especially useful when running SIPp in background - mode.<br/> + mode. <br/> This can be done in different ways: - <ul> - <li>When SIPp exits to get a final status report (-trace_screen option)</li> - <li>On demand by using USR2 signal (example: <code>kill -SIGUSR2 738</code>)</li> - <li>By pressing 's' key (if -trace_screen option is set)</li> - <li>If the -trace_logs option is set, you can use the <code><log></code> action to print some scenario traces in the <![CDATA[<scenario file name>_<pid>_logs.log]]> file. See the <a href="#action_log">Log action section </a></li> - </ul> - </li> - - <!-- <li>You can log all call ids for calls that timeout (the maximum - number of retransmissions for UDP transport is reached) - by using the command line parameter <code>-trace_timeout</code></li> --> + <ul> + <li>When SIPp exits to get a final status report (-trace_screen option)</li> + <li>On demand by using USR2 signal (example: <code>kill -SIGUSR2 738</code>)</li> + <li>By pressing 's' key (if -trace_screen option is set)</li> + <li>If the -trace_logs option is set, you can use the <code><log></code> action to print some scenario traces in the <scenario file name>_<pid>_logs.log file. See the <a href="#action_log">Log action section </a></li> + </ul> + </li> </ul> <p>SIPp can treat the messages, short messages, logs, and error logs as ring buffers. This allows you to limit the total amount of space used by these log files and keep only the most recent messages. To set the maximum file size use the <code>-ringbuffer_size</code> option. Once the file exceeds this size (the file size can be exceeded up to the size of a single log message), it is rotated. SIPp can keep several of the most recent files, to specify the number of files to keep use the <code>-ringbuffer_files</code> option. The rotated files have a name of the form <name_of_the_scenario>_<pid>_<logname>_<date>.log, where <date> is the number of seconds since the epoch. If more than one log file is rotated during a one second period, then the date is expressed as <seconds.serial>, where serial is an increasing integer identifier.</p> </section> Modified: doc/trunk/src/documentation/skinconf.xml =================================================================== --- doc/trunk/src/documentation/skinconf.xml 2013-01-10 23:02:21 UTC (rev 622) +++ doc/trunk/src/documentation/skinconf.xml 2013-01-13 22:30:13 UTC (rev 623) @@ -73,7 +73,7 @@ <favicon-url></favicon-url> <!-- The following are used to construct a copyright statement --> - <year>2004,2005,2006,2007</year> + <year>2004-2013</year> <vendor>The authors</vendor> <!-- The optional copyright-link URL will be used as a link in the copyright statement This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
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. |