<?xml version="1.0" encoding="ISO-8859-1"?><!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "document-v13.dtd">
<document>
  <header> 
    <title>Welcome to SIPp</title>
    <authors>
        <person name="Richard GAYRAUD [Initial code]" email=""/>
        <person name="Olivier JACQUES [code/documentation]" email="ojacques@users.sourceforge.net"/>
        <person name="Many contributors" email=""/>
    </authors>
  </header>
  <body>
      <p>SIPp is a free Open Source test tool / traffic generator for the SIP protocol. 
      It includes a few basic <link href="http://www.sipstone.org">SipStone</link> 
      user agent scenarios (UAC and UAS) and establishes and releases multiple calls with 
      the INVITE and BYE methods. It can also reads 
      <link href="doc/uac.xml.html">custom XML</link> scenario files describing 
      from very simple to <link href="doc/reference.html#3PCC">complex</link> call flows. 
      It features the <link href="doc/reference.html#stat_screen">dynamic display</link> of 
      statistics about running tests (call rate, round trip delay, and message statistics), 
      periodic CSV <link href="doc/reference.html#Statistics">statistics</link> dumps, 
      TCP and UDP over multiple sockets or multiplexed with 
      retransmission management and <link href="doc/reference.html#traffic_control">dynamically 
      adjustable</link> call rates.</p>
      <p>Other advanced features include support of <link href="doc/reference.html#ipv6">IPv6</link>, 
      <link href="doc/reference.html#tls">TLS</link>, SIP <link href="doc/reference.html#authentication">authentication</link>,
      <link href="doc/reference.html#branching">conditional scenarios</link>, UDP retransmissions, 
      <link href="doc/reference.html#Error+handling">error robustness</link> (call
      timeout, protocol defense), call specific variable, Posix <link href="doc/reference.html#action_regexp">regular expression</link> 
      to extract and re-inject any protocol fields, <link href="doc/reference.html#actions">custom actions</link> 
      (log, system command exec, call stop)
      on message receive, field injection from <link href="doc/reference.html#inffile">external CSV</link> file to emulate live users.</p>
      <p>SIPp can also send media (RTP) traffic through <link href="doc/reference.html#RTP+echo">RTP echo</link> and 
      <link href="doc/reference.html#PCAP+Play">RTP / pcap</link> replay. Media can be audio or audio+video.</p>
      <p>While optimized for traffic, stress and performance testing, SIPp can be used to
      run one single call and exit, providing a <link href="doc/reference.html#Exit+codes">passed/failed</link> verdict.</p>
      <p>Last, but not least, SIPp has a <link href="doc/reference.html">comprehensive documentation</link> available
      both in HTML and PDF format.</p>
      <p>SIPp can be used to test many real SIP equipements 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>
      <p>
        <img src="images/sipp-01.jpg" alt="SIPp screenshot"/>
      </p>
      <p>And here is a video of SIPp in action (Windows Media Player 9 codec or above required):</p>
      <p>
        <icon src="images/wmv.gif" alt="wmv"/>
        <link href="images/sipp-01.wmv">sipp-01.wmv</link>
      </p>
      <p>Want to know more? Please jump to the <link href="doc/index.html">documentation section</link>.</p>
  </body>
</document>