libkdepim Library API Documentation

KPIM::ThreadWeaver::Event Class Reference

A class to represent the events threads generate and send to the Weaver object. More...

#include <weaver.h>

Inheritance diagram for KPIM::ThreadWeaver::Event:

QCustomEvent List of all members.

Public Types

enum  Action {
  NoAction = 0, Finished, Suspended, ThreadStarted,
  ThreadExiting, ThreadBusy, ThreadSuspended, JobStarted,
  JobFinished, JobSPR, JobAPR
}

Public Methods

 Event (Action=NoAction, Thread *=0, Job *job=0)
Threadthread () const
Jobjob () const
Action action () const

Static Public Methods

const int type ()

Detailed Description

A class to represent the events threads generate and send to the Weaver object.

Examples include the start or end of the processing of a job. Threads create the event objects and discard them after posting the event, since the event receiver will assume ownership of the event. Events are associated to the sending thread and possibly to a processed job.

Note: Do not create and use SPR/APR events, use Job::triggerSPR or Job::triggerAPR to create the requests.

Definition at line 98 of file weaver.h.


Member Enumeration Documentation

enum KPIM::ThreadWeaver::Event::Action
 

Enumeration values:
Suspended  All jobs in the queue are done.
ThreadStarted  Thread queueing halted.
JobAPR  Asynchronous Process Request.

Definition at line 101 of file weaver.h.


Member Function Documentation

const int KPIM::ThreadWeaver::Event::type   [static]
 

Return the (custom defined) event type.

Definition at line 154 of file weaver.cpp.

Thread * KPIM::ThreadWeaver::Event::thread   const
 

The ID of the sender thread.

Definition at line 159 of file weaver.cpp.

Referenced by KPIM::ThreadWeaver::Weaver::event().

Job * KPIM::ThreadWeaver::Event::job   const
 

The associated job.

Definition at line 169 of file weaver.cpp.

Referenced by KPIM::ThreadWeaver::Weaver::event().

Event::Action KPIM::ThreadWeaver::Event::action   const
 

The action.

Definition at line 174 of file weaver.cpp.

Referenced by KPIM::ThreadWeaver::Weaver::event(), and KPIM::ThreadWeaver::Job::processEvent().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for libkdepim Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat May 1 11:36:32 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003