libkdepim

KPIM::ThreadWeaver::Event Class Reference

#include <weaver.h>

List of all members.


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 100 of file weaver.h.


Public Types

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

Public Member Functions

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

Static Public Member Functions

static const int type ()

Member Enumeration Documentation

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

Definition at line 103 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.

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

The associated job.

Definition at line 169 of file weaver.cpp.

Event::Action KPIM::ThreadWeaver::Event::action (  )  const

The action.

Definition at line 174 of file weaver.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys