ripple::short_read_test Class Reference

Inheritance diagram for ripple::short_read_test:

Collaboration diagram for ripple::short_read_test:

Classes
class	Base
class	Client
class	Server

Public Member Functions
	short_read_test ()
	~short_read_test ()
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)
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.

Private Types
using	io_context_type = boost::asio::io_context
using	strand_type = boost::asio::strand< io_context_type::executor_type >
using	timer_type = boost::asio::basic_waitable_timer< std::chrono::steady_clock >
using	acceptor_type = boost::asio::ip::tcp::acceptor
using	socket_type = boost::asio::ip::tcp::socket
using	stream_type = boost::asio::ssl::stream< socket_type & >
using	error_code = boost::system::error_code
using	endpoint_type = boost::asio::ip::tcp::endpoint
using	address_type = boost::asio::ip::address

Private Member Functions
void	propagate_abort ()

Static Private Member Functions
template<class Streambuf >
static void	write (Streambuf &sb, std::string const &s)
static suite **	p_this_suite ()

Private Attributes
io_context_type	io_context_
boost::optional< boost::asio::executor_work_guard< boost::asio::io_context::executor_type > >	work_
std::thread	thread_
std::shared_ptr< boost::asio::ssl::context >	context_
bool	abort_ = false
bool	aborted_ = false
runner *	runner_ = nullptr

Detailed Description

Definition at line 53 of file short_read_test.cpp.

Member Typedef Documentation

io_context_type

using ripple::short_read_test::io_context_type = boost::asio::io_context

private

Definition at line 56 of file short_read_test.cpp.

strand_type

using ripple::short_read_test::strand_type = boost::asio::strand<io_context_type::executor_type>

private

Definition at line 57 of file short_read_test.cpp.

timer_type

using ripple::short_read_test::timer_type = boost::asio::basic_waitable_timer<std::chrono::steady_clock>

private

Definition at line 58 of file short_read_test.cpp.

acceptor_type

using ripple::short_read_test::acceptor_type = boost::asio::ip::tcp::acceptor

private

Definition at line 60 of file short_read_test.cpp.

socket_type

using ripple::short_read_test::socket_type = boost::asio::ip::tcp::socket

private

Definition at line 61 of file short_read_test.cpp.

stream_type

using ripple::short_read_test::stream_type = boost::asio::ssl::stream<socket_type&>

private

Definition at line 62 of file short_read_test.cpp.

error_code

using ripple::short_read_test::error_code = boost::system::error_code

private

Definition at line 63 of file short_read_test.cpp.

endpoint_type

using ripple::short_read_test::endpoint_type = boost::asio::ip::tcp::endpoint

private

Definition at line 64 of file short_read_test.cpp.

address_type

using ripple::short_read_test::address_type = boost::asio::ip::address

private

Definition at line 65 of file short_read_test.cpp.

Constructor & Destructor Documentation

short_read_test()

ripple::short_read_test::short_read_test

(

)

Definition at line 634 of file short_read_test.cpp.

~short_read_test()

ripple::short_read_test::~short_read_test

(

)

Definition at line 644 of file short_read_test.cpp.

Member Function Documentation

write()

template<class Streambuf >

static void ripple::short_read_test::write ( Streambuf &  sb, std::string const &  s  )

staticprivate

Definition at line 76 of file short_read_test.cpp.

run()

void ripple::short_read_test::run ( )

overridevirtual

Runs the suite.

Implements beast::unit_test::suite.

Definition at line 651 of file short_read_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 161 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 399 of file suite.h.

pass()

template<class >

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

inherited

Record a successful test condition.

Definition at line 511 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 533 of file suite.h.

fail() [2/2]

template<class >

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

inherited

Definition at line 520 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 229 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 416 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 240 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 429 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 448 of file suite.h.

except() [2/4]

template<class F >

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

inherited

Definition at line 263 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 465 of file suite.h.

except() [4/4]

template<class E , class F >

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

inherited

Definition at line 272 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 482 of file suite.h.

unexcept() [2/2]

template<class F >

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

inherited

Definition at line 281 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 288 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 499 of file suite.h.

unexpected() [2/2]

template<class Condition >

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

inherited

Definition at line 301 of file suite.h.

p_this_suite()

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

staticprivateinherited

Definition at line 310 of file suite.h.

propagate_abort()

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

privateinherited

Definition at line 539 of file suite.h.

Member Data Documentation

io_context_

io_context_type ripple::short_read_test::io_context_

private

Definition at line 67 of file short_read_test.cpp.

work_

boost::optional<boost::asio::executor_work_guard< boost::asio::io_context::executor_type> > ripple::short_read_test::work_

private

Definition at line 70 of file short_read_test.cpp.

thread_

std::thread ripple::short_read_test::thread_

private

Definition at line 71 of file short_read_test.cpp.

context_

std::shared_ptr<boost::asio::ssl::context> ripple::short_read_test::context_

private

Definition at line 72 of file short_read_test.cpp.

abort_

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

privateinherited

Definition at line 57 of file suite.h.

aborted_

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

privateinherited

Definition at line 58 of file suite.h.

runner_

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

privateinherited

Definition at line 59 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 152 of file suite.h.

testcase

testcase_t beast::unit_test::suite::testcase

inherited

Memberspace for declaring test cases.

Definition at line 155 of file suite.h.