1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: IThreadPool.java,v $
*
* $Revision: 1.6 $
*
* last change: $Author: rt $ $Date: 2005-09-07 19:00:03 $
*
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1.
*
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2005 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* 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.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
************************************************************************/
package com.sun.star.lib.uno.environments.remote;
/**
* This interface is an abstraction of the various
* threadpool implementations.
* <p>
* @version $Revision: 1.6 $ $ $Date: 2005-09-07 19:00:03 $
* @author Joerg Budischewski
* @author Kay Ramme
* @see com.sun.star.lib.uno.environments.remote.ThreadPoolFactory
* @see com.sun.star.lib.uno.environments.remote.IThreadPoolFactory
* @since UDK1.0
*/
public interface IThreadPool {
/**
* Retrieves the global threadId for the current thread.
* <p>
* @return the thread id
*/
ThreadId getThreadId();
/**
* Attaches this thread to the thread pool.
* <p>
* @see #enter
*/
public void attach();
/**
* As above, but hands in an already existing
* instance of the threadid of the current thread.
* Returns a handle which can be used in enter and
* detach calls.<p>
* The function exists for performance
* optimization reasons.
* @see #attach
*/
public Object attach( ThreadId id );
/**
* Detaches this thread from the thread pool.
* @see #enter
*/
public void detach();
/**
* As above, but hands in an already existing
* instance of the threadid of the current thread
* and a handle returned by attach.
* The function exists for performance
* optimization reasons.
* @see #attach,#detach
*/
public void detach( Object handle, ThreadId id );
/**
* Lets this thread enter the thread pool.
* This thread then executes all jobs put via
* <code>putJob</code> until a reply job arrives.
* <p>
* @see #putJob
*/
public 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.
* This thread then executes all jobs put via
* <code>putJob</code> until a reply job arrives.
* <p>
* @see #putJob
*/
public Object enter( Object handle, ThreadId id ) throws Throwable;
/**
* Queues a job into the jobQueue of the thread belonging
* to the jobs threadId.
* <p>
* @param job the job
*/
public void putJob(Job job);
/**
* Disposes this thread pool, thus releasing
* all threads by throwing the given
* <code>Throwable</code>.
* <p>
* @param throwing the Throwable
*/
public void dispose(Throwable throwable);
/**
* Destroys the thread pool and tries
* to join all created threads immediatly.
*/
public void destroy();
}
|
