From f20d5d7bd3b3fdbed06e68020337ccd2e6e53e42 Mon Sep 17 00:00:00 2001 From: Gerald Combs Date: Sun, 31 Aug 2014 21:52:32 -0700 Subject: [PATCH] WSUG: Convert ``Telephony'' to AsciiDoc. Leave most of the content intact for now. Change-Id: I21aad681194d1bb1841e29f4ac41be4677fcb909 Reviewed-on: https://code.wireshark.org/review/3939 Petri-Dish: Gerald Combs Tested-by: Petri Dish Buildbot Reviewed-by: Gerald Combs --- docbook/CMakeLists.txt | 3 +- docbook/Makefile.common | 3 +- .../wsug_src/WSUG_chapter_telephony.asciidoc | 100 ++++++++++++++ docbook/wsug_src/WSUG_chapter_telephony.xml | 123 ------------------ 4 files changed, 104 insertions(+), 125 deletions(-) create mode 100644 docbook/wsug_src/WSUG_chapter_telephony.asciidoc delete mode 100644 docbook/wsug_src/WSUG_chapter_telephony.xml diff --git a/docbook/CMakeLists.txt b/docbook/CMakeLists.txt index 7ec3823c9e..fb57c8520d 100644 --- a/docbook/CMakeLists.txt +++ b/docbook/CMakeLists.txt @@ -44,7 +44,7 @@ set(WSUG_FILES WSUG_chapter_introduction.xml WSUG_chapter_io.xml WSUG_chapter_statistics.xml - wsug_src/WSUG_chapter_telephony.xml + WSUG_chapter_telephony.xml wsug_src/WSUG_chapter_troubleshoot.xml WSUG_chapter_use.xml WSUG_chapter_work.xml @@ -61,6 +61,7 @@ set(WSDG_ASCIIDOC_FILES wsug_src/WSUG_chapter_introduction.asciidoc wsug_src/WSUG_chapter_io.asciidoc wsug_src/WSUG_chapter_statistics.asciidoc + wsug_src/WSUG_chapter_telephony.asciidoc wsug_src/WSUG_chapter_use.asciidoc wsug_src/WSUG_chapter_work.asciidoc wsug_src/WSUG_preface.asciidoc diff --git a/docbook/Makefile.common b/docbook/Makefile.common index 836f740c02..7d22e0c706 100644 --- a/docbook/Makefile.common +++ b/docbook/Makefile.common @@ -13,7 +13,7 @@ WSUG_FILES = \ wsug_src/WSUG_chapter_introduction.asciidoc \ wsug_src/WSUG_chapter_io.asciidoc \ wsug_src/WSUG_chapter_statistics.asciidoc \ - wsug_src/WSUG_chapter_telephony.xml \ + wsug_src/WSUG_chapter_telephony.asciidoc \ wsug_src/WSUG_chapter_troubleshoot.xml \ wsug_src/WSUG_chapter_use.asciidoc \ wsug_src/WSUG_chapter_work.asciidoc \ @@ -28,6 +28,7 @@ WSUG_GENERATED_SOURCE = \ wsug_src/WSUG_chapter_capture.xml \ wsug_src/WSUG_chapter_introduction.xml \ wsug_src/WSUG_chapter_io.xml \ + wsug_src/WSUG_chapter_telephony.xml \ wsug_src/WSUG_chapter_statistics.xml \ wsug_src/WSUG_chapter_use.xml \ wsug_src/WSUG_chapter_work.xml \ diff --git a/docbook/wsug_src/WSUG_chapter_telephony.asciidoc b/docbook/wsug_src/WSUG_chapter_telephony.asciidoc new file mode 100644 index 0000000000..0144defe4d --- /dev/null +++ b/docbook/wsug_src/WSUG_chapter_telephony.asciidoc @@ -0,0 +1,100 @@ +++++++++++++++++++++++++++++++++++++++ + +++++++++++++++++++++++++++++++++++++++ + +[[ChTelephony]] + +== Telephony + +[[ChTelIntroduction]] + +=== Introduction + +Wireshark provides a wide range of telephony related network statistics which +can be accessed via the menu:Telephony[] menu. + +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. + +[[ChTelRTPAnalysis]] + +=== RTP Analysis + +The RTP analysis function takes the selected RTP stream (and the reverse stream, +if possible) and generates a list of statistics on it. + +.The ``RTP Stream Analysis'' window +image::wsug_graphics/ws-tel-rtpstream-analysis.png[] + +Starting with basic data as packet number and sequence number, further +statistics are created based on arrival time, delay, jitter, packet size, etc. + +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. + +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. + +[[ChTelVoipCalls]] + +=== VoIP Calls + +The VoIP Calls window shows a list of all detected VoIP calls in the captured +traffic. It finds calls by their signaling. + +More details are described at the +link:wireshark-wiki-site:[]VoIP_calls[wireshark-wiki-site:[]VoIP_calls] page. + +[[ChTelLTEMACTraffic]] + +=== LTE MAC Traffic Statistics + +Statistics of the captured LTE MAC traffic. This window will summarize the LTE +MAC traffic found in the capture. + +.The ``LTE MAC Traffic Statistics'' window +image::wsug_graphics/ws-stats-lte-mac-traffic.png[] + +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. + +[[ChTelLTERLCTraffic]] + +=== LTE RLC Traffic Statistics + +Statistics of the captured LTE RLC traffic. This window will summarize the LTE +RLC traffic found in the capture. + +.The ``LTE RLC Traffic Statistics'' window +image::wsug_graphics/ws-stats-lte-rlc-traffic.png[] + +At the top, the check-box allows this window to include RLC PDUs found within +MAC PDUs or not. This will affect both the PDUs counted as well as the display +filters generated (see below). + +The upper list shows summaries of each active UE. Each row in the lower list +shows statistical highlights for individual channels within the selected UE. + +The lower part of the windows allows display filters to be generated and set for +the selected channel. Note that in the case of Acknowledged Mode channels, if a +single direction is chosen, the generated filter will show data in that +direction and control PDUs in the opposite direction. + +[[ChTelXXX]] + +=== The protocol specific statistics windows + +The protocol specific statistics windows display detailed information of +specific protocols and might be described in a later version of this document. + +Some of these statistics are described at the +link:wireshark-wiki-site:[]Statistics[wireshark-wiki-site:[]Statistics] pages. + +++++++++++++++++++++++++++++++++++++++ + +++++++++++++++++++++++++++++++++++++++ \ No newline at end of file diff --git a/docbook/wsug_src/WSUG_chapter_telephony.xml b/docbook/wsug_src/WSUG_chapter_telephony.xml deleted file mode 100644 index 330d40844c..0000000000 --- a/docbook/wsug_src/WSUG_chapter_telephony.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - Telephony -
- Introduction - - Wireshark provides a wide range of telephony related network statistics - which can be accessed via the Telephony menu. - - - 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. - -
- -
- RTP Analysis - - The RTP analysis function takes the selected RTP stream (and the reverse - stream, if possible) and generates a list of statistics on it. - -
The "RTP Stream Analysis" window - -
- - Starting with basic data as packet number and sequence number, further - statistics are created based on arrival time, delay, jitter, packet size, - etc. - - - 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. - - - 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. - -
- -
- VoIP Calls - - The VoIP Calls window shows a list of all detected VoIP calls in the - captured traffic. It finds calls by their signaling. - - - More details are described at the - page. - -
- -
- LTE MAC Traffic Statistics - - Statistics of the captured LTE MAC traffic. This window will summarize the - LTE MAC traffic found in the capture. - - -
The "LTE MAC Traffic Statistics" window - -
- - - 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. - -
- -
- LTE RLC Traffic Statistics - - Statistics of the captured LTE RLC traffic. This window will summarize the - LTE RLC traffic found in the capture. - - -
The "LTE RLC Traffic Statistics" window - -
- - - At the top, the check-box allows this window to include RLC PDUs found - within MAC PDUs or not. This will affect both the PDUs counted as well - as the display filters generated (see below). - - - - The upper list shows summaries of each active UE. - Each row in the lower list shows statistical highlights for individual - channels within the selected UE. - - - - The lower part of the windows allows display filters to be generated and - set for the selected channel. Note that in the case of Acknowledged - Mode channels, if a single direction is chosen, the generated filter will - show data in that direction and control PDUs in the opposite direction. - - -
- - -
- The protocol specific statistics windows - - The protocol specific statistics windows display detailed information - of specific protocols and might be described in a later - version of this document. - - - Some of these statistics are described at the - pages. - -
- - - -