KisBusyWaitBroker Class Reference

a simple singleton class for tracking busy-waits on the image and breaking deadlock ties when needed. More...

#include <KisBusyWaitBroker.h>

Classes
struct	Private

Public Member Functions
bool	guiThreadIsWaitingForBetterWeather () const
	KisBusyWaitBroker ()
void	notifyGeneralWaitEnded ()
void	notifyGeneralWaitStarted ()
void	notifyWaitOnImageEnded (KisImage *image)
void	notifyWaitOnImageStarted (KisImage *image)
void	setFeedbackCallback (std::function< void(KisImageSP)> callback)
	~KisBusyWaitBroker ()

Static Public Member Functions
static KisBusyWaitBroker *	instance ()

Private Member Functions
	Q_DISABLE_COPY (KisBusyWaitBroker)

Private Attributes
QScopedPointer< Private >	m_d

Detailed Description

a simple singleton class for tracking busy-waits on the image and breaking deadlock ties when needed.

When KisImage::barrierLock()/waitForDone() goes into sleep, waiting for the worker threads to finish, it notifies KisBusyWaitBroker about that. Therefore worker threads know that GUI thread is inactive now and can resolve the ties.

Definition at line 20 of file KisBusyWaitBroker.h.

Constructor & Destructor Documentation

KisBusyWaitBroker()

KisBusyWaitBroker::KisBusyWaitBroker

(

)

Definition at line 31 of file KisBusyWaitBroker.cpp.

    : m_d(new Private)
{
}

~KisBusyWaitBroker()

KisBusyWaitBroker::~KisBusyWaitBroker

(

)

Definition at line 36 of file KisBusyWaitBroker.cpp.

{
}

Member Function Documentation

guiThreadIsWaitingForBetterWeather()

bool KisBusyWaitBroker::guiThreadIsWaitingForBetterWeather

(

)

const

Returns

true if GUI thread is currently sleeping on an image lock. When a worker thread is sure that GUI thread is sleeping, it has a bit more freedom in manipulating the image (and especially vector shapes)

Definition at line 103 of file KisBusyWaitBroker.cpp.

{
    return m_d->guiThreadLockCount;
}

References m_d.

instance()

KisBusyWaitBroker * KisBusyWaitBroker::instance ( )

static

Definition at line 40 of file KisBusyWaitBroker.cpp.

{
    return s_instance;
}

notifyGeneralWaitEnded()

void KisBusyWaitBroker::notifyGeneralWaitEnded

(

)

Definition at line 90 of file KisBusyWaitBroker.cpp.

{
    if (QThread::currentThread() != qApp->thread()) return;
 
    QMutexLocker l(&m_d->lock);
    m_d->guiThreadLockCount--;
}

References m_d.

notifyGeneralWaitStarted()

void KisBusyWaitBroker::notifyGeneralWaitStarted

(

)

Definition at line 82 of file KisBusyWaitBroker.cpp.

{
    if (QThread::currentThread() != qApp->thread()) return;
 
    QMutexLocker l(&m_d->lock);
    m_d->guiThreadLockCount++;
}

References m_d.

notifyWaitOnImageEnded()

void KisBusyWaitBroker::notifyWaitOnImageEnded

(

KisImage *

image

)

Definition at line 65 of file KisBusyWaitBroker.cpp.

{
    if (QThread::currentThread() != qApp->thread()) return;
 
    {
        QMutexLocker l(&m_d->lock);
        m_d->guiThreadLockCount--;
 
        m_d->waitingOnImages[image]--;
        KIS_SAFE_ASSERT_RECOVER_NOOP(m_d->waitingOnImages[image] >= 0);
 
        if (m_d->waitingOnImages[image] == 0) {
            m_d->waitingOnImages.remove(image);
        }
    }
}

References KIS_SAFE_ASSERT_RECOVER_NOOP, and m_d.

notifyWaitOnImageStarted()

void KisBusyWaitBroker::notifyWaitOnImageStarted

(

KisImage *

image

)

Definition at line 45 of file KisBusyWaitBroker.cpp.

{
    if (QThread::currentThread() != qApp->thread()) return;
 
    bool needsStartCallback = false;
 
    {
        QMutexLocker l(&m_d->lock);
 
        m_d->guiThreadLockCount++;
        m_d->waitingOnImages[image]++;
 
        needsStartCallback = m_d->waitingOnImages[image] == 1;
    }
 
    if (m_d->feedbackCallback && needsStartCallback && image->refCount()) {
        m_d->feedbackCallback(image);
    }
}

References m_d, and KisShared::refCount().

Q_DISABLE_COPY()

KisBusyWaitBroker::Q_DISABLE_COPY ( KisBusyWaitBroker )

private

setFeedbackCallback()

void KisBusyWaitBroker::setFeedbackCallback

(

std::function< void(KisImageSP)>

callback

)

Set a callback that is called before image goes into sleep. This callback may show the user some feedback window with a progress bar.

This callback is expected to be initialized during the construction of KisPart.

Definition at line 98 of file KisBusyWaitBroker.cpp.

{
    m_d->feedbackCallback = callback;
}

References m_d.

Member Data Documentation

m_d

QScopedPointer<Private> KisBusyWaitBroker::m_d

private

Definition at line 56 of file KisBusyWaitBroker.h.

---

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

• libs/image/KisBusyWaitBroker.h
• libs/image/KisBusyWaitBroker.cpp