#include <thread.hpp>

Public Member Functions
	thread (const std::string &name="", thread_idle_notifier *notifier=0)

	thread (thread &&m)=delete

thread &	operator= (thread &&t)=delete

const string &	name () const
	returns the name given by set_name() for this thread More...

void	set_name (const string &n)
	associates a name with this thread. More...

const char *	current_task_desc () const

void	debug (const std::string &d)
	print debug info about the state of every context / promise. More...

template<typename Functor >
auto	async (Functor &&f, const char *desc FC_TASK_NAME_DEFAULT_ARG, priority prio=priority()) -> fc::future< decltype(f())>

void	poke ()

template<typename Functor >
auto	schedule (Functor &&f, const fc::time_point &when, const char *desc FC_TASK_NAME_DEFAULT_ARG, priority prio=priority()) -> fc::future< decltype(f())>

void	quit ()

void	signal (int)

bool	is_running () const

bool	is_current () const

priority	current_priority () const

	~thread ()

template<typename T1 , typename T2 >
int	wait_any (const fc::future< T1 > &f1, const fc::future< T2 > &f2, const microseconds &timeout_us=microseconds::maximum())

Static Public Member Functions
static thread &	current ()

static void	cleanup ()

Friends
class	promise_base

class	task_base

class	thread_d

class	mutex

class	detail::worker_pool

class	non_preemptable_scope_check

void *	detail::get_thread_specific_data (unsigned slot)

void	detail::set_thread_specific_data (unsigned slot, void new_value, void(cleanup)(void *))

unsigned	detail::get_next_unused_task_storage_slot ()

void *	detail::get_task_specific_data (unsigned slot)

void	detail::set_task_specific_data (unsigned slot, void new_value, void(cleanup)(void *))

void	yield ()

void	usleep (const microseconds &)

void	sleep_until (const time_point &)

void	exec ()

int	wait_any (std::vector< promise_base::ptr > &&v, const microseconds &)

int	wait_any_until (std::vector< promise_base::ptr > &&v, const time_point &tp)

Detailed Description

Definition at line 39 of file thread.hpp.

Constructor & Destructor Documentation

◆ thread() [1/2]

fc::thread::thread	(	const std::string &	name = `""`,
		thread_idle_notifier *	notifier = `0`
	)

Definition at line 74 of file thread.cpp.

◆ thread() [2/2]

fc::thread::thread ( thread && m )

delete

◆ ~thread()

fc::thread::~thread ( )

Definition at line 116 of file thread.cpp.

Member Function Documentation

◆ async()

template<typename Functor >

auto fc::thread::async	(	Functor &&	f,
		const char *desc	FC_TASK_NAME_DEFAULT_ARG,
		priority	prio = `priority()`
	)		-> fc::future<decltype(f())>

inline

Calls function f in this thread and returns a future<T> that can be used to wait on the result.

Parameters

f	the operation to perform
prio	the priority relative to other tasks

Definition at line 87 of file thread.hpp.

◆ cleanup()

void fc::thread::cleanup ( )

static

Definition at line 131 of file thread.cpp.

◆ current()

thread & fc::thread::current ( )

static

Returns the current thread. Note: Creates fc::thread object (but not a boost thread) if no current thread assigned yet (this can happend if current() is called from the main thread of application or from an existing "unknown" boost thread). In such cases, thread_d doesn't have access boost::thread object.

Definition at line 125 of file thread.cpp.

◆ current_priority()

priority fc::thread::current_priority ( ) const

Definition at line 269 of file thread.cpp.

◆ current_task_desc()

const char * fc::thread::current_task_desc ( ) const

Definition at line 154 of file thread.cpp.

◆ debug()

void fc::thread::debug ( const std::string & d )

print debug info about the state of every context / promise.

This method is helpful to figure out where your program is 'hung' by listing every async operation (context) and what it is blocked on (future).

Note: debug info is more useful if you provide a description for your async tasks and promises.

Definition at line 161 of file thread.cpp.

◆ is_current()

bool fc::thread::is_current ( ) const

Definition at line 479 of file thread.cpp.

◆ is_running()

bool fc::thread::is_running ( ) const

Returns: true unless quit() has been called.

Definition at line 264 of file thread.cpp.

◆ name()

const string & fc::thread::name ( ) const

returns the name given by set_name() for this thread

Definition at line 138 of file thread.cpp.

◆ operator=()

thread& fc::thread::operator= ( thread && t )

delete

◆ poke()

void fc::thread::poke ( )

Definition at line 340 of file thread.cpp.

◆ quit()

void fc::thread::quit ( )

This method will cancel all pending tasks causing them to throw cmt::error::thread_quit.

If the current thread is not this thread, then the current thread will wait for this thread to exit.

This is a blocking wait via boost::thread::join and other tasks in the current thread will not run while waiting for this thread to quit.

Todo:: make quit non-blocking of the calling thread by eliminating the call to boost::thread::join

Definition at line 174 of file thread.cpp.

◆ schedule()

template<typename Functor >

auto fc::thread::schedule	(	Functor &&	f,
		const fc::time_point &	when,
		const char *desc	FC_TASK_NAME_DEFAULT_ARG,
		priority	prio = `priority()`
	)		-> fc::future<decltype(f())>

inline

Calls function f in this thread and returns a future<T> that can be used to wait on the result.

Parameters

f	the method to be called
prio	the priority of this method relative to others
when	determines when this call will happen, as soon as possible after `when`

Definition at line 110 of file thread.hpp.

◆ set_name()

void fc::thread::set_name ( const string & n )

associates a name with this thread.

Definition at line 143 of file thread.cpp.

◆ signal()

void fc::thread::signal ( int sig )

Send signal to underlying native thread. Only for Linux and macOS

Definition at line 167 of file thread.cpp.

◆ wait_any()

template<typename T1 , typename T2 >

int fc::thread::wait_any	(	const fc::future< T1 > &	f1,
		const fc::future< T2 > &	f2,
		const microseconds &	timeout_us = `microseconds::maximum()`
	)

inline

Definition at line 150 of file thread.hpp.

Friends And Related Function Documentation

◆ detail::get_next_unused_task_storage_slot

unsigned detail::get_next_unused_task_storage_slot ( )

friend

◆ detail::get_task_specific_data

void* detail::get_task_specific_data ( unsigned slot )

friend

◆ detail::get_thread_specific_data

void* detail::get_thread_specific_data ( unsigned slot )

friend

◆ detail::set_task_specific_data

void detail::set_task_specific_data	(	unsigned	slot,
		void *	new_value,
		void()(void )	cleanup
	)

friend

◆ detail::set_thread_specific_data

void detail::set_thread_specific_data	(	unsigned	slot,
		void *	new_value,
		void()(void )	cleanup
	)

friend

◆ detail::worker_pool

friend class detail::worker_pool

friend

Definition at line 162 of file thread.hpp.

◆ exec

void fc::thread::exec ( )

friend

Enters the main loop processing tasks until quit() is called.

Definition at line 375 of file thread.cpp.

◆ mutex

friend class mutex

friend

Definition at line 161 of file thread.hpp.

◆ non_preemptable_scope_check

friend class non_preemptable_scope_check

friend

Definition at line 169 of file thread.hpp.

◆ promise_base

friend class promise_base

friend

Definition at line 158 of file thread.hpp.

◆ sleep_until

void fc::thread::sleep_until ( const time_point & tp )

friend

Yields until the specified time in the future.

Definition at line 371 of file thread.cpp.

◆ task_base

friend class task_base

friend

Definition at line 159 of file thread.hpp.

◆ thread_d

friend class thread_d

friend

Definition at line 160 of file thread.hpp.

◆ usleep

void usleep ( const microseconds & u )

friend

Yields to other ready tasks for u microseconds.

Definition at line 368 of file thread.cpp.

◆ wait_any

int wait_any	(	std::vector< promise_base::ptr > &&	v,
		const microseconds &	timeout_us = `microseconds::maximum()`
	)

friend

Definition at line 380 of file thread.cpp.

◆ wait_any_until

int fc::thread::wait_any_until	(	std::vector< promise_base::ptr > &&	v,
		const time_point &	tp
	)

friend

Definition at line 385 of file thread.cpp.

◆ yield

void yield ( )

friend

Yields to other ready tasks before returning.

Definition at line 365 of file thread.cpp.

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

libraries/fc/include/fc/thread/thread.hpp
libraries/fc/src/thread/thread.cpp

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ thread() [1/2]

◆ thread() [2/2]

◆ ~thread()

Member Function Documentation

◆ async()

◆ cleanup()

◆ current()

◆ current_priority()

◆ current_task_desc()

◆ debug()

◆ is_current()

◆ is_running()

◆ name()

◆ operator=()

◆ poke()

◆ quit()

◆ schedule()

◆ set_name()

◆ signal()

◆ wait_any()

Friends And Related Function Documentation

◆ detail::get_next_unused_task_storage_slot

◆ detail::get_task_specific_data

◆ detail::get_thread_specific_data

◆ detail::set_task_specific_data

◆ detail::set_thread_specific_data

◆ detail::worker_pool

◆ exec

◆ mutex

◆ non_preemptable_scope_check

◆ promise_base

◆ sleep_until

◆ task_base

◆ thread_d

◆ usleep

◆ wait_any

◆ wait_any_until

◆ yield