public interface

ListeningConnector

implements Connector
com.sun.jdi.connect.ListeningConnector
Known Indirect Subclasses

Class Overview

A connector which listens for a connection initiated by a target VM.

Summary

Public Methods
abstract VirtualMachine accept(Map<String, ? extends Connector.Argument> arguments)
Waits for a target VM to attach to this connector.
abstract String startListening(Map<String, ? extends Connector.Argument> arguments)
Listens for one or more connections initiated by target VMs.
abstract void stopListening(Map<String, ? extends Connector.Argument> arguments)
Cancels listening for connections.
abstract boolean supportsMultipleConnections()
Indicates whether this listening connector supports multiple connections for a single argument map.
[Expand]
Inherited Methods
From interface com.sun.jdi.connect.Connector

Public Methods

public abstract VirtualMachine accept (Map<String, ? extends Connector.Argument> arguments)

Waits for a target VM to attach to this connector.

Throws
TransportTimeoutException when the Connector encapsulates a transport that supports a timeout when accepting, a Connector.Argument representing a timeout has been set in the argument map, and a timeout occurs whilst waiting for the target VM to connect.
IOException when unable to accept. Specific exceptions are dependent on the Connector implementation in use.
IllegalConnectorArgumentsException when one of the connector arguments is invalid.

public abstract String startListening (Map<String, ? extends Connector.Argument> arguments)

Listens for one or more connections initiated by target VMs. The connector uses the given argument map in determining the address at which to listen or else it generates an appropriate listen address. In either case, an address string is returned from this method which can be used in starting target VMs to identify this connector. The format of the address string is connector, transport, and, possibly, platform dependent.

The argument map associates argument name strings to instances of Connector.Argument. The default argument map for a connector can be obtained through defaultArguments(). Argument map values can be changed, but map entries should not be added or deleted.

This method does not return a VirtualMachine, and, normally, returns before any target VM initiates a connection. The connected target is obtained through accept(Map) (using the same argument map as is passed to this method).

If arguments contains addressing information. and only one conection will be accepted, the accept method can be called immediately without calling this method.

Returns
  • the address at which the connector is listening for a connection.
Throws
IOException when unable to start listening. Specific exceptions are dependent on the Connector implementation in use.
IllegalConnectorArgumentsException when one of the connector arguments is invalid.

public abstract void stopListening (Map<String, ? extends Connector.Argument> arguments)

Cancels listening for connections. The given argument map should match the argument map given for a previous startListening(Map) invocation.

Throws
IOException when unable to stop listening. Specific exceptions are dependent on the Connector implementation in use.
IllegalConnectorArgumentsException when one of the connector arguments is invalid.

public abstract boolean supportsMultipleConnections ()

Indicates whether this listening connector supports multiple connections for a single argument map. If so, a call to startListening(Map) may allow multiple target VM to become connected.

Returns
  • true if multiple connections are supported; false otherwise.