The fiber. More...

#include <fiber.h>

Inheritance diagram for zth::Fiber:

Public Types
enum	State { Uninitialized = 0 , New , Ready , Running , Waiting , Suspended , Dead }

typedef void()	FiberHook(Fiber &)

typedef ContextAttr::EntryArg	EntryArg

typedef void(*	Entry) (EntryArg)

typedef Hook< Fiber & >	Hook_type

Public Types inherited from zth::Listable
typedef void *	user_type

Public Types inherited from zth::UniqueID< Fiber >
typedef NamedUniqueID	base

Public Member Functions
	Fiber (Entry entry, EntryArg arg=EntryArg())

virtual	~Fiber () noexcept override

int	setStackSize (size_t size) noexcept

size_t	stackSize () const noexcept

size_t	stackUsage () const

Context *	context () const noexcept

State	state () const noexcept

void *	fls () const noexcept

void	setFls (void *data=nullptr) noexcept

Timestamp const &	runningSince () const noexcept

Timestamp const &	stateEnd () const noexcept

TimeInterval const &	totalTime () const noexcept

void	atExit (Hook_type::function_type f, Hook_type::arg_type arg=Hook_type::arg_type())

void	atCleanup (Hook_type::function_type f, Hook_type::arg_type arg=Hook_type::arg_type())

int	init (Timestamp const &now=Timestamp::now())

int	run (Fiber &from, Timestamp now=Timestamp::now())

bool	allowYield (Timestamp const &now=Timestamp::now()) const noexcept

void	kill () noexcept

void	nap (Timestamp const &sleepUntil=Timestamp::null()) noexcept

void	wakeup () noexcept

void	suspend () noexcept

void	resume () noexcept

string	str () const

Public Member Functions inherited from zth::Listable
constexpr	Listable () noexcept

constexpr	Listable (Listable const &e) noexcept

Listable &	operator= (Listable const &rhs) noexcept

	Listable (Listable &&l) noexcept

Listable &	operator= (Listable &&l) noexcept

Public Member Functions inherited from zth::UniqueID< Fiber >
	UniqueID (UniqueID const &)=delete

	UniqueID (UniqueID &&u) noexcept

	UniqueID (string const &name)

	UniqueID (string &&name)

	UniqueID (char const *name=nullptr)

UniqueID &	operator= (UniqueID const &)=delete

UniqueID &	operator= (UniqueID &&u) noexcept

virtual	~UniqueID () noexcept override=default

void const *	normptr () const noexcept

uint64_t	id () const noexcept

Public Member Functions inherited from zth::NamedUniqueID< Named >
virtual	~NamedUniqueID () noexcept override=default

string const &	name () const noexcept

void	setName (string const &name)

void	setName (char const *name)

void	setName (string &&name)

virtual char const *	id_str () const noexcept override

Public Member Functions inherited from zth::RefCounted
	RefCounted () noexcept

virtual	~RefCounted () noexcept

void	used () noexcept

bool	unused () noexcept

size_t	refs () const noexcept

Static Public Attributes
static FiberHook *	hookNew = nullptr
	Hook to be called when a Fiber is created.

static FiberHook *	hookDead = nullptr
	Hook to be called when a Fiber is destroyed.

static uintptr_t const	ExitUnknown = (uintptr_t)-1

Protected Member Functions
void	setState (State state, Timestamp const &t=Timestamp::now()) noexcept

void	fiberEntry_ () noexcept

Protected Member Functions inherited from zth::UniqueID< Fiber >
virtual uint64_t	id_ () const noexcept final

Protected Member Functions inherited from zth::NamedUniqueID< Named >
	NamedUniqueID (char const *name=nullptr)

	NamedUniqueID (string const &name)

	NamedUniqueID (string &&name)

Protected Member Functions inherited from zth::UniqueIDBase
virtual	~UniqueIDBase () noexcept=default

Protected Member Functions inherited from zth::RefCounted
virtual void	cleanup () noexcept

Static Protected Member Functions
static void	fiberEntry (void *that) noexcept

Additional Inherited Members
Static Public Member Functions inherited from zth::UniqueID< Fiber >
static uint64_t	getID () noexcept

Detailed Description

The fiber.

This class manages a fiber's context and state, given an entry function.

Usually, don't subclass this class (use zth::Runnable instead), as the zth::Fiber is owned by and part of a zth::Worker's administration. For example, a Fiber object is deleted by the Worker when it is dead.

Examples: measure.cpp.

Definition at line 49 of file fiber.h.

Member Typedef Documentation

◆ Entry

typedef void(* zth::Fiber::Entry) (EntryArg)

Definition at line 72 of file fiber.h.

◆ EntryArg

typedef ContextAttr::EntryArg zth::Fiber::EntryArg

Definition at line 71 of file fiber.h.

◆ FiberHook

typedef void() zth::Fiber::FiberHook(Fiber &)

Definition at line 53 of file fiber.h.

◆ Hook_type

typedef Hook<Fiber&> zth::Fiber::Hook_type

Definition at line 170 of file fiber.h.

Member Enumeration Documentation

◆ State

enum zth::Fiber::State

Enumerator
Uninitialized
New
Ready
Running
Waiting
Suspended
Dead

Definition at line 69 of file fiber.h.

Constructor & Destructor Documentation

◆ Fiber()

zth::Fiber::Fiber	(	Entry	entry,
		EntryArg	arg = `EntryArg()`
	)

inlineexplicit

Definition at line 75 of file fiber.h.

◆ ~Fiber()

virtual zth::Fiber::~Fiber ( )

inlineoverridevirtualnoexcept

Definition at line 95 of file fiber.h.

Member Function Documentation

◆ allowYield()

bool zth::Fiber::allowYield ( Timestamp const & now = Timestamp::now() ) const

inlinenoexcept

Definition at line 275 of file fiber.h.

◆ atCleanup()

void zth::Fiber::atCleanup	(	Hook_type::function_type	f,
		Hook_type::arg_type	arg = `Hook_type::arg_type()`
	)

inline

Definition at line 177 of file fiber.h.

◆ atExit()

void zth::Fiber::atExit	(	Hook_type::function_type	f,
		Hook_type::arg_type	arg = `Hook_type::arg_type()`
	)

inline

Definition at line 172 of file fiber.h.

◆ context()

Context * zth::Fiber::context ( ) const

inlinenoexcept

Examples: measure.cpp.

Definition at line 135 of file fiber.h.

◆ fiberEntry()

static void zth::Fiber::fiberEntry ( void * that )

inlinestaticprotectednoexcept

Definition at line 438 of file fiber.h.

◆ fiberEntry_()

void zth::Fiber::fiberEntry_ ( )

inlineprotectednoexcept

Definition at line 445 of file fiber.h.

◆ fls()

void * zth::Fiber::fls ( ) const

inlinenoexcept

Definition at line 145 of file fiber.h.

◆ init()

int zth::Fiber::init ( Timestamp const & now = Timestamp::now() )

inline

Definition at line 182 of file fiber.h.

◆ kill()

void zth::Fiber::kill ( )

inlinenoexcept

Examples: measure.cpp.

Definition at line 280 of file fiber.h.

◆ nap()

void zth::Fiber::nap ( Timestamp const & sleepUntil = Timestamp::null() )

inlinenoexcept

Definition at line 289 of file fiber.h.

◆ resume()

void zth::Fiber::resume ( )

inlinenoexcept

Definition at line 370 of file fiber.h.

◆ run()

int zth::Fiber::run	(	Fiber &	from,
		Timestamp	now = `Timestamp::now()`
	)

inline

Definition at line 206 of file fiber.h.

◆ runningSince()

Timestamp const & zth::Fiber::runningSince ( ) const

inlinenoexcept

Definition at line 155 of file fiber.h.

◆ setFls()

void zth::Fiber::setFls ( void * data = nullptr )

inlinenoexcept

Definition at line 150 of file fiber.h.

◆ setStackSize()

int zth::Fiber::setStackSize ( size_t size )

inlinenoexcept

Definition at line 116 of file fiber.h.

◆ setState()

void zth::Fiber::setState	(	State	state,
		Timestamp const &	t = `Timestamp::now()`
	)

inlineprotectednoexcept

Definition at line 425 of file fiber.h.

◆ stackSize()

size_t zth::Fiber::stackSize ( ) const

inlinenoexcept

Definition at line 125 of file fiber.h.

◆ stackUsage()

size_t zth::Fiber::stackUsage ( ) const

inline

Definition at line 130 of file fiber.h.

◆ state()

State zth::Fiber::state ( ) const

inlinenoexcept

Definition at line 140 of file fiber.h.

◆ stateEnd()

Timestamp const & zth::Fiber::stateEnd ( ) const

inlinenoexcept

Definition at line 160 of file fiber.h.

◆ str()

string zth::Fiber::str ( ) const

inline

Definition at line 381 of file fiber.h.

◆ suspend()

void zth::Fiber::suspend ( )

inlinenoexcept

Definition at line 345 of file fiber.h.

◆ totalTime()

TimeInterval const & zth::Fiber::totalTime ( ) const

inlinenoexcept

Definition at line 165 of file fiber.h.

◆ wakeup()

void zth::Fiber::wakeup ( )

inlinenoexcept

Definition at line 321 of file fiber.h.

Member Data Documentation

◆ ExitUnknown

uintptr_t const zth::Fiber::ExitUnknown = (uintptr_t)-1

static

Definition at line 73 of file fiber.h.

◆ hookDead

Fiber::FiberHook * zth::Fiber::hookDead = nullptr

static

Hook to be called when a Fiber is destroyed.

This function is called just after the fiber has died.

Definition at line 67 of file fiber.h.

◆ hookNew

Fiber::FiberHook * zth::Fiber::hookNew = nullptr

static

Hook to be called when a Fiber is created.

This function is called after initialization of the fiber.

Definition at line 60 of file fiber.h.

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

include/libzth/fiber.h
src/fiber.cpp

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Entry

◆ EntryArg

◆ FiberHook

◆ Hook_type

Member Enumeration Documentation

◆ State

Constructor & Destructor Documentation

◆ Fiber()

◆ ~Fiber()

Member Function Documentation

◆ allowYield()

◆ atCleanup()

◆ atExit()

◆ context()

◆ fiberEntry()

◆ fiberEntry_()

◆ fls()

◆ init()

◆ kill()

◆ nap()

◆ resume()

◆ run()

◆ runningSince()

◆ setFls()

◆ setStackSize()

◆ setState()

◆ stackSize()

◆ stackUsage()

◆ state()

◆ stateEnd()

◆ str()

◆ suspend()

◆ totalTime()

◆ wakeup()

Member Data Documentation

◆ ExitUnknown

◆ hookDead

◆ hookNew