Wrapper around an IpcService object that provides simpler method calls to the Dobby 'hypervisor' daemon. More...

#include <IDobbyProxy.h>

Inheritance diagram for IDobbyProxy:

[legend]

Collaboration diagram for IDobbyProxy:

[legend]

Public Types
typedef std::function< void(int32_t, const std::string &, IDobbyProxyEvents::ContainerState, const void *)>	StateChangeListener

Public Member Functions
virtual bool	shutdown () const =0

virtual bool	ping () const =0

virtual bool	isAlive (const std::chrono::milliseconds &timeout) const =0

virtual bool	setLogMethod (uint32_t method, int pipeFd) const =0

virtual bool	setLogLevel (int level) const =0

virtual bool	setAIDbusAddress (bool privateBus, const std::string &address) const =0

bool	isAlive () const

int32_t	setLogMethod (uint32_t method) const

virtual int32_t	startContainerFromSpec (const std::string &id, const std::string &jsonSpec, const std::list< int > &files, const std::string &command="", const std::string &displaySocket="", const std::vector< std::string > &envVars=std::vector< std::string >()) const =0

virtual int32_t	startContainerFromBundle (const std::string &id, const std::string &bundlePath, const std::list< int > &files, const std::string &command="", const std::string &displaySocket="", const std::vector< std::string > &envVars=std::vector< std::string >()) const =0

virtual bool	stopContainer (int32_t descriptor, bool withPrejudice) const =0

virtual bool	pauseContainer (int32_t descriptor) const =0

virtual bool	resumeContainer (int32_t descriptor) const =0

virtual bool	hibernateContainer (int32_t descriptor, const std::string &options) const =0

virtual bool	wakeupContainer (int32_t descriptor) const =0

virtual bool	addContainerMount (int32_t descriptor, const std::string &source, const std::string &destination, const std::vector< std::string > &mountFlags, const std::string &mountData) const =0

virtual bool	removeContainerMount (int32_t descriptor, const std::string &source) const =0

virtual bool	addAnnotation (int32_t cd, const std::string &key, const std::string &value) const =0

virtual bool	removeAnnotation (int32_t cd, const std::string &key) const =0

virtual bool	execInContainer (int32_t cd, const std::string &options, const std::string &command) const =0

virtual int	getContainerState (int32_t descriptor) const =0

virtual std::string	getContainerInfo (int32_t descriptor) const =0

virtual std::list< std::pair< int32_t, std::string > >	listContainers () const =0

int32_t	startContainerFromSpec (const std::string &id, const std::string &jsonSpec) const

int32_t	startContainerFromBundle (const std::string &id, const std::string &bundlePath) const

bool	stopContainer (int32_t descriptor) const

virtual int	registerListener (const StateChangeListener &listener, const void *cbParams)=0

virtual void	unregisterListener (int tag)=0

virtual bool	createBundle (const std::string &id, const std::string &jsonSpec) const =0

virtual std::string	getSpec (int32_t descriptor) const =0

virtual std::string	getOCIConfig (int32_t descriptor) const =0

Public Member Functions inherited from AICommon::Notifier< IDobbyProxyEvents >
void	addObserver (const std::shared_ptr< IDobbyProxyEvents > &observer)
	Register interest in receiving updates.

void	removeObserver (const std::shared_ptr< IDobbyProxyEvents > &observer)
	Unregister from updates.

void	setDispatcher (const std::shared_ptr< IDispatcher > &dispatcher_)

Additional Inherited Members
Protected Member Functions inherited from AICommon::Notifier< IDobbyProxyEvents >
void	notify (F f, Args &&... args)

void	notify (F f)

Protected Attributes inherited from AICommon::Notifier< IDobbyProxyEvents >
std::shared_ptr< IDispatcher >	dispatcher

Detailed Description

Wrapper around an IpcService object that provides simpler method calls to the Dobby 'hypervisor' daemon.

All the methods are constant because the class doesn't have any internal state.

Member Function Documentation

◆ addAnnotation()

virtual bool IDobbyProxy::addAnnotation	(	int32_t	cd,
		const std::string &	key,
		const std::string &	value
	)		const

pure virtual

Implemented in DobbyProxy.

◆ addContainerMount()

virtual bool IDobbyProxy::addContainerMount	(	int32_t	descriptor,
		const std::string &	source,
		const std::string &	destination,
		const std::vector< std::string > &	mountFlags,
		const std::string &	mountData
	)		const

pure virtual

Implemented in DobbyProxy.

◆ createBundle()

virtual bool IDobbyProxy::createBundle	(	const std::string &	id,
		const std::string &	jsonSpec
	)		const

pure virtual

Implemented in DobbyProxy.

◆ execInContainer()

virtual bool IDobbyProxy::execInContainer	(	int32_t	cd,
		const std::string &	options,
		const std::string &	command
	)		const

pure virtual

Implemented in DobbyProxy.

◆ getContainerInfo()

virtual std::string IDobbyProxy::getContainerInfo ( int32_t descriptor ) const

pure virtual

Implemented in DobbyProxy.

◆ getContainerState()

virtual int IDobbyProxy::getContainerState ( int32_t descriptor ) const

pure virtual

Implemented in DobbyProxy.

◆ getOCIConfig()

virtual std::string IDobbyProxy::getOCIConfig ( int32_t descriptor ) const

pure virtual

Implemented in DobbyProxy.

◆ getSpec()

virtual std::string IDobbyProxy::getSpec ( int32_t descriptor ) const

pure virtual

Implemented in DobbyProxy.

◆ hibernateContainer()

virtual bool IDobbyProxy::hibernateContainer	(	int32_t	descriptor,
		const std::string &	options
	)		const

pure virtual

Implemented in DobbyProxy.

◆ isAlive()

virtual bool IDobbyProxy::isAlive ( const std::chrono::milliseconds & timeout ) const

pure virtual

Implemented in DobbyProxy.

◆ listContainers()

virtual std::list< std::pair< int32_t, std::string > > IDobbyProxy::listContainers ( ) const

pure virtual

Implemented in DobbyProxy.

◆ pauseContainer()

virtual bool IDobbyProxy::pauseContainer ( int32_t descriptor ) const

pure virtual

Implemented in DobbyProxy.

◆ ping()

virtual bool IDobbyProxy::ping ( ) const

pure virtual

Implemented in DobbyProxy.

◆ registerListener()

virtual int IDobbyProxy::registerListener	(	const StateChangeListener &	listener,
		const void *	cbParams
	)

pure virtual

Implemented in DobbyProxy.

◆ removeAnnotation()

virtual bool IDobbyProxy::removeAnnotation	(	int32_t	cd,
		const std::string &	key
	)		const

pure virtual

Implemented in DobbyProxy.

◆ removeContainerMount()

virtual bool IDobbyProxy::removeContainerMount	(	int32_t	descriptor,
		const std::string &	source
	)		const

pure virtual

Implemented in DobbyProxy.

◆ resumeContainer()

virtual bool IDobbyProxy::resumeContainer ( int32_t descriptor ) const

pure virtual

Implemented in DobbyProxy.

◆ setAIDbusAddress()

virtual bool IDobbyProxy::setAIDbusAddress	(	bool	privateBus,
		const std::string &	address
	)		const

pure virtual

Implemented in DobbyProxy.

◆ setLogLevel()

virtual bool IDobbyProxy::setLogLevel ( int level ) const

pure virtual

Implemented in DobbyProxy.

◆ setLogMethod()

virtual bool IDobbyProxy::setLogMethod	(	uint32_t	method,
		int	pipeFd
	)		const

pure virtual

Implemented in DobbyProxy.

◆ shutdown()

virtual bool IDobbyProxy::shutdown ( ) const

pure virtual

Implemented in DobbyProxy.

◆ startContainerFromBundle()

virtual int32_t IDobbyProxy::startContainerFromBundle	(	const std::string &	id,
		const std::string &	bundlePath,
		const std::list< int > &	files,
		const std::string &	command = `""`,
		const std::string &	displaySocket = `""`,
		const std::vector< std::string > &	envVars = `std::vector< std::string >()`
	)		const

pure virtual

Implemented in DobbyProxy.

◆ startContainerFromSpec()

virtual int32_t IDobbyProxy::startContainerFromSpec	(	const std::string &	id,
		const std::string &	jsonSpec,
		const std::list< int > &	files,
		const std::string &	command = `""`,
		const std::string &	displaySocket = `""`,
		const std::vector< std::string > &	envVars = `std::vector< std::string >()`
	)		const

pure virtual

Implemented in DobbyProxy.

◆ stopContainer()

virtual bool IDobbyProxy::stopContainer	(	int32_t	descriptor,
		bool	withPrejudice
	)		const

pure virtual

Implemented in DobbyProxy.

◆ unregisterListener()

virtual void IDobbyProxy::unregisterListener ( int tag )

pure virtual

Implemented in DobbyProxy.

◆ wakeupContainer()

virtual bool IDobbyProxy::wakeupContainer ( int32_t descriptor ) const

pure virtual

Implemented in DobbyProxy.

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

AppInfrastructure/Public/Dobby/IDobbyProxy.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addAnnotation()

◆ addContainerMount()

◆ createBundle()

◆ execInContainer()

◆ getContainerInfo()

◆ getContainerState()

◆ getOCIConfig()

◆ getSpec()

◆ hibernateContainer()

◆ isAlive()

◆ listContainers()

◆ pauseContainer()

◆ ping()

◆ registerListener()

◆ removeAnnotation()

◆ removeContainerMount()

◆ resumeContainer()

◆ setAIDbusAddress()

◆ setLogLevel()

◆ setLogMethod()

◆ shutdown()

◆ startContainerFromBundle()

◆ startContainerFromSpec()

◆ stopContainer()

◆ unregisterListener()

◆ wakeupContainer()