qi Namespace Reference

Namespaces
	detail

Classes
class	File
class	FileImpl
class	FileProxy
class	LogListener
class	LogListenerProxy
class	LogManager
class	LogManagerProxy
struct	LogMessage
class	LogProvider
class	LogProviderImpl
class	LogProviderProxy
class	ProgressNotifier
class	ProgressNotifierImpl
class	ProgressNotifierProxy
class	Task
class	TaskCall
class	TaskCall< Future< T > >

Typedefs
using	FilePtr = qi::Object< File >
	Pointer to a file with shared/remote semantic. More...
using	LogListenerPtr = qi::Object< LogListener >
using	LogManagerPtr = qi::Object< LogManager >
using	LogProviderPtr = qi::Object< LogProvider >
using	ProgressNotifierPtr = qi::Object< ProgressNotifier >
	Pointer to a ProgressNotifier with shared/remote semantic. More...

Functions
boost::lockfree::queue< qi::LogMessage * >	_pendingMessages (qi::os::getEnvDefault("QI_LOG_MAX_MSGS_BUFFERS", 500))
void	_qiregisterFile ()
void	_qiregisterFileOperation ()
void	_qiregisterFileProxy ()
void	_qiregisterProgressNotifier ()
void	_qiregisterProgressNotifierProxy ()
FutureSync< void >	copyToLocal (FilePtr file, Path localPath)
QICORE_API ProgressNotifierPtr	createProgressNotifier (Future< void > operationFuture={})
QICORE_API qi::FutureSync< qi::LogProviderPtr >	initializeLogging (SessionPtr session, const std::string &categoryPrefix="")
template<class FileOpType , class... Args>
auto	launchStandalone (Args &&... args) -> decltype(std::declval< FileOpType >().start())
QICORE_API LogProviderPtr	makeLogProvider ()
QICORE_API LogProviderPtr	makeLogProvider (LogManagerPtr logger)
QICORE_API FilePtr	openLocalFile (const qi::Path &localPath)
FileOperationPtr	prepareCopyToLocal (FilePtr file, Path localPath)
	QI_REGISTER_IMPLEMENTATION (LogProvider, LogProviderImpl)
	QI_REGISTER_MT_OBJECT (LogProvider, setLevel, addFilter, setFilters, setLogger, setCategoryPrefix)
	QI_REGISTER_PROXY_INTERFACE (LogListenerProxy, LogListener)
	QI_REGISTER_PROXY_INTERFACE (LogManagerProxy, LogManager)
	QI_REGISTER_PROXY_INTERFACE (LogProviderProxy, LogProvider)
void	registerFileCreation (qi::ModuleBuilder &mb)
void	registerFileOperations (qi::ModuleBuilder &mb)
void	registerLogProvider (qi::ModuleBuilder *mb)
void	registerProgressNotifierCreation (qi::ModuleBuilder &mb)
static void	removeProviderAtStop (SessionPtr session, int id)
static void	silenceQiCategories (qi::log::SubscriberId subscriber)

Variables
static bool	initialized = false

Detailed Description

Author

Aldebaran Robotics Aldebaran Robotics (c) 2013 All Rights Reserved

Typedef Documentation

FilePtr

using qi::FilePtr = typedef qi::Object<File>

Pointer to a file with shared/remote semantic.

Definition at line 213 of file file.hpp.

LogListenerPtr

typedef qi::Object< LogListener > qi::LogListenerPtr

Definition at line 57 of file loglistener.hpp.

LogManagerPtr

typedef qi::Object< LogManager > qi::LogManagerPtr

Definition at line 42 of file logmanager.hpp.

LogProviderPtr

typedef qi::Object< LogProvider > qi::LogProviderPtr

Definition at line 23 of file logmanager.hpp.

ProgressNotifierPtr

using qi::ProgressNotifierPtr = typedef qi::Object<ProgressNotifier>

Pointer to a ProgressNotifier with shared/remote semantic.

Definition at line 114 of file file.hpp.

Function Documentation

_pendingMessages()

boost::lockfree::queue<qi::LogMessage*> qi::_pendingMessages

(

qi::os::getEnvDefault("QI_LOG_MAX_MSGS_BUFFERS", 500)

)

_qiregisterFile()

void qi::_qiregisterFile

(

)

Definition at line 146 of file fileimpl.cpp.

_qiregisterFileOperation()

void qi::_qiregisterFileOperation

(

)

Definition at line 29 of file fileoperation.cpp.

_qiregisterFileProxy()

void qi::_qiregisterFileProxy

(

)

Definition at line 78 of file file_proxy.cpp.

_qiregisterProgressNotifier()

void qi::_qiregisterProgressNotifier

(

)

Definition at line 117 of file progressnotifier.cpp.

_qiregisterProgressNotifierProxy()

void qi::_qiregisterProgressNotifierProxy

(

)

Definition at line 87 of file progressnotifier_proxy.cpp.

copyToLocal()

FutureSync<void> qi::copyToLocal	(	FilePtr	file,
		Path	localPath
	)

Definition at line 19 of file fileoperation.cpp.

createProgressNotifier()

ProgressNotifierPtr qi::createProgressNotifier

(

Future< void >

operationFuture = {}

)

Create and provide a remotely shareable ProgressNotifier object.

Parameters

operationFuture

Optional future of an operation to associate the notifier with.

Returns

A progress notifier, associated to the operation of the future if provided.

Definition at line 160 of file progressnotifier.cpp.

initializeLogging()

qi::FutureSync< qi::LogProviderPtr > qi::initializeLogging	(	SessionPtr	session,
		const std::string &	categoryPrefix = ""
	)

Definition at line 70 of file logproviderimpl.cpp.

launchStandalone()

template<class FileOpType , class... Args>

auto qi::launchStandalone

(

Args &&...

args

)

-> decltype(std::declval<FileOpType>().start())

Definition at line 12 of file fileoperation.cpp.

makeLogProvider() [1/2]

LogProviderPtr qi::makeLogProvider

(

)

Definition at line 52 of file logproviderimpl.cpp.

makeLogProvider() [2/2]

LogProviderPtr qi::makeLogProvider

(

LogManagerPtr

logger

)

Definition at line 57 of file logproviderimpl.cpp.

openLocalFile()

FilePtr qi::openLocalFile

(

const qi::Path &

localPath

)

Open a local file located at the specified path and provide it for reading as a sharable file access.

Warning

Throws a std::runtime_exception if the provided path is not an existing file path.

Parameters

localPath

Path to a file on the local file system that can be open.

Returns

A shareable access to the opened local file.

Definition at line 186 of file fileimpl.cpp.

prepareCopyToLocal()

FileOperationPtr qi::prepareCopyToLocal	(	FilePtr	file,
		Path	localPath
	)

Definition at line 24 of file fileoperation.cpp.

QI_REGISTER_IMPLEMENTATION()

qi::QI_REGISTER_IMPLEMENTATION	(	LogProvider	,
		LogProviderImpl
	)

QI_REGISTER_MT_OBJECT()

qi::QI_REGISTER_MT_OBJECT	(	LogProvider	,
		setLevel	,
		addFilter	,
		setFilters	,
		setLogger	,
		setCategoryPrefix
	)

QI_REGISTER_PROXY_INTERFACE() [1/3]

qi::QI_REGISTER_PROXY_INTERFACE	(	LogListenerProxy	,
		LogListener
	)

QI_REGISTER_PROXY_INTERFACE() [2/3]

qi::QI_REGISTER_PROXY_INTERFACE	(	LogManagerProxy	,
		LogManager
	)

QI_REGISTER_PROXY_INTERFACE() [3/3]

qi::QI_REGISTER_PROXY_INTERFACE	(	LogProviderProxy	,
		LogProvider
	)

registerFileCreation()

void qi::registerFileCreation

(

qi::ModuleBuilder &

mb

)

Definition at line 191 of file fileimpl.cpp.

registerFileOperations()

void qi::registerFileOperations

(

qi::ModuleBuilder &

mb

)

Definition at line 40 of file fileoperation.cpp.

registerLogProvider()

void qi::registerLogProvider

(

qi::ModuleBuilder *

mb

)

Definition at line 260 of file logproviderimpl.cpp.

registerProgressNotifierCreation()

void qi::registerProgressNotifierCreation

(

qi::ModuleBuilder &

mb

)

Definition at line 165 of file progressnotifier.cpp.

removeProviderAtStop()

static void qi::removeProviderAtStop ( SessionPtr  session, int  id  )

static

Definition at line 62 of file logproviderimpl.cpp.

silenceQiCategories()

static void qi::silenceQiCategories ( qi::log::SubscriberId  subscriber )

static

Definition at line 91 of file logproviderimpl.cpp.

Variable Documentation

initialized

bool qi::initialized = false

static

Definition at line 69 of file logproviderimpl.cpp.