Routine Http

Library in development! The purpose of library is to relieve the developer of routine tasks, while developing simple RestFull api.

Dependencies

• Asio or Boost.Asio
• taocpp/json & taocpp/PEGTL
• OpenSSL
• spdlog & fmt

deps can change in the future

Building

by default using clang C++23, before build please check CMakeLists.txt.

Clang C++23 with default CMakeLists.txt building instruction:

mkdir build && cd build
cmake .. -DUSE_BOOST_ASIO=ON
cmake --build . --target routine
sudo cmake --install .

use flag USE_BOOST_ASIO to resolve boost:: namespaces for asio library

Example

// create class and override the RequestHandler methods
class EchoHandler : public routine::http::RequestHandler {
public:
  // DONT FORGET TO SPECIFY THE PATH OF RESOURCE HANDLER
  inline static const std::string path{"/api/{argument}/echo"};

	// Executed in IO-bound threads.
	// > Return nullptr - to add to the queue,
	// > or return a ready Response_ptr to skip the queue and return to the client.
	routine::http::Response_ptr prepare_request(routine::http::Request_ptr request) override {
    if (request->method() != routine::http::Method::Head)
	    // make body if this implies a query
      request->body() = std::make_unique<routine::http::MemoryBody>();
    return nullptr;
  }

  // Executed in threads bound to the processor.
  // > Return nullptr - to add to the queue again,
  // > or return a ready Response_ptr for sending to the client.
  routine::http::Response_ptr process_request(routine::http::Request_ptr request) override {
    auto response = std::make_unique<routine::http::Response>(
        routine::http::Status::OK, routine::http::Headers{}, std::move(request->body()));
    return response;
  }
};

int main() {
  {
    // Initialize loggers
    // see /examples/example1.cpp
  }

  // Routing handlers
  auto router = std::make_unique<routine::http::RouteHandler>();
  // add your handlers
  router->add_handler<DynamicEchoHandler>();

  // Init main components
  auto scheduler = std::make_shared<routine::Scheduler>();
  scheduler->set_router(std::move(router));
  auto acceptor = std::make_unique<routine::net::Acceptor<routine::net::HttpSession>>(scheduler, 80);

  // Start
  acceptor->async_accept();
	// run 1 IO thread and 2 CPU threads workers
  scheduler->run(1, 2);
  // lock main thread
  scheduler->join_threads();
  return 0;
}

Docs

All documents you can see in readme.md or 'docs/' folder.

In development

• Body types
  • FileBody
• TLS support for HTTPs
• GZIP, DEFLATE and BR support
• Chunked-Body
• Service controller
  • monitoring, stats and logs
  • *admin web ui
• Middleware components for Requests/Responses
• Handlers runtime benchmarks
• anything, but not unit tests ☺

The code may contain comments in russian lang. Using the interface you not notice it, but I apologize☺

If something doesn't work, it's probably my fail. If it's not too much trouble, please let me know

License

Library is distributed under the MIT license. Any use or modification is not deny.