NEWT Utility class MainThread

FIXME: Update this documentation! This class just provides a main-thread utility, forking of a main java class on another thread while being able to continue doing platform specific things on the main-thread. The latter is essential for eg. MacOSX, where we continue to run NSApp.run().

This class provides a startup singleton main thread, from which a new thread with the users main class is launched.
Such behavior is necessary for native windowing toolkits, where the windowing management must happen on the so called main thread e.g. for Mac OS X !
Utilizing this class as a launchpad, now you are able to use a NEWT multithreaded application with window handling within the different threads, even on these restricted platforms.
To support your NEWT Window platform, you have to pass your main thread actions to invoke(..), have a look at the NEWT Mac OSX Window driver implementation

Todo

Some hardcoded dependencies exist in this implementation, where you have to patch this code or factor it out.

If your platform is not Mac OS X, but you want to test your code without modifying this class, you have to set the system property newt.MainThread.force to true.

The code is compatible with all other platform, which support multithreaded windowing handling. Since those platforms won't trigger the main thread serialization, the main method will be simply executed, in case you haven't set newt.MainThread.force to true.

Test case on Mac OS X (or any other platform):

   java -XstartOnFirstThread com.jogamp.newt.util.MainThread demos.es1.RedSquare -GL2 -GL2 -GL2 -GL2

Which starts 4 threads, each with a window and OpenGL rendering.

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static class	MainThread.UserApp

Field Summary

Modifier and Type	Field and Description
protected static final boolean	DEBUG
public static final boolean	HINT_USE_MAIN_THREAD if true, use the main thread EDT, otherwise AWT's EDT
private static final boolean	isMacOSX
private static final String	MACOSXDisplayClassName
private static MainThread.UserApp	mainAction
private static final Platform.OSType	osType
private static final ThreadGroup	rootThreadGroup
private static final MainThread	singletonMainThread
public static boolean	useMainThread

Access	Constructor and Description
public	MainThread()

Method Summary

Modifier and Type	Method and Description
private static final Thread[]	getAllThreads(final int[] count)
private static final int	getNonDaemonThreadCount(final List<Thread> ignoreThreads)
private static final List<Thread>	getNonDaemonThreads()
private static final ThreadGroup	getRootThreadGroup()
public static MainThread	getSingleton()
public static void	main(final String[] args) Your new java application main entry, which pipelines your application

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DEBUG	back to summary
protected static final boolean DEBUG

HINT_USE_MAIN_THREAD	back to summary
public static final boolean HINT_USE_MAIN_THREAD if true, use the main thread EDT, otherwise AWT's EDT

isMacOSX	back to summary
private static final boolean isMacOSX

MACOSXDisplayClassName	back to summary
private static final String MACOSXDisplayClassName

mainAction	back to summary
private static MainThread.UserApp mainAction

osType	back to summary
private static final Platform.OSType osType

rootThreadGroup	back to summary
private static final ThreadGroup rootThreadGroup

singletonMainThread	back to summary
private static final MainThread singletonMainThread

useMainThread	back to summary
public static boolean useMainThread

MainThread	back to summary
public MainThread()

Method Detail

getAllThreads	back to summary
private static final Thread[] getAllThreads(final int[] count)

getNonDaemonThreadCount	back to summary
private static final int getNonDaemonThreadCount(final List<Thread> ignoreThreads)

getNonDaemonThreads	back to summary
private static final List<Thread> getNonDaemonThreads()

getRootThreadGroup	back to summary
private static final ThreadGroup getRootThreadGroup()

getSingleton	back to summary
public static MainThread getSingleton()

main	back to summary
public static void main(final String[] args) throws SecurityException, NoSuchMethodException, ClassNotFoundException Your new java application main entry, which pipelines your application

com.jogamp.newt.util back to summary

pack-priv Class MainThread.UserApp

Class Inheritance

extends Thread

java.lang.Object
java.lang.Thread
com.jogamp.common.util.InterruptSource.Thread
com.jogamp.newt.util.MainThread.UserApp

Field Summary

Modifier and Type	Field and Description
private final String[]	mainClassArgs
private final Method	mainClassMain
private final String	mainClassName
private final String	mainClassNameShort
private List<Thread>	nonDaemonThreadsAtStart

Constructor Summary

Access	Constructor and Description
public	UserApp(final String mainClassName, final String[] mainClassArgs)

Method Summary

Modifier and Type	Method and Description
public void	run() Overrides java.lang.Thread.run. Implements java.lang.Runnable.run. This method is run by the thread when it executes.

Inherited from com.jogamp.common.util.InterruptSource.Thread:: clearInterruptSource create getInterruptCounter getInterruptSource interrupt

Field Detail

mainClassArgs	back to summary
private final String[] mainClassArgs

mainClassMain	back to summary
private final Method mainClassMain

mainClassName	back to summary
private final String mainClassName

mainClassNameShort	back to summary
private final String mainClassNameShort

nonDaemonThreadsAtStart	back to summary
private List<Thread> nonDaemonThreadsAtStart

Constructor Detail

UserApp	back to summary
public UserApp(final String mainClassName, final String[] mainClassArgs) throws SecurityException, NoSuchMethodException, ClassNotFoundException

Method Detail

run back to summary

run	back to summary
public void run() Overrides java.lang.Thread.run. Implements java.lang.Runnable.run. Doc from java.lang.Thread.run. This method is run by the thread when it executes. Subclasses of `Thread` may override this method. This method is not intended to be invoked directly. If this thread is a platform thread created with a `Runnable` task then invoking this method will invoke the task's `run` method. If this thread is a virtual thread then invoking this method directly does nothing. Annotations @Override

public void run()

Overrides java.lang.Thread.run.

Implements java.lang.Runnable.run.

Doc from java.lang.Thread.run.

This method is run by the thread when it executes. Subclasses of Thread may override this method.

This method is not intended to be invoked directly. If this thread is a platform thread created with a Runnable task then invoking this method will invoke the task's run method. If this thread is a virtual thread then invoking this method directly does nothing.

Annotations

@Override

public Class MainThread

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class MainThread.UserApp

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail