LeechCraft::Util::detail::SequenceProxy< Ret, Future, DestructionTag > Class Template Reference

A proxy object allowing type-checked sequencing of actions and responsible for starting the initial action. More...

#include "futures.h"

Public Types
using	Ret_t = Ret

Public Member Functions
	SequenceProxy (Sequencer< Future > *sequencer)
	Constructs a sequencer proxy managing the given sequencer. More...
	SequenceProxy (SequenceProxy &&proxy)=default
	Move-constructs from proxy. More...
template<typename F >
auto	Then (F &&f) -> SequenceProxy< UnwrapFutureType_t< decltype(f(std::declval< Ret >()))>, Future, DestructionTag >
	Adds the functor f to the chain of actions. More...
template<typename F >
auto	Then (F &&f) -> std::enable_if_t< std::is_same< void, decltype(f(std::declval< Ret >()))>::value >
	Adds the funtor f to the chain of actions and closes the chain. More...
template<typename F >
auto	Then (F &&f) -> std::enable_if_t< std::is_same< void, Ret >::value &&std::is_same< void, decltype(f())>::value >
template<typename F >
auto	operator>> (F &&f) -> decltype(this->Then(std::forward< F >(f)))
template<typename F >
SequenceProxy< Ret, Future, std::result_of_t< F()> >	DestructionValue (F &&f)
template<typename F >
void	MultipleResults (F &&f)
template<typename F , typename Finish >
void	MultipleResults (F &&f, Finish &&finish)
template<typename F , typename Finish , typename Start >
void	MultipleResults (F &&f, Finish &&finish, Start &&start)
	operator QFuture< Ret > ()

Public Attributes
	Seq_

Friends
template<typename , typename , typename >
class	SequenceProxy

Detailed Description

template<typename Ret, typename Future, typename DestructionTag>
class LeechCraft::Util::detail::SequenceProxy< Ret, Future, DestructionTag >

A proxy object allowing type-checked sequencing of actions and responsible for starting the initial action.

SequenceProxy manages a Sequencer object, which itself is directly responsible for walking the chain of sequenced actions.

Internally, objects of this class are reference-counted. As soon as the last instance is destroyed, the initial action is started.

Template Parameters

Ret	The type T that QFuture<T> returned by the last chained executor is specialized with.
E0	The type of the first executor.
A0	The types of the arguments to the executor E0.

Definition at line 491 of file futures.h.

Member Typedef Documentation

template<typename Ret , typename Future , typename DestructionTag >

using LeechCraft::Util::detail::SequenceProxy< Ret, Future, DestructionTag >::Ret_t = Ret

Definition at line 511 of file futures.h.

Constructor & Destructor Documentation

template<typename Ret , typename Future , typename DestructionTag >

LeechCraft::Util::detail::SequenceProxy< Ret, Future, DestructionTag >::SequenceProxy ( Sequencer< Future > *  sequencer )

inline

Constructs a sequencer proxy managing the given sequencer.

Parameters

[in]

sequencer

The sequencer to manage.

Definition at line 518 of file futures.h.

References LeechCraft::Util::detail::Sequencer< Future >::Start().

Here is the call graph for this function:

template<typename Ret , typename Future , typename DestructionTag >

LeechCraft::Util::detail::SequenceProxy< Ret, Future, DestructionTag >::SequenceProxy ( SequenceProxy< Ret, Future, DestructionTag > &&  proxy )

default

Move-constructs from proxy.

Parameters

[in]

proxy

The proxy object from which the sequencer should be borrowed.

Member Function Documentation

template<typename Ret , typename Future , typename DestructionTag >

template<typename F >

SequenceProxy<Ret, Future, std::result_of_t<F ()> > LeechCraft::Util::detail::SequenceProxy< Ret, Future, DestructionTag >::DestructionValue ( F &&  f )

inline

Definition at line 599 of file futures.h.

template<typename Ret , typename Future , typename DestructionTag >

template<typename F >

void LeechCraft::Util::detail::SequenceProxy< Ret, Future, DestructionTag >::MultipleResults ( F &&  f )

inline

Definition at line 608 of file futures.h.

template<typename Ret , typename Future , typename DestructionTag >

template<typename F , typename Finish >

void LeechCraft::Util::detail::SequenceProxy< Ret, Future, DestructionTag >::MultipleResults ( F &&  f, Finish &&  finish  )

inline

Definition at line 614 of file futures.h.

template<typename Ret , typename Future , typename DestructionTag >

template<typename F , typename Finish , typename Start >

void LeechCraft::Util::detail::SequenceProxy< Ret, Future, DestructionTag >::MultipleResults ( F &&  f, Finish &&  finish, Start &&  start  )

inline

Definition at line 621 of file futures.h.

template<typename Ret , typename Future , typename DestructionTag >

LeechCraft::Util::detail::SequenceProxy< Ret, Future, DestructionTag >::operator QFuture< Ret > ( )

inline

Definition at line 628 of file futures.h.

References LeechCraft::Util::detail::SequenceProxy< Ret, Future, DestructionTag >::Then().

Here is the call graph for this function:

template<typename Ret , typename Future , typename DestructionTag >

template<typename F >

auto LeechCraft::Util::detail::SequenceProxy< Ret, Future, DestructionTag >::operator>> ( F &&  f ) -> decltype (this->Then (std::forward<F> (f)))

inline

Definition at line 593 of file futures.h.

References LeechCraft::Util::detail::SequenceProxy< Ret, Future, DestructionTag >::Then().

Here is the call graph for this function:

template<typename Ret , typename Future , typename DestructionTag >

template<typename F >

auto LeechCraft::Util::detail::SequenceProxy< Ret, Future, DestructionTag >::Then ( F &&  f ) -> SequenceProxy<UnwrapFutureType_t<decltype (f (std::declval<Ret> ()))>, Future, DestructionTag>

inline

Adds the functor f to the chain of actions.

The functor f should return QFuture<T0> when called with a value of type Ret. That is, the expression f (std::declval<Ret> ()) should be well-formed, and, moreover, its return type should be QFuture<T0> for some T0.

Parameters

[in]

f

The functor to chain.

Returns

An object of type SequencerProxy<T0, E0, A0> ready for chaining new functions.

Template Parameters

F	The type of the functor to chain.

Definition at line 553 of file futures.h.

Referenced by LeechCraft::Util::detail::SequenceProxy< Ret, Future, DestructionTag >::operator QFuture< Ret >(), and LeechCraft::Util::detail::SequenceProxy< Ret, Future, DestructionTag >::operator>>().

Here is the caller graph for this function:

template<typename Ret , typename Future , typename DestructionTag >

template<typename F >

auto LeechCraft::Util::detail::SequenceProxy< Ret, Future, DestructionTag >::Then ( F &&  f ) -> std::enable_if_t<std::is_same<void, decltype (f (std::declval<Ret> ()))>::value>

inline

Adds the funtor f to the chain of actions and closes the chain.

The function f should return void when called with a value of type Ret.

No more functors may be chained after adding a void-returning functor.

Parameters

[in]

f

The functor to chain.

Template Parameters

F	The type of the functor to chain.

Definition at line 575 of file futures.h.

template<typename Ret , typename Future , typename DestructionTag >

template<typename F >

auto LeechCraft::Util::detail::SequenceProxy< Ret, Future, DestructionTag >::Then ( F &&  f ) -> std::enable_if_t<std::is_same<void, Ret>::value && std::is_same<void, decltype (f ())>::value>

inline

Definition at line 584 of file futures.h.

Friends And Related Function Documentation

template<typename Ret , typename Future , typename DestructionTag >

template<typename , typename , typename >

friend class SequenceProxy

friend

Definition at line 494 of file futures.h.

Member Data Documentation

template<typename Ret , typename Future , typename DestructionTag >

LeechCraft::Util::detail::SequenceProxy< Ret, Future, DestructionTag >::Seq_

Initial value:

{ sequencer }
            {
            }

            
            SequenceProxy (const SequenceProxy& proxy) = delete

Definition at line 520 of file futures.h.

---

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

• /home/abuild/rpmbuild/BUILD/leechcraft-0.6.70-9312-g4cc613a2df/src/util/threads/futures.h