Concurrency::task_options Class Reference

Represents the allowed options for creating a task More...

#include <ppltasks.h>

Public Member Functions
	task_options ()
	Default list of task creation options More...
	task_options (cancellation_token _Token)
	Task option that specify a cancellation token More...
	task_options (task_continuation_context _ContinuationContext)
	Task option that specify a continuation context. This is valid only for continuations (then) More...
	task_options (cancellation_token _Token, task_continuation_context _ContinuationContext)
	Task option that specify a cancellation token and a continuation context. This is valid only for continuations (then) More...
template<typename _SchedType >
	task_options (std::shared_ptr< _SchedType > _Scheduler)
	Task option that specify a scheduler with shared lifetime More...
	task_options (scheduler_interface &_Scheduler)
	Task option that specify a scheduler reference More...
	task_options (scheduler_ptr _Scheduler)
	Task option that specify a scheduler More...
	task_options (const task_options &_TaskOptions)
	Task option copy constructor More...
void	set_cancellation_token (cancellation_token _Token)
	Sets the given token in the options More...
void	set_continuation_context (task_continuation_context _ContinuationContext)
	Sets the given continuation context in the options More...
bool	has_cancellation_token () const
	Indicates whether a cancellation token was specified by the user More...
cancellation_token	get_cancellation_token () const
	Returns the cancellation token More...
task_continuation_context	get_continuation_context () const
	Returns the continuation context More...
bool	has_scheduler () const
	Indicates whether a scheduler n was specified by the user More...
scheduler_ptr	get_scheduler () const
	Returns the scheduler More...

Private Member Functions
task_options const &	operator= (task_options const &_Right)

Private Attributes
scheduler_ptr	_M_Scheduler
cancellation_token	_M_CancellationToken
task_continuation_context	_M_ContinuationContext
details::_Internal_task_options	_M_InternalTaskOptions
bool	_M_HasCancellationToken
bool	_M_HasScheduler

Friends
details::_Internal_task_options &	details::_get_internal_task_options (task_options &)
const details::_Internal_task_options &	details::_get_internal_task_options (const task_options &)

Detailed Description

Represents the allowed options for creating a task

Constructor & Destructor Documentation

Concurrency::task_options::task_options ( )

inline

Default list of task creation options

        : _M_Scheduler(get_ambient_scheduler()),
          _M_CancellationToken(cancellation_token::none()),
          _M_ContinuationContext(task_continuation_context::use_default()),
          _M_HasCancellationToken(false),
          _M_HasScheduler(false)
    {
    }

Concurrency::task_options::task_options ( cancellation_token  _Token )

inline

Task option that specify a cancellation token

        : _M_Scheduler(get_ambient_scheduler()),
          _M_CancellationToken(_Token),
          _M_ContinuationContext(task_continuation_context::use_default()),
          _M_HasCancellationToken(true),
          _M_HasScheduler(false)
    {
    }

Concurrency::task_options::task_options ( task_continuation_context  _ContinuationContext )

inline

Task option that specify a continuation context. This is valid only for continuations (then)

        : _M_Scheduler(get_ambient_scheduler()),
          _M_CancellationToken(cancellation_token::none()),
          _M_ContinuationContext(_ContinuationContext),
          _M_HasCancellationToken(false),
          _M_HasScheduler(false)
    {
    }

Concurrency::task_options::task_options ( cancellation_token  _Token, task_continuation_context  _ContinuationContext  )

inline

Task option that specify a cancellation token and a continuation context. This is valid only for continuations (then)

        : _M_Scheduler(get_ambient_scheduler()),
          _M_CancellationToken(_Token),
          _M_ContinuationContext(_ContinuationContext),
          _M_HasCancellationToken(true),
          _M_HasScheduler(false)
    {
    }

template<typename _SchedType >

Concurrency::task_options::task_options ( std::shared_ptr< _SchedType >  _Scheduler )

inline

Task option that specify a scheduler with shared lifetime

        : _M_Scheduler(std::move(_Scheduler)),
          _M_CancellationToken(cancellation_token::none()),
          _M_ContinuationContext(task_continuation_context::use_default()),
          _M_HasCancellationToken(false),
          _M_HasScheduler(true)
    {
    }

Concurrency::task_options::task_options ( scheduler_interface &  _Scheduler )

inline

Task option that specify a scheduler reference

        : _M_Scheduler(&_Scheduler),
          _M_CancellationToken(cancellation_token::none()),
          _M_ContinuationContext(task_continuation_context::use_default()),
          _M_HasCancellationToken(false),
          _M_HasScheduler(true)
    {
    }

Concurrency::task_options::task_options ( scheduler_ptr  _Scheduler )

inline

Task option that specify a scheduler

        : _M_Scheduler(std::move(_Scheduler)),
          _M_CancellationToken(cancellation_token::none()),
          _M_ContinuationContext(task_continuation_context::use_default()),
          _M_HasCancellationToken(false),
          _M_HasScheduler(true)
    {
    }

Concurrency::task_options::task_options ( const task_options &  _TaskOptions )

inline

Task option copy constructor

        : _M_Scheduler(_TaskOptions.get_scheduler()),
          _M_CancellationToken(_TaskOptions.get_cancellation_token()),
          _M_ContinuationContext(_TaskOptions.get_continuation_context()),
          _M_HasCancellationToken(_TaskOptions.has_cancellation_token()),
          _M_HasScheduler(_TaskOptions.has_scheduler())
    {
    }

Member Function Documentation

cancellation_token Concurrency::task_options::get_cancellation_token ( ) const

inline

Returns the cancellation token

    {
        return _M_CancellationToken;
    }

task_continuation_context Concurrency::task_options::get_continuation_context ( ) const

inline

Returns the continuation context

    {
        return _M_ContinuationContext;
    }

scheduler_ptr Concurrency::task_options::get_scheduler ( ) const

inline

Returns the scheduler

    {
        return _M_Scheduler;
    }

bool Concurrency::task_options::has_cancellation_token ( ) const

inline

Indicates whether a cancellation token was specified by the user

    {
        return _M_HasCancellationToken;
    }

bool Concurrency::task_options::has_scheduler ( ) const

inline

Indicates whether a scheduler n was specified by the user

    {
        return _M_HasScheduler;
    }

task_options const& Concurrency::task_options::operator= ( task_options const &  _Right )

private

void Concurrency::task_options::set_cancellation_token ( cancellation_token  _Token )

inline

Sets the given token in the options

    {
        _M_CancellationToken = _Token;
       _M_HasCancellationToken = true;
    }

void Concurrency::task_options::set_continuation_context ( task_continuation_context  _ContinuationContext )

inline

Sets the given continuation context in the options

    {
        _M_ContinuationContext = _ContinuationContext;
    }

Friends And Related Function Documentation

details::_Internal_task_options& details::_get_internal_task_options ( task_options &  )

friend

const details::_Internal_task_options& details::_get_internal_task_options ( const task_options &  )

friend

Member Data Documentation

cancellation_token Concurrency::task_options::_M_CancellationToken

private

task_continuation_context Concurrency::task_options::_M_ContinuationContext

private

bool Concurrency::task_options::_M_HasCancellationToken

private

bool Concurrency::task_options::_M_HasScheduler

private

details::_Internal_task_options Concurrency::task_options::_M_InternalTaskOptions

private

scheduler_ptr Concurrency::task_options::_M_Scheduler

private

---

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

• VS2017/inc/ppltasks.h