The root namespace for libschauer. More...

Classes
class	AbstractBaseModel
	Base class for all data models. More...

class	AbstractConfiguration
	Configuration settings base class. More...

class	AbstractContainerModel
	Base class for models providing a list or table of available containers. More...

class	AbstractImageModel
	Base class for models providing a list or table of available images. More...

class	AbstractNamFactory
	Creates QNetworkAccessManager instances for Schauer API classes. More...

class	AbstractVersionModel
	Base class for models providing version information. More...

class	ContainerListModel
	List model providing availabel containers. More...

class	CreateContainerJob
	Creates a new container from an image. More...

class	CreateExecInstanceJob
	Create an execution instance. More...

class	GetVersionJob
	Queries version information from the Docker daemon. More...

class	ImageListModel
	List model providing available images. More...

class	Job
	Base class for all API jobs. More...

class	ListContainersJob
	Queries the list of available containers form the Docker daemon. More...

class	ListImagesJob
	Queries the list of available images from the Docker daemon. More...

class	RemoveContainerJob
	Remove a container from the Docker daemon. More...

class	SJob
	Base class for all jobs. More...

class	StartContainerJob
	Starts a Docker container. More...

class	StartExecInstanceJob
	Start a previously set up exec instance. More...

class	StopContainerJob
	Stops a Docker container. More...

class	VersionListModel
	List model providing version information. More...

Enumerations
enum	{ MissingConfig = SJob::UserDefinedError + 1, MissingHost, MissingUser, MissingPassword, AuthNFailed, AuthZFailed, InvalidRequestUrl, RequestTimedOut, JsonParseError, SslError, NetworkError, APIError, EmptyReply, EmptyJson, WrongOutputType, InvalidInput, UnknownError }
	Error codes. More...

Functions
SCHAUER_LIBRARY AbstractConfiguration *	defaultConfiguration ()
	Returns a pointer to a global default configuration. More...

SCHAUER_LIBRARY bool	loadTranslations (const QLocale &locale=QLocale())
	Load and install the translations for libschauer. More...

SCHAUER_LIBRARY AbstractNamFactory *	networkAccessManagerFactory ()
	Returns a pointer to a global network access manager factory. More...

SCHAUER_LIBRARY void	setDefaultConfiguration (AbstractConfiguration *configuration)
	Sets a pointer to a global default configuration. More...

SCHAUER_LIBRARY void	setNetworkAccessManagerFactory (AbstractNamFactory *factory)
	Sets a pointer to a global network access manager factory. More...

SCHAUER_LIBRARY QVersionNumber	version ()
	Returns the version of the currently used libschauer. More...

Detailed Description

The root namespace for libschauer.

Enumeration Type Documentation

anonymous enum

Error codes.

Enumerator
MissingConfig	AbstractConfiguration is missin on this API class.
MissingHost	The remote host is missing.
MissingUser	The username is missing.
MissingPassword	The password is missing.
AuthNFailed	Authentication failed, check username and password.
AuthZFailed	Authorization failed.
InvalidRequestUrl	The generated request URL is not valid.
RequestTimedOut	The request timed out.
JsonParseError	Failed to parse JSON response message.
SslError	Error while performing SSL/TLS encryption.
NetworkError	Network related error.
APIError	Error returned by the Docker API.
EmptyReply	The repsone data is empty but that was not expected.
EmptyJson	The repsone data is empty but that was not expected.
WrongOutputType	The output type is not the expected one.
InvalidInput	Some input data is not valid.
UnknownError	An unknown error.

AbstractConfiguration * Schauer::defaultConfiguration ( )

Returns a pointer to a global default configuration.

bool Schauer::loadTranslations ( const QLocale & locale = QLocale() )

Load and install the translations for libschauer.

Returns true on success, otherwise false.

AbstractNamFactory * Schauer::networkAccessManagerFactory ( )

Returns a pointer to a global network access manager factory.

void Schauer::setDefaultConfiguration ( AbstractConfiguration * configuration )

Sets a pointer to a global default configuration.

void Schauer::setNetworkAccessManagerFactory ( AbstractNamFactory * factory )

Sets a pointer to a global network access manager factory.

QVersionNumber Schauer::version ( )

Returns the version of the currently used libschauer.