Aws::Transfer::S3FileRequest Class Reference

#include <S3FileRequest.h>

Inheritance diagram for Aws::Transfer::S3FileRequest:

Public Types
using	S3FileCompletionCallback = std::function< void() >

Public Member Functions
	S3FileRequest (const Aws::String &fileName, const Aws::String &bucketName, const Aws::String &keyName, const std::shared_ptr< Aws::S3::S3Client > &s3Client)
virtual	~S3FileRequest ()
virtual float	GetProgress () const
const Aws::String &	GetBucketName () const
const Aws::String &	GetFileName () const
const Aws::String &	GetKeyName () const
bool	IsDone () const
bool	CompletedSuccessfully () const
virtual bool	WaitUntilDone () const
const Aws::String &	GetFailure () const
void	SetLastFailure (const char *failureString)
virtual bool	IsReady () const =0
virtual uint64_t	GetFileSize () const
uint64_t	GetProgressAmount () const
void	AddCompletionCallback (S3FileCompletionCallback addCallback)

Protected Member Functions
const std::shared_ptr< Aws::S3::S3Client > &	GetS3Client () const
void	Cancel ()
virtual bool	DoCancelAction ()=0
virtual void	SetDone ()
void	SetCompleted ()
void	CompletionSuccess ()
virtual void	CompletionFailure (const char *failureStr)
virtual void	SetFileSize (uint64_t curSize)
void	ClearProgress ()
void	RegisterProgress (int64_t progressAmount)

Detailed Description

Definition at line 39 of file S3FileRequest.h.

Member Typedef Documentation

using Aws::Transfer::S3FileRequest::S3FileCompletionCallback = std::function < void() >

Definition at line 43 of file S3FileRequest.h.

Constructor & Destructor Documentation

Aws::Transfer::S3FileRequest::S3FileRequest	(	const Aws::String &	fileName,
		const Aws::String &	bucketName,
		const Aws::String &	keyName,
		const std::shared_ptr< Aws::S3::S3Client > &	s3Client
	)

virtual Aws::Transfer::S3FileRequest::~S3FileRequest ( )

virtual

Member Function Documentation

void Aws::Transfer::S3FileRequest::AddCompletionCallback

(

S3FileCompletionCallback

addCallback

)

void Aws::Transfer::S3FileRequest::Cancel ( )

protected

void Aws::Transfer::S3FileRequest::ClearProgress ( )

protected

bool Aws::Transfer::S3FileRequest::CompletedSuccessfully

(

)

const

virtual void Aws::Transfer::S3FileRequest::CompletionFailure ( const char *  failureStr )

protectedvirtual

void Aws::Transfer::S3FileRequest::CompletionSuccess ( )

protected

virtual bool Aws::Transfer::S3FileRequest::DoCancelAction ( )

protectedpure virtual

Implemented in Aws::Transfer::UploadFileRequest.

const Aws::String& Aws::Transfer::S3FileRequest::GetBucketName

(

)

const

const Aws::String& Aws::Transfer::S3FileRequest::GetFailure

(

)

const

const Aws::String& Aws::Transfer::S3FileRequest::GetFileName

(

)

const

virtual uint64_t Aws::Transfer::S3FileRequest::GetFileSize ( ) const

inlinevirtual

Definition at line 77 of file S3FileRequest.h.

const Aws::String& Aws::Transfer::S3FileRequest::GetKeyName

(

)

const

virtual float Aws::Transfer::S3FileRequest::GetProgress ( ) const

virtual

uint64_t Aws::Transfer::S3FileRequest::GetProgressAmount

(

)

const

const std::shared_ptr<Aws::S3::S3Client>& Aws::Transfer::S3FileRequest::GetS3Client ( ) const

protected

bool Aws::Transfer::S3FileRequest::IsDone

(

)

const

virtual bool Aws::Transfer::S3FileRequest::IsReady ( ) const

pure virtual

Implemented in Aws::Transfer::DownloadFileRequest.

void Aws::Transfer::S3FileRequest::RegisterProgress ( int64_t  progressAmount )

protected

void Aws::Transfer::S3FileRequest::SetCompleted ( )

protected

virtual void Aws::Transfer::S3FileRequest::SetDone ( )

protectedvirtual

Reimplemented in Aws::Transfer::UploadFileRequest.

virtual void Aws::Transfer::S3FileRequest::SetFileSize ( uint64_t  curSize )

inlineprotectedvirtual

Definition at line 98 of file S3FileRequest.h.

void Aws::Transfer::S3FileRequest::SetLastFailure

(

const char *

failureString

)

virtual bool Aws::Transfer::S3FileRequest::WaitUntilDone ( ) const

virtual

---

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

• aws-cpp-sdk-transfer/include/aws/transfer/S3FileRequest.h