PTL::VTask Class Reference

VTask is the abstract class stored in thread_pool. More...

#include <VTask.hh>

Inheritance diagram for PTL::VTask:

Public Types
typedef std::thread::id	tid_type
typedef size_t	size_type
typedef VTask	this_type
typedef std::atomic_uintmax_t	count_t
typedef VTask *	iterator
typedef const VTask *	const_iterator
typedef std::function< void()>	void_func_t

Public Member Functions
	VTask ()
	VTask (VTaskGroup *task_group)
	VTask (ThreadPool *pool)
virtual	~VTask ()
virtual void	operator() ()=0
void	operator-- ()
virtual bool	is_native_task () const
virtual ThreadPool *	pool () const
VTaskGroup *	group () const
iterator	begin ()
iterator	end ()
const_iterator	begin () const
const_iterator	end () const
const_iterator	cbegin () const
const_iterator	cend () const
intmax_t &	depth ()
const intmax_t &	depth () const

Static Protected Member Functions
static tid_type	this_tid ()

Protected Attributes
intmax_t	m_depth
VTaskGroup *	m_group
ThreadPool *	m_pool
void_func_t	m_func = []() {}

Detailed Description

VTask is the abstract class stored in thread_pool.

Definition at line 54 of file VTask.hh.

Member Typedef Documentation

const_iterator

typedef const VTask* PTL::VTask::const_iterator

Definition at line 62 of file VTask.hh.

count_t

typedef std::atomic_uintmax_t PTL::VTask::count_t

Definition at line 60 of file VTask.hh.

iterator

typedef VTask* PTL::VTask::iterator

Definition at line 61 of file VTask.hh.

size_type

typedef size_t PTL::VTask::size_type

Definition at line 58 of file VTask.hh.

this_type

typedef VTask PTL::VTask::this_type

Definition at line 59 of file VTask.hh.

tid_type

typedef std::thread::id PTL::VTask::tid_type

Definition at line 57 of file VTask.hh.

void_func_t

typedef std::function<void()> PTL::VTask::void_func_t

Definition at line 63 of file VTask.hh.

Constructor & Destructor Documentation

VTask() [1/3]

VTask::VTask

(

)

Definition at line 40 of file VTask.cc.

: m_depth(0)
, m_group(nullptr)
, m_pool(nullptr)
{}

VTask() [2/3]

VTask::VTask ( VTaskGroup *  task_group )

explicit

Definition at line 48 of file VTask.cc.

: m_depth(0)
, m_group(task_group)
, m_pool((m_group) ? task_group->pool() : nullptr)
{}

VTask() [3/3]

VTask::VTask ( ThreadPool *  pool )

explicit

Definition at line 56 of file VTask.cc.

: m_depth(0)
, m_group(nullptr)
, m_pool(tp)
{}

~VTask()

VTask::~VTask ( )

virtual

Definition at line 64 of file VTask.cc.

{}

Member Function Documentation

begin() [1/2]

iterator PTL::VTask::begin ( )

inline

Definition at line 84 of file VTask.hh.

{ return this; }

begin() [2/2]

const_iterator PTL::VTask::begin ( ) const

inline

Definition at line 87 of file VTask.hh.

{ return this; }

cbegin()

const_iterator PTL::VTask::cbegin ( ) const

inline

Definition at line 90 of file VTask.hh.

{ return this; }

cend()

const_iterator PTL::VTask::cend ( ) const

inline

Definition at line 91 of file VTask.hh.

{ return this + 1; }

depth() [1/2]

intmax_t & PTL::VTask::depth ( )

inline

Definition at line 93 of file VTask.hh.

{ return m_depth; }

depth() [2/2]

const intmax_t & PTL::VTask::depth ( ) const

inline

Definition at line 94 of file VTask.hh.

{ return m_depth; }

end() [1/2]

iterator PTL::VTask::end ( )

inline

Definition at line 85 of file VTask.hh.

{ return this + 1; }

end() [2/2]

const_iterator PTL::VTask::end ( ) const

inline

Definition at line 88 of file VTask.hh.

{ return this + 1; }

group()

VTaskGroup * PTL::VTask::group ( ) const

inline

Definition at line 80 of file VTask.hh.

{ return m_group; }

Referenced by PTL::ThreadPool::run_on_this().

is_native_task()

bool VTask::is_native_task ( ) const

virtual

Reimplemented in PTL::PackagedTask< RetT, Args >, PTL::Task< RetT, Args >, PTL::Task< RetT, void >, and PTL::Task< void, void >.

Definition at line 95 of file VTask.cc.

{
    return (m_group) ? m_group->is_native_task_group() : false;
}

Referenced by PTL::ThreadPool::add_task().

operator()()

virtual void PTL::VTask::operator() ( )

pure virtual

Implemented in PTL::Task< RetT, Args >, PTL::Task< RetT, void >, PTL::Task< void, void >, and PTL::PackagedTask< RetT, Args >.

operator--()

void VTask::operator--

(

)

Definition at line 69 of file VTask.cc.

{
    if(m_group)
    {
        intmax_t _count = --(*m_group);
        if(_count < 2)
        {
            try
            {
                m_group->task_cond()->notify_all();
            } catch(std::system_error& e)
            {
                auto     tid = ThreadPool::get_this_thread_id();
                AutoLock l(TypeMutex<decltype(std::cerr)>(), std::defer_lock);
                if(!l.owns_lock())
                    l.lock();
                std::cerr << "[" << tid << "] Caught system error: " << e.what()
                          << std::endl;
            }
        }
    }
}

Referenced by PTL::Task< RetT, Args >::operator()(), PTL::Task< RetT, void >::operator()(), and PTL::Task< void, void >::operator()().

pool()

ThreadPool * VTask::pool ( ) const

virtual

Definition at line 103 of file VTask.cc.

{
    return (!m_pool && m_group) ? m_group->pool() : m_pool;
}

this_tid()

static tid_type PTL::VTask::this_tid ( )

inlinestaticprotected

Definition at line 97 of file VTask.hh.

{ return std::this_thread::get_id(); }

Member Data Documentation

m_depth

intmax_t PTL::VTask::m_depth

protected

Definition at line 100 of file VTask.hh.

Referenced by depth().

m_func

void_func_t PTL::VTask::m_func = []() {}

protected

Definition at line 103 of file VTask.hh.

m_group

VTaskGroup* PTL::VTask::m_group

protected

Definition at line 101 of file VTask.hh.

Referenced by group(), is_native_task(), operator--(), and pool().

m_pool

ThreadPool* PTL::VTask::m_pool

protected

Definition at line 102 of file VTask.hh.

Referenced by pool().

---

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

• VTask.hh
• VTask.cc