diff options
author | Jaap Keuter <jaap.keuter@xs4all.nl> | 2009-12-27 22:20:03 +0000 |
---|---|---|
committer | Jaap Keuter <jaap.keuter@xs4all.nl> | 2009-12-27 22:20:03 +0000 |
commit | b74a82e665911d2d008287a523f150b947b5f1ef (patch) | |
tree | 4429f12c65794a2262e84d32471dc5a764d8e533 /docbook | |
parent | 7265357a1a02b045c459669bb9d846aae2f2ca05 (diff) |
Start Telephony statistics chapter.
svn path=/trunk/; revision=31369
Diffstat (limited to 'docbook')
-rw-r--r-- | docbook/Makefile.common | 1 | ||||
-rw-r--r-- | docbook/user-guide.xml | 8 | ||||
-rw-r--r-- | docbook/wsug_graphics/ws-tel-rtpstream-analysis.png | bin | 0 -> 68916 bytes | |||
-rw-r--r-- | docbook/wsug_src/WSUG_chapter_statistics.xml | 140 | ||||
-rw-r--r-- | docbook/wsug_src/WSUG_chapter_telephony.xml | 91 | ||||
-rw-r--r-- | docbook/wsug_src/WSUG_chapter_use.xml | 30 |
6 files changed, 192 insertions, 78 deletions
diff --git a/docbook/Makefile.common b/docbook/Makefile.common index 519d6cfcd1..1eddea1df9 100644 --- a/docbook/Makefile.common +++ b/docbook/Makefile.common @@ -14,6 +14,7 @@ WSUG_FILES = \ wsug_src/WSUG_chapter_introduction.xml \ wsug_src/WSUG_chapter_io.xml \ wsug_src/WSUG_chapter_statistics.xml \ + wsug_src/WSUG_chapter_telephony.xml \ wsug_src/WSUG_chapter_troubleshoot.xml \ wsug_src/WSUG_chapter_use.xml \ wsug_src/WSUG_chapter_work.xml \ diff --git a/docbook/user-guide.xml b/docbook/user-guide.xml index 7084ef6473..18a729e536 100644 --- a/docbook/user-guide.xml +++ b/docbook/user-guide.xml @@ -245,6 +245,10 @@ FILE SECTION <!ENTITY WiresharkStatsSrtDcerpcFilter SYSTEM "./wsug_graphics/ws-stats-srt-dcerpc-filter.png" NDATA PNG> <!ENTITY WiresharkStatsSrtDcerpc SYSTEM "./wsug_graphics/ws-stats-srt-dcerpc.png" NDATA PNG> + <!-- Chapter Telephony --> + <!ENTITY WiresharkTelRTPStreamAnalysis SYSTEM "./wsug_graphics/ws-tel-rtpstream-analysis.png" NDATA PNG> + <!ENTITY WiresharkStatsLTEMACTraffic SYSTEM "./wsug_graphics/ws-stats-lte-mac-traffic.png" NDATA PNG> + <!-- Fourth Chapter --> <!ENTITY WiresharkCaptureInterfacesDialog SYSTEM "./wsug_graphics/ws-capture-interfaces.png" NDATA PNG> <!ENTITY WiresharkCaptureInterfacesDialogWin32 SYSTEM "./wsug_graphics/ws-capture-interfaces-win32.png" NDATA PNG> @@ -295,6 +299,7 @@ FILE SECTION <!ENTITY ChapterWork SYSTEM "wsug_src/WSUG_chapter_work.xml"> <!ENTITY ChapterAdvanced SYSTEM "wsug_src/WSUG_chapter_advanced.xml"> <!ENTITY ChapterStatistics SYSTEM "wsug_src/WSUG_chapter_statistics.xml"> + <!ENTITY ChapterTelephony SYSTEM "wsug_src/WSUG_chapter_telephony.xml"> <!ENTITY ChapterCustomize SYSTEM "wsug_src/WSUG_chapter_customize.xml"> <!ENTITY ChapterTroubleshoot SYSTEM "wsug_src/WSUG_chapter_troubleshoot.xml"> <!ENTITY AppMessages SYSTEM "wsug_src/WSUG_app_messages.xml"> @@ -332,7 +337,8 @@ WSLua Reference Manual &ChapterIo; &ChapterWork; &ChapterAdvanced; - &ChapterStatistics; + &ChapterStatistics; + &ChapterTelephony; &ChapterCustomize; &WsLuaRm; diff --git a/docbook/wsug_graphics/ws-tel-rtpstream-analysis.png b/docbook/wsug_graphics/ws-tel-rtpstream-analysis.png Binary files differnew file mode 100644 index 0000000000..530d4e5775 --- /dev/null +++ b/docbook/wsug_graphics/ws-tel-rtpstream-analysis.png diff --git a/docbook/wsug_src/WSUG_chapter_statistics.xml b/docbook/wsug_src/WSUG_chapter_statistics.xml index 76c8637daa..3fa2ed79cc 100644 --- a/docbook/wsug_src/WSUG_chapter_statistics.xml +++ b/docbook/wsug_src/WSUG_chapter_statistics.xml @@ -291,7 +291,32 @@ </listitem> <listitem> <para> - <command>IPX</command>: XXX - insert info here. + <command>IPX</command>: an IPX endpoint is concatenation of a 32 bit + network number and 48 bit node address, be default the Ethernets' MAC + address. + </para> + </listitem> + <listitem> + <para> + <command>JXTA</command>: a JXTA endpoint is a 160 bit SHA-1 URN. + </para> + </listitem> + <listitem> + <para> + <command>NCP</command>: XXX - insert info here. + </para> + </listitem> + <listitem> + <para> + <command>RSVP</command>: XXX - insert info here. + </para> + </listitem> + <listitem> + <para> + <command>SCTP</command>: a SCTP endpoint is a combination of the host IP + addresses (plural) and the SCTP port used. So different SCTP ports on the + same IP address are different SCTP endpoints, but the same SCTP port on + different IP addresses of the same host are still the same endpoint. </para> </listitem> <listitem> @@ -314,6 +339,16 @@ different UDP endpoints. </para> </listitem> + <listitem> + <para> + <command>USB</command>: XXX - insert info here. + </para> + </listitem> + <listitem> + <para> + <command>WLAN</command>: XXX - insert info here. + </para> + </listitem> </itemizedlist> <note><title>Broadcast / multicast endpoints</title> <para> @@ -489,67 +524,6 @@ </tip> </section> - <section id="ChStatCompareCaptureFiles"> - <title>Compare two capture files</title> - <para> - Compare two capture files. - </para> - </section> - - <section id="ChStatWLANTraffic"> - <title>WLAN Traffic Statistics</title> - <para> - Statistics of the captured WLAN traffic. This window will summarize the - wireless network traffic found in the capture. Probe requests will be - merged into an existing network if the SSID matches. - </para> - - <figure><title>The "WLAN Traffic Statistics" window</title> - <graphic entityref="WiresharkStatsWLANTraffic" format="PNG"/> - </figure> - - <para> - Each row in the list shows the statistical values for exactly one wireless network. - </para> - <para> - <command>Name resolution</command> will be done if selected in the window - and if it is active for the MAC layer. - </para> - <para> - <command>Only show existing networks</command> will exclude probe requests - with a SSID not matching any network from the list. - </para> - <para> - The <command>copy</command> button will copy the list values to the - clipboard in CSV (Comma Separated Values) format. - </para> - <tip><title>Tip!</title> - <para> - This window will be updated frequently, so it will be useful, even if - you open it before (or while) you are doing a live capture. - </para> - </tip> - </section> - - <section id="ChStatLTEMACTraffic"> - <title>LTE MAC Traffic Statistics</title> - <para> - Statistics of the captured LTE MAC traffic. This window will summarize the - LTE MAC traffic found in the capture. - </para> - - <figure><title>The "LTE MAC Traffic Statistics" window</title> - <graphic entityref="WiresharkStatsLTEMACTraffic" format="PNG"/> - </figure> - - <para> - The top pane shows statistics for common channels. - Each row in the middle pane shows statistical highlights for exactly one UE/C-RNTI. - In the lower pane, you can see the for the currently selected UE/C-RNTI - the traffic broken down by individual channel. - </para> - </section> - <section id="ChStatSRT"> <title>Service Response Time</title> <para> @@ -620,7 +594,49 @@ </para> </section> </section> +<!-- + <section id="ChStatCompareCaptureFiles"> + <title>Compare two capture files</title> + <para> + Compare two capture files. + </para> + </section> +--> + <section id="ChStatWLANTraffic"> + <title>WLAN Traffic Statistics</title> + <para> + Statistics of the captured WLAN traffic. This window will summarize the + wireless network traffic found in the capture. Probe requests will be + merged into an existing network if the SSID matches. + </para> + <figure><title>The "WLAN Traffic Statistics" window</title> + <graphic entityref="WiresharkStatsWLANTraffic" format="PNG"/> + </figure> + + <para> + Each row in the list shows the statistical values for exactly one wireless network. + </para> + <para> + <command>Name resolution</command> will be done if selected in the window + and if it is active for the MAC layer. + </para> + <para> + <command>Only show existing networks</command> will exclude probe requests + with a SSID not matching any network from the list. + </para> + <para> + The <command>copy</command> button will copy the list values to the + clipboard in CSV (Comma Separated Values) format. + </para> + <tip><title>Tip!</title> + <para> + This window will be updated frequently, so it will be useful, even if + you open it before (or while) you are doing a live capture. + </para> + </tip> + </section> + <section id="ChStatXXX"> <title>The protocol specific statistics windows</title> <para> diff --git a/docbook/wsug_src/WSUG_chapter_telephony.xml b/docbook/wsug_src/WSUG_chapter_telephony.xml new file mode 100644 index 0000000000..891dc15efd --- /dev/null +++ b/docbook/wsug_src/WSUG_chapter_telephony.xml @@ -0,0 +1,91 @@ +<!-- WSUG Chapter Telephony --> +<!-- $Id$ --> + +<chapter id="ChTelephony"> + <title>Telephony</title> + <section id="ChTelIntroduction"> + <title>Introduction</title> + <para> + Wireshark provides a wide range of telephony related network statistics + which can be accessed via the <command>Telephony</command> menu. + </para> + <para> + These statistics range from specific signaling protocols, to analysis of + signaling and media flows. If encoded in a compatible encoding the media + flow can even be played. + </para> + </section> + + <section id="ChTelRTPAnalysis"> + <title>RTP Analysis</title> + <para> + The RTP analysis function takes the selected RTP stream (and the reverse + stream, if possible) and generates a list of statistics on it. + </para> + <figure><title>The "RTP Stream Analysis" window</title> + <graphic entityref="WiresharkTelRTPStreamAnalysis" format="PNG"/> + </figure> + <para> + Starting with basic data as packet number and sequence number, further + statistics are created based on arrival time, delay, jitter, packet size, + etc. + </para> + <para> + Besides the per packet statistics, the lower pane shows the overall + statistics, with minimums and maximums for delta, jitter and clock skew. + Also an indication of lost packets is included. + </para> + <para> + The RTP Stream Analysis window further provides the option to save the RTP + payload (as raw data or, if in a PCM encoding, in an Audio file). Other + options a to export and plot various statistics on the RTP streams. + </para> + </section> + + <section id="ChTelVoipCalls"> + <title>VoIP Calls</title> + <para> + The VoIP Calls window shows a list of all detected VoIP calls in the + captured traffic. It finds calls by their signaling. + </para> + <para> + More details are described at the + <ulink url="&WiresharkWikiPage;/VoIP_calls"/> page. + </para> + </section> + + <section id="ChTelLTEMACTraffic"> + <title>LTE MAC Traffic Statistics</title> + <para> + Statistics of the captured LTE MAC traffic. This window will summarize the + LTE MAC traffic found in the capture. + </para> + + <figure><title>The "LTE MAC Traffic Statistics" window</title> + <graphic entityref="WiresharkStatsLTEMACTraffic" format="PNG"/> + </figure> + + <para> + The top pane shows statistics for common channels. + Each row in the middle pane shows statistical highlights for exactly one UE/C-RNTI. + In the lower pane, you can see the for the currently selected UE/C-RNTI + the traffic broken down by individual channel. + </para> + </section> + + <section id="ChTelXXX"> + <title>The protocol specific statistics windows</title> + <para> + The protocol specific statistics windows display detailed information + of specific protocols and might be described in a later + version of this document. + </para> + <para> + Some of these statistics are described at the + <ulink url="&WiresharkWikiPage;/Statistics"/> pages. + </para> + </section> + +</chapter> +<!-- End of WSUG Chapter Telephony --> + diff --git a/docbook/wsug_src/WSUG_chapter_use.xml b/docbook/wsug_src/WSUG_chapter_use.xml index 734241f58f..f6f887d48a 100644 --- a/docbook/wsug_src/WSUG_chapter_use.xml +++ b/docbook/wsug_src/WSUG_chapter_use.xml @@ -1724,77 +1724,77 @@ <row> <entry><command>ANSI</command></entry> <entry></entry> - <entry><para>See <xref linkend="ChStatXXX"/></para></entry> + <entry><para>See <xref linkend="ChTelXXX"/></para></entry> </row> <row> <entry><command>Fax T38 Analysis...</command></entry> <entry></entry> - <entry><para>See <xref linkend="ChStatXXX"/></para></entry> + <entry><para>See <xref linkend="ChTelXXX"/></para></entry> </row> <row> <entry><command>GSM</command></entry> <entry></entry> - <entry><para>See <xref linkend="ChStatXXX"/></para></entry> + <entry><para>See <xref linkend="ChTelXXX"/></para></entry> </row> <row> <entry><command>H.225...</command></entry> <entry></entry> - <entry><para>See <xref linkend="ChStatXXX"/></para></entry> + <entry><para>See <xref linkend="ChTelXXX"/></para></entry> </row> <row> <entry><command>IAX2</command></entry> <entry></entry> - <entry><para>See <xref linkend="ChStatXXX"/></para></entry> + <entry><para>See <xref linkend="ChTelXXX"/></para></entry> </row> <row> <entry><command>ISUP Messages...</command></entry> <entry></entry> - <entry><para>See <xref linkend="ChStatXXX"/></para></entry> + <entry><para>See <xref linkend="ChTelXXX"/></para></entry> </row> <row> <entry><command>LTE MAC...</command></entry> <entry></entry> - <entry><para>See <xref linkend="ChStatLTEMACTraffic"/></para></entry> + <entry><para>See <xref linkend="ChTelLTEMACTraffic"/></para></entry> </row> <row> <entry><command>MTP3</command></entry> <entry></entry> - <entry><para>See <xref linkend="ChStatXXX"/></para></entry> + <entry><para>See <xref linkend="ChTelXXX"/></para></entry> </row> <row> <entry><command>RTP</command></entry> <entry></entry> - <entry><para>See <xref linkend="ChStatXXX"/></para></entry> + <entry><para>See <xref linkend="ChTelRTPAnalysis"/></para></entry> </row> <row> <entry><command>SCTP</command></entry> <entry></entry> - <entry><para>See <xref linkend="ChStatXXX"/></para></entry> + <entry><para>See <xref linkend="ChTelXXX"/></para></entry> </row> <row> <entry><command>SIP...</command></entry> <entry></entry> - <entry><para>See <xref linkend="ChStatXXX"/></para></entry> + <entry><para>See <xref linkend="ChTelXXX"/></para></entry> </row> <row> <entry><command>SMPP Operations...</command></entry> <entry></entry> - <entry><para>See <xref linkend="ChStatXXX"/></para></entry> + <entry><para>See <xref linkend="ChTelXXX"/></para></entry> </row> <row> <entry><command>UCP Messages...</command></entry> <entry></entry> - <entry><para>See <xref linkend="ChStatXXX"/></para></entry> + <entry><para>See <xref linkend="ChTelXXX"/></para></entry> </row> <row> <entry><command>VoIP Calls...</command></entry> <entry></entry> - <entry><para>See <xref linkend="ChStatXXX"/></para></entry> + <entry><para>See <xref linkend="ChTelVoipCalls"/></para></entry> </row> <row> <entry><command>WAP-WSP...</command></entry> <entry></entry> - <entry><para>See <xref linkend="ChStatXXX"/></para></entry> + <entry><para>See <xref linkend="ChTelXXX"/></para></entry> </row> </tbody> </tgroup> |