-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Reintroduce ComThread and move base functions into ObjectFactory
The removal of the ComThread broke one use case of the win32.com.util packages. It was now necessary to explicitly handle threading and COM initialization. The intention was to broaden the possible use cases of the win32.com.util package. This changeset tries to reinstantiate the old functionality while keeping the benefits of the intended change by introducing a new baseclass.
- Loading branch information
1 parent
3a803b7
commit d188ddc
Showing
18 changed files
with
1,052 additions
and
268 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
150 changes: 150 additions & 0 deletions
150
contrib/platform/src/com/sun/jna/platform/win32/COM/util/ComThread.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| /* Copyright (c) 2014 Dr David H. Akehurst (itemis), All Rights Reserved | ||
| * | ||
| * This library is free software; you can redistribute it and/or | ||
| * modify it under the terms of the GNU Lesser General Public | ||
| * License as published by the Free Software Foundation; either | ||
| * version 2.1 of the License, or (at your option) any later version. | ||
| * | ||
| * This library is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
| * Lesser General Public License for more details. | ||
| */ | ||
| package com.sun.jna.platform.win32.COM.util; | ||
|
|
||
| import java.lang.Thread.UncaughtExceptionHandler; | ||
| import java.util.concurrent.Callable; | ||
| import java.util.concurrent.ExecutionException; | ||
| import java.util.concurrent.ExecutorService; | ||
| import java.util.concurrent.Executors; | ||
| import java.util.concurrent.ThreadFactory; | ||
| import java.util.concurrent.TimeUnit; | ||
| import java.util.concurrent.TimeoutException; | ||
|
|
||
| import com.sun.jna.platform.win32.Ole32; | ||
| import com.sun.jna.platform.win32.WinNT; | ||
| import com.sun.jna.platform.win32.COM.COMUtils; | ||
|
|
||
| public class ComThread { | ||
| private static ThreadLocal<Boolean> isCOMThread = new ThreadLocal<Boolean>(); | ||
|
|
||
| ExecutorService executor; | ||
| Runnable firstTask; | ||
| boolean requiresInitialisation; | ||
| long timeoutMilliseconds; | ||
| UncaughtExceptionHandler uncaughtExceptionHandler; | ||
|
|
||
| public ComThread(final String threadName, long timeoutMilliseconds, UncaughtExceptionHandler uncaughtExceptionHandler) { | ||
| this(threadName, timeoutMilliseconds, uncaughtExceptionHandler, Ole32.COINIT_MULTITHREADED); | ||
| } | ||
|
|
||
| public ComThread(final String threadName, long timeoutMilliseconds, UncaughtExceptionHandler uncaughtExceptionHandler, final int coinitialiseExFlag) { | ||
| this.requiresInitialisation = true; | ||
| this.timeoutMilliseconds = timeoutMilliseconds; | ||
| this.uncaughtExceptionHandler = uncaughtExceptionHandler; | ||
| this.firstTask = new Runnable() { | ||
| @Override | ||
| public void run() { | ||
| try { | ||
| //If we do not use COINIT_MULTITHREADED, it is necessary to have | ||
| // a message loop see - | ||
| // [http://www.codeguru.com/cpp/com-tech/activex/apts/article.php/c5529/Understanding-COM-Apartments-Part-I.htm] | ||
| // [http://www.codeguru.com/cpp/com-tech/activex/apts/article.php/c5533/Understanding-COM-Apartments-Part-II.htm] | ||
| WinNT.HRESULT hr = Ole32.INSTANCE.CoInitializeEx(null, coinitialiseExFlag); | ||
| isCOMThread.set(true); | ||
| COMUtils.checkRC(hr); | ||
| ComThread.this.requiresInitialisation = false; | ||
| } catch (Throwable t) { | ||
| ComThread.this.uncaughtExceptionHandler.uncaughtException(Thread.currentThread(), t); | ||
| } | ||
| } | ||
| }; | ||
| executor = Executors.newSingleThreadExecutor(new ThreadFactory() { | ||
|
|
||
| @Override | ||
| public Thread newThread(Runnable r) { | ||
| if (!ComThread.this.requiresInitialisation) { | ||
| // something has gone wrong! | ||
| throw new RuntimeException("ComThread executor has a problem."); | ||
| } | ||
| Thread thread = new Thread(r, threadName); | ||
| //make sure this is a daemon thread, or it will stop JVM existing | ||
| // if program does not call terminate(); | ||
| thread.setDaemon(true); | ||
|
|
||
| thread.setUncaughtExceptionHandler(new UncaughtExceptionHandler() { | ||
| @Override | ||
| public void uncaughtException(Thread t, Throwable e) { | ||
| ComThread.this.requiresInitialisation = true; | ||
| ComThread.this.uncaughtExceptionHandler.uncaughtException(t, e); | ||
| } | ||
| }); | ||
|
|
||
| return thread; | ||
| } | ||
| }); | ||
|
|
||
| } | ||
|
|
||
| /** | ||
| * Stop the COM Thread. | ||
| * | ||
| * @param timeoutMilliseconds | ||
| * number of milliseconds to wait for a clean shutdown before a | ||
| * forced shutdown is attempted | ||
| */ | ||
| public void terminate(long timeoutMilliseconds) { | ||
| try { | ||
|
|
||
| executor.submit(new Runnable() { | ||
| @Override | ||
| public void run() { | ||
| Ole32.INSTANCE.CoUninitialize(); | ||
| } | ||
| }).get(timeoutMilliseconds, TimeUnit.MILLISECONDS); | ||
|
|
||
| executor.shutdown(); | ||
|
|
||
| } catch (InterruptedException e) { | ||
| e.printStackTrace(); | ||
| } catch (ExecutionException e) { | ||
| e.printStackTrace(); | ||
| } catch (TimeoutException e) { | ||
| executor.shutdownNow(); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| protected void finalize() throws Throwable { | ||
| if (!executor.isShutdown()) { | ||
| this.terminate(100); | ||
| } | ||
| } | ||
|
|
||
| static void setComThread(boolean value) { | ||
| isCOMThread.set(value); | ||
| } | ||
|
|
||
| public <T> T execute(Callable<T> task) throws TimeoutException, InterruptedException, ExecutionException { | ||
| // If the call is done on a COM thread, invoke directly | ||
| // if the call comes from outside the invokation is dispatched | ||
| // into the Dispatch Thread. | ||
| Boolean comThread = isCOMThread.get(); | ||
| if(comThread == null) { | ||
| comThread = false; | ||
| } | ||
| if(comThread) { | ||
| try { | ||
| return task.call(); | ||
| } catch (Exception ex) { | ||
| throw new ExecutionException(ex); | ||
| } | ||
| } else { | ||
| if (this.requiresInitialisation) { | ||
| executor.execute(firstTask); | ||
| } | ||
| return executor.submit(task).get(this.timeoutMilliseconds, TimeUnit.MILLISECONDS); | ||
| } | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.