KDE PIM / Developers / API Docs / libkdepim

KPIM::ThreadWeaver::Event Class Reference

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

#include <weaver.h>

Inherits QCustomEvent.

List of all members.

Public Types

Public Member Functions

Static Public Member Functions


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.


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.

Member Function Documentation

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

Return the (custom defined) event type.

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

The ID of the sender thread.

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

The associated job.

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

The action.


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