blob: 597313efaaebdf26ef0dd69d920ca7e4de84b859 (
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
|
/*
* 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();
}
|
