public class

GenericListeningConnector

extends Object
implements Connector ListeningConnector
java.lang.Object
   ↳ com.sun.tools.jdi.GenericListeningConnector
Known Direct Subclasses

Summary

Protected Constructors
GenericListeningConnector(TransportService ts)
Initialize a new instance of this connector.
Public Methods
VirtualMachine accept(Map<String, ? extends Connector.Argument> args)
Waits for a target VM to attach to this connector.
static GenericListeningConnector create(TransportService ts)
Create an instance of this Connector.
Map<String, Connector.Argument> defaultArguments()
Returns the arguments accepted by this Connector and their default values.
String description()
Returns a human-readable description of this connector and its purpose.
String name()
Returns a short identifier for the connector.
String startListening(Map<String, ? extends Connector.Argument> args)
Listens for one or more connections initiated by target VMs.
String startListening(String address, Map<String, ? extends Connector.Argument> args)
void stopListening(Map<String, ? extends Connector.Argument> args)
Cancels listening for connections.
boolean supportsMultipleConnections()
Indicates whether this listening connector supports multiple connections for a single argument map.
String toString()
Returns a string representation of the object.
Transport transport()
Returns the transport mechanism used by this connector to establish connections with a target VM.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.sun.jdi.connect.Connector
From interface com.sun.jdi.connect.ListeningConnector

Protected Constructors

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.

Public Methods

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

Waits for a target VM to attach to this connector.

Throws
IOException
IllegalConnectorArgumentsException

public static GenericListeningConnector create (TransportService ts)

Create an instance of this Connector. The resulting ListeningConnector will have "address" and "timeout" connector arguments.

public Map<String, Connector.Argument> defaultArguments ()

Returns the arguments accepted by this Connector and their default values. The keys of the returned map are string argument names. The values are Connector.Argument containing information about the argument and its default value.

Returns
  • the map associating argument names with argument information and default value.

public String description ()

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

Returns
  • the description of this connector

public String 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.

Returns
  • the name of this connector.

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

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
IllegalConnectorArgumentsException

public String startListening (String address, Map<String, ? extends Connector.Argument> args)

Throws
IOException
IllegalConnectorArgumentsException

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

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

Throws
IOException
IllegalConnectorArgumentsException

public 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.

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: 

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
  • a string representation of the object.

public Transport transport ()

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

Returns