Modifier and Type	Class and Description
public static enum	CLCommandQueuePool.FinishAction The action executed after a task completes.
private static class	CLCommandQueuePool.QueueThread
private static class	CLCommandQueuePool.QueueThreadFactory
private static class	CLCommandQueuePool.TaskWrapper<C extends CLQueueContext, R>

Modifier and Type	Field and Description
private List<CLQueueContext>	contexts
private ExecutorService	excecutor
private CLCommandQueuePool.FinishAction	finishAction
private boolean	released

Access	Constructor and Description
private	CLCommandQueuePool(final CLQueueContextFactory<C> factory, final Collection<CLCommandQueue> queues)

Method Summary

Modifier and Type	Method and Description
public static <C extends CLQueueContext> CLCommandQueuePool<C>	create(final CLQueueContextFactory<C> factory, final CLMultiContext mc, final CLCommandQueue.Mode... modes)
public static <C extends CLQueueContext> CLCommandQueuePool<C>	create(final CLQueueContextFactory<C> factory, final Collection<CLDevice> devices, final CLCommandQueue.Mode... modes)
public static <C extends CLQueueContext> CLCommandQueuePool<C>	create(final CLQueueContextFactory<C> factory, final Collection<CLCommandQueue> queues)
public void	finishQueues() Calls `CLCommandQueue#finish()` on all queues.
public void	flushQueues() Calls `CLCommandQueue#flush()` on all queues.
public CLCommandQueuePool.FinishAction	getFinishAction()
public List<CLCommandQueue>	getQueues() Returns the command queues used in this pool.
public int	getSize() Returns the size of this pool (number of command queues).
private List<CLQueueContext>	initContexts(final Collection<CLCommandQueue> queues, final CLQueueContextFactory<C> factory)
private void	initExecutor()
public <R> List<Future<R>>	invokeAll(final Collection<? extends CLTask<? super C, R>> tasks) Submits all tasks to the pool for immediate execution (blocking) and returns their `Future` holding the result.
public <R> List<Future<R>>	invokeAll(final Collection<? extends CLTask<? super C, R>> tasks, final long timeout, final TimeUnit unit) Submits all tasks to the pool for immediate execution (blocking) and returns their `Future` holding the result.
public boolean	isReleased() Implements com.jogamp.opencl.CLResource.isReleased. Returns true if `release()` has been called.
public void	release() Implements com.jogamp.opencl.CLResource.release. Releases all queues.
public void	setFinishAction(final CLCommandQueuePool.FinishAction action) Sets the action which is run after every completed task.
public <R> Future<R>	submit(final CLTask<? super C, R> task) Submits this task to the pool for execution returning its `Future`.
public <R> List<Future<R>>	submitAll(final Collection<? extends CLTask<? super C, R>> tasks) Submits all tasks to the pool for execution and returns their `Future`.
public CLCommandQueuePool<C>	Returns: this switchContext(final CLQueueContextFactory<C> factory) Switches the context of all queues - this operation can be expensive.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private <R> List<CLCommandQueuePool.TaskWrapper<C, R>>	wrapTasks(final Collection<? extends CLTask<? super C, R>> tasks)

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

Field Detail

contexts	back to summary
private List<CLQueueContext> contexts

excecutor	back to summary
private ExecutorService excecutor

finishAction	back to summary
private CLCommandQueuePool.FinishAction finishAction

released	back to summary
private boolean released

Constructor Detail

CLCommandQueuePool	back to summary
private CLCommandQueuePool(final CLQueueContextFactory<C> factory, final Collection<CLCommandQueue> queues)

Method Detail

create	back to summary
public static <C extends CLQueueContext> CLCommandQueuePool<C> create(final CLQueueContextFactory<C> factory, final CLMultiContext mc, final CLCommandQueue.Mode... modes)

create	back to summary
public static <C extends CLQueueContext> CLCommandQueuePool<C> create(final CLQueueContextFactory<C> factory, final Collection<CLDevice> devices, final CLCommandQueue.Mode... modes)

create	back to summary
public static <C extends CLQueueContext> CLCommandQueuePool<C> create(final CLQueueContextFactory<C> factory, final Collection<CLCommandQueue> queues)

finishQueues	back to summary
public void finishQueues() Calls `CLCommandQueue#finish()` on all queues.

flushQueues	back to summary
public void flushQueues() Calls `CLCommandQueue#flush()` on all queues.

getFinishAction	back to summary
public CLCommandQueuePool.FinishAction getFinishAction()

getQueues	back to summary
public List<CLCommandQueue> getQueues() Returns the command queues used in this pool.

getSize	back to summary
public int getSize() Returns the size of this pool (number of command queues).

initContexts	back to summary
private List<CLQueueContext> initContexts(final Collection<CLCommandQueue> queues, final CLQueueContextFactory<C> factory)

initExecutor	back to summary
private void initExecutor()

invokeAll back to summary

invokeAll	back to summary
public <R> List<Future<R>> invokeAll(final Collection<? extends CLTask<? super C, R>> tasks) throws InterruptedException Submits all tasks to the pool for immediate execution (blocking) and returns their `Future` holding the result. See Also `ExecutorService#invokeAll(java.util.Collection)`

public <R> List<Future<R>> invokeAll(final Collection<? extends CLTask<? super C, R>> tasks) throws InterruptedException

Submits all tasks to the pool for immediate execution (blocking) and returns their Future holding the result.

See Also: ExecutorService#invokeAll(java.util.Collection)

invokeAll back to summary

invokeAll	back to summary
public <R> List<Future<R>> invokeAll(final Collection<? extends CLTask<? super C, R>> tasks, final long timeout, final TimeUnit unit) throws InterruptedException Submits all tasks to the pool for immediate execution (blocking) and returns their `Future` holding the result. See Also `ExecutorService#invokeAll(java.util.Collection, long, java.util.concurrent.TimeUnit)`

public <R> List<Future<R>> invokeAll(final Collection<? extends CLTask<? super C, R>> tasks, final long timeout, final TimeUnit unit) throws InterruptedException

Submits all tasks to the pool for immediate execution (blocking) and returns their Future holding the result.

See Also: ExecutorService#invokeAll(java.util.Collection, long, java.util.concurrent.TimeUnit)

isReleased back to summary

isReleased	back to summary
public boolean isReleased() Implements com.jogamp.opencl.CLResource.isReleased. Doc from com.jogamp.opencl.CLResource.isReleased. Returns true if `release()` has been called. Annotations @Override

public boolean isReleased()

Implements com.jogamp.opencl.CLResource.isReleased.

Doc from com.jogamp.opencl.CLResource.isReleased.

Returns true if release() has been called.

Annotations

@Override

release	back to summary
public void release() Implements com.jogamp.opencl.CLResource.release. Releases all queues. Annotations @Override

release

back to summary

public void release()

Implements com.jogamp.opencl.CLResource.release.

Releases all queues.

Annotations

@Override

setFinishAction	back to summary
public void setFinishAction(final CLCommandQueuePool.FinishAction action) Sets the action which is run after every completed task. This is mainly intended for debugging, default value is `FinishAction#DO_NOTHING`.

submit back to summary

submit	back to summary
public <R> Future<R> submit(final CLTask<? super C, R> task) Submits this task to the pool for execution returning its `Future`. See Also `ExecutorService#submit(java.util.concurrent.Callable)`

public <R> Future<R> submit(final CLTask<? super C, R> task)

Submits this task to the pool for execution returning its Future.

See Also: ExecutorService#submit(java.util.concurrent.Callable)

submitAll	back to summary
public <R> List<Future<R>> submitAll(final Collection<? extends CLTask<? super C, R>> tasks) Submits all tasks to the pool for execution and returns their `Future`. Calls `submit(com.jogamp.opencl.util.concurrent.CLTask)` for every task.

switchContext	back to summary
public CLCommandQueuePool<C> switchContext(final CLQueueContextFactory<C> factory) Switches the context of all queues - this operation can be expensive. Blocks until all tasks finish and sets up a new context for all queues. Returns:CLCommandQueuePool<C> this

switchContext

back to summary

public CLCommandQueuePool<C> switchContext(final CLQueueContextFactory<C> factory)

Switches the context of all queues - this operation can be expensive. Blocks until all tasks finish and sets up a new context for all queues.

Returns:CLCommandQueuePool<C>: this

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

wrapTasks	back to summary
private <R> List<CLCommandQueuePool.TaskWrapper<C, R>> wrapTasks(final Collection<? extends CLTask<? super C, R>> tasks)

com.jogamp.opencl.util.concurrent back to summary

public final Enum CLCommandQueuePool.FinishAction

Class Inheritance

extends Enum<CLCommandQueuePool.FinishAction>

java.lang.Object
java.lang.Enum
com.jogamp.opencl.util.concurrent.CLCommandQueuePool.FinishAction

The action executed after a task completes.

Field Summary

Modifier and Type	Field and Description
public static final CLCommandQueuePool.FinishAction	DO_NOTHING Does nothing, the task is responsible to make sure all computations have finished when the task finishes
public static final CLCommandQueuePool.FinishAction	FINISH Finishes the queue on task completion.
public static final CLCommandQueuePool.FinishAction	FLUSH Flushes the queue on task completion.

Constructor Summary

Access	Constructor and Description
private	FinishAction()

Method Summary

Modifier and Type	Method and Description
public static CLCommandQueuePool.FinishAction	valueOf(String name)
public static CLCommandQueuePool.FinishAction[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DO_NOTHING	back to summary
public static final CLCommandQueuePool.FinishAction DO_NOTHING Does nothing, the task is responsible to make sure all computations have finished when the task finishes

FINISH	back to summary
public static final CLCommandQueuePool.FinishAction FINISH Finishes the queue on task completion.

FLUSH	back to summary
public static final CLCommandQueuePool.FinishAction FLUSH Flushes the queue on task completion.

Constructor Detail

FinishAction	back to summary
private FinishAction()

Method Detail

valueOf	back to summary
public static CLCommandQueuePool.FinishAction valueOf(String name)

values	back to summary
public static CLCommandQueuePool.FinishAction[] values()

com.jogamp.opencl.util.concurrent back to summary

private Class CLCommandQueuePool.QueueThread

Class Inheritance

extends Thread

java.lang.Object
java.lang.Thread
com.jogamp.common.util.InterruptSource.Thread
com.jogamp.opencl.util.concurrent.CLCommandQueuePool.QueueThread

Field Summary

Modifier and Type	Field and Description
private final CLQueueContext	context

Constructor Summary

Access	Constructor and Description
public	QueueThread(final ThreadGroup group, final Runnable runnable, final CLQueueContext context, final int index)

Method Summary

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

Field Detail

context	back to summary
private final CLQueueContext context

Constructor Detail

QueueThread	back to summary
public QueueThread(final ThreadGroup group, final Runnable runnable, final CLQueueContext context, final int index)

com.jogamp.opencl.util.concurrent back to summary

private Class CLCommandQueuePool.QueueThreadFactory

Class Inheritance

extends Object
implements ThreadFactory

java.lang.Object
com.jogamp.opencl.util.concurrent.CLCommandQueuePool.QueueThreadFactory

All Implemented Interfaces

java.util.concurrent.ThreadFactory

Field Summary

Modifier and Type	Field and Description
private final List<CLQueueContext>	context
private int	index

Constructor Summary

Access	Constructor and Description
private	QueueThreadFactory(final List<CLQueueContext> queues)

Method Summary

Modifier and Type	Method and Description
public synchronized Thread	newThread(final Runnable a runnable to be executed by new thread instance runnable) Implements java.util.concurrent.ThreadFactory.newThread. Constructs a new unstarted `Thread` to run the given runnable.

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

Field Detail

context	back to summary
private final List<CLQueueContext> context

index	back to summary
private int index

Constructor Detail

QueueThreadFactory	back to summary
private QueueThreadFactory(final List<CLQueueContext> queues)

Method Detail

newThread back to summary

newThread	back to summary
public synchronized Thread newThread(final Runnable runnable) Implements java.util.concurrent.ThreadFactory.newThread. Doc from java.util.concurrent.ThreadFactory.newThread. Constructs a new unstarted `Thread` to run the given runnable. Parameters runnable:Runnable a runnable to be executed by new thread instance Returns:Thread constructed thread, or `null` if the request to create a thread is rejected

public synchronized Thread newThread(final Runnable runnable)

Implements java.util.concurrent.ThreadFactory.newThread.

Doc from java.util.concurrent.ThreadFactory.newThread.

Constructs a new unstarted Thread to run the given runnable.

Parameters

runnable:Runnable: a runnable to be executed by new thread instance

Returns:Thread

constructed thread, or null if the request to create a thread is rejected

com.jogamp.opencl.util.concurrent back to summary

private Class CLCommandQueuePool.TaskWrapper<C extends CLQueueContext, R>

Class Inheritance

extends Object
implements Callable<R>

java.lang.Object
com.jogamp.opencl.util.concurrent.CLCommandQueuePool.TaskWrapper

All Implemented Interfaces

java.util.concurrent.Callable

Field Summary

Modifier and Type	Field and Description
private final CLCommandQueuePool.FinishAction	mode
private final CLTask<? super C, R>	task

Constructor Summary

Access	Constructor and Description
public	TaskWrapper(final CLTask<? super C, R> task, final CLCommandQueuePool.FinishAction mode)

Method Summary

Modifier and Type	Method and Description
public R	call() Implements java.util.concurrent.Callable.call. Computes a result, or throws an exception if unable to do so.

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

Field Detail

mode	back to summary
private final CLCommandQueuePool.FinishAction mode

task	back to summary
private final CLTask<? super C, R> task

Constructor Detail

TaskWrapper	back to summary
public TaskWrapper(final CLTask<? super C, R> task, final CLCommandQueuePool.FinishAction mode)

Method Detail

call

back to summary

public R call() throws Exception

Implements java.util.concurrent.Callable.call.

Doc from java.util.concurrent.Callable.call.

Computes a result, or throws an exception if unable to do so.

Returns:R

computed result

Exceptions

Exception:: if unable to compute a result

public Class CLCommandQueuePool<C extends CLQueueContext>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum CLCommandQueuePool.FinishAction

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class CLCommandQueuePool.QueueThread

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

private Class CLCommandQueuePool.QueueThreadFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class CLCommandQueuePool.TaskWrapper<C extends CLQueueContext, R>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail