YARP
Yet Another Robot Platform
PlayStreamThread Class Reference

#include <portaudioPlayer/PortAudioPlayerDeviceDriver.h>

+ Inheritance diagram for PlayStreamThread:

Public Member Functions

 PlayStreamThread ()
 
void threadRelease () override
 Release method. More...
 
bool threadInit () override
 Initialization method. More...
 
void run () override
 Main body of the new thread. More...
 
- Public Member Functions inherited from yarp::os::Thread
 Thread ()
 Constructor. More...
 
virtual ~Thread ()
 Destructor. More...
 
virtual void onStop ()
 Call-back, called while halting the thread (before join). More...
 
bool start ()
 Start the new thread running. More...
 
bool stop ()
 Stop the thread. More...
 
virtual void beforeStart ()
 Called just before a new thread starts. More...
 
virtual void afterStart (bool success)
 Called just after a new thread starts (or fails to start), this is executed by the same thread that calls start(). More...
 
bool isStopping ()
 Returns true if the thread is stopping (Thread::stop has been called). More...
 
bool isRunning ()
 Returns true if the thread is running (Thread::start has been called successfully and the thread has not stopped). More...
 
long int getKey ()
 Get a unique identifier for the thread. More...
 
int setPriority (int priority, int policy=-1)
 Set the priority and scheduling policy of the thread, if the OS supports that. More...
 
int getPriority ()
 Query the current priority of the thread, if the OS supports that. More...
 
int getPolicy ()
 Query the current scheduling policy of the thread, if the OS supports that. More...
 
bool join (double seconds=-1)
 The function returns when the thread execution has completed. More...
 
void setOptions (int stackSize=0)
 Set the stack size for the new thread. More...
 

Public Attributes

bool something_to_play
 
PaStream * stream
 

Additional Inherited Members

- Static Public Member Functions inherited from yarp::os::Thread
static int getCount ()
 Check how many threads are running. More...
 
static long int getKeyOfCaller ()
 Get a unique identifier for the calling thread. More...
 
static void yield ()
 Reschedule the execution of current thread, allowing other threads to run. More...
 
static void setDefaultStackSize (int stackSize)
 Set the default stack size for all threads created after this point. More...
 

Detailed Description

Definition at line 47 of file PortAudioPlayerDeviceDriver.h.

Constructor & Destructor Documentation

◆ PlayStreamThread()

PlayStreamThread::PlayStreamThread ( )

Definition at line 133 of file PortAudioPlayerDeviceDriver.cpp.

Member Function Documentation

◆ run()

void PlayStreamThread::run ( )
overridevirtual

Main body of the new thread.

Override this method to do what you want. After Thread::start is called, this method will start running in a separate thread. It is important that this method either keeps checking Thread::isStopping to see if it should stop, or you override the Thread::onStop method to interact with it in some way to shut the new thread down. There is no really reliable, portable way to stop a thread cleanly unless that thread cooperates.

Implements yarp::os::Thread.

Definition at line 150 of file PortAudioPlayerDeviceDriver.cpp.

◆ threadInit()

bool PlayStreamThread::threadInit ( )
overridevirtual

Initialization method.

The thread executes this function when it starts and before "run". This is a good place to perform initialization tasks that need to be done by the thread itself (device drivers initialization, memory allocation etc). If the function returns false the thread quits and never calls "run". The return value of threadInit() is notified to the class and passed as a parameter to afterStart(). Note that afterStart() is called by the same thread that is executing the "start" method.

Reimplemented from yarp::os::Thread.

Definition at line 144 of file PortAudioPlayerDeviceDriver.cpp.

◆ threadRelease()

void PlayStreamThread::threadRelease ( )
overridevirtual

Release method.

The thread executes this function once when it exits, after the last "run". This is a good place to release resources that were initialized in threadInit() (release memory, and device driver resources).

Reimplemented from yarp::os::Thread.

Definition at line 140 of file PortAudioPlayerDeviceDriver.cpp.

Member Data Documentation

◆ something_to_play

bool PlayStreamThread::something_to_play

Definition at line 56 of file PortAudioPlayerDeviceDriver.h.

◆ stream

PaStream* PlayStreamThread::stream

Definition at line 57 of file PortAudioPlayerDeviceDriver.h.


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