io_latency_probe_test Class Reference

Inheritance diagram for io_latency_probe_test:

Collaboration diagram for io_latency_probe_test:

Classes
struct	test_sampler

Public Types
using	yield_context = boost::asio::yield_context
	The type of yield context passed to functions.

Public Member Functions
void	run () override
	Runs the suite.
template<class = void>
void	operator() (runner &r)
	Invokes the test using the specified runner.
template<class = void>
void	pass ()
	Record a successful test condition.
template<class F , class String >
bool	except (F &&f, String const &reason)
template<class F >
bool	except (F &&f)
template<class E , class F , class String >
bool	except (F &&f, String const &reason)
template<class E , class F >
bool	except (F &&f)
template<class F , class String >
bool	unexcept (F &&f, String const &reason)
template<class F >
bool	unexcept (F &&f)
std::string const &	arg () const
	Return the argument associated with the runner.
template<class Condition , class String >
bool	unexpected (Condition shouldBeFalse, String const &reason)
template<class Condition >
bool	unexpected (Condition shouldBeFalse)
boost::asio::io_context &	get_io_context ()
	Return the io_context associated with the object.
template<class F0 , class... FN>
void	yield_to (F0 &&f0, FN &&... fn)
	Run one or more functions, each in a coroutine.
template<class String >
void	fail (String const &reason, char const *file, int line)
	Record a failure.
template<class = void>
void	fail (std::string const &reason="")
template<class Condition >
bool	expect (Condition const &shouldBeTrue)
	Evaluate a test condition.
template<class Condition , class String >
bool	expect (Condition const &shouldBeTrue, String const &reason)
template<class Condition >
bool	expect (Condition const &shouldBeTrue, char const *file, int line)
template<class Condition , class String >
bool	expect (Condition const &shouldBeTrue, String const &reason, char const *file, int line)

Static Public Member Functions
static suite *	this_suite ()
	Returns the "current" running suite.

Public Attributes
log_os< char >	log
	Logging output stream.
testcase_t	testcase
	Memberspace for declaring test cases.

Protected Attributes
boost::asio::io_context	ios_

Private Types
using	MyTimer = boost::asio::basic_waitable_timer< std::chrono::steady_clock >

Private Member Functions
void	testSampleOne (boost::asio::yield_context &yield)
void	testSampleOngoing (boost::asio::yield_context &yield)
void	testCanceled (boost::asio::yield_context &yield)
void	propagate_abort ()
void	spawn ()
template<class F0 , class... FN>
void	spawn (F0 &&f, FN &&... fn)

Static Private Member Functions
static suite **	p_this_suite ()

Private Attributes
bool	abort_ = false
bool	aborted_ = false
runner *	runner_ = nullptr
boost::optional< boost::asio::executor_work_guard< boost::asio::io_context::executor_type > >	work_
std::vector< std::thread >	threads_
std::mutex	m_
std::condition_variable	cv_
std::size_t	running_ = 0

Detailed Description

Definition at line 18 of file beast_io_latency_probe_test.cpp.

Member Typedef Documentation

MyTimer

using io_latency_probe_test::MyTimer = boost::asio::basic_waitable_timer<std::chrono::steady_clock>

private

Definition at line 21 of file beast_io_latency_probe_test.cpp.

yield_context

using beast::test::enable_yield_to::yield_context = boost::asio::yield_context

inherited

The type of yield context passed to functions.

Definition at line 44 of file yield_to.h.

Member Function Documentation

testSampleOne()

void io_latency_probe_test::testSampleOne ( boost::asio::yield_context &  yield )

private

Definition at line 147 of file beast_io_latency_probe_test.cpp.

testSampleOngoing()

void io_latency_probe_test::testSampleOngoing ( boost::asio::yield_context &  yield )

private

Definition at line 162 of file beast_io_latency_probe_test.cpp.

testCanceled()

void io_latency_probe_test::testCanceled ( boost::asio::yield_context &  yield )

private

Definition at line 204 of file beast_io_latency_probe_test.cpp.

run()

void io_latency_probe_test::run ( )

overridevirtual

Runs the suite.

Implements beast::unit_test::suite.

Definition at line 215 of file beast_io_latency_probe_test.cpp.

this_suite()

static suite * beast::unit_test::suite::this_suite ( )

staticinherited

Returns the "current" running suite.

If no suite is running, nullptr is returned.

Definition at line 158 of file suite.h.

operator()()

template<class >

void beast::unit_test::suite::operator() ( runner &  r )

inherited

Invokes the test using the specified runner.

Data members are set up here instead of the constructor as a convenience to writing the derived class to avoid repetition of forwarded constructor arguments to the base. Normally this is called by the framework for you.

Definition at line 396 of file suite.h.

pass()

template<class >

void beast::unit_test::suite::pass ( )

inherited

Record a successful test condition.

Definition at line 508 of file suite.h.

fail() [1/2]

template<class String >

void beast::unit_test::suite::fail ( String const &  reason, char const *  file, int  line  )

inherited

Record a failure.

Parameters

reason	Optional text added to the output on a failure.
file	The source code file where the test failed.
line	The source code line number where the test failed.

Definition at line 530 of file suite.h.

fail() [2/2]

template<class >

void beast::unit_test::suite::fail ( std::string const &  reason = "" )

inherited

Definition at line 517 of file suite.h.

expect() [1/4]

template<class Condition >

bool beast::unit_test::suite::expect ( Condition const &  shouldBeTrue )

inherited

Evaluate a test condition.

This function provides improved logging by incorporating the file name and line number into the reported output on failure, as well as additional text specified by the caller.

Parameters

shouldBeTrue	The condition to test. The condition is evaluated in a boolean context.
reason	Optional added text to output on a failure.
file	The source code file where the test failed.
line	The source code line number where the test failed.

Returns

true if the test condition indicates success.

Definition at line 226 of file suite.h.

expect() [2/4]

template<class Condition , class String >

bool beast::unit_test::suite::expect ( Condition const &  shouldBeTrue, String const &  reason  )

inherited

Definition at line 413 of file suite.h.

expect() [3/4]

template<class Condition >

bool beast::unit_test::suite::expect ( Condition const &  shouldBeTrue, char const *  file, int  line  )

inherited

Definition at line 237 of file suite.h.

expect() [4/4]

template<class Condition , class String >

bool beast::unit_test::suite::expect ( Condition const &  shouldBeTrue, String const &  reason, char const *  file, int  line  )

inherited

Definition at line 426 of file suite.h.

except() [1/4]

template<class F , class String >

bool beast::unit_test::suite::except ( F &&  f, String const &  reason  )

inherited

Definition at line 445 of file suite.h.

except() [2/4]

template<class F >

bool beast::unit_test::suite::except ( F &&  f )

inherited

Definition at line 260 of file suite.h.

except() [3/4]

template<class E , class F , class String >

bool beast::unit_test::suite::except ( F &&  f, String const &  reason  )

inherited

Definition at line 462 of file suite.h.

except() [4/4]

template<class E , class F >

bool beast::unit_test::suite::except ( F &&  f )

inherited

Definition at line 269 of file suite.h.

unexcept() [1/2]

template<class F , class String >

bool beast::unit_test::suite::unexcept ( F &&  f, String const &  reason  )

inherited

Definition at line 479 of file suite.h.

unexcept() [2/2]

template<class F >

bool beast::unit_test::suite::unexcept ( F &&  f )

inherited

Definition at line 278 of file suite.h.

arg()

std::string const & beast::unit_test::suite::arg ( ) const

inherited

Return the argument associated with the runner.

Definition at line 285 of file suite.h.

unexpected() [1/2]

template<class Condition , class String >

bool beast::unit_test::suite::unexpected ( Condition  shouldBeFalse, String const &  reason  )

inherited

Definition at line 496 of file suite.h.

unexpected() [2/2]

template<class Condition >

bool beast::unit_test::suite::unexpected ( Condition  shouldBeFalse )

inherited

Definition at line 298 of file suite.h.

p_this_suite()

static suite ** beast::unit_test::suite::p_this_suite ( )

staticprivateinherited

Definition at line 307 of file suite.h.

propagate_abort()

void beast::unit_test::suite::propagate_abort ( )

privateinherited

Definition at line 536 of file suite.h.

get_io_context()

boost::asio::io_context & beast::test::enable_yield_to::get_io_context ( )

inherited

Return the io_context associated with the object.

Definition at line 63 of file yield_to.h.

yield_to()

template<class F0 , class... FN>

void beast::test::enable_yield_to::yield_to ( F0 &&  f0, FN &&...  fn  )

inherited

Run one or more functions, each in a coroutine.

This call will block until all coroutines terminate.

Each functions should have this signature:

void f(yield_context);

Parameters

fn...

One or more functions to invoke.

Definition at line 102 of file yield_to.h.

spawn() [1/2]

void beast::test::enable_yield_to::spawn ( )

privateinherited

Definition at line 91 of file yield_to.h.

spawn() [2/2]

template<class F0 , class... FN>

void beast::test::enable_yield_to::spawn ( F0 &&  f, FN &&...  fn  )

privateinherited

Definition at line 112 of file yield_to.h.

Member Data Documentation

abort_

bool beast::unit_test::suite::abort_ = false

privateinherited

Definition at line 54 of file suite.h.

aborted_

bool beast::unit_test::suite::aborted_ = false

privateinherited

Definition at line 55 of file suite.h.

runner_

runner* beast::unit_test::suite::runner_ = nullptr

privateinherited

Definition at line 56 of file suite.h.

log

log_os<char> beast::unit_test::suite::log

inherited

Logging output stream.

Text sent to the log output stream will be forwarded to the output stream associated with the runner.

Definition at line 149 of file suite.h.

testcase

testcase_t beast::unit_test::suite::testcase

inherited

Memberspace for declaring test cases.

Definition at line 152 of file suite.h.

ios_

boost::asio::io_context beast::test::enable_yield_to::ios_

protectedinherited

Definition at line 31 of file yield_to.h.

work_

boost::optional<boost::asio::executor_work_guard< boost::asio::io_context::executor_type> > beast::test::enable_yield_to::work_

privateinherited

Definition at line 36 of file yield_to.h.

threads_

std::vector<std::thread> beast::test::enable_yield_to::threads_

privateinherited

Definition at line 37 of file yield_to.h.

m_

std::mutex beast::test::enable_yield_to::m_

privateinherited

Definition at line 38 of file yield_to.h.

cv_

std::condition_variable beast::test::enable_yield_to::cv_

privateinherited

Definition at line 39 of file yield_to.h.

running_

std::size_t beast::test::enable_yield_to::running_ = 0

privateinherited

Definition at line 40 of file yield_to.h.