J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved. |
| 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 |
| 7 | * published by the Free Software Foundation. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun in the LICENSE file that accompanied this code. |
| 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 | * |
| 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | |
| 26 | package com.sun.jdi.connect; |
| 27 | |
| 28 | /** |
| 29 | * This exception may be thrown as a result of a timeout |
| 30 | * when attaching to a target VM, or waiting to accept a |
| 31 | * connection from a target VM. |
| 32 | * |
| 33 | * <p> When attaching to a target VM, using {@link |
| 34 | * AttachingConnector#attach attach} this |
| 35 | * exception may be thrown if the connector supports a timeout |
| 36 | * {@link Connector.Argument connector argument}. Similiarly, |
| 37 | * when waiting to accept a connection from a target VM, |
| 38 | * using {@link ListeningConnector#accept accept} this |
| 39 | * exception may be thrown if the connector supports a |
| 40 | * timeout connector argument when accepting. |
| 41 | * |
| 42 | * <p> In addition, for developers creating {@link |
| 43 | * com.sun.jdi.connect.spi.TransportService TransportService} |
| 44 | * implementations this exception is thrown when |
| 45 | * {@link com.sun.jdi.connect.spi.TransportService#attach attach} |
| 46 | * times out when establishing a connection to a target VM, |
| 47 | * or {@link com.sun.jdi.connect.spi.TransportService#accept |
| 48 | * accept} times out while waiting for a target VM to connect. </p> |
| 49 | * |
| 50 | * @see AttachingConnector#attach |
| 51 | * @see ListeningConnector#accept |
| 52 | * @see com.sun.jdi.connect.spi.TransportService#attach |
| 53 | * @see com.sun.jdi.connect.spi.TransportService#accept |
| 54 | * |
| 55 | * @since 1.5 |
| 56 | */ |
| 57 | public class TransportTimeoutException extends java.io.IOException { |
| 58 | |
| 59 | /** |
| 60 | * Constructs a <tt>TransportTimeoutException</tt> with no detail |
| 61 | * message. |
| 62 | */ |
| 63 | public TransportTimeoutException() { |
| 64 | } |
| 65 | |
| 66 | |
| 67 | /** |
| 68 | * Constructs a <tt>TransportTimeoutException</tt> with the |
| 69 | * specified detail message. |
| 70 | * |
| 71 | * @param message the detail message pertaining to this exception. |
| 72 | */ |
| 73 | public TransportTimeoutException(String message) { |
| 74 | super(message); |
| 75 | } |
| 76 | |
| 77 | } |