JUCE: TimeSliceClient Class Reference

JUCE

Public Member Functions | List of all members
TimeSliceClient Class Referenceabstract

Used by the TimeSliceThread class. More...

Inheritance diagram for TimeSliceClient:

## Public Member Functions
virtual | ~TimeSliceClient ()=default
| Destructor. More...
virtual int | useTimeSlice ()=0
| Called back by a TimeSliceThread. More...

## Detailed Description

Used by the TimeSliceThread class.

To register your class with a TimeSliceThread, derive from this class and use the TimeSliceThread::addTimeSliceClient() method to add it to the list.

Make sure you always call TimeSliceThread::removeTimeSliceClient() before deleting your client!

See also
  TimeSliceThread

## Constructor & Destructor Documentation

## ◆ ~TimeSliceClient()

virtual TimeSliceClient::~TimeSliceClient | ( |  | ) |
| virtualdefault

Destructor.

## Member Function Documentation

## ◆ useTimeSlice()

virtual int TimeSliceClient::useTimeSlice | ( |  | ) |
| pure virtual

Called back by a TimeSliceThread.

When you register this class with it, a TimeSliceThread will repeatedly call this method.

The implementation of this method should use its time-slice to do something that's quick - never block for longer than absolutely necessary.

Returns
  Your method should return the number of milliseconds which it would like to wait before being called again. Returning 0 will make the thread call again as soon as possible (after possibly servicing other busy clients). If you return a value below zero, your client will be removed from the list of clients, and won't be called again. The value you specify isn't a guaranteee, and is only used as a hint by the thread - the actual time before the next callback may be more or less than specified. You can force the TimeSliceThread to wake up and poll again immediately by calling its notify() method.

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

- juce_TimeSliceThread.h