Public Member Functions | List of all members
Aws::DataFlow::Task< T > Class Template Referenceabstract

#include <task.h>

Inheritance diagram for Aws::DataFlow::Task< T >:
Inheritance graph
[legend]

Public Member Functions

virtual void cancel ()
 
virtual T & getBatchData ()=0
 
virtual void onComplete (const UploadStatus &status)=0
 
virtual void run (std::shared_ptr< IPublisher< T >> publisher)
 
virtual ~Task ()=default
 

Detailed Description

template<typename T>
class Aws::DataFlow::Task< T >

Define a task (runnable) to get batch data and call a callback when finished with this task.

Template Parameters
T

Definition at line 63 of file task.h.

Constructor & Destructor Documentation

template<typename T >
virtual Aws::DataFlow::Task< T >::~Task ( )
virtualdefault

Member Function Documentation

template<typename T >
virtual void Aws::DataFlow::Task< T >::cancel ( )
inlinevirtual

This task is no longer valid. Call onComplete with a FAIL status.

Definition at line 81 of file task.h.

template<typename T >
virtual T& Aws::DataFlow::Task< T >::getBatchData ( )
pure virtual

Get this task's data

Returns

Implemented in Aws::DataFlow::BasicTask< T >.

template<typename T >
virtual void Aws::DataFlow::Task< T >::onComplete ( const UploadStatus status)
pure virtual

Override this method to handle completion status.

Parameters
status

Implemented in Aws::DataFlow::BasicTask< T >.

template<typename T >
virtual void Aws::DataFlow::Task< T >::run ( std::shared_ptr< IPublisher< T >>  publisher)
inlinevirtual

Run this task with the input publisher. Run calls IPublisher::attemptPublish and then calls onComplete with the resulting IPublisher UploadStatus status.

Parameters
publishermechanism to publish

Definition at line 73 of file task.h.


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


dataflow_lite
Author(s): AWS RoboMaker
autogenerated on Fri May 7 2021 02:18:22