Merge branch 'master' of github.com:oatpp/example-websocket

Author: lganzzzo

async-server/README.md

@@ -1,6 +1,6 @@
 # websocket async-server
 
-Simple example of the asynchronous websocket echo server.
+Simple example of the **asynchronous** websocket echo server. Built with oat++ (AKA oatpp) web framework.
 
 See more:
 

client-mbedtls/README.md

@@ -0,0 +1,53 @@
+# secure websocket client with mbedtls
+
+Simple example of the secure websocket client. Built with oat++ (AKA oatpp) web framework.  
+TLS backend - MbedTLS.
+
+See more:
+
+- [Oat++ Website](https://oatpp.io/)
+- [Oat++ Github Repository](https://github.com/oatpp/oatpp)
+- [Get Started With Oat++](https://oatpp.io/docs/start)
+
+## Overview
+
+### Project layout
+
+```
+|- CMakeLists.txt                         // projects CMakeLists.txt
+|- src/
+|    |
+|    |- WSListener.hpp                    // WebSocket listeners are defined here
+|    |- App.cpp                           // main() is here
+|
+|- utility/install-oatpp-modules.sh       // utility script to install required oatpp-modules.  
+```
+
+## Build and Run
+
+### Using CMake
+
+**Requires** 
+- MbedTLS installed - see [install mbedtls](#install-mbedtls). 
+- [oatpp](https://github.com/oatpp/oatpp), [oatpp-websocket](https://github.com/oatpp/oatpp-websocket), 
+and [oatpp-mbedtls](https://github.com/oatpp/oatpp-mbedtls) modules installed. You may run `utility/install-oatpp-modules.sh` 
+script to install required oatpp modules.
+
+```
+$ mkdir build && cd build
+$ cmake ..
+$ make 
+$ ./websocket-client-mbedtls-exe       # - run application.
+```
+
+## Install MbedTLS
+
+```bash
+git clone -b 'mbedtls-2.16.1' --single-branch --depth 1 --recurse-submodules https://github.com/ARMmbed/mbedtls
+
+cd mbedtls
+mkdir build && cd build
+
+cmake ..
+make install
+```

client/README.md

@@ -0,0 +1,41 @@
+# websocket client
+
+Simple example of the websocket client. Built with oat++ (AKA oatpp) web framework.
+
+See more:
+
+- [Oat++ Website](https://oatpp.io/)
+- [Oat++ Github Repository](https://github.com/oatpp/oatpp)
+- [Get Started With Oat++](https://oatpp.io/docs/start)
+
+## Overview
+
+### Project layout
+
+```
+|- CMakeLists.txt                         // projects CMakeLists.txt
+|- src/
+|    |
+|    |- WSListener.hpp                    // WebSocket listeners are defined here
+|    |- App.cpp                           // main() is here
+|
+|- utility/install-oatpp-modules.sh       // utility script to install required oatpp-modules.  
+```
+
+## Build and Run
+
+### Using CMake
+
+**Requires:** [oatpp](https://github.com/oatpp/oatpp), and [oatpp-websocket](https://github.com/oatpp/oatpp-websocket) 
+modules installed. You may run `utility/install-oatpp-modules.sh` 
+script to install required oatpp modules.
+
+After all dependencies satisfied:
+
+```
+$ mkdir build && cd build
+$ cmake ..
+$ make 
+$ ./websocket-client-exe       # - run application.
+```
+

server/README.md

@@ -0,0 +1,48 @@
+# websocket server
+
+Simple example of the **multithreaded** websocket echo server. Built with oat++ (AKA oatpp) web framework.
+
+See more:
+
+- [Oat++ Website](https://oatpp.io/)
+- [Oat++ Github Repository](https://github.com/oatpp/oatpp)
+- [Get Started With Oat++](https://oatpp.io/docs/start)
+
+## Overview
+
+### Project layout
+
+```
+|- CMakeLists.txt                         // projects CMakeLists.txt
+|- src/
+|    |
+|    |- controller/
+|    |    |
+|    |    |- MyController.hpp             // ApiController with websocket endpoint
+|    |
+|    |- websocket/
+|    |    |
+|    |    |- WSListener.hpp               // WebSocket listeners are defined here
+|    |
+|    |- AppComponent.hpp                  // Application config. 
+|    |- App.cpp                           // main() is here
+|
+|- utility/install-oatpp-modules.sh       // utility script to install required oatpp-modules.  
+```
+
+## Build and Run
+
+### Using CMake
+
+**Requires:** [oatpp](https://github.com/oatpp/oatpp), and [oatpp-websocket](https://github.com/oatpp/oatpp-websocket) 
+modules installed. You may run `utility/install-oatpp-modules.sh` 
+script to install required oatpp modules.
+
+After all dependencies satisfied:
+
+```
+$ mkdir build && cd build
+$ cmake ..
+$ make 
+$ ./websocket-server-exe       # - run application.
+```