A wait operation, suitable for use with an I/O timer, with a stackless coroutine as the completion task. More...

#include <co_timer.hpp>

Inheritance diagram for lely::io::CoTimerWait:

Collaboration diagram for lely::io::CoTimerWait:

Public Member Functions
	CoTimerWait (ev_exec_t *exec) noexcept
	Constructs a wait operation.

	CoTimerWait () noexcept
	Constructs a wait operation.

ev::Executor	get_executor () const noexcept
	Returns the executor to which the completion task is (to be) submitted.

virtual void	operator() (int overrun, ::std::error_code ec) noexcept=0
	The coroutine to be executed once the wait operation completes (or is canceled).

Public Member Functions inherited from lely::util::Coroutine
void	restart () noexcept
	Resets the stackless coroutine so the next invocation starts at the beginning.

bool	is_ready () const noexcept
	Returns true if the stackless coroutine has finished.

bool	is_parent () const noexcept
	Returns true if the stackless coroutine is the parent of a fork.

bool	is_child () const noexcept
	Returns true if the stackless coroutine is the child of a fork.

Additional Inherited Members
Data Fields inherited from io_timer_wait
struct ev_task	task
	The task (to be) submitted upon completion (or cancellation) of the wait operation.

struct io_timer_wait_result	r
	The result of the wait operation.

Detailed Description

A wait operation, suitable for use with an I/O timer, with a stackless coroutine as the completion task.

Definition at line 37 of file co_timer.hpp.

Member Function Documentation

virtual void lely::io::CoTimerWait::operator()	(	int	overrun,
		::std::error_code	ec
	)

pure virtualnoexcept

The coroutine to be executed once the wait operation completes (or is canceled).

Parameters

overrun	the expiration overrun count (see io_timer_getoverrun()) on success, or -1 on error (or if the operation is canceled).
ec	the error code if overrun is -1.

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