Skip to content

Latest commit

 

History

History
186 lines (123 loc) · 5.07 KB

README.rst

File metadata and controls

186 lines (123 loc) · 5.07 KB
Raw

Hello Sample Application

Overview

This sample application includes a client a server implementing the RPC interface described in thrift/hello.thrift. The purpose of this example is to demonstrate how components at different layer in thrift can be combined to build an application with desired features.

Requirements

Building and Running

This application can be run on a Linux host, with either the server or the client in the QEMU environment, and the peer is built and run natively on the host.

Building native client and server

$ make -j -C hello_client
$ make -j -C hello_server

Under hello_client, 4 executables will be generated, and components used in each layer of them are listed below:

hello_client TSocket TBufferedTransport TBinaryProtocol
hello_client_compact TSocket TBufferedTransport TCompactProtocol
hello_client_zlib TSocket TZlibTransport TBinaryProtocol
hello_client_ssl TSSLSocket TBufferedTransport TBinaryProtocol

The same applies for the server. Only the client and the server with the same set of stacks can communicate.

Build net-tools

Fetch and build the Zephyr net-tools project, which is located in a separate Git repository:

$ git clone https://github.com/zephyrproject-rtos/net-tools
$ cd net-tools
$ make

Qemu Setup

When running Zephyr inside of Qemu, a UNIX domain socket is used as a virtual serial port. Run this command in the background (with &). Later, the process can be stopped with fg and Ctrl+C.

$ net-tools/loop-socat.sh &

For networked examples (Linux-only for now), do the following:

$ sudo net-tools/loop-slip-tap.sh
# Enter password when prompted
# press Ctrl+Z to background the process

Support for networked examples under macOS is a `work-in-progress<https://github.com/zephyrproject-rtos/zephyr/issues/15738>`_. Thank you for your patience.

Running zephyr server in QEMU

Build the Zephyr version of the thrift application like this:

Build echo-server sample application like this:

.. zephyr-app-commands::
   :zephyr-app: ../modules/lib/thrift/samples/lib/thrift/hello_server
   :board: <board to use>
   :goals: build
   :compact:

To enable advanced features, extra arguments should be passed accordingly:

  • TCompactProtocol: -DTHRIFT_COMPACT_PROTOCOL=y
  • TZlibTransport: -DTHRIFT_ZLIB_TRANSPORT=y
  • TSSLSocket: -DCONF_FILE="prj.conf ../hello_common/overlay-tls.conf"

Example building for the mps2_an385 with TSSLSocket support:

.. zephyr-app-commands::
   :zephyr-app: ../modules/lib/thrift/samples/lib/thrift/hello_server
   :host-os: unix
   :board: mps2_an385
   :conf: "prj.conf ../hello_common/overlay-tls.conf"
   :goals: run
   :compact:

In another terminal, run the hello_client sample app compiled for the host OS:

$ ./hello_client/hello_client

You should observe the following in the original hello_server terminal:

ping
echo: Hello, world!
counter: 1
counter: 2
counter: 3
counter: 4
counter: 5

Running zephyr client in QEMU

In another terminal, run the hello_server sample app compiled for the host OS:

$ ./hello_server/hello_server 0.0.0.0

Then, in annother terminal, run the hello_client sample application with:

west build -p auto -b qemu_x86_64 -t run ../modules/lib/thrift/samples/lib/thrift/hello_client \
    -DCONFIG_NET_CONFIG_NEED_IPV6=n \
    -DCONFIG_NET_CONFIG_MY_IPV4_ADDR=\"192.0.2.1\" \
    -DCONFIG_NET_CONFIG_PEER_IPV4_ADDR=\"192.0.2.2\"

The additional arguments for advanced features are the same as hello_client.

You should observe the following in the original hello_client terminal:

Booting from ROM..
SeaBIOS (version rel-1.15.0-0-g2dd4b9b3f840-prebuilt.qemu.org)
*** Booting Zephyr OS build zephyr-v3.0.0-1366-gca26ff490759  ***


[00:00:00.010,000] <inf> net_config: Initializing network
[00:00:00.010,000] <inf> net_config: IPv4 address: 192.0.2.1
[00:00:00.110,000] <inf> net_config: IPv6 address: 2001:db8::1
[00:00:00.110,000] <inf> net_config: IPv6 address: 2001:db8::1
uart:~$
ping
echo: Hello, world!
counter: 1
counter: 2
counter: 3
counter: 4
counter: 5