openshot-audio  0.1.6
Classes | Public Member Functions | Friends | List of all members
AsyncUpdater Class Referenceabstract

#include <juce_AsyncUpdater.h>

Inheritance diagram for AsyncUpdater:
ApplicationCommandManager AudioProcessorGraph ChildProcessPingThread CodeEditorComponent::Pimpl ComboBox Desktop FileListComponent::ItemComponent FileListTreeItem FilenameComponent MenuBarModel ModalComponentManager MouseInputSourceInternal OSXMessageBox ScrollBar Slider::Pimpl TableHeaderComponent Timer::TimerThread TreeView::ContentComponent Value::ValueSource WasapiClasses::WASAPIAudioIODevice WindowsMessageBox

Classes

class  AsyncUpdaterMessage
 

Public Member Functions

 AsyncUpdater ()
 
virtual ~AsyncUpdater ()
 
void triggerAsyncUpdate ()
 
void cancelPendingUpdate () noexcept
 
void handleUpdateNowIfNeeded ()
 
bool isUpdatePending () const noexcept
 
virtual void handleAsyncUpdate ()=0
 

Friends

class ReferenceCountedObjectPtr< AsyncUpdaterMessage >
 

Detailed Description

Has a callback method that is triggered asynchronously.

This object allows an asynchronous callback function to be triggered, for tasks such as coalescing multiple updates into a single callback later on.

Basically, one or more calls to the triggerAsyncUpdate() will result in the message thread calling handleAsyncUpdate() as soon as it can.

Constructor & Destructor Documentation

◆ AsyncUpdater()

AsyncUpdater::AsyncUpdater ( )

Creates an AsyncUpdater object.

◆ ~AsyncUpdater()

AsyncUpdater::~AsyncUpdater ( )
virtual

Destructor. If there are any pending callbacks when the object is deleted, these are lost.

Member Function Documentation

◆ cancelPendingUpdate()

void AsyncUpdater::cancelPendingUpdate ( )
noexcept

This will stop any pending updates from happening.

If called after triggerAsyncUpdate() and before the handleAsyncUpdate() callback happens, this will cancel the handleAsyncUpdate() callback.

Note that this method simply cancels the next callback - if a callback is already in progress on a different thread, this won't block until the callback finishes, so there's no guarantee that the callback isn't still running when the method returns.

◆ handleAsyncUpdate()

virtual void AsyncUpdater::handleAsyncUpdate ( )
pure virtual

Called back to do whatever your class needs to do.

This method is called by the message thread at the next convenient time after the triggerAsyncUpdate() method has been called.

Implemented in WindowsMessageBox, MouseInputSourceInternal, ComboBox, Slider::Pimpl, FileListTreeItem, FileListComponent::ItemComponent, MenuBarModel, and ModalComponentManager.

◆ handleUpdateNowIfNeeded()

void AsyncUpdater::handleUpdateNowIfNeeded ( )

If an update has been triggered and is pending, this will invoke it synchronously.

Use this as a kind of "flush" operation - if an update is pending, the handleAsyncUpdate() method will be called immediately; if no update is pending, then nothing will be done.

Because this may invoke the callback, this method must only be called on the main event thread.

◆ isUpdatePending()

bool AsyncUpdater::isUpdatePending ( ) const
noexcept

Returns true if there's an update callback in the pipeline.

◆ triggerAsyncUpdate()

void AsyncUpdater::triggerAsyncUpdate ( )

Causes the callback to be triggered at a later time.

This method returns immediately, having made sure that a callback to the handleAsyncUpdate() method will occur as soon as possible.

If an update callback is already pending but hasn't happened yet, calls to this method will be ignored.

It's thread-safe to call this method from any number of threads without needing to worry about locking.

Friends And Related Function Documentation

◆ ReferenceCountedObjectPtr< AsyncUpdaterMessage >


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