C++ Rest SDK: pplx::task_options Class Reference

Logo

C++ Rest SDK

The C++ REST SDK is a Microsoft project for cloud-based client-server communication in native code using a modern asynchronous C++ API design. This project aims to help C++ developers connect to and interact with services.

[フレーム]

Public Member Functions | Friends | List of all members

pplx::task_options Class Reference

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

#include <pplxtasks.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...

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

pplx::task_options::task_options ( )

inline

Default list of task creation options

pplx::task_options::task_options ( cancellation_token _Token )

inline

Task option that specify a cancellation token

pplx::task_options::task_options ( task_continuation_context _ContinuationContext )

inline

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

pplx::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)

template<typename _SchedType >

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

inline

Task option that specify a scheduler with shared lifetime

pplx::task_options::task_options ( scheduler_interface & _Scheduler )

inline

Task option that specify a scheduler reference

pplx::task_options::task_options ( scheduler_ptr _Scheduler )

inline

Task option that specify a scheduler

pplx::task_options::task_options ( const task_options & _TaskOptions )

inline

Task option copy constructor

Member Function Documentation

cancellation_token pplx::task_options::get_cancellation_token ( ) const

inline

Returns the cancellation token

task_continuation_context pplx::task_options::get_continuation_context ( ) const

inline

Returns the continuation context

scheduler_ptr pplx::task_options::get_scheduler ( ) const

inline

Returns the scheduler

bool pplx::task_options::has_cancellation_token ( ) const

inline

Indicates whether a cancellation token was specified by the user

bool pplx::task_options::has_scheduler ( ) const

inline

Indicates whether a scheduler n was specified by the user

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

inline

Sets the given token in the options

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

inline

Sets the given continuation context in the options

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

include/pplx/pplxtasks.h

Generated by doxygen 1.8.10