OpenJDK 27 · com.sun.tools.jdi.GenericListeningConnector

Modifier and Type	Field and Description
pack-priv static final String	ARG_ADDRESS
pack-priv static final String	ARG_TIMEOUT
pack-priv Map<Map<String, ? extends Connector.Argument>, TransportService.ListenKey>	listenMap
pack-priv Transport	transport
pack-priv TransportService	transportService

Access	Constructor and Description
private	GenericListeningConnector(TransportService ts, boolean addAddressArgument) Initialize a new instance of this connector.
protected	GenericListeningConnector(TransportService ts) Initialize a new instance of this connector.

Method Summary

Modifier and Type	Method and Description
public VirtualMachine	accept(Map<String, ? extends Connector.Argument> args) Implements com.sun.jdi.connect.ListeningConnector.accept. Waits for a target VM to attach to this connector.
public static GenericListeningConnector	create(TransportService ts) Create an instance of this Connector.
public String	description() Implements com.sun.jdi.connect.Connector.description. Returns a human-readable description of this connector and its purpose.
public String	name() Implements com.sun.jdi.connect.Connector.name. Returns a short identifier for the connector.
public String	startListening(String address, Map<String, ? extends Connector.Argument> args)
public String	startListening(Map<String, ? extends Connector.Argument> args) Implements com.sun.jdi.connect.ListeningConnector.startListening. Listens for one or more connections initiated by target VMs.
public void	stopListening(Map<String, ? extends Connector.Argument> args) Implements com.sun.jdi.connect.ListeningConnector.stopListening. Cancels listening for connections.
public boolean	supportsMultipleConnections() Implements com.sun.jdi.connect.ListeningConnector.supportsMultipleConnections. Indicates whether this listening connector supports multiple connections for a single argument map.
public Transport	transport() Implements com.sun.jdi.connect.Connector.transport. Returns the transport mechanism used by this connector to establish connections with a target VM.
protected void	updateArgumentMapIfRequired(Map<String, ? extends Connector.Argument> args, TransportService.ListenKey listener)

Inherited from com.sun.tools.jdi.ConnectorImpl:: addBooleanArgument addIntegerArgument addSelectedArgument addStringArgument argument defaultArguments getString toString

ARG_ADDRESS	back to summary
pack-priv static final String ARG_ADDRESS

ARG_TIMEOUT	back to summary
pack-priv static final String ARG_TIMEOUT

listenMap	back to summary
pack-priv Map<Map<String, ? extends Connector.Argument>, TransportService.ListenKey> listenMap

transport	back to summary
pack-priv Transport transport

transportService	back to summary
pack-priv TransportService transportService

GenericListeningConnector	back to summary
private GenericListeningConnector(TransportService ts, boolean addAddressArgument) Initialize a new instance of this connector. The connector encapsulates a transport service, has a "timeout" connector argument, and optionally an "address" connector argument.

GenericListeningConnector	back to summary
protected GenericListeningConnector(TransportService ts) Initialize a new instance of this connector. This constructor is used when sub-classing - the resulting connector will a "timeout" connector argument.

Method Detail

accept	back to summary
public VirtualMachine accept(Map<String, ? extends Connector.Argument> args) throws IOException, IllegalConnectorArgumentsException Implements com.sun.jdi.connect.ListeningConnector.accept. Doc from com.sun.jdi.connect.ListeningConnector.accept. Waits for a target VM to attach to this connector. Exceptions IOException: when unable to accept. Specific exceptions are dependent on the Connector implementation in use. IllegalConnectorArgumentsException: when one of the connector arguments is invalid.

back to summary

public VirtualMachine accept(Map<String, ? extends Connector.Argument> args) throws IOException, IllegalConnectorArgumentsException

Implements com.sun.jdi.connect.ListeningConnector.accept.

Doc from com.sun.jdi.connect.ListeningConnector.accept.

Waits for a target VM to attach to this connector.

Exceptions

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

create	back to summary
public static GenericListeningConnector create(TransportService ts) Create an instance of this Connector. The resulting ListeningConnector will have "address" and "timeout" connector arguments.

description	back to summary
public String description() Implements com.sun.jdi.connect.Connector.description. Doc from com.sun.jdi.connect.Connector.description. Returns a human-readable description of this connector and its purpose.

description

back to summary

public String description()

Implements com.sun.jdi.connect.Connector.description.

Doc from com.sun.jdi.connect.Connector.description.

Returns a human-readable description of this connector and its purpose.

name	back to summary
public String name() Implements com.sun.jdi.connect.Connector.name. Doc from com.sun.jdi.connect.Connector.name. Returns a short identifier for the connector. Connector implementors should follow similar naming conventions as are used with packages to avoid name collisions. For example, the Sun connector implementations have names prefixed with "com.sun.jdi.". Not intended for exposure to end-user.

name

back to summary

public String name()

Implements com.sun.jdi.connect.Connector.name.

Doc from com.sun.jdi.connect.Connector.name.

Returns a short identifier for the connector. Connector implementors should follow similar naming conventions as are used with packages to avoid name collisions. For example, the Sun connector implementations have names prefixed with "com.sun.jdi.". Not intended for exposure to end-user.

startListening	back to summary
public String startListening(String address, Map<String, ? extends Connector.Argument> args) throws IOException, IllegalConnectorArgumentsException

startListening back to summary

startListening	back to summary
public String startListening(Map<String, ? extends Connector.Argument> args) throws IOException, IllegalConnectorArgumentsException Implements com.sun.jdi.connect.ListeningConnector.startListening. Doc from com.sun.jdi.connect.ListeningConnector.startListening. 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 `Connector#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` (using the same argument map as is passed to this method). If `arguments` contains addressing information and only one connection will be accepted, the `accept` method can be called immediately without calling this method. Exceptions 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 String startListening(Map<String, ? extends Connector.Argument> args) throws IOException, IllegalConnectorArgumentsException

Implements com.sun.jdi.connect.ListeningConnector.startListening.

Doc from com.sun.jdi.connect.ListeningConnector.startListening.

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 Connector#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 (using the same argument map as is passed to this method).

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

Exceptions

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.

stopListening back to summary

stopListening	back to summary
public void stopListening(Map<String, ? extends Connector.Argument> args) throws IOException, IllegalConnectorArgumentsException Implements com.sun.jdi.connect.ListeningConnector.stopListening. Doc from com.sun.jdi.connect.ListeningConnector.stopListening. Cancels listening for connections. The given argument map should match the argument map given for a previous `startListening` invocation. Exceptions 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 void stopListening(Map<String, ? extends Connector.Argument> args) throws IOException, IllegalConnectorArgumentsException

Implements com.sun.jdi.connect.ListeningConnector.stopListening.

Doc from com.sun.jdi.connect.ListeningConnector.stopListening.

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

Exceptions

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.

supportsMultipleConnections back to summary

supportsMultipleConnections	back to summary
public boolean supportsMultipleConnections() Implements com.sun.jdi.connect.ListeningConnector.supportsMultipleConnections. Doc from com.sun.jdi.connect.ListeningConnector.supportsMultipleConnections. Indicates whether this listening connector supports multiple connections for a single argument map. If so, a call to `startListening` may allow multiple target VM to become connected.

public boolean supportsMultipleConnections()

Implements com.sun.jdi.connect.ListeningConnector.supportsMultipleConnections.

Doc from com.sun.jdi.connect.ListeningConnector.supportsMultipleConnections.

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

transport	back to summary
public Transport transport() Implements com.sun.jdi.connect.Connector.transport. Doc from com.sun.jdi.connect.Connector.transport. Returns the transport mechanism used by this connector to establish connections with a target VM.

transport

back to summary

public Transport transport()

Implements com.sun.jdi.connect.Connector.transport.

Doc from com.sun.jdi.connect.Connector.transport.

Returns the transport mechanism used by this connector to establish connections with a target VM.

updateArgumentMapIfRequired	back to summary
protected void updateArgumentMapIfRequired(Map<String, ? extends Connector.Argument> args, TransportService.ListenKey listener)

public Class GenericListeningConnector

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail