Sirikata::Transfer::TransferRequest Class Reference

#include <TransferRequest.hpp>

Inheritance diagram for Sirikata::Transfer::TransferRequest:

Collaboration diagram for Sirikata::Transfer::TransferRequest:

List of all members.

Public Types
typedef std::tr1::function< void()>	ExecuteFinished
Public Member Functions
Priority	getPriority () const
bool	isDeletionRequest () const
virtual const std::string &	getIdentifier () const =0
	Get an identifier for the data referred to by this TransferRequest.
const std::string &	getClientID () const
virtual void	execute (std::tr1::shared_ptr< TransferRequest > req, ExecuteFinished cb)=0
virtual void	notifyCaller (TransferRequestPtr me, TransferRequestPtr from)=0
virtual	~TransferRequest ()
Protected Member Functions
void	setClientID (const std::string &clientID)
void	setPriority (Priority p)
void	setDeletion ()
Protected Attributes
Priority	mPriority
std::string	mClientID
bool	mDeletionRequest
Friends
class	TransferPool

---

Member Typedef Documentation

typedef std::tr1::function<void()> Sirikata::Transfer::TransferRequest::ExecuteFinished

---

Constructor & Destructor Documentation

virtual Sirikata::Transfer::TransferRequest::~TransferRequest

(

)

[inline, virtual]

---

Member Function Documentation

virtual void Sirikata::Transfer::TransferRequest::execute	(	std::tr1::shared_ptr< TransferRequest >	req,
		ExecuteFinished	cb
	)		[pure virtual]

Implemented in Sirikata::Transfer::MetadataRequest, Sirikata::Transfer::DirectChunkRequest, and Sirikata::Transfer::ChunkRequest.

const std::string& Sirikata::Transfer::TransferRequest::getClientID

(

)

const [inline]

virtual const std::string& Sirikata::Transfer::TransferRequest::getIdentifier

(

)

const [pure virtual]

Get an identifier for the data referred to by this TransferRequest.

The identifier is not unique for each TransferRequest. Instead, it identifies the asset data: if two identifiers are equal, they refer to the same data. (Two different identifiers may *ultimately* refer to the same data because two names could point to the same underlying hash).

Implemented in Sirikata::Transfer::MetadataRequest, Sirikata::Transfer::DirectChunkRequest, and Sirikata::Transfer::UploadRequest.

Priority Sirikata::Transfer::TransferRequest::getPriority

(

)

const [inline]

bool Sirikata::Transfer::TransferRequest::isDeletionRequest

(

)

const [inline]

virtual void Sirikata::Transfer::TransferRequest::notifyCaller	(	TransferRequestPtr	me,
		TransferRequestPtr	from
	)		[pure virtual]

Implemented in Sirikata::Transfer::MetadataRequest, Sirikata::Transfer::DirectChunkRequest, Sirikata::Transfer::ChunkRequest, and Sirikata::Transfer::UploadRequest.

void Sirikata::Transfer::TransferRequest::setClientID

(

const std::string &

clientID

)

[inline, protected]

void Sirikata::Transfer::TransferRequest::setDeletion

(

)

[inline, protected]

void Sirikata::Transfer::TransferRequest::setPriority

(

Priority

p

)

[inline, protected]

---

Friends And Related Function Documentation

friend class TransferPool [friend]

---

Member Data Documentation

std::string Sirikata::Transfer::TransferRequest::mClientID [protected]

bool Sirikata::Transfer::TransferRequest::mDeletionRequest [protected]

Priority Sirikata::Transfer::TransferRequest::mPriority [protected]

---

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

• libcore/include/sirikata/core/transfer/TransferRequest.hpp