summaryrefslogtreecommitdiffstats
path: root/src/com/jogamp/opencl/util/concurrent/CLPoolable.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/com/jogamp/opencl/util/concurrent/CLPoolable.java')
-rw-r--r--src/com/jogamp/opencl/util/concurrent/CLPoolable.java59
1 files changed, 59 insertions, 0 deletions
diff --git a/src/com/jogamp/opencl/util/concurrent/CLPoolable.java b/src/com/jogamp/opencl/util/concurrent/CLPoolable.java
new file mode 100644
index 00000000..6efd8dee
--- /dev/null
+++ b/src/com/jogamp/opencl/util/concurrent/CLPoolable.java
@@ -0,0 +1,59 @@
+/*
+ * Copyright (c) 2011, Michael Bien
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification, are
+ * permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this list of
+ * conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice, this list
+ * of conditions and the following disclaimer in the documentation and/or other materials
+ * provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+
+/*
+ * Created on Tuesday, August 02 2011 21:51
+ */
+package com.jogamp.opencl.util.concurrent;
+
+import com.jogamp.opencl.CLCommandQueue;
+
+/**
+ * A OpenCL task designed to be executed in a managed environment.
+ * @author Michael Bien
+ */
+public interface CLPoolable<C extends CLQueueContext, R> {
+
+ /**
+ * Creates a CLQueueContext for this task. A context may contain static resources
+ * like OpenCL program binaries or pre allocated buffers. A context can be used by an group
+ * of tasks identified by a common context key ({@link #getContextKey()}). This method
+ * won't be called if a context was already created by an previously executed task having the
+ * same context key.
+ */
+ C createQueueContext(CLCommandQueue queue);
+
+ /**
+ * Runs the task on a queue and returns a result.
+ */
+ R execute(C context);
+
+ /**
+ * Returns the context key for this task.
+ */
+ Object getContextKey();
+
+}