jau::io::SyncStreamResponse Struct Reference

Synchronous stream response. More...

#include <io_util.hpp>

Collaboration diagram for jau::io::SyncStreamResponse:

Public Member Functions
	SyncStreamResponse ()
	SyncStreamResponse (net_tk_handle handle_)
constexpr_atomic bool	failed () const noexcept
	Stream failed and is aborted, i.e.
constexpr_atomic bool	processing () const noexcept
	Stream processing in progress, i.e.
constexpr_atomic bool	success () const noexcept
	Stream completed successfully, i.e.

Public Attributes
uint64_t	content_length
	content_length tracking the content_length
net_tk_handle	handle
	used network tookit handle, if owned by caller
bool	has_content_length
	indicating whether content_length is known from server
url_header_resp	header_resp
	synchronized URL header response completion
relaxed_atomic_io_result_t	result
	tracking io_result_t. If set to other than io_result_t::NONE while streaming, streaming is aborted. See failed(), processing() and success()
std::vector< uint8_t >	result_data
	piggy-bag result data compiled by user, e.g. via AsyncStreamConsumerFunc
std::string	result_text
	piggy-bag result data compiled by user, e.g. via AsyncStreamConsumerFunc
uint64_t	total_read
	tracking the total_read

Detailed Description

Synchronous stream response.

Definition at line 231 of file io_util.hpp.

Constructor & Destructor Documentation

SyncStreamResponse() [1/2]

jau::io::SyncStreamResponse::SyncStreamResponse ( net_tk_handle handle_ )

inline

Definition at line 232 of file io_util.hpp.

Here is the caller graph for this function:

SyncStreamResponse() [2/2]

jau::io::SyncStreamResponse::SyncStreamResponse ( )

inline

Definition at line 240 of file io_util.hpp.

Member Function Documentation

failed()

constexpr_atomic bool jau::io::SyncStreamResponse::failed ( ) const

inlinenoexcept

Stream failed and is aborted, i.e.

io_result_t::FAILED == result

Definition at line 244 of file io_util.hpp.

processing()

constexpr_atomic bool jau::io::SyncStreamResponse::processing ( ) const

inlinenoexcept

Stream processing in progress, i.e.

io_result_t::NONE == result

Definition at line 246 of file io_util.hpp.

success()

constexpr_atomic bool jau::io::SyncStreamResponse::success ( ) const

inlinenoexcept

Stream completed successfully, i.e.

io_result_t::SUCCESS == result

Definition at line 248 of file io_util.hpp.

Member Data Documentation

handle

net_tk_handle jau::io::SyncStreamResponse::handle

used network tookit handle, if owned by caller

Definition at line 251 of file io_util.hpp.

header_resp

url_header_resp jau::io::SyncStreamResponse::header_resp

synchronized URL header response completion

Definition at line 253 of file io_util.hpp.

has_content_length

bool jau::io::SyncStreamResponse::has_content_length

indicating whether content_length is known from server

Definition at line 255 of file io_util.hpp.

content_length

uint64_t jau::io::SyncStreamResponse::content_length

content_length tracking the content_length

Definition at line 257 of file io_util.hpp.

total_read

uint64_t jau::io::SyncStreamResponse::total_read

tracking the total_read

Definition at line 259 of file io_util.hpp.

result

relaxed_atomic_io_result_t jau::io::SyncStreamResponse::result

tracking io_result_t. If set to other than io_result_t::NONE while streaming, streaming is aborted. See failed(), processing() and success()

Definition at line 261 of file io_util.hpp.

result_data

std::vector<uint8_t> jau::io::SyncStreamResponse::result_data

piggy-bag result data compiled by user, e.g. via AsyncStreamConsumerFunc

Definition at line 263 of file io_util.hpp.

result_text

std::string jau::io::SyncStreamResponse::result_text

piggy-bag result data compiled by user, e.g. via AsyncStreamConsumerFunc

Definition at line 265 of file io_util.hpp.

---

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

• include/jau/io/io_util.hpp