zephyr/samples/net/ws_echo_server
Reto Schneider 7eabab2f5d samples, tests: Use semi-accurate project names
When using an IDE (e.g. Eclipse, Qt Creator), the project name gets
displayed. This greatly simplifies the navigation between projects when
having many of them open at the same time. Naming every project "NONE"
defeats this functionality.

This patch tries to use sensible project names while not duplicating
too much of what is already represented in the path. This is done by
using the name of the directory the relevant CMakeLists.txt file is
stored in. To ensure unique project names in the samples (and again, in
the tests folder) folder, small manual adjustments have been done.

Signed-off-by: Reto Schneider <code@reto-schneider.ch>
2018-10-27 21:31:25 -04:00
..
src samples: net: ws_echo_server: Convert to new logging system 2018-10-04 14:13:57 +03:00
CMakeLists.txt samples, tests: Use semi-accurate project names 2018-10-27 21:31:25 -04:00
README.rst
prj.conf samples: net: ws_echo_server: Convert to new logging system 2018-10-04 14:13:57 +03:00
prj_tls.conf net: Remove obsolete config options from samples and tests 2018-10-11 14:44:14 -04:00
sample.yaml net: websocket: Use system provided base64 function 2018-03-23 08:30:26 -04:00

README.rst

.. _websocket-server-sample:

Websocket Server
################

Overview
********

The websocket-server sample application for Zephyr implements a websocket
server. The websocket-server listens for incoming IPv4 or IPv6 HTTP(S)
requests and sends back the same data.

The source code for this sample application can be found at:
:file:`samples/net/ws_server`.

Requirements
************

- :ref:`networking_with_qemu`

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

There are multiple ways to use this application. One of the most common
usage scenario is to run websocket-server application inside QEMU. This is
described in :ref:`networking_with_qemu`.

Build websocket-server sample application like this:

.. zephyr-app-commands::
   :zephyr-app: samples/net/ws_echo_server
   :board: qemu_x86
   :goals: run
   :compact:

The default make BOARD configuration for this sample is ``qemu_x86``.

Connect to the websocket server from your browser using these URLs
http://[2001:db8::1] or http://192.0.2.1 as configured in the project's
``prj.conf`` file.