Starter Project - Async API

Github Repository

Starter project for Oat++ (AKA oatpp) application. Based on oatpp Async API.

TIP

Async API suits best for services dedicated to a single type of tasks that run at high concurrency levels.
Example:

• Simultanious download of multiple files.
• Streaming to large number of clients (1K or more).
• Chats.

For all other purposes use simple API.

Before you start

Read:

• Simple API vs Async API
• Async
• Oatpp-Coroutines
• ENDPOINT_ASYNC

Overview

Project layout

|- CMakeLists.txt                        // projects CMakeLists.txt
|- src/
|    |
|    |- controller/                      // Folder containing UserController where all endpoints are declared
|    |- dto/                             // DTOs are declared here
|    |- AppComponent.hpp                 // Service config
|    |- App.cpp                          // main() is here
|    
|- test/                                 // test folder
|- utility/install-oatpp-modules.sh      // utility script to install required oatpp-modules.

---

Build and Run

Using CMake

Requires

• oatpp module installed. You may run utility/install-oatpp-modules.sh script to install required oatpp modules.

$ mkdir build && cd build
$ cmake ..
$ make 
$ ./my-project-exe                  # - run application.

In Docker

$ docker build -t oatpp-starter-async .
$ docker run -p 8000:8000 -t oatpp-starter-async