author | clanger |
Fri, 16 Jun 2017 14:09:31 +0200 | |
changeset 45564 | 0149773a140c |
parent 34894 | 3248b89d1921 |
permissions | -rw-r--r-- |
2 | 1 |
/* |
23010
6dadb192ad81
8029235: Update copyright year to match last edit in jdk8 jdk repository for 2013
lana
parents:
20742
diff
changeset
|
2 |
* Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved. |
2 | 3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 |
* |
|
5 |
* This code is free software; you can redistribute it and/or modify it |
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
|
5506 | 7 |
* published by the Free Software Foundation. Oracle designates this |
2 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5506 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
2 | 10 |
* |
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
|
15 |
* accompanied this code). |
|
16 |
* |
|
17 |
* You should have received a copy of the GNU General Public License version |
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 |
* |
|
5506 | 21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
2 | 24 |
*/ |
25 |
||
26 |
package com.sun.jdi.event; |
|
27 |
||
45564 | 28 |
import com.sun.jdi.Mirror; |
29 |
import com.sun.jdi.VMDisconnectedException; |
|
30 |
import com.sun.jdi.VirtualMachine; |
|
31 |
import com.sun.jdi.request.EventRequest; |
|
2 | 32 |
|
33 |
/** |
|
34 |
* Manager of incoming debugger events for a target VM. |
|
35 |
* Events are always grouped in {@link EventSet}s. |
|
36 |
* EventSets generated by the debugger back end can be read |
|
37 |
* here. There is one instance of EventQueue assigned to a particular |
|
45564 | 38 |
* {@link VirtualMachine VirtualMachine}. |
2 | 39 |
* <P> |
40 |
* Some events cause the suspension of the target VM - event requests |
|
41 |
* ({@link com.sun.jdi.request}) with a |
|
45564 | 42 |
* {@link EventRequest#suspendPolicy() suspend policy} |
43 |
* of {@link EventRequest#SUSPEND_ALL SUSPEND_ALL} |
|
44 |
* or {@link EventRequest#SUSPEND_EVENT_THREAD |
|
45 |
* SUSPEND_EVENT_THREAD} and sometimes {@link VMStartEvent}. |
|
2 | 46 |
* If these suspensions are not resumed the target VM will hang. |
47 |
* Thus, it is always good policy to |
|
45564 | 48 |
* {@link #remove() remove()} every EventSet from the event queue until |
49 |
* an EventSet containing a {@link VMDisconnectEvent} is read. |
|
50 |
* Unless {@link VirtualMachine#resume() resume} is |
|
2 | 51 |
* being handled in another way, each EventSet should invoke |
52 |
* {@link EventSet#resume()}. |
|
53 |
* |
|
54 |
* @see EventSet |
|
55 |
* @see VirtualMachine |
|
56 |
* |
|
57 |
* @author Robert Field |
|
58 |
* @since 1.3 |
|
59 |
*/ |
|
60 |
public interface EventQueue extends Mirror { |
|
61 |
||
62 |
/** |
|
63 |
* Waits forever for the next available event. |
|
64 |
* |
|
65 |
* @return the next {@link EventSet}. |
|
45564 | 66 |
* @throws InterruptedException if any thread has interrupted this thread. |
67 |
* @throws VMDisconnectedException if the connection |
|
68 |
* to the target VM is no longer available. Note this will always |
|
69 |
* be preceded by a {@link VMDisconnectEvent}. |
|
2 | 70 |
*/ |
71 |
EventSet remove() throws InterruptedException; |
|
72 |
||
73 |
/** |
|
74 |
* Waits a specified time for the next available event. |
|
75 |
* |
|
76 |
* @param timeout Time in milliseconds to wait for the next event |
|
77 |
* @return the next {@link EventSet}, or null if there is a timeout. |
|
78 |
* @throws InterruptedException if any thread has interrupted |
|
79 |
* this thread. |
|
45564 | 80 |
* @throws VMDisconnectedException if the connection |
81 |
* to the target VM is no longer available. Note this will always |
|
82 |
* be preceded by a {@link VMDisconnectEvent}. |
|
2 | 83 |
* @throws IllegalArgumentException if the timeout argument |
84 |
* contains an illegal value. |
|
85 |
*/ |
|
86 |
EventSet remove(long timeout) throws InterruptedException; |
|
87 |
} |