ThreadedSource Class Reference
#include <yatephone.h>
Public Member Functions | |
| virtual void | destroyed () |
| bool | start (const char *name="ThreadedSource", Thread::Priority prio=Thread::Normal) |
| void | stop () |
| Thread * | thread () const |
| bool | running () const |
| bool | asyncDelete () const |
Protected Member Functions | |
| ThreadedSource (const char *format="slin") | |
| void | asyncDelete (bool async) |
| void | clearThread () |
| virtual void | run ()=0 |
| virtual void | cleanup () |
| virtual bool | zeroRefsTest () |
Friends | |
| class | ThreadedSourcePrivate |
Detailed Description
A data source with a thread of its ownConstructor & Destructor Documentation
| ThreadedSource | ( | const char * | format = "slin" |
) | [inline, protected] |
Threaded Source constructor
- Parameters:
-
format Name of the data format, default "slin" (Signed Linear)
Member Function Documentation
| void asyncDelete | ( | bool | async | ) | [inline, protected] |
Derived classes should call this method to let the source to be destroyed asynchronously in the data thread
| bool asyncDelete | ( | ) | const [inline] |
Get the current status of the asynchronous deletion flag
| virtual void cleanup | ( | ) | [protected, virtual] |
The cleanup after thread method, deletes the source if already dereferenced and set for asynchronous deletion
| void clearThread | ( | ) | [inline, protected] |
Clear the worker thread pointer
| virtual void destroyed | ( | ) | [virtual] |
The destruction notification, stops the thread
Reimplemented from DataSource.
| virtual void run | ( | ) | [protected, pure virtual] |
The worker method. You have to reimplement it as you need
| bool running | ( | ) | const |
Check if the data thread is running
- Returns:
- True if the data thread was started and is running
| bool start | ( | const char * | name = "ThreadedSource", |
|
| Thread::Priority | prio = Thread::Normal | |||
| ) |
Starts the worker thread
- Parameters:
-
name Static name of this thread prio Thread's priority
- Returns:
- True if started, false if an error occured
| void stop | ( | ) |
Stops and destroys the worker thread if running
| Thread* thread | ( | ) | const |
Return a pointer to the worker thread
- Returns:
- Pointer to running worker thread or NULL
| virtual bool zeroRefsTest | ( | ) | [protected, virtual] |
Override so destruction can be delayed after all references were lost to let the data pumping thread end normally
- Returns:
- True to delete the source right away, false to defer
Reimplemented from RefObject.
The documentation for this class was generated from the following file:
