Aws::FileManagement Namespace Reference

Classes
class	DataManagerStrategy
class	DataReader
class	FileManager
class	FileManagerStrategy
struct	FileManagerStrategyOptions
class	FileObject
class	FileTokenInfo
class	FileUploadStreamer
struct	FileUploadStreamerOptions
class	FileUploadTask
class	FileUploadTaskAsync
class	TokenStore
struct	TokenStoreOptions

Typedefs
using	DataToken = uint64_t
template<typename T >
using	FileUploadTaskPtr = std::shared_ptr< FileUploadTask< T >>
template<typename T >
using	TaskObservedBlockingQueue = Aws::DataFlow::ObservedBlockingQueue< TaskPtr< T >>
template<typename T >
using	TaskObservedQueue = Aws::DataFlow::ObservedQueue< TaskPtr< T >>
template<typename T >
using	TaskPtr = std::shared_ptr< Aws::DataFlow::Task< T >>
template<typename T >
using	TaskSink = Aws::DataFlow::Sink< TaskPtr< T >>

Enumerations
enum	TokenStatus { ACTIVE, INACTIVE }

Functions
template<typename T , typename O , class = typename std::enable_if<std::is_base_of<DataReader<T>, O>::value, O>::type>
std::shared_ptr< FileUploadStreamer< T > >	createFileUploadStreamer (std::shared_ptr< O > file_manager, FileUploadStreamerOptions file_manager_options)
static const std::string	kTokenStoreFile ("token_store.info")
bool	operator!= (const FileTokenInfo &lhs, const FileTokenInfo &rhs)
bool	operator== (const FileTokenInfo &lhs, const FileTokenInfo &rhs)
void	printCache (std::unordered_map< DataToken, FileTokenInfo > token_store, std::unordered_map< std::string, std::list< DataToken >> file_tokens, std::unordered_map< std::string, FileTokenInfo > staged_tokens_)
void	sanitizePath (std::string &path)

Variables
static const FileManagerStrategyOptions	kDefaultFileManagerStrategyOptions {"~/.ros/cwlogs", "cwlog", ".log", 1024, 1024*1024, false}
static constexpr const char *	kEofKey = "eof"
static constexpr const char *	kFilePathKey = "file_path"
static constexpr const char *	kPositionKey = "position"
static constexpr std::chrono::milliseconds	kTimeout = std::chrono::minutes(5)

Typedef Documentation

using Aws::FileManagement::DataToken = typedef uint64_t

Definition at line 39 of file file_manager_strategy.h.

template<typename T >

using Aws::FileManagement::FileUploadTaskPtr = typedef std::shared_ptr<FileUploadTask<T>>

Definition at line 108 of file file_upload_task.h.

template<typename T >

using Aws::FileManagement::TaskObservedBlockingQueue = typedef Aws::DataFlow::ObservedBlockingQueue<TaskPtr<T>>

Definition at line 114 of file file_upload_task.h.

template<typename T >

using Aws::FileManagement::TaskObservedQueue = typedef Aws::DataFlow::ObservedQueue<TaskPtr<T>>

Definition at line 111 of file file_upload_task.h.

template<typename T >

using Aws::FileManagement::TaskPtr = typedef std::shared_ptr<Aws::DataFlow::Task<T>>

Definition at line 105 of file file_upload_task.h.

template<typename T >

using Aws::FileManagement::TaskSink = typedef Aws::DataFlow::Sink<TaskPtr<T>>

Definition at line 117 of file file_upload_task.h.

Enumeration Type Documentation

enum Aws::FileManagement::TokenStatus

Enumerator
ACTIVE
INACTIVE

Definition at line 34 of file file_manager_strategy.h.

Function Documentation

template<typename T , typename O , class = typename std::enable_if<std::is_base_of<DataReader<T>, O>::value, O>::type>

std::shared_ptr<FileUploadStreamer<T> > Aws::FileManagement::createFileUploadStreamer	(	std::shared_ptr< O >	file_manager,
		FileUploadStreamerOptions	file_manager_options
	)

Create a file upload manager complete with a file status monitor attached to the file_manager, and a task based queue.

Template Parameters

T	the type of messages the file uploader will handle

Parameters

file_manager

to use as the source of these messages

Returns

a shared pointer to a configured file upload manager.

Exceptions

Invalid

Argument for the file manager

Definition at line 40 of file file_management_factory.h.

static const std::string Aws::FileManagement::kTokenStoreFile ( "token_store.info"  )

static

bool Aws::FileManagement::operator!= ( const FileTokenInfo &  lhs, const FileTokenInfo &  rhs  )

inline

Definition at line 135 of file file_manager_strategy.h.

bool Aws::FileManagement::operator== ( const FileTokenInfo &  lhs, const FileTokenInfo &  rhs  )

inline

Definition at line 131 of file file_manager_strategy.h.

void Aws::FileManagement::printCache	(	std::unordered_map< DataToken, FileTokenInfo >	token_store,
		std::unordered_map< std::string, std::list< DataToken >>	file_tokens,
		std::unordered_map< std::string, FileTokenInfo >	staged_tokens_
	)

Definition at line 79 of file file_manager_strategy.cpp.

void Aws::FileManagement::sanitizePath

(

std::string &

path

)

Sanitizes the path provided by making sure it ends with a '/' character and also replacing the '~', if it's at the front of the string, with the value of the $HOME environment variable. If $HOME is not set it attempts to use $ROS_HOME. If niether is set then it throws a runtime exception.

Definition at line 34 of file file_manager_strategy.cpp.

Variable Documentation

const FileManagerStrategyOptions Aws::FileManagement::kDefaultFileManagerStrategyOptions {"~/.ros/cwlogs", "cwlog", ".log", 1024, 1024*1024, false}

static

Definition at line 75 of file file_manager_options.h.

constexpr const char* Aws::FileManagement::kEofKey = "eof"

static

Definition at line 42 of file file_manager_strategy.h.

constexpr const char* Aws::FileManagement::kFilePathKey = "file_path"

static

Definition at line 43 of file file_manager_strategy.h.

constexpr const char* Aws::FileManagement::kPositionKey = "position"

static

Definition at line 41 of file file_manager_strategy.h.

constexpr std::chrono::milliseconds Aws::FileManagement::kTimeout = std::chrono::minutes(5)

static

Definition at line 39 of file file_upload_streamer.h.