Public Attributes
std::shared_ptr< std::shared_mutex >	async_mutex_

std::any	async_state_

std::shared_ptr< bool >	is_completed_

Public Member Functions
	async_result_invoke (std::any async_state)

std::shared_mutex &	async_mutex () override
	Gets a std::mutex that is used to wait for an asynchronous operation to complete.

std::any	async_state () const noexcept override
	Gets a user-defined object that qualifies or contains information about an asynchronous operation.

bool	completed_synchronously () const noexcept override
	Gets a value that indicates whether the asynchronous operation completed synchronously.

bool	is_completed () const noexcept override
	Gets a value that indicates whether the asynchronous operation has completed.

virtual std::shared_mutex &	async_mutex ()=0
	Gets a std::mutex that is used to wait for an asynchronous operation to complete.

virtual std::any	async_state () const noexcept=0
	Gets a user-defined object that qualifies or contains information about an asynchronous operation.

virtual bool	completed_synchronously () const noexcept=0
	Gets a value that indicates whether the asynchronous operation completed synchronously.

virtual bool	is_completed () const noexcept=0
	Gets a value that indicates whether the asynchronous operation has completed.

Member Function Documentation

◆ async_mutex()

std::shared_mutex & xtd::forms::control::async_result_invoke::async_mutex ( )

inlineoverridevirtual

Gets a std::mutex that is used to wait for an asynchronous operation to complete.

Returns: A std::mutex that is used to wait for an asynchronous operation to complete.

Remarks: The return value allows the client to wait for an asynchronous operation to complete instead of polling xtd::iasync_result::is_completed until the operation concludes. The return value can be used to perform a wait operation.

Notes to Implementers: The object that implements xtd::iasync_result does not need to create the std::mutex until the xtd::iasync_result::async_mutex property is read. It is the choice of the xtd::iasync_result implementer. However, if the implementer creates xtd::iasync_result::async_mutex, it is the responsibility of the implementer to signal the std::mutex that will terminate the wait at the appropriate time. Once created, xtd::iasync_result xtd::iasync_result::async_mutex should be kept alive until the user calls the method that concludes the asynchronous operation. At that time the object behind xtd::iasync_result::async_mutex can be discarded.

Notes to Callers: Clients that wait for the operation to complete (as opposed to polling) use this property to obtain a synchronization object to wait on.

std::any xtd::forms::control::async_result_invoke::async_state ( ) const

inlineoverridevirtualnoexcept

Gets a user-defined object that qualifies or contains information about an asynchronous operation.

Returns: A user-defined object that qualifies or contains information about an asynchronous operation.

Remarks: This property returns the object that is the last parameter of the method that initiates an asynchronous operation.

Notes to Implementers: Implement this property to allow the caller of an asynchronous operation to obtain an application-defined object specified at the start of the operation.

Notes to Callers: This object can be used to pass state information for the asynchronous operation to an AsyncCallback that you provide.

bool xtd::forms::control::async_result_invoke::completed_synchronously ( ) const

inlineoverridevirtualnoexcept

Gets a value that indicates whether the asynchronous operation completed synchronously.

Returns: true if the asynchronous operation completed synchronously; otherwise, false.

Remarks: If the synchronous completion of the call is detected in the xtd::async_callback delegate, it is probable that the thread that initiated the asynchronous operation is the current thread.

Notes to Callers: Use this property to determine if the asynchronous operation completed synchronously. For example, this property can return true for an asynchronous I/O operation if the I/O request was small.

bool xtd::forms::control::async_result_invoke::is_completed ( ) const

inlineoverridevirtualnoexcept

Gets a value that indicates whether the asynchronous operation has completed.

Remarks: When this property is true, you can assume it is safe to discard any resources you allocate for use by the asynchronous operation.

Notes to Implementers: Implementers will typically return the value of a private field or internal test as the value of this property.

Notes to Callers: Clients that poll for operation status (as opposed to waiting on a synchronization object) use this property to determine the status of the operation.

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