xrpl::IOList Class Reference

Manages a set of objects performing asynchronous I/O. More...

#include <io_list.h>

Collaboration diagram for xrpl::IOList:

Classes
class	Work

Public Member Functions
	IOList ()=default
	~IOList ()
	Destroy the list.
bool	closed () const
	Return true if the list is closed.
template<class T, class... Args>
std::shared_ptr< T >	emplace (Args &&... args)
	Create associated work if not closed.
template<class Finisher>
void	close (Finisher &&f)
	Cancel active I/O.
void	close ()
template<class = void>
void	join ()
	Block until the io_list stops.

Private Member Functions
template<class = void>
void	destroy ()

Private Attributes
std::mutex	m_
std::size_t	n_ = 0
bool	closed_ = false
std::condition_variable	cv_
boost::container::flat_map< Work *, std::weak_ptr< Work > >	map_
std::function< void(void)>	f_

Detailed Description

Manages a set of objects performing asynchronous I/O.

Definition at line 18 of file io_list.h.

Constructor & Destructor Documentation

IOList()

xrpl::IOList::IOList ( )

default

~IOList()

xrpl::IOList::~IOList

(

)

Destroy the list.

Effects: Closes the IOList if it was not previously closed. No finisher is invoked in this case.

Blocks until all work is destroyed.

Definition at line 77 of file io_list.h.

Member Function Documentation

destroy()

template<class>

void xrpl::IOList::destroy ( )

private

Definition at line 190 of file io_list.h.

closed()

bool xrpl::IOList::closed ( ) const

nodiscard

Return true if the list is closed.

Thread Safety: Undefined result if called concurrently with close().

Definition at line 90 of file io_list.h.

emplace()

template<class T, class... Args>

std::shared_ptr< T > xrpl::IOList::emplace

(

Args &&...

args

)

Create associated work if not closed.

Requirements: std::is_base_of_v<Work, T> == true

Thread Safety: May be called concurrently.

Effects: Atomically creates, inserts, and returns new work T, or returns nullptr if the io_list is closed,

If the call succeeds and returns a new object, it is guaranteed that a subsequent call to close will invoke Work::close on the object.

Definition at line 198 of file io_list.h.

close() [1/2]

template<class Finisher>

void xrpl::IOList::close

(

Finisher &&

f

)

Cancel active I/O.

Thread Safety: May not be called concurrently.

Effects: Associated work is closed.

Finisher if provided, will be called when all associated work is destroyed. The finisher may be called from a foreign thread, or within the call to this function.

Only the first call to close will set the finisher.

No effect after the first call.

Definition at line 222 of file io_list.h.

close() [2/2]

void xrpl::IOList::close

(

)

Definition at line 141 of file io_list.h.

join()

template<class>

void xrpl::IOList::join

(

)

Block until the io_list stops.

Effects: The caller is blocked until the io_list is closed and all associated work is destroyed.

Thread safety: May be called concurrently.

Preconditions: No call to io_context::run on any io_context used by work objects associated with this io_list exists in the caller's call stack.

Definition at line 248 of file io_list.h.

Member Data Documentation

m_

std::mutex xrpl::IOList::m_

private

Definition at line 58 of file io_list.h.

n_

std::size_t xrpl::IOList::n_ = 0

private

Definition at line 59 of file io_list.h.

closed_

bool xrpl::IOList::closed_ = false

private

Definition at line 60 of file io_list.h.

cv_

std::condition_variable xrpl::IOList::cv_

private

Definition at line 61 of file io_list.h.

map_

boost::container::flat_map<Work*, std::weak_ptr<Work> > xrpl::IOList::map_

private

Definition at line 62 of file io_list.h.

f_

std::function<void(void)> xrpl::IOList::f_

private

Definition at line 63 of file io_list.h.