Sirikata
Public Types | Public Member Functions | Private Member Functions | Private Attributes
Sirikata::Transfer::UploadRequest Class Reference

Upload requests allow you to upload content to the CDN and retrieve their URL when the upload is complete. More...

#include <TransferRequest.hpp>

Inheritance diagram for Sirikata::Transfer::UploadRequest:
Collaboration diagram for Sirikata::Transfer::UploadRequest:

List of all members.

Public Types

typedef std::map< String, String > StringMap
typedef std::tr1::function
< void(UploadRequestPtr
request, const Transfer::URI
&path)> 
UploadCallback

Public Member Functions

 UploadRequest (OAuthParamsPtr oauth, const StringMap &files, const String &path, const StringMap &params, Priority priority, UploadCallback cb)
virtual ~UploadRequest ()
virtual const std::string & getIdentifier () const
 Get an identifier for the data referred to by this TransferRequest.
virtual void execute (TransferRequestPtr req, ExecuteFinished cb)
virtual void notifyCaller (TransferRequestPtr me, TransferRequestPtr from)
OAuthParamsPtr oauth ()
const StringMapfiles ()
const String & path ()
const StringMapparams ()

Private Member Functions

void execute_finished (Transfer::URI uploaded_path, ExecuteFinished cb)

Private Attributes

const OAuthParamsPtr mOAuth
const StringMap mFiles
const String mPath
const StringMap mParams
Transfer::URI mUploadedPath
UploadCallback mCB

Detailed Description

Upload requests allow you to upload content to the CDN and retrieve their URL when the upload is complete.


Member Typedef Documentation

typedef std::map<String, String> Sirikata::Transfer::UploadRequest::StringMap
typedef std::tr1::function<void( UploadRequestPtr request, const Transfer::URI& path)> Sirikata::Transfer::UploadRequest::UploadCallback

Constructor & Destructor Documentation

Sirikata::Transfer::UploadRequest::UploadRequest ( OAuthParamsPtr  oauth,
const StringMap files,
const String &  path,
const StringMap params,
Priority  priority,
UploadCallback  cb 
) [inline]
virtual Sirikata::Transfer::UploadRequest::~UploadRequest ( ) [inline, virtual]

Member Function Documentation

void Sirikata::Transfer::UploadRequest::execute ( TransferRequestPtr  req,
ExecuteFinished  cb 
) [virtual]
void Sirikata::Transfer::UploadRequest::execute_finished ( Transfer::URI  uploaded_path,
ExecuteFinished  cb 
) [private]
const StringMap& Sirikata::Transfer::UploadRequest::files ( ) [inline]
const std::string & Sirikata::Transfer::UploadRequest::getIdentifier ( ) const [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).

Implements Sirikata::Transfer::TransferRequest.

References mPath.

void Sirikata::Transfer::UploadRequest::notifyCaller ( TransferRequestPtr  me,
TransferRequestPtr  from 
) [virtual]
OAuthParamsPtr Sirikata::Transfer::UploadRequest::oauth ( ) [inline]
const StringMap& Sirikata::Transfer::UploadRequest::params ( ) [inline]
const String& Sirikata::Transfer::UploadRequest::path ( ) [inline]

Member Data Documentation

Referenced by notifyCaller().

Referenced by getIdentifier().

Referenced by execute_finished(), and notifyCaller().


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