PTL::Task< void, void > Class Reference

The task class is supplied to thread_pool. More...

#include <Task.hh>

Inheritance diagram for PTL::Task< void, void >:

Public Types
typedef std::future< RetT >	future_type
typedef std::packaged_task< RetT()>	packaged_task_type
typedef std::promise< RetT >	promise_type
typedef RetT	result_type
typedef void	RetT
typedef size_t	size_type
typedef Task< void, void >	this_type
typedef std::thread::id	tid_type
typedef std::function< void()>	void_func_t

Public Member Functions
intmax_t	depth () const
virtual RetT	get () final
virtual future_type	get_future () final
bool	is_native_task () const
virtual void	operator() () final
Task &	operator= (const Task &)=delete
Task &	operator= (Task &&)=default
template<typename FuncT >
	Task (bool _is_native, intmax_t _depth, FuncT func)
	Task (const Task &)=delete
template<typename FuncT >
	Task (FuncT func)
	Task (Task &&)=default
virtual void	wait () final
virtual	~Task ()=default

Protected Attributes
intmax_t	m_depth = 0
void_func_t	m_func = []() {}
bool	m_is_native = false

Private Attributes
packaged_task_type	m_ptask {}

Detailed Description

The task class is supplied to thread_pool.

Definition at line 229 of file Task.hh.

Member Typedef Documentation

future_type

typedef std::future<RetT> PTL::Task< void, void >::future_type

Definition at line 235 of file Task.hh.

packaged_task_type

typedef std::packaged_task<RetT()> PTL::Task< void, void >::packaged_task_type

Definition at line 236 of file Task.hh.

promise_type

typedef std::promise<RetT> PTL::Task< void, void >::promise_type

Definition at line 234 of file Task.hh.

result_type

typedef RetT PTL::Task< void, void >::result_type

Definition at line 237 of file Task.hh.

RetT

typedef void PTL::Task< void, void >::RetT

Definition at line 232 of file Task.hh.

size_type

typedef size_t PTL::VTask::size_type

inherited

Definition at line 57 of file VTask.hh.

this_type

typedef Task<void, void> PTL::Task< void, void >::this_type

Definition at line 233 of file Task.hh.

tid_type

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

inherited

Definition at line 56 of file VTask.hh.

void_func_t

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

inherited

Definition at line 58 of file VTask.hh.

Constructor & Destructor Documentation

Task() [1/4]

template<typename FuncT >

PTL::Task< void, void >::Task ( FuncT  func )

inlineexplicit

Definition at line 241 of file Task.hh.

    : TaskFuture<RetT>{}
    , m_ptask{ std::move(func) }
    {}

Task() [2/4]

template<typename FuncT >

PTL::Task< void, void >::Task ( bool  _is_native, intmax_t  _depth, FuncT  func  )

inline

Definition at line 247 of file Task.hh.

    : TaskFuture<RetT>{ _is_native, _depth }
    , m_ptask{ std::move(func) }
    {}

~Task()

virtual PTL::Task< void, void >::~Task ( )

virtualdefault

Task() [3/4]

PTL::Task< void, void >::Task ( const Task< void, void > &  )

delete

Task() [4/4]

PTL::Task< void, void >::Task ( Task< void, void > &&  )

default

Member Function Documentation

depth()

intmax_t PTL::VTask::depth ( ) const

inlineinherited

Definition at line 78 of file VTask.hh.

{ return m_depth; }

References PTL::VTask::m_depth.

get()

virtual RetT PTL::Task< void, void >::get ( )

inlinefinalvirtual

Implements PTL::TaskFuture< void >.

Definition at line 265 of file Task.hh.

{ return m_ptask.get_future().get(); }

References PTL::Task< RetT, Args >::m_ptask.

get_future()

virtual future_type PTL::Task< void, void >::get_future ( )

inlinefinalvirtual

Implements PTL::TaskFuture< void >.

Definition at line 263 of file Task.hh.

{ return m_ptask.get_future(); }

References PTL::Task< RetT, Args >::m_ptask.

is_native_task()

bool PTL::VTask::is_native_task ( ) const

inlineinherited

Definition at line 77 of file VTask.hh.

{ return m_is_native; }

References PTL::VTask::m_is_native.

operator()()

virtual void PTL::Task< void, void >::operator() ( )

inlinefinalvirtual

Implements PTL::VTask.

Definition at line 262 of file Task.hh.

{ m_ptask(); }

References PTL::Task< RetT, Args >::m_ptask.

operator=() [1/2]

Task & PTL::Task< void, void >::operator= ( const Task< void, void > &  )

delete

operator=() [2/2]

Task & PTL::Task< void, void >::operator= ( Task< void, void > &&  )

default

wait()

virtual void PTL::Task< void, void >::wait ( )

inlinefinalvirtual

Implements PTL::TaskFuture< void >.

Definition at line 264 of file Task.hh.

{ return m_ptask.get_future().wait(); }

References PTL::Task< RetT, Args >::m_ptask.

Field Documentation

m_depth

intmax_t PTL::VTask::m_depth = 0

protectedinherited

Definition at line 82 of file VTask.hh.

Referenced by PTL::VTask::depth().

m_func

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

protectedinherited

Definition at line 83 of file VTask.hh.

m_is_native

bool PTL::VTask::m_is_native = false

protectedinherited

Definition at line 81 of file VTask.hh.

Referenced by PTL::VTask::is_native_task().

m_ptask

packaged_task_type PTL::Task< void, void >::m_ptask {}

private

Definition at line 268 of file Task.hh.

---

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

• source/externals/ptl/include/PTL/Task.hh