xtd::threading::tasks::task< result_t > Class Template Reference

Inheritance diagram for xtd::threading::tasks::task< result_t >:

Definition

template<typename result_t>
class xtd::threading::tasks::task< result_t >

Represents an asynchronous operation.

Namespace

xtd::threading::tasks

Library

xtd.core

Classes
struct	promise_type
struct	awaiter

Public Constructors
	task (const xtd::func< result_t > &funcfunc)
	task (const xtd::func< result_t > &funcfunc, const xtd::threading::cancellation_token &cancellation_token)
	task (const xtd::func< result_t, const xtd::any_object & > &funcfunc, const xtd::any_object &state)
	task (const xtd::func< result_t, const xtd::any_object & > &funcfunc, const xtd::any_object &state, const xtd::threading::cancellation_token &cancellation_token)

Public Properties
auto	result () const -> const result_t &

Public Operators
auto	operator co_await () noexcept

Public Static Methods
static auto	from_result (result_t result) -> task

Additional Inherited Members
static constexpr xtd::usize	wait_timeout
	Indicates that a xtd::threading::wait_handle::wait_any operation timed out before any of the wait handles were signaled. This field is constant.
	basic_task (const xtd::func< result_t > &funcfunc)
	Initializes a new xtd::threading::tasks::basic_task <result_t> with the specified function.
auto	async_state () const noexcept -> xtd::any_object override
	Gets a user-defined object that qualifies or contains information about an asynchronous operation.
auto	creation_options () const noexcept -> xtd::threading::tasks::task_creation_options
auto	exception () const noexcept -> xtd::ref< xtd::exception >
auto	id () const noexcept -> xtd::usize override
	Gets an ID for this xtd::threading::tasks::task instance.
auto	is_canceled () const noexcept -> bool
auto	is_completed () const noexcept -> bool override
	Gets a value that indicates whether the asynchronous operation has completed.
auto	is_faulted () const noexcept -> bool
auto	status () const noexcept -> xtd::threading::tasks::task_status
auto	continue_with (xtd::action<> continuation) -> void
auto	rethrow_exception () -> void
auto	run_synchronously () -> void
auto	start () -> void override
	Starts the xtd::threading::tasks::task, scheduling it for execution to the current xtd::threading::tasks::task_scheduler.
auto	wait () -> void override
	Waits for the xtd::threading::tasks::task to complete execution.
	object ()=default
	Create a new instance of the ultimate base class object.
virtual auto	equals (const object &obj) const noexcept -> bool
	Determines whether the specified object is equal to the current object.
virtual auto	get_hash_code () const noexcept -> xtd::usize
	Serves as a hash function for a particular type.
virtual auto	get_type () const noexcept -> type_object
	Gets the type of the current instance.
template<typename object_t>
auto	memberwise_clone () const -> xtd::unique_ptr_object< object_t >
	Creates a shallow copy of the current object.
virtual auto	to_string () const -> xtd::string
	Returns a xtd::string that represents the current object.
virtual auto	wait (xtd::int32 milliseconds_timeout) -> bool=0
	Waits for the task to complete execution with specified milliseconds timout.
virtual auto	wait (xtd::int32 milliseconds_timeout, xtd::threading::cancellation_token &cancellation_token) -> bool=0
	Waits for the task to complete execution with specified milliseconds timout and cancellation token.
virtual auto	wait (const xtd::time_span &timeout) -> bool=0
	Waits for the task to complete execution with specified timout.
virtual auto	wait (const xtd::time_span &timeout, xtd::threading::cancellation_token &cancellation_token) -> bool=0
	Waits for the task to complete execution with specified timout and cancellation token.
static auto	completed_task () -> task< result_t >
static auto	current_id () noexcept -> xtd::usize
static auto	factory () noexcept -> const xtd::threading::tasks::task_factory &
static auto	from_cancelation (const xtd::threading::cancellation_token &cancellation_token) -> task< result_t >
static auto	from_exception (from_exception_t exception) -> task< result_t >
static auto	delay (const xtd::time_span &delay) -> task<>
static auto	run (const xtd::func< result_t > &funcfunc) -> task< result_t >
static auto	wait_all (const collection_t &tasks) -> bool
static xtd::usize	wait_any (const collection_t &tasks)
static auto	when_all (items_t &&... items) -> task<>
static auto	when_any (items_t &&... items) -> task< xtd::usize >
template<typename object_a_t, typename object_b_t>
static auto	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are the same instance.

---

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

• xtd.core/include/xtd/threading/tasks/task_result.hpp