.. include:: ../../vars.rst
.. _section-administration-tutorial-step-4:

Step 4: Routing Service
=======================

In this step, we will look at the *Routing Service* interface. Click on the
Routing Service node in the Physical View or in the Processes View. The first
tab, Routing Entities, contains four sub-views: a hierarchical (tree),
configuration, a statistics view, and a graph depicting the service. We will
also look at the Resource Charts tab.

.. figure:: ../../_static/administration/tut4_routingEntities.png
    :alt: Routing Service entities
    :name: Routing Service entities
    :align: center
    :figWidth: 100%

==========================
Routing Service Graph View
==========================
	
The graph view shows *Routing Service's* internal entities. 
It is interactive: you can click on each entity,
causing the statistics and configuration views to update their
displays with information corresponding to that entity. Right-clicking
an entity displays a menu of commands that can be sent to the service.

Right-click on *DefaultDomainRoute* and
choose the pause menu item. Note that the Routes contained within that
Domain Route change their states from running to paused. You can also
see the change in *Shapes Demo*: the shapes should have stopped
moving. 

Right-click on *DefaultDomainRoute*
and choose resume. The Routes should go back to running, and *Shapes
Demo* should receive data again. Note also that the throughput
(samples per second and bytes per second) now shows non-zero
results.

==================
Configuration View
==================
	
The configuration view displays configuration data for the selected
service entity. Note that the XML displayed may not exactly match the
original configuration file's content. Also please note that the
configuration is shown only for the selected entity and does not
include sub-entities. This means, for example, that you cannot simply
copy the service configuration XML to a file and use it directly.

Click on *default* in the graph or tree views to see
the service's top-level configuration.

.. figure:: ../../_static/administration/tut4_configuration.png
    :alt: Routing Service configuration
    :name: Routing Service configuration
    :align: center
    :figWidth: 100%

========================
Hierarchical (tree) View
========================

This view contains several columns, which display the state, throughput,
and latency data for the service. This view can also be used to select
entities (which cross-highlight in the graph view) to inspect their
configuration or statistics.

.. figure:: ../../_static/administration/tut4_treeView.png
    :alt: Routing Service tree view
    :name: Routing Service tree view
    :align: center
    :figWidth: 100%

===============
Statistics view
===============

The statistics view displays state and performance data for the selected
service entity. It overlaps with the information shown in the tree view but
is primarily intended to be used with the graph.

.. figure:: ../../_static/administration/tut4_statistics.png
    :alt: Routing Service statistics
    :name: Routing Service statistics
    :align: center
    :figWidth: 100%

==============
Graphical View
==============

The Graphical View tab allows you to visualize the Process View graph 
related to the Routing Service process, as explained in the Tutorial
:ref:`section-administration-tutorial-step-3`.

.. figure:: ../../_static/administration/tut4_processView.png
    :alt: Routing Service process view
    :name: Routing Service process view
    :align: center
    :figWidth: 100%

============
DDS Entities
============

The DDS Entities tab will display information about all the entities
that were created by the Routing Service process.

.. figure:: ../../_static/administration/tut4_ddsEntitiesTab.png
    :alt: Routing Service DDS Entities tab
    :name: Routing Service DDS Entities tab
    :align: center
    :figWidth: 100%

===
Log
===

The Log tab will provide the log messages that were received through
the Distributed Logger by the Routing Service process.

.. figure:: ../../_static/administration/tut4_logTab.png
    :alt: Routing Service log tab
    :name: Routing Service log tab
    :align: center
    :figWidth: 100%

===============================
RTI Routing Service Information
===============================

The RTI Routing Service information tab provides specific information
about the Routing Service Process.

.. figure:: ../../_static/administration/tut4_routingServiceTab.png
    :alt: Routing Service information tab
    :name: Routing Service information tab
    :align: center
    :figWidth: 100%

===================
Resource Charts Tab
===================

The Resource Charts tab contains a chart showing the CPU and memory consumption
of the service over time.

.. figure:: ../../_static/administration/tut4_resourceCharts.png
    :alt: Routing Service resource chart
    :name: Routing Service resource chart
    :align: center
    :figWidth: 100%