Class User32Util.MessageLoopThread

java.lang.Object

java.lang.Thread

com.sun.jna.platform.win32.User32Util.MessageLoopThread

All Implemented Interfaces:

Runnable

Enclosing class:

User32Util

public static class User32Util.MessageLoopThread
extends Thread

Helper class, that runs a windows message loop as a seperate thread. This is intended to be used in conjunction with APIs, that need a spinning message loop. One example for this are the DDE functions, that can only be used if a message loop is present. To enable interaction with the mainloop the MessageLoopThread allows to dispatch callables into the mainloop and let these Callables be invoked on the message thread. This implies, that the Callables should block the loop as short as possible.

Author:

Ralf HAMBERGER, Markus KARG (markus[at]headcrashing[dot]eu)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	User32Util.MessageLoopThread.Handler

Nested classes/interfaces inherited from class Thread

Thread.Builder, Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor	Description
MessageLoopThread()

Method Summary

Modifier and Type	Method	Description
void	exit()
protected boolean	getMessageFailed()	The method is called from the thread, that run the message dispatcher, when the call to User32.GetMessage(WinUser.MSG, WinDef.HWND, int, int) fails (returns -1).
void	run()
<V> Future<V>	runAsync(Callable<V> command)
<V> V	runOnThread(Callable<V> callable)

Methods inherited from class Thread

activeCount, checkAccess, clone, currentThread, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, isVirtual, join, join, join, join, ofPlatform, ofVirtual, onSpinWait, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, sleep, start, startVirtualThread, stop, threadId, toString, yield

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

MessageLoopThread

public MessageLoopThread()

Method Details

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

runAsync

public <V> Future<V> runAsync(Callable<V> command)

runOnThread

public <V> V runOnThread(Callable<V> callable)
                  throws Exception

Throws:

Exception

exit

public void exit()

getMessageFailed

protected boolean getMessageFailed()

The method is called from the thread, that run the message dispatcher, when the call to User32.GetMessage(WinUser.MSG, WinDef.HWND, int, int) fails (returns -1).

If the method returns true, the MainLoop is exitted, if it returns false the mainloop is resumed.

Default behavior: The error code is logged to the com.sun.jna.platform.win32.User32Util.MessageLoopThread logger and the main loop exists.

Returns:

true if MainLoop should exit, false it it should resume