RESTinio
Loading...
Searching...
No Matches
restinio::impl::response_context_t Class Reference

A context for a single response. More...

#include <response_coordinator.hpp>

Public Member Functions

void reinit (request_id_t request_id) noexcept
 Reinitialize context.
void enqueue_group (write_group_t wg)
 Put write group to data queue.
bool empty () const noexcept
 Is context empty.
write_group_t dequeue_group () noexcept
 Extract write group from data queue.
auto request_id () const noexcept
 Get id of associated request.
void response_output_flags (response_output_flags_t flags) noexcept
 Get flags of corrent response data flow.
auto response_output_flags () const noexcept
 Get flags of corrent response data flow.
bool is_complete () const noexcept
 Is response data of a given request is complete.

Private Attributes

request_id_t m_request_id { 0 }
write_groups_container_t m_write_groups
 Unsent responses parts.
response_output_flags_t m_response_output_flags
 Response flags.

Friends

write_groups_container_tutest_access (response_context_t &ctx)
 Access write-groups container (used in unit tests)

Detailed Description

A context for a single response.

Definition at line 38 of file response_coordinator.hpp.

Member Function Documentation

◆ dequeue_group()

write_group_t restinio::impl::response_context_t::dequeue_group ( )
inlinenoexcept

Extract write group from data queue.

Definition at line 85 of file response_coordinator.hpp.

◆ empty()

bool restinio::impl::response_context_t::empty ( ) const
inlinenoexcept

Is context empty.

Definition at line 81 of file response_coordinator.hpp.

◆ enqueue_group()

void restinio::impl::response_context_t::enqueue_group ( write_group_t wg)
inline

Put write group to data queue.

Definition at line 63 of file response_coordinator.hpp.

◆ is_complete()

bool restinio::impl::response_context_t::is_complete ( ) const
inlinenoexcept

Is response data of a given request is complete.

Definition at line 133 of file response_coordinator.hpp.

◆ reinit()

void restinio::impl::response_context_t::reinit ( request_id_t request_id)
inlinenoexcept

Reinitialize context.

Parameters
request_idNew request id.

Definition at line 50 of file response_coordinator.hpp.

◆ request_id()

auto restinio::impl::response_context_t::request_id ( ) const
inlinenoexcept

Get id of associated request.

Definition at line 115 of file response_coordinator.hpp.

◆ response_output_flags() [1/2]

auto restinio::impl::response_context_t::response_output_flags ( ) const
inlinenoexcept

Get flags of corrent response data flow.

Definition at line 126 of file response_coordinator.hpp.

◆ response_output_flags() [2/2]

void restinio::impl::response_context_t::response_output_flags ( response_output_flags_t flags)
inlinenoexcept

Get flags of corrent response data flow.

Definition at line 119 of file response_coordinator.hpp.

◆ utest_access

write_groups_container_t & utest_access ( response_context_t & ctx)
friend

Access write-groups container (used in unit tests)

Definition at line 43 of file response_coordinator.hpp.

Member Data Documentation

◆ m_request_id

request_id_t restinio::impl::response_context_t::m_request_id { 0 }
private

Definition at line 141 of file response_coordinator.hpp.

◆ m_response_output_flags

response_output_flags_t restinio::impl::response_context_t::m_response_output_flags
private
Initial value:
{
@ connection_keepalive
This response says to keep connection.
@ not_final_parts
Intermediate parts (more parts of response to follow).

Response flags.

Definition at line 148 of file response_coordinator.hpp.

◆ m_write_groups

write_groups_container_t restinio::impl::response_context_t::m_write_groups
private

Unsent responses parts.

Definition at line 144 of file response_coordinator.hpp.


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