Static Public Member Functions

atscppapi::Async Class Reference

This class provides a method to create an async operation. More...

#include <Async.h>

Inherits atscppapi::noncopyable.

Collaboration diagram for atscppapi::Async:
Collaboration graph
[legend]

Static Public Member Functions

template<typename AsyncProviderType >
static void execute (AsyncReceiver< AsyncProviderType > *event_receiver, AsyncProviderType *provider, shared_ptr< Mutex > mutex)
 This method sets up the dispatch controller to link the async operation provider and receiver and then initiates the operation by invoking the provider.

Detailed Description

This class provides a method to create an async operation.

Definition at line 191 of file Async.h.


Member Function Documentation

template<typename AsyncProviderType >
static void atscppapi::Async::execute ( AsyncReceiver< AsyncProviderType > *  event_receiver,
AsyncProviderType *  provider,
shared_ptr< Mutex mutex 
) [inline, static]

This method sets up the dispatch controller to link the async operation provider and receiver and then initiates the operation by invoking the provider.

Parameters:
event_receiver The receiver of the async complete dispatch.
provider The provider of the async operation.
mutex The mutex that is locked during the dispatch of the async event complete. One will be created if nothing is passed in. Transaction plugins should use TransactionPlugin::getMutex() here and global plugins can pass an appropriate or NULL mutex.

Definition at line 205 of file Async.h.

References atscppapi::Mutex::TYPE_RECURSIVE.


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