#include <juce_MessageManager.h>
This class is in charge of the application's event-dispatch loop.
- See Also
- Message, CallbackMessage, MessageManagerLock, JUCEApplication, JUCEApplicationBase
MessageManager::~MessageManager |
( |
| ) |
|
|
noexcept |
void MessageManager::broadcastMessage |
( |
const String & |
messageText | ) |
|
|
static |
Sends a message to all other JUCE applications that are running.
- Parameters
-
messageText | the string that will be passed to the actionListenerCallback() method of the broadcast listeners in the other app. |
- See Also
- registerBroadcastListener, ActionListener
Calls a function using the message-thread.
This can be used by any thread to cause this function to be called-back by the message thread. If it's the message-thread that's calling this method, then the function will just be called; if another thread is calling, a message will be posted to the queue, and this method will block until that message is delivered, the function is called, and the result is returned.
Be careful not to cause any deadlocks with this! It's easy to do - e.g. if the caller thread has a critical section locked, which an unrelated message callback then tries to lock before the message thread gets round to processing this callback.
- Parameters
-
callback | the function to call - its signature must bevoid* myCallbackFunction (void*)
|
userData | a user-defined pointer that will be passed to the function that gets called |
- Returns
- the value that the callback function returns.
- See Also
- MessageManagerLock
bool MessageManager::currentThreadHasLockedMessageManager |
( |
| ) |
const |
|
noexcept |
Returns true if the caller thread has currently got the message manager locked.
see the MessageManagerLock class for more info about this.
This will be true if the caller is the message thread, because that automatically gains a lock while a message is being dispatched.
void MessageManager::deleteInstance |
( |
| ) |
|
|
static |
Deletes the global MessageManager instance. Does nothing if no instance had been created.
void MessageManager::deliverBroadcastMessage |
( |
const String & |
value | ) |
|
void MessageManager::deregisterBroadcastListener |
( |
ActionListener * |
listener | ) |
|
Deregisters a broadcast listener.
Returns the global instance of the MessageManager, or nullptr if it doesn't exist.
bool MessageManager::hasStopMessageBeenSent |
( |
| ) |
const |
|
inlinenoexcept |
bool MessageManager::isThisTheMessageThread |
( |
| ) |
const |
|
noexcept |
Returns true if the caller-thread is the message thread.
void MessageManager::registerBroadcastListener |
( |
ActionListener * |
listener | ) |
|
Registers a listener to get told about broadcast messages.
The actionListenerCallback() callback's string parameter is the message passed into broadcastMessage().
- See Also
- broadcastMessage
void MessageManager::runDispatchLoop |
( |
| ) |
|
Runs the event dispatch loop until a stop message is posted.
This method is only intended to be run by the application's startup routine, as it blocks, and will only return after the stopDispatchLoop() method has been used.
- See Also
- stopDispatchLoop
void MessageManager::setCurrentThreadAsMessageThread |
( |
| ) |
|
Called to tell the manager that the current thread is the one that's running the dispatch loop.
(Best to ignore this method unless you really know what you're doing..)
- See Also
- getCurrentMessageThread
void MessageManager::stopDispatchLoop |
( |
| ) |
|
Sends a signal that the dispatch loop should terminate.
After this is called, the runDispatchLoop() or runDispatchLoopUntil() methods will be interrupted and will return.
- See Also
- runDispatchLoop
The documentation for this class was generated from the following files: