jurt/com/sun/star/lib/uno/environments/remote/IThreadPool.java

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: IThreadPool.java,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 package com.sun.star.lib.uno.environments.remote;
  32
  33 /**
  34  * This interface is an abstraction of the various
  35  * threadpool implementations.
  36  * <p>
  37  * @version     $Revision: 1.7 $ $ $Date: 2008-04-11 11:20:01 $
  38  * @author          Joerg Budischewski
  39  * @author          Kay Ramme
  40  * @see         com.sun.star.lib.uno.environments.remote.ThreadPoolFactory
  41  * @see         com.sun.star.lib.uno.environments.remote.IThreadPoolFactory
  42  * @since       UDK1.0
  43  */
  44 public interface IThreadPool {
  45     /**
  46      * Retrieves the global threadId for the current thread.
  47      * <p>
  48      * @return the thread id
  49      */
  50     ThreadId getThreadId();
  51
  52     /**
  53      * Attaches this thread to the thread pool.
  54      * <p>
  55      * @see                 #enter
  56      */
  57     public void attach();
  58
  59     /**
  60      * As above, but hands in an already existing
  61      * instance of the threadid of the current thread.
  62      * Returns a handle which can be used in enter and
  63      * detach calls.<p>
  64      * The function exists for performance
  65      * optimization reasons.
  66      * @see #attach
  67      */
  68     public Object attach( ThreadId id );
  69
  70     /**
  71      * Detaches this thread from the thread pool.
  72      * @see                 #enter
  73      */
  74     public void detach();
  75
  76     /**
  77      * As above, but hands in an already existing
  78      * instance of the threadid of the current thread
  79      * and a handle returned by attach.
  80      * The function exists for performance
  81      * optimization reasons.
  82      * @see #attach,#detach
  83      */
  84     public void detach( Object handle, ThreadId id );
  85
  86     /**
  87      * Lets this thread enter the thread pool.
  88      * This thread then executes all jobs put via
  89      * <code>putJob</code> until a reply job arrives.
  90      * <p>
  91      * @see                 #putJob
  92      */
  93     public Object enter() throws Throwable;
  94
  95     /**
  96      * as above but hands in an already existing
  97      * instance of the threadid of the current thread
  98      * and a handle returned by attach.
  99      * This thread then executes all jobs put via
 100      * <code>putJob</code> until a reply job arrives.
 101      * <p>
 102      * @see                 #putJob
 103      */
 104     public Object enter( Object handle, ThreadId id ) throws Throwable;
 105
 106     /**
 107      * Queues a job into the jobQueue of the thread belonging
 108      * to the jobs threadId.
 109      * <p>
 110      * @param job       the job
 111      */
 112     public void putJob(Job job);
 113
 114     /**
 115      * Disposes this thread pool, thus releasing
 116      * all threads by throwing the given
 117      * <code>Throwable</code>.
 118      * <p>
 119      * @param throwing   the Throwable
 120      */
 121     public void dispose(Throwable throwable);
 122
 123
 124     /**
 125      * Destroys the thread pool and tries
 126      * to join all created threads immediatly.
 127      */
 128     public void destroy();
 129 }
 130