atscppapi::AsyncProvider Class Reference

AsyncProvider is the interface that providers of async operations must implement. The system allows decoupling of the lifetime/scope of provider and receiver objects. The receiver object might have expired before the async operation is complete and the system handles this case. Because of this decoupling, it is the responsibility of the provider to manage it's expiration - self-destruct on completion is a good option. More...

#include "Async.h"

Inheritance diagram for atscppapi::AsyncProvider:

Public Member Functions
virtual void	run (shared_ptr< AsyncDispatchControllerBase > dispatch_controller)=0

Detailed Description

AsyncProvider is the interface that providers of async operations must implement. The system allows decoupling of the lifetime/scope of provider and receiver objects. The receiver object might have expired before the async operation is complete and the system handles this case. Because of this decoupling, it is the responsibility of the provider to manage it's expiration - self-destruct on completion is a good option.

Member Function Documentation

virtual void atscppapi::AsyncProvider::run ( shared_ptr< AsyncDispatchControllerBase >  dispatch_controller )

pure virtual

This method is invoked when the async operation is requested. This call should be used to just start the async operation and not block this thread.

Parameters

dispatch_controller

provides a way to dispatch an "async complete" event to the requester.

Implemented in atscppapi::AsyncHttpFetch, and atscppapi::AsyncTimer.

---

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

• src/include/atscppapi/Async.h