restinio::http_server_t< Traits > Class Template Reference

Class for http-server. More...

#include <http_server.hpp>

Public Types
using	traits_t = Traits
	An alias for Traits type.

Public Member Functions
	http_server_t (const http_server_t &)=delete
	http_server_t (http_server_t &&)=delete
template<typename D>
	http_server_t (io_context_holder_t io_context, basic_server_settings_t< D, Traits > &&settings)
template<typename Configurator, typename = decltype( std::declval<Configurator>()( std::declval<server_settings_t<Traits>&>() ) )>
	http_server_t (io_context_holder_t io_context, Configurator &&configurator)
virtual	~http_server_t ()
	It is allowed to inherit from http_server_t.
asio_ns::io_context &	io_context () noexcept
	Get io_context on which server runs.
template<typename Server_Open_Ok_CB, typename Server_Open_Error_CB>
void	open_async (Server_Open_Ok_CB open_ok_cb, Server_Open_Error_CB open_err_cb)
	Starts server in async way.
void	open_sync ()
	Start server.
template<typename Server_Close_Ok_CB, typename Server_Close_Error_CB>
void	close_async (Server_Close_Ok_CB close_ok_cb, Server_Close_Error_CB close_err_cb)
	Closes server in async way.
void	close_sync ()
	Stop server.

Private Types
enum class	running_state_t { not_running , running }
	State of server. More...
using	connection_settings_t = impl::connection_settings_t< Traits >
using	connection_factory_t = impl::connection_factory_t< Traits >
using	acceptor_t = impl::acceptor_t< Traits >
using	timer_manager_t = typename Traits::timer_manager_t
using	timer_manager_handle_t = std::shared_ptr< timer_manager_t >

Private Member Functions
void	call_cleanup_functor () noexcept
	Call a cleanup functor if it is defined.

Static Private Member Functions
template<typename Callback>
static void	call_nothrow_cb (Callback &&cb) noexcept
	Call callback and terminate the application if callback throws.

Private Attributes
io_context_shared_ptr_t	m_io_context
	A wrapper for asio io_context where server is running.
cleanup_functor_t	m_cleanup_functor
	An optional user's cleanup functor.
std::shared_ptr< acceptor_t >	m_acceptor
	Acceptor for new connections.
timer_manager_handle_t	m_timer_manager
	Timer manager object.
running_state_t	m_running_state { running_state_t::not_running }
	Server state.

Detailed Description

template<typename Traits = default_traits_t>
class restinio::http_server_t< Traits >

Class for http-server.

With the help of this class one can run a server. Server can be started and stopped in sync or async way.

Please note that it is responsibility of user to provide a working context for http_server. It means that user must call asio::io_context::run() on some work thread (or on several working threads).

Sync way for starting and stopping a http_server can be used only if http_server_t::open_sync() and http_server_t::close_sync() methods are called somewhere inside asio::io_context::run(). For example:

// Create and initialize object.
restinio::http_server_t< my_traits_t > server{
        restinio::own_io_context(),
        [&]( auto & settings ){
            //
            settings
                .port( args.port() )
                // .set_more_params( ... )
                .request_handler(
                    []( restinio::request_handle_t req ){
                            // Handle request.
                    } );
        } };
 
// Post initial action to asio event loop.
asio::post( server.io_context(),
    [&] {
        // Starting the server in a sync way.
        server.open_sync();
    } );
 
// Running server.
server.io_context().run();

Async way for starting and stopping a http_server can be used if http_server_t::open_async() and http_server_t::close_async() can be called from any other thread. For example:

asio::io_context io_ctx;
restinio::http_server_t< my_traits_t > server{
        restinio::external_io_context(io_ctx),
        [&]( auto & settings ) { ... } };
 
// Launch thread on which server will work.
std::thread server_thread{ [&] {
        io_ctx.run();
    } };
 
// This variable will be used for holding information about
// a possible exception in open_async.
std::exception_ptr exception_from_open_async;
 
// Start server in async way. Actual start will be performed
// on the context of server_thread.
server.open_async(
        // Ok callback. Nothing to do.
        []() noexcept {},
        // Error callback. Just store information about an exception.
        [&]( std::exception_ptr ex_ptr ) noexcept {
            exception_from_open_async = ex_ptr;
        } );
...
// Wait while server_thread finishes its work.
server_thread.join();

Examples

sample/using_external_io_context/main.cpp, and sample/websocket_detailed/main.cpp.

Definition at line 172 of file http_server.hpp.

Member Typedef Documentation

acceptor_t

template<typename Traits = default_traits_t>

using restinio::http_server_t< Traits >::acceptor_t = impl::acceptor_t< Traits >

private

Definition at line 176 of file http_server.hpp.

connection_factory_t

template<typename Traits = default_traits_t>

using restinio::http_server_t< Traits >::connection_factory_t = impl::connection_factory_t< Traits >

private

Definition at line 175 of file http_server.hpp.

connection_settings_t

template<typename Traits = default_traits_t>

using restinio::http_server_t< Traits >::connection_settings_t = impl::connection_settings_t< Traits >

private

Definition at line 174 of file http_server.hpp.

timer_manager_handle_t

template<typename Traits = default_traits_t>

using restinio::http_server_t< Traits >::timer_manager_handle_t = std::shared_ptr< timer_manager_t >

private

Definition at line 178 of file http_server.hpp.

timer_manager_t

template<typename Traits = default_traits_t>

using restinio::http_server_t< Traits >::timer_manager_t = typename Traits::timer_manager_t

private

Definition at line 177 of file http_server.hpp.

traits_t

template<typename Traits = default_traits_t>

using restinio::http_server_t< Traits >::traits_t = Traits

An alias for Traits type.

Since

v.0.5.0

Definition at line 186 of file http_server.hpp.

Member Enumeration Documentation

running_state_t

template<typename Traits = default_traits_t>

enum class restinio::http_server_t::running_state_t

strongprivate

State of server.

Enumerator
not_running
running

Definition at line 402 of file http_server.hpp.

Constructor & Destructor Documentation

http_server_t() [1/4]

template<typename Traits = default_traits_t>

restinio::http_server_t< Traits >::http_server_t ( const http_server_t< Traits > & )

delete

http_server_t() [2/4]

template<typename Traits = default_traits_t>

restinio::http_server_t< Traits >::http_server_t ( http_server_t< Traits > && )

delete

http_server_t() [3/4]

template<typename Traits = default_traits_t>

template<typename D>

restinio::http_server_t< Traits >::http_server_t ( io_context_holder_t io_context, basic_server_settings_t< D, Traits > && settings )

inline

Definition at line 193 of file http_server.hpp.

http_server_t() [4/4]

template<typename Traits = default_traits_t>

template<typename Configurator, typename = decltype( std::declval<Configurator>()( std::declval<server_settings_t<Traits>&>() ) )>

restinio::http_server_t< Traits >::http_server_t ( io_context_holder_t io_context, Configurator && configurator )

inline

Definition at line 236 of file http_server.hpp.

~http_server_t()

template<typename Traits = default_traits_t>

virtual restinio::http_server_t< Traits >::~http_server_t ( )

inlinevirtual

It is allowed to inherit from http_server_t.

Definition at line 246 of file http_server.hpp.

Member Function Documentation

call_cleanup_functor()

template<typename Traits = default_traits_t>

void restinio::http_server_t< Traits >::call_cleanup_functor ( )

inlineprivatenoexcept

Call a cleanup functor if it is defined.

Note

Cleanup functor can be called only once. Next call to call_cleanup_functor() will do nothing.

Attention

Cleanup functor can't throw.

Definition at line 421 of file http_server.hpp.

call_nothrow_cb()

template<typename Traits = default_traits_t>

template<typename Callback>

void restinio::http_server_t< Traits >::call_nothrow_cb ( Callback && cb )

inlinestaticprivatenoexcept

Call callback and terminate the application if callback throws.

Definition at line 432 of file http_server.hpp.

close_async()

template<typename Traits = default_traits_t>

template<typename Server_Close_Ok_CB, typename Server_Close_Error_CB>

void restinio::http_server_t< Traits >::close_async ( Server_Close_Ok_CB close_ok_cb, Server_Close_Error_CB close_err_cb )

inline

Closes server in async way.

Usage example:

restinio::http_server_t< my_traits > server{ ... };
 
server.open_async(...);
 
// It's time to close the server.
server.close_async(
    // OK callback. Will be called if acceptor and other
    // stuff is closed without problems.
    // Please note that OK callback should not throw exceptions.
    [&]() noexcept {
        ... // Some actions to perform if everything is OK.
            // For example, shutting down worker threads.
    },
    // Error callback. Will be called if an exception is thrown
    // during closing acceptor or other stuff.
    // Please note that error callback should not throw exceptions.
    []( std::exception_ptr ex ) noexcept {
        ... // Some actions. Like storing `ex` somewhere.
    } );

Attention

If an error is thrown during closing the acceptor and other stuff, the close_err_cb is called, but the state of the http_server_t is undefined.

close_ok_cb and close_err_cb should be noexcept functions/lambdas. This requirement is not enforced by static_assert in RESTinio's code to avoid problems in cases when std::function is used for these callbacks.

Definition at line 348 of file http_server.hpp.

close_sync()

template<typename Traits = default_traits_t>

void restinio::http_server_t< Traits >::close_sync ( )

inline

Stop server.

If server was stopped successfully then function returns, otherwise it throws.

Definition at line 377 of file http_server.hpp.

io_context()

template<typename Traits = default_traits_t>

asio_ns::io_context & restinio::http_server_t< Traits >::io_context ( )

inlinenoexcept

Get io_context on which server runs.

Definition at line 253 of file http_server.hpp.

open_async()

template<typename Traits = default_traits_t>

template<typename Server_Open_Ok_CB, typename Server_Open_Error_CB>

void restinio::http_server_t< Traits >::open_async ( Server_Open_Ok_CB open_ok_cb, Server_Open_Error_CB open_err_cb )

inline

Starts server in async way.

Note

It is necessary to be sure that ioservice is running.

Attention

open_ok_cb and open_err_cb should be noexcept functions/lambdas. This requirement is not enforced by static_assert in RESTinio's code to avoid problems in cases when std::function is used for these callbacks.

Definition at line 269 of file http_server.hpp.

open_sync()

template<typename Traits = default_traits_t>

void restinio::http_server_t< Traits >::open_sync ( )

inline

Start server.

If server was started successfully then function returns, otherwise it throws.

Definition at line 298 of file http_server.hpp.

Member Data Documentation

m_acceptor

template<typename Traits = default_traits_t>

std::shared_ptr< acceptor_t > restinio::http_server_t< Traits >::m_acceptor

private

Acceptor for new connections.

Definition at line 396 of file http_server.hpp.

m_cleanup_functor

template<typename Traits = default_traits_t>

cleanup_functor_t restinio::http_server_t< Traits >::m_cleanup_functor

private

An optional user's cleanup functor.

Definition at line 393 of file http_server.hpp.

m_io_context

template<typename Traits = default_traits_t>

io_context_shared_ptr_t restinio::http_server_t< Traits >::m_io_context

private

A wrapper for asio io_context where server is running.

Definition at line 390 of file http_server.hpp.

m_running_state

template<typename Traits = default_traits_t>

running_state_t restinio::http_server_t< Traits >::m_running_state { running_state_t::not_running }

private

Server state.

Definition at line 409 of file http_server.hpp.

m_timer_manager

template<typename Traits = default_traits_t>

timer_manager_handle_t restinio::http_server_t< Traits >::m_timer_manager

private

Timer manager object.

Definition at line 399 of file http_server.hpp.

---

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

• restinio/http_server.hpp