RESTinio
Private Types | List of all members
restinio::server_settings_t< Traits > Class Template Referencefinal

A fluent style interface for setting http server params. More...

#include <settings.hpp>

Inheritance diagram for restinio::server_settings_t< Traits >:
restinio::basic_server_settings_t< server_settings_t< default_traits_t >, default_traits_t > restinio::socket_type_dependent_settings_t< server_settings_t< default_traits_t >, Traits::stream_socket_t > restinio::connection_state_listener_holder_t< Traits::connection_state_listener_t > restinio::ip_blocker_holder_t< Traits::ip_blocker_t > restinio::details::max_parallel_connections_holder_t< connection_count_limit_types< default_traits_t >::limiter_t >

Private Types

using base_type_t = basic_server_settings_t< server_settings_t< Traits >, Traits >
 

Additional Inherited Members

- Public Types inherited from restinio::basic_server_settings_t< server_settings_t< default_traits_t >, default_traits_t >
using request_handler_t = request_handler_type_from_traits_t< default_traits_t >
 Request handler. More...
 
using timer_manager_t = typename Traits::timer_manager_t
 Timers manager. More...
 
using timer_factory_t = typename timer_manager_t::factory_t
 
using logger_t = typename Traits::logger_t
 Logger. More...
 
using extra_data_factory_t = typename Traits::extra_data_factory_t
 The actual type of extra-data-factory. More...
 
using extra_data_factory_handle_t = std::shared_ptr< extra_data_factory_t >
 Type of shared-pointer to extra-data-factory. More...
 
- Public Member Functions inherited from restinio::basic_server_settings_t< server_settings_t< default_traits_t >, default_traits_t >
 basic_server_settings_t (std::uint16_t port=8080, asio_ns::ip::tcp protocol=asio_ns::ip::tcp::v4())
 
server_settings_t< default_traits_t > & buffer_size (std::size_t s) &
 Size of buffer for io operations. More...
 
server_settings_t< default_traits_t > && buffer_size (std::size_t s) &&
 
std::size_t buffer_size () const
 
server_settings_t< default_traits_t > & connection_state_listener (std::shared_ptr< typename Traits::connection_state_listener_t > listener) &
 Setter for connection state listener. More...
 
server_settings_t< default_traits_t > && connection_state_listener (std::shared_ptr< typename Traits::connection_state_listener_t > listener) &&
 Setter for connection state listener. More...
 
const std::shared_ptr< typename Traits::connection_state_listener_t > & connection_state_listener () const noexcept
 Get reference to connection state listener. More...
 
void ensure_valid_connection_state_listener ()
 Internal method for checking presence of state listener object. More...
 
server_settings_t< default_traits_t > & ip_blocker (std::shared_ptr< typename Traits::ip_blocker_t > blocker) &
 Setter for IP-blocker. More...
 
server_settings_t< default_traits_t > && ip_blocker (std::shared_ptr< typename Traits::ip_blocker_t > blocker) &&
 Setter for IP-blocker. More...
 
const std::shared_ptr< typename Traits::ip_blocker_t > & ip_blocker () const noexcept
 Get reference to IP-blocker. More...
 
void ensure_valid_ip_blocker ()
 Internal method for checking presence of IP-blocker object. More...
 
server_settings_t< default_traits_t > & acceptor_post_bind_hook (acceptor_post_bind_hook_t hook) &
 A setter for post-bind callback. More...
 
server_settings_t< default_traits_t > && acceptor_post_bind_hook (acceptor_post_bind_hook_t hook) &&
 A setter for post-bind callback. More...
 
RESTINIO_NODISCARD acceptor_post_bind_hook_t giveaway_acceptor_post_bind_hook ()
 A getter for post-bind callback. More...
 
RESTINIO_NODISCARD const incoming_http_msg_limits_tincoming_http_msg_limits () const noexcept
 Getter of optional limits for incoming HTTP messages. More...
 
server_settings_t< default_traits_t > & incoming_http_msg_limits (const incoming_http_msg_limits_t &limits) &noexcept
 Setter of optional limits for incoming HTTP messages. More...
 
server_settings_t< default_traits_t > && incoming_http_msg_limits (const incoming_http_msg_limits_t &limits) &&noexcept
 Setter of optional limits for incoming HTTP messages. More...
 
server_settings_t< default_traits_t > & max_parallel_connections (std::size_t value) &noexcept
 Setter for connection count limit. More...
 
server_settings_t< default_traits_t > && max_parallel_connections (std::size_t value) &&noexcept
 Setter for connection count limit. More...
 
std::size_t max_parallel_connections () const noexcept
 
server_settings_t< default_traits_t > & port (std::uint16_t p) &
 Server endpoint. More...
 
server_settings_t< default_traits_t > && port (std::uint16_t p) &&
 
RESTINIO_NODISCARD std::uint16_t port () const
 
server_settings_t< default_traits_t > & protocol (asio_ns::ip::tcp p) &
 
server_settings_t< default_traits_t > && protocol (asio_ns::ip::tcp p) &&
 
RESTINIO_NODISCARD asio_ns::ip::tcp protocol () const
 
server_settings_t< default_traits_t > & address (std::string addr) &
 
server_settings_t< default_traits_t > && address (std::string addr) &&
 
server_settings_t< default_traits_t > & address (asio_ns::ip::address addr) &
 
server_settings_t< default_traits_t > && address (asio_ns::ip::address addr) &&
 
RESTINIO_NODISCARD const details::address_variant_taddress () const
 
server_settings_t< default_traits_t > & read_next_http_message_timelimit (std::chrono::steady_clock::duration d) &
 } More...
 
server_settings_t< default_traits_t > && read_next_http_message_timelimit (std::chrono::steady_clock::duration d) &&
 
std::chrono::steady_clock::duration read_next_http_message_timelimit () const
 
server_settings_t< default_traits_t > & write_http_response_timelimit (std::chrono::steady_clock::duration d) &
 A period of time wait for response to be written to socket. More...
 
server_settings_t< default_traits_t > && write_http_response_timelimit (std::chrono::steady_clock::duration d) &&
 
std::chrono::steady_clock::duration write_http_response_timelimit () const
 
server_settings_t< default_traits_t > & handle_request_timeout (std::chrono::steady_clock::duration d) &
 A period of time that is given for a handler to create response. More...
 
server_settings_t< default_traits_t > && handle_request_timeout (std::chrono::steady_clock::duration d) &&
 
std::chrono::steady_clock::duration handle_request_timeout () const
 
server_settings_t< default_traits_t > & max_pipelined_requests (std::size_t mpr) &
 Max pipelined requests able to receive on single connection. More...
 
server_settings_t< default_traits_t > && max_pipelined_requests (std::size_t mpr) &&
 
std::size_t max_pipelined_requests () const
 
server_settings_t< default_traits_t > & acceptor_options_setter (acceptor_options_setter_t aos) &
 Acceptor options setter. More...
 
server_settings_t< default_traits_t > && acceptor_options_setter (acceptor_options_setter_t aos) &&
 
std::unique_ptr< acceptor_options_setter_tacceptor_options_setter ()
 
server_settings_t< default_traits_t > & socket_options_setter (socket_options_setter_t sos) &
 Socket options setter. More...
 
server_settings_t< default_traits_t > && socket_options_setter (socket_options_setter_t sos) &&
 
std::unique_ptr< socket_options_setter_tsocket_options_setter ()
 
server_settings_t< default_traits_t > & concurrent_accepts_count (std::size_t n) &
 Max number of running concurrent accepts. More...
 
server_settings_t< default_traits_t > && concurrent_accepts_count (std::size_t n) &&
 
std::size_t concurrent_accepts_count () const
 
server_settings_t< default_traits_t > & separate_accept_and_create_connect (bool do_separate) &noexcept
 Do separate an accept operation and connection instantiation. More...
 
server_settings_t< default_traits_t > && separate_accept_and_create_connect (bool do_separate) &&noexcept
 
bool separate_accept_and_create_connect () const noexcept
 
server_settings_t< default_traits_t > & cleanup_func (Func &&func) &
 Cleanup function. More...
 
server_settings_t< default_traits_t > && cleanup_func (Func &&func) &&
 
RESTINIO_NODISCARD cleanup_functor_t giveaway_cleanup_func ()
 
server_settings_t< default_traits_t > & request_handler (std::unique_ptr< request_handler_t > handler) &
 
server_settings_t< default_traits_t > & request_handler (Params &&... params) &
 
server_settings_t< default_traits_t > && request_handler (Params &&... params) &&
 
std::unique_ptr< request_handler_trequest_handler ()
 
server_settings_t< default_traits_t > & timer_manager (Params &&... params) &
 
server_settings_t< default_traits_t > && timer_manager (Params &&... params) &&
 
std::unique_ptr< timer_factory_ttimer_factory ()
 
server_settings_t< default_traits_t > & logger (Params &&... params) &
 
server_settings_t< default_traits_t > && logger (Params &&... params) &&
 
std::unique_ptr< logger_tlogger ()
 
server_settings_t< default_traits_t > & extra_data_factory (extra_data_factory_handle_t factory) &
 Setter for extra-data-factory. More...
 
server_settings_t< default_traits_t > && extra_data_factory (extra_data_factory_handle_t factory) &&
 Setter for extra-data-factory. More...
 
RESTINIO_NODISCARD extra_data_factory_handle_t giveaway_extra_data_factory () const noexcept
 Extractor for extra-data-factory. More...
 
- Public Member Functions inherited from restinio::socket_type_dependent_settings_t< server_settings_t< default_traits_t >, Traits::stream_socket_t >
 socket_type_dependent_settings_t () noexcept=default
 
 socket_type_dependent_settings_t (const socket_type_dependent_settings_t &) noexcept=default
 
 socket_type_dependent_settings_t (socket_type_dependent_settings_t &&) noexcept=default
 
socket_type_dependent_settings_toperator= (const socket_type_dependent_settings_t &) noexcept=default
 
socket_type_dependent_settings_toperator= (socket_type_dependent_settings_t &&) noexcept=delete
 
- Protected Member Functions inherited from restinio::socket_type_dependent_settings_t< server_settings_t< default_traits_t >, Traits::stream_socket_t >
 ~socket_type_dependent_settings_t () noexcept=default
 
- Protected Member Functions inherited from restinio::connection_state_listener_holder_t< Traits::connection_state_listener_t >
void check_valid_connection_state_listener_pointer () const
 Checks that pointer to state listener is not null. More...
 
- Protected Member Functions inherited from restinio::ip_blocker_holder_t< Traits::ip_blocker_t >
void check_valid_ip_blocker_pointer () const
 Checks that pointer to IP-blocker is not null. More...
 
- Protected Member Functions inherited from restinio::details::max_parallel_connections_holder_t< connection_count_limit_types< default_traits_t >::limiter_t >
std::size_t max_parallel_connections () const noexcept
 
void set_max_parallel_connections (std::size_t v) noexcept
 
- Protected Attributes inherited from restinio::connection_state_listener_holder_t< Traits::connection_state_listener_t >
std::shared_ptr< Traits::connection_state_listener_t > m_connection_state_listener
 
- Protected Attributes inherited from restinio::ip_blocker_holder_t< Traits::ip_blocker_t >
std::shared_ptr< Traits::ip_blocker_t > m_ip_blocker
 
- Protected Attributes inherited from restinio::details::max_parallel_connections_holder_t< connection_count_limit_types< default_traits_t >::limiter_t >
std::size_t m_max_parallel_connections
 Actual value of the limit. More...
 
- Static Protected Attributes inherited from restinio::connection_state_listener_holder_t< Traits::connection_state_listener_t >
static constexpr bool has_actual_connection_state_listener
 
- Static Protected Attributes inherited from restinio::ip_blocker_holder_t< Traits::ip_blocker_t >
static constexpr bool has_actual_ip_blocker
 
- Static Protected Attributes inherited from restinio::details::max_parallel_connections_holder_t< connection_count_limit_types< default_traits_t >::limiter_t >
static constexpr bool has_actual_max_parallel_connections
 

Detailed Description

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

A fluent style interface for setting http server params.

Examples
sample/shared_tls_context/main.cpp, and sample/using_external_io_context/main.cpp.

Definition at line 1766 of file settings.hpp.

Member Typedef Documentation

◆ base_type_t

template<typename Traits = default_traits_t>
using restinio::server_settings_t< Traits >::base_type_t = basic_server_settings_t< server_settings_t<Traits>, Traits>
private

Definition at line 1769 of file settings.hpp.


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