zephyr/samples/cpp/cpp_synchronization
Benjamin Cabé 774fd8b328 samples: cpp: use zephyr:code-sample directive
Describe the samples using code-sample directive in preparation for
upcoming changes to the Zephyr documentation that will be leveraging
the provided description and metadata.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-08-27 15:13:43 -04:00
..
src
CMakeLists.txt
prj.conf lib/cpp: Remove CONFIG_CPP_MAIN 2023-05-31 06:16:35 -04:00
README.rst samples: cpp: use zephyr:code-sample directive 2024-08-27 15:13:43 -04:00
sample.yaml

.. zephyr:code-sample:: cpp_synchronization
   :name: C++ synchronization

   Use Zephyr synchronization primitives from C++ code.

Overview
********
The sample project illustrates usage of pure virtual class, member
functions with different types of arguments, global objects constructor
invocation.

A simple application demonstrates basic sanity of the kernel.  The main thread
and a cooperative thread take turns printing a greeting message to the console,
and use timers and semaphores to control the rate at which messages are
generated. This demonstrates that kernel scheduling, communication, and
timing are operating correctly.

Building and Running
********************

This kernel project outputs to the console.  It can be built and executed
on QEMU as follows:

.. zephyr-app-commands::
   :zephyr-app: samples/cpp/cpp_synchronization
   :host-os: unix
   :board: qemu_x86
   :goals: run
   :compact:

Sample Output
=============

.. code-block:: console

     Create semaphore 0x001042b0
     Create semaphore 0x001042c4
     main: Hello World!
     coop_thread_entry: Hello World!
     main: Hello World!
     coop_thread_entry: Hello World!
     main: Hello World!
     coop_thread_entry: Hello World!
     main: Hello World!
     coop_thread_entry: Hello World!
     main: Hello World!
     coop_thread_entry: Hello World!
     main: Hello World!
     coop_thread_entry: Hello World!
     main: Hello World!
     coop_thread_entry: Hello World!
     main: Hello World!
     coop_thread_entry: Hello World!
     main: Hello World!
     coop_thread_entry: Hello World!
     main: Hello World!

     <repeats endlessly>

Exit QEMU by pressing :kbd:`CTRL+A` :kbd:`x`.