View Javadoc
1   /*
2    * Copyright (c) 1998, 2013, Oracle and/or its affiliates. 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.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle 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 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.
24   */
25  
26  package com.sun.jdi.connect;
27  
28  import com.sun.jdi.connect.spi.TransportService;        // for javadoc
29  
30  /**
31   * A method of communication between a debugger and a target VM.
32   *
33   * <p> A Transport represents the transport mechanism used by a
34   * {@link com.sun.jdi.connect.Connector Connector} to establish a
35   * connection with a target VM. It consists of a name which is obtained
36   * by invoking the {@link #name} method. Furthermore, a Transport
37   * encapsulates a {@link com.sun.jdi.connect.spi.TransportService
38   * TransportService} which is the underlying service used
39   * to establish connections and exchange Java Debug Wire Protocol
40   * (JDWP) packets with a target VM.
41   *
42   * @author Gordon Hirsch
43   * @since  1.3
44   */
45  @jdk.Exported
46  public interface Transport {
47      /**
48       * Returns a short identifier for the transport.
49       *
50       * @return the name of this transport.
51       */
52      String name();
53  }