genode/repos/os/src/app/ping
Norman Feske bf62d6b896 Move timer from os to base repository
Since the timer and timeout handling is part of the base library (the
dynamic linker), it belongs to the base repository.

Besides moving the timer and its related infrastructure (alarm, timeout
libs, tests) to the base repository, this patch also moves the timer
from the 'drivers' subdirectory directly to 'src' and disamibuates the
timer's build locations for the various kernels. Otherwise the different
timer implementations could interfere with each other when using one
build directory with multiple kernels.

Note that this patch changes the include paths for the former os/timer,
os/alarm.h, os/duration.h, and os/timed_semaphore.h to base/.

Issue #3101
2019-01-14 12:33:57 +01:00
..
config.xsd base: define generic config XSD types globally 2018-08-28 16:48:47 +02:00
dhcp_client.cc ping: dynamic IP configuration 2018-05-30 13:36:12 +02:00
dhcp_client.h ping: shorter retry timeouts in DHCP client 2018-05-30 13:36:33 +02:00
ipv4_address_prefix.cc ping: dynamic IP configuration 2018-05-30 13:36:12 +02:00
ipv4_address_prefix.h ping: dynamic IP configuration 2018-05-30 13:36:12 +02:00
ipv4_config.cc ping: dynamic IP configuration 2018-05-30 13:36:12 +02:00
ipv4_config.h ping: dynamic IP configuration 2018-05-30 13:36:12 +02:00
main.cc ping: support UDP 2018-05-30 13:36:12 +02:00
nic.cc ping: dynamic IP configuration 2018-05-30 13:36:12 +02:00
nic.h ping: dynamic IP configuration 2018-05-30 13:36:12 +02:00
protocol.h ping: support UDP 2018-05-30 13:36:12 +02:00
README ping: support UDP 2018-05-30 13:36:12 +02:00
target.mk ping: dynamic IP configuration 2018-05-30 13:36:12 +02:00
xml_node.cc ping: dynamic IP configuration 2018-05-30 13:36:12 +02:00
xml_node.h Move timer from os to base repository 2019-01-14 12:33:57 +01:00

The 'ping' component continuously sends ICMP Echo or UDP requests to a given
IP host and waits for the corresponding ICMP Echo or UDP replies. For each
successfull ICMP Echo or UDP handshake it prints a short statistic. The ICMP
data field gets filled with the letters of the alphabet ('a' to 'z') repeatedly.


Configuration
~~~~~~~~~~~~~

This is an example configuration of the component which shows the default
value for each attribute except 'config.dst_ip' and 'config.interface':

! <config interface="10.0.0.72/24"
!         dst_ip="10.0.0.24"
!         dst_port="50000"
!         protocol="icmp"
!         period_sec="5"
!         verbose="no"
!         count="5" />

This is a short description of the tags and attributes:

:config.interface:
  Optional. IP address and subnet of the component. If not set, the component
  requests and maintains the IP configuration via DHCP.

:config.gateway:
  Optional. IP address of the gateway of the IP subnet.

:config.dst_ip:
  Mandatory. IP address of the target host.

:config.period_sec:
  Optional. Length of send interval in seconds.

:config.verbose:
  Optional. Toggles wether the component shall log debugging information.

:config.count:
  Optional. After how many successful pings the component exits successfully.

:config.dst_port:
  Optional. Destination port resp. ICMP query ID to use.

:config.protocol:
  Optional. Protocol to ping with. Can be one of 'icmp', 'udp'.


Sessions
~~~~~~~~

This is an overview of the sessions required and provided by the
component apart from the environment sessions:

* Requires one Timer session.


Examples
~~~~~~~~

Examples of how to use the ping component can be found in the test scripts
'os/run/ping.run' and 'os/run/ping_nic_router.run'.