Buteo Synchronization Framework
Signals | Public Member Functions | Protected Member Functions | List of all members
Buteo::ClientThread Class Reference

Thread for client plugins. More...

#include <ClientThread.h>

Inheritance diagram for Buteo::ClientThread:

Signals

void initError (const QString &aProfileName, const QString &aMessage, SyncResults::MinorCode aErrorCode)
 Emitted when synchronization cannot be started due to an error in plugin initialization.
 

Public Member Functions

 ClientThread ()
 Constructor.
 
virtual ~ClientThread ()
 Destructor.
 
QString getProfileName () const
 Returns profile that this thread is running.
 
ClientPlugingetPlugin () const
 Returns plugin that this thread is running.
 
bool startThread (ClientPlugin *aClientPlugin)
 Starts client thread.
 
void stopThread ()
 Stops client thread.
 
SyncResults getSyncResults ()
 Returns the results for this particular thread.
 

Protected Member Functions

virtual void run ()
 overriding method for QThread::run
 

Detailed Description

Thread for client plugins.

Constructor & Destructor Documentation

◆ ClientThread()

ClientThread::ClientThread ( )

Constructor.

◆ ~ClientThread()

ClientThread::~ClientThread ( )
virtual

Destructor.

Member Function Documentation

◆ getPlugin()

ClientPlugin * ClientThread::getPlugin ( ) const

Returns plugin that this thread is running.

Returns
Plugin

◆ getProfileName()

QString ClientThread::getProfileName ( ) const

Returns profile that this thread is running.

Returns
Profile name

◆ getSyncResults()

SyncResults ClientThread::getSyncResults ( )

Returns the results for this particular thread.

◆ initError

void Buteo::ClientThread::initError ( const QString &  aProfileName,
const QString &  aMessage,
SyncResults::MinorCode  aErrorCode 
)
signal

Emitted when synchronization cannot be started due to an error in plugin initialization.

Parameters
aProfileNameName of the profile being synchronized
aMessageMessage data related to error event
aErrorCodeError code

◆ startThread()

bool ClientThread::startThread ( ClientPlugin aClientPlugin)

Starts client thread.

Parameters
aClientPluginClient plug-in to run. Plug-in is owned by the caller, and must not be deleted while the thread is running.
Returns
True on success, otherwise false

◆ stopThread()

void ClientThread::stopThread ( )

Stops client thread.


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