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

#include <Schauer/ListConstainersJob>

Inheritance diagram for Schauer::ListContainersJob:

Properties
int	limit
	Sets the number of most recently created containers to return, including non-running ones. More...

bool	showAll
	Set this to `true` to show all containers. More...

bool	showSize
	Set this to `true` to return size of the container. More...

Properties inherited from Schauer::Job
Schauer::AbstractConfiguration	configuration
	Pointer to an object providing configuration data. More...

Properties inherited from Schauer::SJob
Schauer::SJob::Capabilities	capabilities
	Capabilities of this job. More...

int	error
	Error code. More...

QString	errorString
	Human-readable error message. More...

QString	errorText
	Additional error text. More...

ulong	percent
	Overall progress of the job. More...

Public Member Functions
	ListContainersJob (QObject *parent=nullptr)
	Constructs a new ListContainersJob with the given parent. More...

	~ListContainersJob () override
	Destroys the LIstContainersJob. More...

int	limit () const
	Getter function for the limit property. More...

void	setLimit (int limit)
	Setter function for the limit property. More...

void	setShowAll (bool showAll)
	Setter function for the showAll property. More...

void	setShowSize (bool showSize)
	Setter function for the showSize property. More...

bool	showAll () const
	Getter function for the showAll property. More...

bool	showSize () const
	Getter function for the showSize property. More...

void	start () override
	Starts querying the list of available containers asynchronously. More...

Public Member Functions inherited from Schauer::Job
	~Job () override
	Destroys the Job object. More...

AbstractConfiguration *	configuration () const
	Getter function for the configuraion property. More...

QString	errorString () const override
	Returns a human readable and translated error string. More...

QJsonDocument	replyData () const
	Returns the API reply data after successful request. More...

void	setConfiguration (AbstractConfiguration *configuration)
	Setter function for the configuration property. More...

Public Member Functions inherited from Schauer::SJob
	SJob (QObject *parent=nullptr)
	Stores a combination of Capability values. More...

	~SJob () override
	Desconstructs the SJob obejct. More...

Capabilities	capabilities () const
	Returns the capabilities of this job. More...

int	error () const
	Returns the error code, if there has been an error. More...

QString	errorText () const
	Returns the error text if there has been an error. More...

bool	exec ()
	Executes the job synchronously. More...

bool	isAutoDelete () const
	Returns `true` if this job automatically deletes itself once the job is finished. More...

bool	isFinishedNotificationHidden () const

bool	isSuspended () const
	Returns `true` if the job was suspended with the suspend() call. More...

unsigned long	percent () const
	Returns the overall progress of this job. More...

Q_SCRIPTABLE qulonglong	processedAmount (Unit unit) const
	Returns the processed amount of a given unit for this job. More...

void	setAutoDelete (bool autodelete)
	Sets the auto-delete property of the job. More...

void	setFinishedNotificationHidden (bool hide=true)

Q_SCRIPTABLE qulonglong	totalAmount (Unit unit) const
	Returns the total amount of a given unit for this job. More...

Signals
void	limitChanged (int limit)
	Notifier signal for the limit property. More...

void	showAllChanged (bool showAll)
	Notifier signal for the showAll property. More...

void	showSizeChanged (bool showSize)
	Notifier signal for the showSize property. More...

Signals inherited from Schauer::Job
void	configurationChanged (Schauer::AbstractConfiguration *configuration)
	Notifier signal for the configuration property. More...

void	failed (int errorCode, const QString &errorString)
	Emitted when the API request has been failed. More...

void	succeeded (const QJsonDocument &json)
	Emitted when the API request ha been successfully finished. More...

Signals inherited from Schauer::SJob
void	description (Schauer::SJob *job, const QString &title, const QPair< QString, QString > &field1=QPair< QString, QString >(), const QPair< QString, QString > &field2=QPair< QString, QString >())
	Emitted to display general description of this job. More...

void	finished (Schauer::SJob *job)
	Emitted when the job is finished, in any case. More...

void	infoMessage (Schauer::SJob *job, const QString &plain, const QString &rich=QString())
	Emitted to display state information about this job. More...

void	percent (Schauer::SJob *job, unsigned long percent)
	Progress signal showing the overall progress of the job This is valid for any kind of job, and allows using a a progress bar very easily. More...

void	percentChanged (Schauer::SJob *job, unsigned long percent)
	Progress signal showing the overall progress of the job This is valid for any kind of job, and allows using a a progress bar very easily. More...

void	processedAmount (Schauer::SJob *job, SJob::Unit unit, qulonglong amount)
	Regularly emitted to show the progress of this job by giving the current amount. More...

void	processedAmountChanged (Schauer::SJob *job, SJob::Unit unit, qulonglong amount)
	Regularly emitted to show the progress of this job by giving the current amount. More...

void	processedSize (Schauer::SJob *job, qulonglong size)
	Regularly emitted to show the progress of this job (current data size in bytes for transfers, entries listed, etc.). More...

void	result (Schauer::SJob *job)
	Emitted when the job is finished (except when killed with SJob::Quietly). More...

void	resumed (Schauer::SJob *job)
	Emitted when the job is resumed. More...

void	speed (Schauer::SJob *job, unsigned long speed)
	Emitted to display information about the speed of this job. More...

void	suspended (Schauer::SJob *job)
	Emitted when the job is suspended. More...

void	totalAmount (Schauer::SJob *job, SJob::Unit unit, qulonglong amount)
	Emitted when we know the amount the job will have to process. More...

void	totalAmountChanged (Schauer::SJob *job, SJob::Unit unit, qulonglong amount)
	Emitted when we know the amount the job will have to process. More...

void	totalSize (Schauer::SJob *job, qulonglong size)
	Emitted when we know the size of this job (data size in bytes for transfers, number of entries for listings, etc). More...

void	warning (Schauer::SJob *job, const QString &plain, const QString &rich=QString())
	Emitted to display a warning about this job. More...

Additional Inherited Members
Public Types inherited from Schauer::SJob
enum	{ NoError = 0, KilledJobError = 1, UserDefinedError = 100 }
	Error codes. More...

enum	Capability { NoCapabilities = 0x0000, Killable = 0x0001, Suspendable = 0x0002 }
	Job capabilities. More...

enum	Unit { Bytes = 0, Files, Directories, Items }
	Describes the unit used in the methods that handle reporting the job progress info. More...

Public Slots inherited from Schauer::SJob
bool	kill (Schauer::SJob::KillVerbosity verbosity=Quietly)
	Aborts this job. More...

bool	resume ()
	Resumes this job. More...

bool	suspend ()
	Suspends this job. More...

Protected Member Functions inherited from Schauer::Job
	Job (QObject *parent=nullptr)
	Constructs a new Job object with the given parent. More...

void	sendRequest ()
	Performs basic checks, sets up and sends the request. More...

Protected Member Functions inherited from Schauer::SJob
virtual bool	doKill ()
	Aborts this job quietly. More...

virtual bool	doResume ()
	Resumes this job. More...

virtual bool	doSuspend ()
	Suspends this job. More...

void	emitPercent (qulonglong processedAmount, qulonglong totalAmount)
	Utility function for inherited jobs. More...

void	emitResult ()
	Utility function to emit the result signal, and suicide this job. More...

void	emitSpeed (unsigned long speed)
	Utility function for inherited jobs. More...

bool	isFinished () const
	Returns `true` if the job has been finished and has emitted the finished() signal. More...

void	setCapabilities (Capabilities capabilities)
	Sets the capabilities for this job. More...

void	setError (int errorCode)
	Sets the error code. More...

void	setErrorText (const QString &errorText)
	Sets the error text. More...

void	setPercent (unsigned long percentage)
	Sets the overall progress of the job. More...

void	setProcessedAmount (Unit unit, qulonglong amount)
	Sets the processed size. More...

void	setProgressUnit (Unit unit)
	Sets the unit that will be used internally to calculate the progress percentage. More...

void	setTotalAmount (Unit unit, qulonglong amount)
	Sets the total size. More...

Detailed Description

Queries the list of available containers form the Docker daemon.

Use this class to get a list of available containers from the Docker daemon. There is also AbstractContainersModel to provide this information.

API route: /containers/json

API method: GET

Docker API Documentation: ContainerList

Todo:: Implement filters

Property Documentation

◆ limit

int ListContainersJob::limit

readwrite

Sets the number of most recently created containers to return, including non-running ones.

By default this is set to 0 so that no limit will be set.

Access functions

int limit() const
void setLimit(int limit)

Notifier signal

void limitChanged(int limit)

◆ showAll

bool ListContainersJob::showAll

readwrite

Set this to true to show all containers.

By default this is false and only running containers are shown.

Access functions

bool showAll() const
void setShowAll(bool showAll)

Notifier signal

void showAllChanged(bool showAll)

◆ showSize

bool ListContainersJob::showSize

readwrite

Set this to true to return size of the container.

The size will be shown in the fields SizeRw and SizeRootFs. By default this is set to false.

Access function

bool showSize() const
void setShowSize(bool showSize)

Notifier signal

void showSizeChanged(bool showSize)

Constructor & Destructor Documentation

◆ ListContainersJob()

ListContainersJob::ListContainersJob ( QObject * parent = nullptr )

explicit

Constructs a new ListContainersJob with the given parent.

◆ ~ListContainersJob()

ListContainersJob::~ListContainersJob ( )

overridedefault

Destroys the LIstContainersJob.

Member Function Documentation

◆ limit()

int Schauer::ListContainersJob::limit ( ) const

Getter function for the limit property.

See also: setLimit(), limitChanged()

◆ limitChanged

void Schauer::ListContainersJob::limitChanged ( int limit )

signal

Notifier signal for the limit property.

See also: limit(), setLimit()

◆ setLimit()

void ListContainersJob::setLimit ( int limit )

Setter function for the limit property.

See also: limit(), limitChanged()

◆ setShowAll()

void ListContainersJob::setShowAll ( bool showAll )

Setter function for the showAll property.

See also: showAll(), showAllChanged()

◆ setShowSize()

void ListContainersJob::setShowSize ( bool showSize )

Setter function for the showSize property.

See also: showSize(), showSizeChanged()

◆ showAll()

bool Schauer::ListContainersJob::showAll ( ) const

Getter function for the showAll property.

See also: setShowAll(), showAllChanged()

◆ showAllChanged

void Schauer::ListContainersJob::showAllChanged ( bool showAll )

signal

Notifier signal for the showAll property.

See also: showAll(), setShowAll

◆ showSize()

bool Schauer::ListContainersJob::showSize ( ) const

Getter function for the showSize property.

See also: setShowSize(), showSizeChanged()

◆ showSizeChanged

void Schauer::ListContainersJob::showSizeChanged ( bool showSize )

signal

Notifier signal for the showSize property.

See also: showSize(), setShowSize()

◆ start()

void ListContainersJob::start ( )

overridevirtual

Starts querying the list of available containers asynchronously.

When the job is finished, result() will be emitted. To query the images in a synchronous way, use exec().

Implements Schauer::SJob.

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

Schauer/listcontainersjob.h
build/Schauer/SchauerQt5_autogen/include/moc_listcontainersjob.cpp
Schauer/listcontainersjob.cpp

Properties

Public Member Functions

Signals

Additional Inherited Members

Detailed Description

Property Documentation

◆ limit

◆ showAll

◆ showSize

Constructor & Destructor Documentation

◆ ListContainersJob()

◆ ~ListContainersJob()

Member Function Documentation

◆ limit()

◆ limitChanged

◆ setLimit()

◆ setShowAll()

◆ setShowSize()

◆ showAll()

◆ showAllChanged

◆ showSize()

◆ showSizeChanged

◆ start()