Welcome to RESTinio v.0.7 documentation!

• What Is It?
  • RESTinio features
  • The status of RESTinio
  • License
• Obtain And Build
  • Prerequisites
  • Obtaining
    • Cloning of Git repository
    • Getting archive
    • Vcpkg
    • Conan
  • Build
    • CMake
    • Dependencies default settings
  • Notes on building with Boost::ASIO
• Getting started
  • Minimalistic hello world
  • Enhance request handler
  • Enhance request handler even more
• Basic idea
  • Traits
  • Class http_server_t<Traits>
  • Class server_settings_t<Traits>
• Traits
  • List of types that must be defined be Traits
  • timer_manager_t
  • logger_t
  • request_handler_t
  • strand_t
  • stream_socket_t
  • http_method_mapper_t
  • connection_state_listener_t
  • ip_blocker_t
  • extra_data_factory_t
• Using restinio::run
  • Simple forms of restinio::run
  • Version of restinio::run for an existing http_server_t object
  • run_async function
  • A helper class on_pool_runner_t
  • Running http_server manually
• RESTinio’s threading model and sync/async request processing
  • RESTinio doesn’t use any hidden worker threads
  • Synchronous or asynchrouns request-processing
  • A note about response’s flush() and done() methods
• Using external io_context
  • Running single RESTinio server on external asio::io_context object
  • Running several instances of RESTinio server on the same asio::io_context object
• Request handler
  • Request handler
    • Simplified view
    • The actual picture
  • Request structure
    • Support for incoming requests with chunked encoding
• Extra-data in request object
  • Extra-data in request object
  • The role of extra-data-factory
    • Is extra-data-factory DefaultConstructible or not?
• Response builder
  • RESTinio controlled output response builder
  • User controlled output response builder
  • Chunked transfer encoding output builder
  • Notificators
    • Notificator invocation logic
  • Status line
    • RFC 2616 statuses (413, 414 from RFC 7231)
    • RFC 2518 statuses
    • RFC 6585 statuses
    • RFC 7538 statuses
• Working with http headers
  • HTTP header fields
    • Enumeration of fields and field’s values
  • Request header
  • Response header
  • Helpers for parsing values of HTTP-fields
    • Parsing errors
    • find_first helper functions
• Query string parameters
  • Additional features of parse_query
    • Parsing traits
    • Support for “web beacon”
  • try_parse_query function template
• Get values from RESTinio key-value containers
  • value_or()
  • opt_value()
• File support (sendfile)
  • File meta
  • Implementation notes
    • Posix
    • Windows
    • Other platforms
    • TLS sockets
  • An important note related to SIGPIPE
• Buffers
  • Const buffer
  • Types with datasizeable interface
  • Support for fmt::basic_memory_buffer<char,1>
  • A shared pointer to a type with datasizeable interface
• Express router
  • Route parameters
    • Casting parameters
    • Note on string view
  • Non matched request handler
  • generic_express_router_t and express_router_t classes
  • Regex engines
  • Performance
    • Benchmarks
• Experimental type-safe easy_parser router
  • The problem
    • The propensity to errors
    • The opacity and absence of type-safety
  • A type-safe router as a solution
  • The easy_parser_router
    • Setting up handlers for routes
    • generic_easy_parser_router_t and easy_parser_router_t classes
  • easy_parser_router DSL
  • Performance
  • easy_parser
    • Intro
    • easy_parser and easy_parser_router namespaces
    • The main easy_parser principle
    • Support of PEG features
    • Where to find information about easy_parser’s ready-to-use stuff?
  • Some more complex examples
    • A router from long_output example
    • Parsing of UUIDs in URL
• Method-matchers for express- and easy_parser-based routers
  • Ready-to-use method-matchers
  • A possibility to make own matchers
  • Method-matchers can be used for express- and easy_parser-based routers
• Chains of synchronous handlers
  • The problem
  • The solution in common words
    • How to pass a data from one step to another?
    • Why a chain of synchonous handlers?
  • Ready-to-use implementations of chains
    • fixed_size_chain
    • growable_size_chain
• Chains of asynchronous handlers
  • The problem
  • What does “asynchronous handler” mean?
    • The role of request_handling_status_t::accepted in case of an asynchronous handler
  • How async_chain works?
    • Where schedulers are called?
    • Thread safety for a controller
  • Ready-to-use implementations of chains
    • fixed_size_chain
    • growable_size_chain
• Compression (defalate, gzip)
  • zlib_t
    • params_t
    • zlib_t API
    • Usage examples
  • Easy interface
    • Single function for compression/decompression
    • Body appenders
    • Handle decompressed body
  • Samples
• Various helpers
  • try_parse_field helper function
  • Multipart body helpers
    • enumerate_parts function
    • Building blocks of enumerate_parts function
  • File upload helpers
    • analyze_part
    • enumerate_parts_with_files
  • Authorization helpers
    • Authorization HTTP-field parser
    • A support for extraction of parameters for Basic authentification
    • A support for extraction of parameters for Bearer authentification
    • Handling several authentification schemes
• Connection state listener
  • How to specify connection state listener?
    • The restinio::connection_state::notice_t class
  • When and where state listener is called?
  • Access to TLS-parameters
  • Limitation of the current RESTinio logic and max_pipelined_requests
  • Thread safety of state listener
  • Performance impact
• IP-blocker
  • How to specify IP-blocker?
    • The restinio::ip_blocker::incoming_info_t class
  • When and where IP-blocker is called?
  • Thread safety of IP-blocker
  • Integration of IP-blocker and connection-state-listener
• Server settings
  • Traits independent settings
    • acceptor_options_setter
    • acceptor_post_bind_hook
    • address(asio::ip::address)
    • address(std::string)
    • buffer_size
    • cleanup_func
    • concurrent_accepts_count
    • handle_request_timeout
    • incoming_http_msg_limits
    • max_pipelined_requests
    • port
    • protocol
    • read_next_http_message_timelimit
    • separate_accept_and_create_connect
    • socket_options_setter
    • write_http_response_timelimit
  • Traits dependent settings
    • max_parallel_connections
    • logger
    • request_handler
    • timer_manager
• Cleanup function
  • Purpose
  • When cleanup_func is called
  • Important notes
• RESTinio context entities running on asio::io_context
  • Acceptor
    • Post-bind hook for the acceptor
    • Limiting the number of parallel connections
  • Connection
• Websocket
  • Upgrade connection
  • Сorrectness of WebSocket frames
  • Close WebSocket
  • Minimalistic sample
• TLS support
• ASIO Support
  • ASIO Versions
  • Linking tips
  • Implementation details
• Version History
  • 0.7.2
  • 0.7.0
  • 0.6.13
  • 0.6.12
  • 0.6.11
  • 0.6.10
  • 0.6.9
  • 0.6.8
  • 0.6.7.1
  • 0.6.7
  • 0.6.6
  • 0.6.5
  • 0.6.4
  • 0.6.3
  • 0.6.2
  • 0.6.1
  • 0.6.0
  • 0.5.1
  • 0.5.0
  • 0.4.9
  • 0.4.8.4 (including 0.4.8.1-0.4.8.7)
  • 0.4.8
  • 0.4.7
  • 0.4.6
  • 0.4.5.1
  • 0.4.4
  • 0.4.3
  • 0.4.2
  • 0.4.1
  • 0.4.0
  • 0.3.0
  • 0.2.2
  • 0.2.1
  • 0.2.0
  • 0.1.0

Indices and tables

• Search Page