Run

Concepts
concept	uvco::MainFunction

Functions
Promise< void >	uvco::yield ()
	Suspend current coroutine until next event loop iteration.
MultiPromise< unsigned >	uvco::yield (unsigned count)
	Generate count values from 0 to count - 1.
template<typename R , MainFunction< R > F>
R	uvco::runMain (F main, Scheduler::RunMode mode=Scheduler::RunMode::Deferred)

Detailed Description

Function Documentation

runMain()

template<typename R , MainFunction< R > F>

R uvco::runMain	(	F	main,
		Scheduler::RunMode	mode
	)

Set up event loop, then run main function to set up promises. Finally, clean up once the event loop has finished. An exception thrown within a coroutine is rethrown here.

MainFunction is a function taking a single const Loop& argument, and returning a Promise<R>. The supplied Loop is necessary to instantiate different types of resources, such as TCP streams or timers.

Example:

runMain<void>([](const Loop& loop) -> Promise<void> {
  // Set up resources here.
  TtyStream stdin = TtyStream::stdin(loop);
  std::optional<std::string> line = co_await stdin.read();
  co_await stdin.close();
  co_return;
});

                                         {
  Loop loop{mode};
  Promise<R> promise = main(loop);
  runLoop(loop);
  return promise.unwrap();
}

yield() [1/2]

Promise< void > uvco::yield

(

)

Suspend current coroutine until next event loop iteration.

{ co_await YieldAwaiter_{}; }

yield() [2/2]

MultiPromise< unsigned > uvco::yield

(

unsigned

count

)

Generate count values from 0 to count - 1.

                                             {
  for (unsigned i = 0; i < count; ++i) {
    co_yield i;
  }
}