• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdelibs API Reference
  • KDE Home
  • Contact Us
 

ThreadWeaver

  • ThreadWeaver
  • State
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ThreadWeaver::State Class Referenceabstract

#include <State.h>

Inheritance diagram for ThreadWeaver::State:
Inheritance graph
[legend]

Public Member Functions

 State (WeaverInterface *weaver)
 
virtual ~State ()
 
virtual void activated ()
 
virtual Job * applyForWork (Thread *th, Job *previous)=0
 
virtual void resume ()=0
 
virtual StateId stateId () const =0
 
QString stateName () const
 
virtual void suspend ()=0
 
virtual void waitForAvailableJob (Thread *th)=0
 

Protected Member Functions

WeaverInterface * weaver ()
 

Protected Attributes

Private *const d
 

Detailed Description

We use a State pattern to handle the system state in ThreadWeaver.

Definition at line 73 of file State.h.

Constructor & Destructor Documentation

State::State ( WeaverInterface *  weaver)
explicit

Default constructor.

Definition at line 59 of file State.cpp.

State::~State ( )
virtual

Destructor.

Definition at line 64 of file State.cpp.

Member Function Documentation

void State::activated ( )
virtual

The state has been changed so that this object is responsible for state handling.

Reimplemented in ThreadWeaver::SuspendingState, and ThreadWeaver::WorkingHardState.

Definition at line 74 of file State.cpp.

virtual Job* ThreadWeaver::State::applyForWork ( Thread *  th,
Job *  previous 
)
pure virtual

Assign a job to an idle thread.

Parameters
ththe thread to give a new Job to
previousthe job this thread finished before calling

Implemented in ThreadWeaver::InConstructionState, ThreadWeaver::SuspendingState, ThreadWeaver::DestructedState, ThreadWeaver::ShuttingDownState, ThreadWeaver::SuspendedState, and ThreadWeaver::WorkingHardState.

virtual void ThreadWeaver::State::resume ( )
pure virtual

Resume job processing.

Implemented in ThreadWeaver::InConstructionState, ThreadWeaver::SuspendingState, ThreadWeaver::DestructedState, ThreadWeaver::ShuttingDownState, ThreadWeaver::SuspendedState, and ThreadWeaver::WorkingHardState.

virtual StateId ThreadWeaver::State::stateId ( ) const
pure virtual

The state Id.

Implemented in ThreadWeaver::SuspendingState, ThreadWeaver::InConstructionState, ThreadWeaver::WorkingHardState, ThreadWeaver::DestructedState, ThreadWeaver::ShuttingDownState, and ThreadWeaver::SuspendedState.

QString State::stateName ( ) const

The ID of the current state.

See also
StateNames, StateID

Definition at line 69 of file State.cpp.

virtual void ThreadWeaver::State::suspend ( )
pure virtual

Suspend job processing.

Implemented in ThreadWeaver::InConstructionState, ThreadWeaver::SuspendingState, ThreadWeaver::DestructedState, ThreadWeaver::ShuttingDownState, ThreadWeaver::SuspendedState, and ThreadWeaver::WorkingHardState.

virtual void ThreadWeaver::State::waitForAvailableJob ( Thread *  th)
pure virtual

Wait (by suspending the calling thread) until a job becomes available.

Implemented in ThreadWeaver::InConstructionState, ThreadWeaver::SuspendingState, ThreadWeaver::DestructedState, ThreadWeaver::ShuttingDownState, ThreadWeaver::SuspendedState, and ThreadWeaver::WorkingHardState.

WeaverInterface * State::weaver ( )
protected

The Weaver interface this state handles.

Definition at line 78 of file State.cpp.

Member Data Documentation

Private* const ThreadWeaver::State::d
protected

Definition at line 107 of file State.h.


The documentation for this class was generated from the following files:
  • State.h
  • State.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:48:53 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

ThreadWeaver

Skip menu "ThreadWeaver"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs API Reference

Skip menu "kdelibs API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  • kjsembed
  •   WTF
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Nepomuk-Core
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal