BluezQt::Job

Search for usage in LXR

#include <BluezQt/Job>

Inheritance diagram for BluezQt::Job:

Public Types

enum  Error { NoError = 0, UserDefinedError = 100 }
 

Properties

int error
 
QString errorText
 
bool finished
 
bool running
 
- Properties inherited from QObject
 objectName
 

Public Slots

void kill ()
 
void start ()
 

Public Member Functions

 Job (QObject *parent=nullptr)
 
 ~Job () override
 
int error () const
 
QString errorText () const
 
bool exec ()
 
bool isFinished () const
 
bool isRunning () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Protected Slots

virtual void doStart ()=0
 

Protected Member Functions

virtual void doEmitResult ()=0
 
void emitResult ()
 
void setError (int errorCode)
 
void setErrorText (const QString &errorText)
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 

Detailed Description

This class represents an asynchronous job performed by BluezQt, it is usually not used directly but instead it is inherit by some other class.

There are two ways of using this class, one is via exec() which will block the thread until a result is fetched, the other is via connecting to the signal result()

Please, think twice before using exec(), it should be used only in either unittest or cli apps.

Note
Job and its subclasses are meant to be used in a fire-and-forget way. Jobs will delete themselves when they finish using deleteLater().
Even given their asynchronous nature, Jobs are still executed in the main thread, so any blocking code executed in it will block the app calling it.
See also
InitManagerJob
InitObexManagerJob

Definition at line 44 of file job.h.

Member Enumeration Documentation

◆ Error

Error type.

See also
error() const
Enumerator
NoError 

Indicates there is no error.

UserDefinedError 

Subclasses should define error codes starting at this value.

Definition at line 70 of file job.h.

Constructor & Destructor Documentation

◆ Job()

BluezQt::Job::Job ( QObject parent = nullptr)
explicit

Creates a new Job object.

Parameters
parent

Definition at line 26 of file job.cpp.

◆ ~Job()

BluezQt::Job::~Job ( )
override

Destroys a Job object.

Definition at line 33 of file job.cpp.

Member Function Documentation

◆ doEmitResult()

virtual void BluezQt::Job::doEmitResult ( )
protectedpure virtual

Implementation for emitting the result signal.

This function is needed to be able to emit result() signal with the job pointer's type being subclass

◆ doStart

virtual void BluezQt::Job::doStart ( )
protectedpure virtualslot

Implementation for start() that will be executed in next loop.

This slot is always called in the next loop, triggered by start().

When implementing this method is important to remember that jobs are not executed on a different thread (unless done that way), so any blocking task has to be done in a different thread or process.

◆ emitResult()

void BluezQt::Job::emitResult ( )
protected

Utility function to emit the result signal, and suicide this job.

Note
Deletes this job using deleteLater().
See also
result() const

Definition at line 55 of file job.cpp.

◆ error()

int BluezQt::Job::error ( ) const

Returns the error code, if there has been an error.

Make sure to call this once result() has been emitted

Returns
the error code for this job, 0 if no error.

◆ errorText()

QString BluezQt::Job::errorText ( ) const

Returns the error text if there has been an error.

Only call if error is not 0.

This is usually some extra data associated with the error, such as a URL. Use errorString() to get a human-readable, translated message.

Returns
a string to help understand the error

◆ exec()

bool BluezQt::Job::exec ( )

Executes the job synchronously.

This will start a nested QEventLoop internally. Nested event loop can be dangerous and can have unintended side effects, you should avoid calling exec() whenever you can and use the asynchronous interface of Job instead.

Should you indeed call this method, you need to make sure that all callers are reentrant, so that events delivered by the inner event loop don't cause non-reentrant functions to be called, which usually wreaks havoc.

Note that the event loop started by this method does not process user input events, which means your user interface will effectively be blocked. Other events like paint or network events are still being processed. The advantage of not processing user input events is that the chance of accidental reentrancy is greatly reduced. Still you should avoid calling this function.

Warning
This method blocks until the job finishes!
Returns
true if the job has been executed without error, false otherwise

Definition at line 103 of file job.cpp.

◆ isFinished()

bool BluezQt::Job::isFinished ( ) const

Returns whether the job have already finished.

Returns
true if the job already finished

Definition at line 88 of file job.cpp.

◆ isRunning()

bool BluezQt::Job::isRunning ( ) const

Returns whether the job is currently running.

Returns
true if the job is running

Definition at line 83 of file job.cpp.

◆ kill

void BluezQt::Job::kill ( )
slot

Kills the job.

This method will kill the job and then call deleteLater(). Only jobs started with start() can be killed.

It will not emit result signal.

Definition at line 44 of file job.cpp.

◆ setError()

void BluezQt::Job::setError ( int  errorCode)
protected

Sets the error code.

It should be called when an error is encountered in the job, just before calling emitResult().

You should define an enum of error codes, with values starting at Job::UserDefinedError, and use those. For example:

enum ExampleErrors{
InvalidFoo = UserDefinedError,
BarNotFound
};
Parameters
errorCodethe error code
See also
emitResult()

Definition at line 93 of file job.cpp.

◆ setErrorText()

void BluezQt::Job::setErrorText ( const QString errorText)
protected

Sets the error text.

It should be called when an error is encountered in the job, just before calling emitResult().

Provides extra information about the error that cannot be determined directly from the error code. For example, a URL or filename. This string is not normally translatable.

Parameters
errorTextthe error text
See also
emitResult(), setError()

Definition at line 98 of file job.cpp.

◆ start

void BluezQt::Job::start ( )
slot

Starts the job asynchronously.

This method will schedule doStart() to be executed in the next loop. This is done so this method returns as soon as possible.

When the job is finished, result() is emitted.

Definition at line 38 of file job.cpp.


The documentation for this class was generated from the following files:
@ UserDefinedError
Subclasses should define error codes starting at this value.
Definition: job.h:74
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Sun Nov 27 2022 04:09:33 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.