Sirikata::Transfer::ResourceDownloadTask Class Reference

ResourceDownloadTask is a helper class for downloading an entire resource. More...

#include <ResourceDownloadTask.hpp>

Inheritance diagram for Sirikata::Transfer::ResourceDownloadTask:

Collaboration diagram for Sirikata::Transfer::ResourceDownloadTask:

List of all members.

Public Types
typedef std::tr1::function < void(ResourceDownloadTaskPtr taskptr, TransferRequestPtr request, DenseDataPtr response)>	DownloadCallback
Public Member Functions
virtual	~ResourceDownloadTask ()
void	mergeData (const SparseData &dataToMerge)
void	start ()
bool	isStarted ()
void	updatePriority (float64 priority)
void	cancel ()
const String &	getIdentifier () const
Static Public Member Functions
static ResourceDownloadTaskPtr	construct (const URI &uri, TransferPoolPtr transfer_pool, double priority, DownloadCallback cb)
static ResourceDownloadTaskPtr	construct (const Chunk &chunk, TransferPoolPtr transfer_pool, double priority, DownloadCallback cb)
Protected Member Functions
	ResourceDownloadTask (const URI &uri, TransferPoolPtr transfer_pool, double priority, DownloadCallback cb)
	ResourceDownloadTask (const Chunk &chunk, TransferPoolPtr transfer_pool, double priority, DownloadCallback cb)
void	metadataFinished (MetadataRequestPtr request, RemoteFileMetadataPtr response)
void	chunkFinished (TransferRequestPtr request, DenseDataPtr response)
Static Protected Member Functions
static void	metadataFinishedWeak (ResourceDownloadTaskWPtr thiswptr, MetadataRequestPtr request, RemoteFileMetadataPtr response)
static void	chunkFinishedWeak (ResourceDownloadTaskWPtr thiswptr, ChunkRequestPtr request, DenseDataPtr response)
static void	directChunkFinishedWeak (ResourceDownloadTaskWPtr thiswptr, DirectChunkRequestPtr request, DenseDataPtr response)
Protected Attributes
bool	mStarted
const URI	mURI
const Chunk	mChunk
TransferPoolPtr	mTransferPool
TransferRequestPtr	mCurrentRequest
SparseData	mMergeData
double	mPriority
DownloadCallback	cb
const String	mID

---

Detailed Description

ResourceDownloadTask is a helper class for downloading an entire resource.

It handles getting the metadata and all the chunks, and then invokes a callback. The callback is also invoked, with empty data, if any part of the transfer failed.

This class should always be used as ResourceDownloadTaskPtr and you must maintain a reference for it to work properly -- the callback will not be invoked if you let the object's refcount drop to 0.

---

Member Typedef Documentation

typedef std::tr1::function<void( ResourceDownloadTaskPtr taskptr, TransferRequestPtr request, DenseDataPtr response)> Sirikata::Transfer::ResourceDownloadTask::DownloadCallback

---

Constructor & Destructor Documentation

Sirikata::Transfer::ResourceDownloadTask::~ResourceDownloadTask

(

)

[virtual]

References cancel().

Sirikata::Transfer::ResourceDownloadTask::ResourceDownloadTask	(	const URI &	uri,
		TransferPoolPtr	transfer_pool,
		double	priority,
		DownloadCallback	cb
	)		[protected]

References mStarted.

Sirikata::Transfer::ResourceDownloadTask::ResourceDownloadTask	(	const Chunk &	chunk,
		TransferPoolPtr	transfer_pool,
		double	priority,
		DownloadCallback	cb
	)		[protected]

References mStarted.

---

Member Function Documentation

void Sirikata::Transfer::ResourceDownloadTask::cancel

(

)

References cb, mCurrentRequest, and mTransferPool.

Referenced by ~ResourceDownloadTask().

void Sirikata::Transfer::ResourceDownloadTask::chunkFinished	(	TransferRequestPtr	request,
		DenseDataPtr	response
	)		[protected]

void Sirikata::Transfer::ResourceDownloadTask::chunkFinishedWeak	(	ResourceDownloadTaskWPtr	thiswptr,
		ChunkRequestPtr	request,
		DenseDataPtr	response
	)		[static, protected]

Referenced by metadataFinished().

ResourceDownloadTaskPtr Sirikata::Transfer::ResourceDownloadTask::construct	(	const Chunk &	chunk,
		TransferPoolPtr	transfer_pool,
		double	priority,
		DownloadCallback	cb
	)		[static]

ResourceDownloadTaskPtr Sirikata::Transfer::ResourceDownloadTask::construct	(	const URI &	uri,
		TransferPoolPtr	transfer_pool,
		double	priority,
		DownloadCallback	cb
	)		[static]

void Sirikata::Transfer::ResourceDownloadTask::directChunkFinishedWeak	(	ResourceDownloadTaskWPtr	thiswptr,
		DirectChunkRequestPtr	request,
		DenseDataPtr	response
	)		[static, protected]

Referenced by start().

const String& Sirikata::Transfer::ResourceDownloadTask::getIdentifier

(

)

const [inline]

bool Sirikata::Transfer::ResourceDownloadTask::isStarted

(

)

[inline]

void Sirikata::Transfer::ResourceDownloadTask::mergeData

(

const SparseData &

dataToMerge

)

References mMergeData.

void Sirikata::Transfer::ResourceDownloadTask::metadataFinished	(	MetadataRequestPtr	request,
		RemoteFileMetadataPtr	response
	)		[protected]

References cb, chunkFinishedWeak(), Sirikata::Logging::error, Sirikata::SelfWeakPtr< ResourceDownloadTask >::getSharedPtr(), Sirikata::SelfWeakPtr< ResourceDownloadTask >::getWeakPtr(), mCurrentRequest, mPriority, mTransferPool, mURI, and SILOG.

void Sirikata::Transfer::ResourceDownloadTask::metadataFinishedWeak	(	ResourceDownloadTaskWPtr	thiswptr,
		MetadataRequestPtr	request,
		RemoteFileMetadataPtr	response
	)		[static, protected]

Referenced by start().

void Sirikata::Transfer::ResourceDownloadTask::start

(

)

References directChunkFinishedWeak(), Sirikata::Transfer::URI::empty(), Sirikata::SelfWeakPtr< ResourceDownloadTask >::getWeakPtr(), mChunk, mCurrentRequest, metadataFinishedWeak(), mPriority, mStarted, mTransferPool, and mURI.

void Sirikata::Transfer::ResourceDownloadTask::updatePriority

(

float64

priority

)

References mCurrentRequest, mPriority, and mTransferPool.

---

Member Data Documentation

DownloadCallback Sirikata::Transfer::ResourceDownloadTask::cb [protected]

Referenced by cancel(), Sirikata::AggregateManager::chunkFinished(), and metadataFinished().

const Chunk Sirikata::Transfer::ResourceDownloadTask::mChunk [protected]

Referenced by start().

TransferRequestPtr Sirikata::Transfer::ResourceDownloadTask::mCurrentRequest [protected]

Referenced by cancel(), Sirikata::AggregateManager::chunkFinished(), metadataFinished(), start(), and updatePriority().

const String Sirikata::Transfer::ResourceDownloadTask::mID [protected]

SparseData Sirikata::Transfer::ResourceDownloadTask::mMergeData [protected]

Referenced by mergeData().

double Sirikata::Transfer::ResourceDownloadTask::mPriority [protected]

Referenced by metadataFinished(), start(), and updatePriority().

bool Sirikata::Transfer::ResourceDownloadTask::mStarted [protected]

Referenced by ResourceDownloadTask(), and start().

TransferPoolPtr Sirikata::Transfer::ResourceDownloadTask::mTransferPool [protected]

Referenced by cancel(), metadataFinished(), start(), and updatePriority().

const URI Sirikata::Transfer::ResourceDownloadTask::mURI [protected]

Referenced by metadataFinished(), and start().

---

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

• libcore/include/sirikata/core/transfer/ResourceDownloadTask.hpp
• libcore/src/transfer/ResourceDownloadTask.cpp