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

#include <Task.hh>

Inheritance diagram for PTL::Task< RetT, Args >:

Public Types
typedef std::future< RetT >	future_type

typedef std::packaged_task< RetT(Args...)>	packaged_task_type

typedef std::promise< RetT >	promise_type

typedef RetT	result_type

typedef size_t	size_type

typedef Task< RetT, Args... >	this_type

typedef std::thread::id	tid_type

typedef std::tuple< Args... >	tuple_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, Args... args)

	Task (const Task &)=delete

template<typename FuncT >
	Task (FuncT func, Args... args)

	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
tuple_type	m_args {}

packaged_task_type	m_ptask {}

Detailed Description

template<typename RetT, typename... Args>
class PTL::Task< RetT, Args >

The task class is supplied to thread_pool.

Definition at line 131 of file Task.hh.

Member Typedef Documentation

◆ future_type

template<typename RetT , typename... Args>

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

Definition at line 136 of file Task.hh.

◆ packaged_task_type

template<typename RetT , typename... Args>

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

Definition at line 137 of file Task.hh.

◆ promise_type

template<typename RetT , typename... Args>

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

Definition at line 135 of file Task.hh.

◆ result_type

template<typename RetT , typename... Args>

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

Definition at line 138 of file Task.hh.

◆ size_type

typedef size_t PTL::VTask::size_type

inherited

Definition at line 57 of file VTask.hh.

◆ this_type

template<typename RetT , typename... Args>

typedef Task<RetT, Args...> PTL::Task< RetT, Args >::this_type

Definition at line 134 of file Task.hh.

◆ tid_type

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

inherited

Definition at line 56 of file VTask.hh.

◆ tuple_type

template<typename RetT , typename... Args>

typedef std::tuple<Args...> PTL::Task< RetT, Args >::tuple_type

Definition at line 139 of file Task.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 RetT , typename... Args>

template<typename FuncT >

PTL::Task< RetT, Args >::Task	(	FuncT	func,
		Args...	args
	)

inline

Definition at line 143 of file Task.hh.

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

◆ Task() [2/4]

template<typename RetT , typename... Args>

template<typename FuncT >

PTL::Task< RetT, Args >::Task	(	bool	_is_native,
		intmax_t	_depth,
		FuncT	func,
		Args...	args
	)

inline

Definition at line 150 of file Task.hh.

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

◆ ~Task()

template<typename RetT , typename... Args>

virtual PTL::Task< RetT, Args >::~Task ( )

virtualdefault

◆ Task() [3/4]

template<typename RetT , typename... Args>

PTL::Task< RetT, Args >::Task ( const Task< RetT, Args > & )

delete

◆ Task() [4/4]

template<typename RetT , typename... Args>

PTL::Task< RetT, Args >::Task ( Task< RetT, Args > && )

default

Member Function Documentation

◆ depth()

intmax_t PTL::VTask::depth ( ) const

inlineinherited

Definition at line 78 of file VTask.hh.

78{ return m_depth; }

PTL::VTask::m_depth

intmax_t m_depth

Definition: VTask.hh:82

References PTL::VTask::m_depth.

◆ get()

template<typename RetT , typename... Args>

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

inlinefinalvirtual

Implements PTL::TaskFuture< RetT >.

Definition at line 173 of file Task.hh.

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

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

◆ get_future()

template<typename RetT , typename... Args>

virtual future_type PTL::Task< RetT, Args >::get_future ( )

inlinefinalvirtual

Implements PTL::TaskFuture< RetT >.

Definition at line 171 of file Task.hh.

171{ 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.

77{ return m_is_native; }

PTL::VTask::m_is_native

bool m_is_native

Definition: VTask.hh:81

References PTL::VTask::m_is_native.

◆ operator()()

template<typename RetT , typename... Args>

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

inlinefinalvirtual

Implements PTL::VTask.

Definition at line 166 of file Task.hh.

    {
        if(m_ptask.valid())
            mpl::apply(std::move(m_ptask), std::move(m_args));
    }

References PTL::mpl::apply(), PTL::Task< RetT, Args >::m_args, and PTL::Task< RetT, Args >::m_ptask.

◆ operator=() [1/2]

template<typename RetT , typename... Args>

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

delete

◆ operator=() [2/2]

template<typename RetT , typename... Args>

Task & PTL::Task< RetT, Args >::operator= ( Task< RetT, Args > && )

default

◆ wait()

template<typename RetT , typename... Args>

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

inlinefinalvirtual

Implements PTL::TaskFuture< RetT >.

Definition at line 172 of file Task.hh.

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

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

Field Documentation

◆ m_args

template<typename RetT , typename... Args>

tuple_type PTL::Task< RetT, Args >::m_args {}

private

Definition at line 177 of file Task.hh.

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

◆ 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

template<typename RetT , typename... Args>

packaged_task_type PTL::Task< RetT, Args >::m_ptask {}

private

Definition at line 176 of file Task.hh.

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

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

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

Public Types

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ future_type

◆ packaged_task_type

◆ promise_type

◆ result_type

◆ size_type

◆ this_type

◆ tid_type

◆ tuple_type

◆ void_func_t

Constructor & Destructor Documentation

◆ Task() [1/4]

◆ Task() [2/4]

◆ ~Task()

◆ Task() [3/4]

◆ Task() [4/4]

Member Function Documentation

◆ depth()

◆ get()

◆ get_future()

◆ is_native_task()

◆ operator()()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ wait()

Field Documentation

◆ m_args

◆ m_depth

◆ m_func

◆ m_is_native

◆ m_ptask