RESTinio

Public Member Functions | Private Attributes | List of all members
restinio::on_pool_runner_t< Http_Server > Class Template Reference

Helper class for running an existing HTTP-server on a thread pool without blocking the current thread. More...

`#include <http_server_run.hpp>`

## Public Member Functions
| on_pool_runner_t (const on_pool_runner_t &)=delete
| on_pool_runner_t (on_pool_runner_t &&)=delete
| on_pool_runner_t (std::size_t pool_size, Http_Server &server)
| Initializing constructor. More...
template<typename On_Ok_Callback , typename On_Error_Callback >
void | start (On_Ok_Callback &&on_ok, On_Error_Callback &&on_error)
| Start the server with callbacks that will be called on success or failure. More...
void | start ()
| Start the server. More...
bool | started () const noexcept
| Is server started. More...
void | stop () noexcept
| Stop the server. More...
void | wait () noexcept
| Wait for full stop of the server. More...

## Private Attributes
Http_Server & | m_server
| HTTP-server to be run. More...
impl::ioctx_on_thread_pool_t< impl::external_io_context_for_thread_pool_t > | m_pool
| Thread pool for running the server. More...

## Detailed Description

template<typename Http_Server>
class restinio::on_pool_runner_t< Http_Server >

Helper class for running an existing HTTP-server on a thread pool without blocking the current thread.

Usage of run() functions has some drawbacks. For example, the current thread on that run() is called, will be blocked until run() returns.

Sometimes it is not appropriate and leads to tricks like that:

// HTTP-server to be run on a thread pool.
restinio::http_server_t< my_traits > server{...};
// Separate worker thread for calling restinio::run().
std::thread run_thread{ [&server] {
restinio::run( restinio::on_thread_pool(
16,
restinio::skip_break_signal_handling(),
server) );
// Now this thread is blocked until HTTP-server will be finished.
} };
... // Some application specific code here.
// Now the server can be stopped.
restinio::initiate_shutdown( server );
run_thread.join();
restinio::http_server_t
Class for http-server.
Definition: http_server.hpp:169
restinio::skip_break_signal_handling
constexpr break_signal_handling_t skip_break_signal_handling() noexcept
Make the indicator for absence of break signal handler.
Definition: http_server_run.hpp:69
restinio::on_thread_pool
run_on_thread_pool_settings_t< Traits > on_thread_pool(std::size_t pool_size)
A special marker for the case when http_server must be run on an thread pool.
Definition: http_server_run.hpp:183
restinio::run
void run(asio_ns::io_context &ioctx, run_on_this_thread_settings_t< Traits > &&settings)
Helper function for running http server until ctrl+c is hit.
Definition: http_server_run.hpp:216
restinio::initiate_shutdown
void initiate_shutdown(http_server_t< Traits > &server)
Helper function for initiation of server shutdown.
Definition: http_server_run.hpp:681

Writing such code is a boring and error-prone task. The class on_pool_runner_t can be used instead:

// HTTP-server to be run on a thread pool.
restinio::http_server_t< my_traits > server{...};
// Launch HTTP-server on a thread pool.
restinio::on_pool_runner_t< restinio::http_server_t<my_traits> > runner{
16,
server
};
runner.start();
... // Some application specific code here.
// Now the server can be stopped.
runner.stop(); // (1)
runner.wait();
restinio::on_pool_runner_t
Helper class for running an existing HTTP-server on a thread pool without blocking the current thread...
Definition: http_server_run.hpp:747
restinio::on_pool_runner_t::start
void start(On_Ok_Callback &&on_ok, On_Error_Callback &&on_error)
Start the server with callbacks that will be called on success or failure.
Definition: http_server_run.hpp:821

Moreover the code at point (1) in the example above it not necessary because on_pool_runner_t automatically stops the server in the destructor.

Since
  v.0.5.1

Definition at line 746 of file http_server_run.hpp.

## Constructor & Destructor Documentation

## ◆ on_pool_runner_t() [1/3]

template<typename Http_Server >

restinio::on_pool_runner_t< Http_Server >::on_pool_runner_t | ( | const on_pool_runner_t< Http_Server > & |  | ) |
| delete

## ◆ on_pool_runner_t() [2/3]

template<typename Http_Server >

restinio::on_pool_runner_t< Http_Server >::on_pool_runner_t | ( | on_pool_runner_t< Http_Server > && |  | ) |
| delete

## ◆ on_pool_runner_t() [3/3]

template<typename Http_Server >

restinio::on_pool_runner_t< Http_Server >::on_pool_runner_t | ( | std::size_t | pool_size,
|  | Http_Server & | server
| ) |  |
| inline

Initializing constructor.

Parameters

  pool_size | Size of thread pool.
  server | Server instance to be run. NOTE. This reference must be valid for all life-time of on_pool_runner instance.

Definition at line 760 of file http_server_run.hpp.

## Member Function Documentation

## ◆ start() [1/2]

template<typename Http_Server >

void restinio::on_pool_runner_t< Http_Server >::start | ( |  | ) |
| inline

Start the server.

It just a shorthand for a version of `start` method with callbacks where all callbacks to nothing.

Definition at line 855 of file http_server_run.hpp.

## ◆ start() [2/2]

template<typename Http_Server >
template<typename On_Ok_Callback , typename On_Error_Callback >

void restinio::on_pool_runner_t< Http_Server >::start | ( | On_Ok_Callback && | on_ok,
|  | On_Error_Callback && | on_error
| ) |  |
| inline

Start the server with callbacks that will be called on success or failure.

The on_ok should be a function/functor with the format:

void () noexcept;

The on_error should be a function/functor with the format:

void (std::exception_ptr) noexcept;

Note
  Both callbacks will be passed to http_server_t::open_async method. It means that on_error callback will be called for errors detected by open_async() methods.

Attention
  Both callbacks should be noexcept functions/functors.

Usage example:

using my_http_server = restinio::http_server_t<some_traits>;
my_http_server server{...};
restinio::on_pool_runner_t<my_http_server> runner{16, server};
std::promise<void> run_promise;
auto run_future = run_promise.get_future();
runner.start(
// Ok callback.
[&run_promise]() noexcept {
run_promise.set_value();
},
// Error callback.
[&run_promise](std::exception_ptr ex) noexcept {
run_promise.set_exception(std::move(ex));
});
// Wait while HTTP-server started (or start failed).
run_future.get();
nonstd::optional_lite::std11::move
T & move(T &t)
Definition: optional.hpp:465

Since
  v.0.6.7

Parameters

  on_ok | A callback to be called if HTTP-server started successfully.
  on_error | A callback to be called if HTTP-server is not started by some reasons. Please note that this callback is passed to http_server_t::open_async() and will be called only for errors detected by open_async() methods. If some error is detected outside of open_async() (for example a failure to start a thread pool) then on_error callback won't be called.

Definition at line 821 of file http_server_run.hpp.

## ◆ started()

template<typename Http_Server >

bool restinio::on_pool_runner_t< Http_Server >::started | ( |  | ) | const
| inline noexcept

Is server started.

Definition at line 864 of file http_server_run.hpp.

## ◆ stop()

template<typename Http_Server >

void restinio::on_pool_runner_t< Http_Server >::stop | ( |  | ) |
| inline noexcept

Stop the server.

Note
  This method is noexcept since v.0.6.7

Definition at line 874 of file http_server_run.hpp.

## ◆ wait()

template<typename Http_Server >

void restinio::on_pool_runner_t< Http_Server >::wait | ( |  | ) |
| inline noexcept

Wait for full stop of the server.

Note
  This method is noexcept since v.0.6.7

Definition at line 903 of file http_server_run.hpp.

## Member Data Documentation

## ◆ m_pool

template<typename Http_Server >

impl::ioctx_on_thread_pool_t< impl::external_io_context_for_thread_pool_t > restinio::on_pool_runner_t< Http_Server >::m_pool
| private

Thread pool for running the server.

Definition at line 753 of file http_server_run.hpp.

## ◆ m_server

template<typename Http_Server >

Http_Server& restinio::on_pool_runner_t< Http_Server >::m_server
| private

HTTP-server to be run.

Definition at line 749 of file http_server_run.hpp.

The documentation for this class was generated from the following file:

- restinio/http_server_run.hpp