Public Member Functions | Protected Member Functions | Friends

atscppapi::AsyncReceiver< AsyncProviderType > Class Template Reference

AsyncReceiver is the interface that receivers of async operations must implement. More...

#include <Async.h>

Inherits atscppapi::noncopyable.

Collaboration diagram for atscppapi::AsyncReceiver< AsyncProviderType >:
Collaboration graph
[legend]

Public Member Functions

virtual void handleAsyncComplete (AsyncProviderType &provider)=0
 This method is invoked when the async operation is completed.
virtual ~AsyncReceiver ()

Protected Member Functions

 AsyncReceiver ()

Friends

class Async

Detailed Description

template<typename AsyncProviderType>
class atscppapi::AsyncReceiver< AsyncProviderType >

AsyncReceiver is the interface that receivers of async operations must implement.

It is templated on the type of the async operation provider.

Definition at line 170 of file Async.h.


Constructor & Destructor Documentation

template<typename AsyncProviderType>
virtual atscppapi::AsyncReceiver< AsyncProviderType >::~AsyncReceiver (  )  [inline, virtual]

Definition at line 180 of file Async.h.

template<typename AsyncProviderType>
atscppapi::AsyncReceiver< AsyncProviderType >::AsyncReceiver (  )  [inline, protected]

Definition at line 182 of file Async.h.


Member Function Documentation

template<typename AsyncProviderType>
virtual void atscppapi::AsyncReceiver< AsyncProviderType >::handleAsyncComplete ( AsyncProviderType &  provider  )  [pure virtual]

This method is invoked when the async operation is completed.

The mutex provided during the creation of the async operation will be automatically locked during the invocation of this method.

Parameters:
provider A reference to the provider which completed the async operation.

Friends And Related Function Documentation

template<typename AsyncProviderType>
friend class Async [friend]

Definition at line 183 of file Async.h.


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