ExternalVendorCode/genode
1
0
Fork 0
mirror of https://github.com/genodelabs/genode.git synced 2024-12-24 15:56:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

sntp_client: improve README, clean source code

Browse Source 
Fixes #3448
This commit is contained in:
Martin Stein 2019-08-26 11:07:20 +02:00 committed by Christian Helmuth
parent 1dd68ce04b
commit cc2828cf3a
3 changed files with 47 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
repos/libports/src/app/sntp_client/README
View File

@ -1,49 +1,46 @@
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.
The 'sntp_client' component periodically requests the current time from a
given SNTP server and reports it as GMT in a format that can also be used
to re-program Genodes RTC driver.
Configuration
~~~~~~~~~~~~~
This is an example configuration of the component which shows the default
value for each attribute except 'config.dst_ip' and 'config.interface':
This is an example configuration of the component with a static IP config,
an individual request interval, and debugging output enabled:
! <config interface="10.0.0.72/24"
! gateway="10.0.0.1"
! dst_ip="10.0.0.24"
! dst_port="50000"
! protocol="icmp"
! period_sec="5"
! verbose="no"
! count="5" />
! period_min="10"
! verbose="yes" />
This is an example configuration of the component with DHCP:
! <config dst_ip="10.0.0.24" />
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.
Optional. Determined via DHCP if not configured. 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.
Optional. Determined via DHCP if not configured. IP address of the gateway
of the IP subnet.
:config.dst_ip:
Mandatory. IP address of the target host.
Mandatory. IP address of the SNTP server.
:config.period_sec:
Optional. Length of send interval in seconds.
:config.period_min:
Optional. Default is 60. Length of request interval in minutes.
: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'.
Optional. Default is "false". Toggles wether the component shall log
debugging information.
Sessions
@ -52,11 +49,29 @@ Sessions
This is an overview of the sessions required and provided by the
component apart from the environment sessions:
* Requires one Timer session.
* One Timer session.
* One Report session with label 'set_rtc'.
Report 'set_rtc' provided by the component
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This is an example content of the report:
! <set_rtc year="2018"
! month="11"
! day="27"
! hour="22"
! minute="45"
! second="32" />
The format of the report is exactly what is expected by the Genode RTC driver.
The time is given as GMT in 24H mode, leap seconds considered, but without
taking the round trip time between SNTP server and client in account.
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'.
An example of how to use the component can be found in the test script
'libports/run/sntp_client.run' and 'os/run/ping_nic_router.run'.

7
repos/libports/src/app/sntp_client/config.xsd
View File

@ -5,13 +5,6 @@
<xs:include schemaLocation="net_types.xsd"/>
<xs:include schemaLocation="timeout_types.xsd"/>
<xs:simpleType name="Protocol">
<xs:restriction base="xs:string">
<xs:enumeration value="icmp" />
<xs:enumeration value="udp" />
</xs:restriction>
</xs:simpleType><!-- Protocol -->
<xs:element name="config">
<xs:complexType>
<xs:attribute name="verbose" type="Boolean" />

5
repos/libports/src/app/sntp_client/main.cc
View File

@ -1,7 +1,7 @@
/*
* \brief Test the reachability of a host on an IP network
* \brief Periodically Request time from SNTP server and report it
* \author Martin Stein
* \date 2018-03-27
* \date 2019-06-27
*/
/*
@ -76,7 +76,6 @@ class Main : public Nic_handler,
Reconstructible<Ipv4_config> _ip_config { _config.attribute_value("interface", Ipv4_address_prefix()),
_config.attribute_value("gateway", Ipv4_address()),
Ipv4_address() };
// Rtc::Connection _rtc { _env };
Reporter reporter { _env, "set_rtc" };
Sntp_timestamp _rtc_ts_to_sntp_ts(Rtc::Timestamp const rtc_ts)