README.rst
1.. _so_txtime-sample:
2
3SO_TXTIME sample
4################
5
6Overview
7********
8
9This sample is a simple UDP sender/receiver which will set the
10SO_TXTIME socket option and expects the Ethernet driver to send
11the data when the TX time is expected. The application requires
12that the board has PTP clock support. A simulated PTP clock is
13provided for qemu_x86 board. Also frdm_k64f and sam_e70_xplained boards
14are supported. Other mcux or gmac Ethernet driver based boards should
15work too.
16User can control how long the application should wait between packets sent by
17setting CONFIG_NET_SAMPLE_PACKET_INTERVAL option.
18Also the TXTIME value can be specified in the config file by setting the
19CONFIG_NET_SAMPLE_PACKET_TXTIME option. In this case the value is
20used as an offset from the current time.
21
22Building and Running
23********************
24
25When the application is run, it starts to send UDP packets. You can start
26``echo-server`` application from `net-tools`_ project to catch these and
27send the data back to this application. Optionally you can set
28CONFIG_NET_SAMPLE_PACKET_SOCKET option, which makes the application
29to create an AF_PACKET type socket. In this case, the ``echo-server``
30application cannot be used as a peer.
31
32This sample can be built and executed on qemu_x86 board as
33described in :ref:`networking_with_host`.
34
35.. _`net-tools`: https://github.com/zephyrproject-rtos/net-tools
36
