suil

A lightweight mordern C++ micro service development framework. see Suil Examples repo for example usage.

Supported Features

• Tag based system logger with support for custom log m_sink

• Memory pool supporting buffer sizes of up to 8912

• Integrates libmill's coroutines which is used as the base library for asynchronous calls

• Dynamic buffer supporting printf(...) like functions and stream operator overloads

• Zero Copy strings which can be help speed up operations on strings

• Integrates IOD framework which is a great tool when it comes to meta programming

• Sockets (minimal SSL support) API using coroutines

• HTTP/1.1 server

  • Support for static and dynamic route handling
  • Static compilation of static routes
  • Support for Middlewares registered at compilation time via generics
    • SQL/Database middleware included as a template
  • File server support
    • Supported mime types can be extended and customized
    • Smaller files are cached in memory, larger files are memory mapped
    • Support for sendfile system call if enabled.
    • HTTP cache headers supported
    • Range requests parsing supported
  • Route attributes
  • Response content type decoded from type of response if returned
  • Request form parser, multi-part & url-encoded forms supported
  • Disk offload for large body (Partially supported or not tested)

• HTTP/1.1 Client

  • Session based HTTP client
  • Easy to use API
  • Customizable response readers
  • SSL support

• Web Socket server support (Version 13) through HTTP upgrade.

• Database support

  • Generic SQL ORM
  • SQLite3 driver
  • PGSQL client
    • Asynchronous or non-blocking in a coroutine way
    • Prepared statements
    • Cached connections

• JWT creation and decoding

  • Simple authentication middleware issuing web tokens (Not tested)

• JSON RPC 2.0 Server and Client

  • Support for a JSON RPC server and client enabled
  • Easy to use JSON RPC API, the API is declared in suil's own custom sccformart and both the service and client are generated from thescc`

• Support for custom code format (scc)

  • scc is used to declare data and service types with syntax resembling that of C++
  • scc source's are transpiled to c++ source's which can then be used in project's
  • scc can be used to generate reflectable type's (for IOD), suil/JSON RPC server/client's see scc source, implementing service and using service/client
  • cmake macro to generate C++ source's from scc sources see rpc example

Let's create a new suil app

Create a suil application within an alpine suil-dev container which contain all the tools to needed to build a suil application. The following steps will launch the environment, create and build a new project. The generate project is also a cmake project and adding sources will require modifying the generated CMakeLists.txt file. A default src/main.cc file is generated and can be modified to accordingly.

 docker run -it --rm suilteam/suil-dev bash`
 mkdir hello && cd hello
 suilapp init
 mkdir .build && cd .build
 cmake ..
 make hello
 ./hello

Note that binaries (applications/shared libraries) built using suilteam/suil-dev container image can be copied to a trimmed down suil production enviroment using container suilteam/suil-prod which is ~8MB.

Build Requirements or Development Dependencies on Ubuntu

When building or developing an application that uses this project on ubuntu, the following libraries should be installed.

• SQLite sudo apt-get install sqlite3 libsqlite3-dev
• PostgresSQL sudo apt-get install libpq-dev postgresql postgresql-server-dev-all
• UUID sudo apt-get install uuid-dev
• OpenSSL sudo apt-get install openssl libssl-dev