blob: c70ccfa7e934395d7fa303aac4210451ce17dc19 (
plain)
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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
package com.sun.star.lib.uno.environments.remote;
/**
* This interface is an abstraction of the various
* threadpool implementations.
* <p>
* @version $Revision: 1.7 $ $ $Date: 2008-04-11 11:20:01 $
* @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();
}
|
