1 files changed, 115 insertions, 0 deletions
diff --git a/ridljar/com/sun/star/lib/uno/environments/remote/IThreadPool.java b/ridljar/com/sun/star/lib/uno/environments/remote/IThreadPool.java
new file mode 100644
index 000000000..1de31ad04
--- /dev/null
+++ b/ridljar/com/sun/star/lib/uno/environments/remote/IThreadPool.java
@@ -0,0 +1,115 @@
+/* -*- Mode: Java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+package com.sun.star.lib.uno.environments.remote;
+
+/**
+ * This interface is an abstraction of the various threadpool implementations.
+ *
+ * @see         com.sun.star.lib.uno.environments.remote.ThreadPoolManager
+ * @since       UDK1.0
+ */
+public interface IThreadPool {
+    /**
+     * Retrieves the global threadId for the current thread.
+     *
+     * @return the thread id.
+     */
+    ThreadId getThreadId();
+
+    /**
+     * Attaches this thread to the thread pool.
+     *
+     * @see                 #enter
+     */
+    void attach();
+
+    /**
+     * As above, but hands in an already existing instance of the threadid of
+     * the current thread.
+     *
+     * <p>The function exists for performance.</p>
+     *
+     * @return Returns a handle which can be used in enter and detach calls.
+     * @see #attach
+     */
+    Object attach( ThreadId id );
+
+    /**
+     * Detaches this thread from the thread pool.
+     * @see                 #enter
+     */
+    void detach();
+
+    /**
+     * As above, but hands in an already existing instance of the threadid of
+     * the current thread and a handle returned by attach.
+     *
+     * <p>The function exists for performance.</p>
+     *
+     * @see #attach()
+     * @see #detach()
+     */
+    void detach( Object handle, ThreadId id );
+
+    /**
+     * Lets this thread enter the thread pool.
+     *
+     * <p>This thread then executes all jobs put via <code>putJob</code> until
+     * a reply job arrives.</p>
+     *
+     * @see                 #putJob
+     */
+    Object enter() throws Throwable;
+
+    /**
+     * As above but hands in an already existing instance of the threadid of
+     * the current thread and a handle returned by attach.
+     *
+     * <p>This thread then executes all jobs put via <code>putJob</code> until
+     * a reply job arrives.</p>
+     *
+     * @see                 #putJob
+     */
+    Object enter( Object handle, ThreadId id ) throws Throwable;
+
+    /**
+     * Queues a job into the jobQueue of the thread belonging to the jobs
+     * threadId.
+     *
+     * @param job       the job
+     */
+    void putJob(Job job);
+
+    /**
+     * Disposes this thread pool, thus releasing all threads by throwing a
+     * <code>DisposedException</code> with the given <code>Throwable</code> cause.
+     *
+     * @param throwable   the cause
+     */
+    void dispose(Throwable throwable);
+
+
+    /**
+     * Destroys the thread pool and tries to join all created threads immediately.
+     */
+    void destroy();
+}
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */