cbe::delegate::DownloadDelegate Class Reference

#include <DownloadDelegate.h>

Classes
struct	ErrorInfo
struct	Exception
	exception thrown by: More...

Public Types
using	Success = DownloadSuccess
using	Error = cbe::delegate::TransferError

Public Member Functions
virtual void	onDownloadSuccess (cbe::Object &&object, std::string path)=0
virtual void	onDownloadError (cbe::delegate::TransferError &&transferError, cbe::util::Context &&context)=0
virtual void	onChunkReceived (cbe::Object &&object, std::uint64_t received, std::uint64_t total)

Detailed Description

Delegate class for the asynchronous version of method:

• cbe::Object::download(const std::string&, DownloadDelegatePtr)
• cbe::Object::downloadStream(const std::string&,cbe::Stream,DownloadDelegatePtr)

Member Function Documentation

onDownloadSuccess()

virtual void cbe::delegate::DownloadDelegate::onDownloadSuccess ( cbe::Object &&  object, std::string  path  )

pure virtual

Called upon successful Download.

Parameters

object	Instance of object that is being Downloaded.
path	Path of object to be downloaded.

onDownloadError()

virtual void cbe::delegate::DownloadDelegate::onDownloadError ( cbe::delegate::TransferError &&  transferError, cbe::util::Context &&  context  )

pure virtual

Called if an error is encountered.

onChunkReceived()

virtual void cbe::delegate::DownloadDelegate::onChunkReceived ( cbe::Object &&  object, std::uint64_t  received, std::uint64_t  total  )

virtual

Called when a chunk of data has been received.

Parameters

object	Object associated with current download.
received	Size, in number of bytes, of the received chunk.
total	Total number of bytes received so far.

---

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

• include/cbe/delegate/DownloadDelegate.h