org.dartlang.vm.service.VmServiceBase Class Reference

Inheritance diagram for org.dartlang.vm.service.VmServiceBase:

Public Member Functions
void	addVmServiceListener (VmServiceListener listener)
void	removeVmServiceListener (VmServiceListener listener)
void	addServiceRunner (String service, RemoteServiceRunner runner)
void	removeServiceRunner (String service)
Version	getRuntimeVersion ()
void	disconnect ()
void	getInstance (String isolateId, String instanceId, final GetInstanceConsumer consumer)
void	getLibrary (String isolateId, String libraryId, final GetLibraryConsumer consumer)
abstract void	getObject (String isolateId, String objectId, GetObjectConsumer consumer)
void	callServiceExtension (String isolateId, String method, ServiceExtensionConsumer consumer)
void	callServiceExtension (String isolateId, String method, JsonObject params, ServiceExtensionConsumer consumer)
void	connectionOpened ()
void	connectionClosed ()

Static Public Member Functions
static VmService	connect (final String url) throws IOException
static VmService	localConnect (int port) throws IOException

Protected Member Functions
void	request (String method, JsonObject params, Consumer consumer)
String	removeNewLines (String str)

Package Functions
abstract void	forwardResponse (Consumer consumer, String type, JsonObject json)
void	logUnknownResponse (Consumer consumer, JsonObject json)
void	processMessage (String jsonText)
void	processRequest (JsonObject json)
void	processNotification (JsonObject json)
void	processResponse (JsonObject json)

Package Attributes
RequestSink	requestSink
Version	runtimeVersion

Additional Inherited Members
Static Public Attributes inherited from org.dartlang.vm.service.internal.VmServiceConst
static final String	CODE = "code"
static final String	ERROR = "error"
static final String	EVENT = "event"
static final String	ID = "id"
static final String	MESSAGE = "message"
static final String	METHOD = "method"
static final String	PARAMS = "params"
static final String	RESULT = "result"
static final String	STREAM_ID = "streamId"
static final String	TYPE = "type"
static final String	JSONRPC = "jsonrpc"
static final String	JSONRPC_VERSION = "2.0"
static final String	DATA = "data"
static final int	PARSE_ERROR = -32700
static final int	INVALID_REQUEST = -32600
static final int	METHOD_NOT_FOUND = -32601
static final int	INVALID_PARAMS = -32602
static final int	SERVER_ERROR = -32000

Detailed Description

Internal VmService base class containing non-generated code.

Definition at line 45 of file VmServiceBase.java.

Member Function Documentation

addServiceRunner()

void org.dartlang.vm.service.VmServiceBase.addServiceRunner ( String  service, RemoteServiceRunner  runner  )

inline

Add a VM RemoteServiceRunner.

Definition at line 217 of file VmServiceBase.java.

                                                                           {
    remoteServiceRunners.put(service, runner);
  }

addVmServiceListener()

void org.dartlang.vm.service.VmServiceBase.addVmServiceListener ( VmServiceListener  listener )

inline

Add a listener to receive Events from the VM.

Definition at line 203 of file VmServiceBase.java.

                                                               {
    vmListeners.add(listener);
  }

callServiceExtension() [1/2]

void org.dartlang.vm.service.VmServiceBase.callServiceExtension ( String  isolateId, String  method, JsonObject  params, ServiceExtensionConsumer  consumer  )

inline

Invoke a specific service protocol extension method.

See https://api.dart.dev/stable/dart-developer/dart-developer-library.html.

Definition at line 314 of file VmServiceBase.java.

                                                                                                                          {
    params.addProperty("isolateId", isolateId);
    request(method, params, consumer);
  }

callServiceExtension() [2/2]

void org.dartlang.vm.service.VmServiceBase.callServiceExtension ( String  isolateId, String  method, ServiceExtensionConsumer  consumer  )

inline

Invoke a specific service protocol extension method.

See https://api.dart.dev/stable/dart-developer/dart-developer-library.html.

Definition at line 303 of file VmServiceBase.java.

                                                                                                       {
    JsonObject params = new JsonObject();
    params.addProperty("isolateId", isolateId);
    request(method, params, consumer);
  }

connect()

static VmService org.dartlang.vm.service.VmServiceBase.connect ( final String  url ) throws IOException

inlinestatic

Connect to the VM observatory service via the specified URI

Returns

an API object for interacting with the VM service (not null).

Definition at line 51 of file VmServiceBase.java.

                                                                       {
    // Validate URL
    URI uri;
    try {
      uri = new URI(url);
    } catch (URISyntaxException e) {
      throw new IOException("Invalid URL: " + url, e);
    }
    String wsScheme = uri.getScheme();
    if (!"ws".equals(wsScheme) && !"wss".equals(wsScheme)) {
      throw new IOException("Unsupported URL scheme: " + wsScheme);
    }
 
    // Create web socket and observatory
    WebSocket webSocket;
    try {
      webSocket = new WebSocket(uri);
    } catch (WebSocketException e) {
      throw new IOException("Failed to create websocket: " + url, e);
    }
    final VmService vmService = new VmService();
 
    // Setup event handler for forwarding responses
    webSocket.setEventHandler(new WebSocketEventHandler() {
      @Override
      public void onClose() {
        Logging.getLogger().logInformation("VM connection closed: " + url);
 
        vmService.connectionClosed();
      }
 
      @Override
      public void onMessage(WebSocketMessage message) {
        Logging.getLogger().logInformation("VM message: " + message.getText());
        try {
          vmService.processMessage(message.getText());
        } catch (Exception e) {
          Logging.getLogger().logError(e.getMessage(), e);
        }
      }
 
      @Override
      public void onOpen() {
        vmService.connectionOpened();
 
        Logging.getLogger().logInformation("VM connection open: " + url);
      }
 
      @Override
      public void onPing() {
      }
 
      @Override
      public void onPong() {
      }
    });
 
    // Establish WebSocket Connection
    //noinspection TryWithIdenticalCatches
    try {
      webSocket.connect();
    } catch (WebSocketException e) {
      throw new IOException("Failed to connect: " + url, e);
    } catch (ArrayIndexOutOfBoundsException e) {
      // The weberknecht can occasionally throw an array index exception if a connect terminates on initial connect
      // (de.roderick.weberknecht.WebSocket.connect, WebSocket.java:126).
      throw new IOException("Failed to connect: " + url, e);
    }
    vmService.requestSink = new WebSocketRequestSink(webSocket);
 
    // Check protocol version
    final CountDownLatch latch = new CountDownLatch(1);
    final String[] errMsg = new String[1];
    vmService.getVersion(new VersionConsumer() {
      @Override
      public void onError(RPCError error) {
        String msg = "Failed to determine protocol version: " + error.getCode() + "\n  message: "
            + error.getMessage() + "\n  details: " + error.getDetails();
        Logging.getLogger().logInformation(msg);
        errMsg[0] = msg;
      }
 
      @Override
      public void received(Version version) {
        vmService.runtimeVersion = version;
 
        latch.countDown();
      }
    });
 
    try {
      if (!latch.await(5, TimeUnit.SECONDS)) {
        throw new IOException("Failed to determine protocol version");
      }
      if (errMsg[0] != null) {
        throw new IOException(errMsg[0]);
      }
    } catch (InterruptedException e) {
      throw new RuntimeException("Interrupted while waiting for response", e);
    }
 
    return vmService;
  }

connectionClosed()

void org.dartlang.vm.service.VmServiceBase.connectionClosed ( )

inline

Definition at line 362 of file VmServiceBase.java.

                                 {
    for (VmServiceListener listener : new ArrayList<>(vmListeners)) {
      try {
        listener.connectionClosed();
      } catch (Exception e) {
        Logging.getLogger().logError("Exception notifying listener", e);
      }
    }
  }

connectionOpened()

void org.dartlang.vm.service.VmServiceBase.connectionOpened ( )

inline

Definition at line 342 of file VmServiceBase.java.

                                 {
    for (VmServiceListener listener : new ArrayList<>(vmListeners)) {
      try {
        listener.connectionOpened();
      } catch (Exception e) {
        Logging.getLogger().logError("Exception notifying listener", e);
      }
    }
  }

disconnect()

void org.dartlang.vm.service.VmServiceBase.disconnect ( )

inline

Disconnect from the VM observatory service.

Definition at line 238 of file VmServiceBase.java.

                           {
    requestSink.close();
  }

forwardResponse()

abstract void org.dartlang.vm.service.VmServiceBase.forwardResponse ( Consumer  consumer, String  type, JsonObject  json  )

abstractpackage

getInstance()

void org.dartlang.vm.service.VmServiceBase.getInstance ( String  isolateId, String  instanceId, final GetInstanceConsumer  consumer  )

inline

Return the instance with the given identifier.

Definition at line 245 of file VmServiceBase.java.

                                                                                                   {
    getObject(isolateId, instanceId, new GetObjectConsumer() {
 
      @Override
      public void onError(RPCError error) {
        consumer.onError(error);
      }
 
      @Override
      public void received(Obj response) {
        if (response instanceof Instance) {
          consumer.received((Instance) response);
        } else {
          onError(RPCError.unexpected("Instance", response));
        }
      }
 
      @Override
      public void received(Sentinel response) {
        onError(RPCError.unexpected("Instance", response));
      }
    });
  }

getLibrary()

void org.dartlang.vm.service.VmServiceBase.getLibrary ( String  isolateId, String  libraryId, final GetLibraryConsumer  consumer  )

inline

Return the library with the given identifier.

Definition at line 272 of file VmServiceBase.java.

                                                                                                {
    getObject(isolateId, libraryId, new GetObjectConsumer() {
 
      @Override
      public void onError(RPCError error) {
        consumer.onError(error);
      }
 
      @Override
      public void received(Obj response) {
        if (response instanceof Library) {
          consumer.received((Library) response);
        } else {
          onError(RPCError.unexpected("Library", response));
        }
      }
 
      @Override
      public void received(Sentinel response) {
        onError(RPCError.unexpected("Library", response));
      }
    });
  }

getObject()

abstract void org.dartlang.vm.service.VmServiceBase.getObject ( String  isolateId, String  objectId, GetObjectConsumer  consumer  )

abstract

getRuntimeVersion()

Version org.dartlang.vm.service.VmServiceBase.getRuntimeVersion ( )

inline

Return the VM service protocol version supported by the current debug connection.

Definition at line 231 of file VmServiceBase.java.

                                     {
    return runtimeVersion;
  }

localConnect()

static VmService org.dartlang.vm.service.VmServiceBase.localConnect ( int  port ) throws IOException

inlinestatic

Connect to the VM observatory service on the given local port.

Returns

an API object for interacting with the VM service (not null).

Deprecated:

prefer the Url based constructor VmServiceBase#connect

Definition at line 163 of file VmServiceBase.java.

                                                                    {
    return connect("ws://localhost:" + port + "/ws");
  }

logUnknownResponse()

void org.dartlang.vm.service.VmServiceBase.logUnknownResponse ( Consumer  consumer, JsonObject  json  )

inlinepackage

Definition at line 374 of file VmServiceBase.java.

                                                              {
    Class<? extends Consumer> consumerClass = consumer.getClass();
    StringBuilder msg = new StringBuilder();
    msg.append("Expected response for ").append(consumerClass).append("\n");
    for (Class<?> interf : consumerClass.getInterfaces()) {
      msg.append("  implementing ").append(interf).append("\n");
    }
    msg.append("  but received ").append(json);
    Logging.getLogger().logError(msg.toString());
  }

processMessage()

void org.dartlang.vm.service.VmServiceBase.processMessage ( String  jsonText )

inlinepackage

Process the response from the VM service and forward that response to the consumer associated with the response id.

Definition at line 389 of file VmServiceBase.java.

                                       {
    if (jsonText == null || jsonText.isEmpty()) {
      return;
    }
 
    // Decode the JSON
    JsonObject json;
    try {
      json = (JsonObject) new JsonParser().parse(jsonText);
    } catch (Exception e) {
      Logging.getLogger().logError("Parse message failed: " + jsonText, e);
      return;
    }
 
    if (json.has("method")) {
      if (!json.has(PARAMS)) {
        final String message = "Missing " + PARAMS;
        Logging.getLogger().logError(message);
        final JsonObject response = new JsonObject();
        response.addProperty(JSONRPC, JSONRPC_VERSION);
        final JsonObject error = new JsonObject();
        error.addProperty(CODE, INVALID_REQUEST);
        error.addProperty(MESSAGE, message);
        response.add(ERROR, error);
        requestSink.add(response);
        return;
      }
      if (json.has("id")) {
        processRequest(json);
      } else {
        processNotification(json);
      }
    } else if (json.has("result") || json.has("error")) {
      processResponse(json);
    } else {
      Logging.getLogger().logError("Malformed message");
    }
  }

processNotification()

void org.dartlang.vm.service.VmServiceBase.processNotification ( JsonObject  json )

inlinepackage

Definition at line 529 of file VmServiceBase.java.

                                            {
    String method;
    try {
      method = json.get(METHOD).getAsString();
    } catch (Exception e) {
      Logging.getLogger().logError("Request malformed " + METHOD, e);
      return;
    }
    JsonObject params;
    try {
      params = json.get(PARAMS).getAsJsonObject();
    } catch (Exception e) {
      Logging.getLogger().logError("Event missing " + PARAMS, e);
      return;
    }
    if ("streamNotify".equals(method)) {
      String streamId;
      try {
        streamId = params.get(STREAM_ID).getAsString();
      } catch (Exception e) {
        Logging.getLogger().logError("Event missing " + STREAM_ID, e);
        return;
      }
      Event event;
      try {
        event = new Event(params.get(EVENT).getAsJsonObject());
      } catch (Exception e) {
        Logging.getLogger().logError("Event missing " + EVENT, e);
        return;
      }
      forwardEvent(streamId, event);
    } else {
      if (!remoteServiceRunners.containsKey(method)) {
        Logging.getLogger().logError("Unknown service " + method);
        return;
      }
 
      final RemoteServiceRunner runner = remoteServiceRunners.get(method);
      try {
        runner.run(params, ignoreCallback);
      } catch (Exception e) {
        Logging.getLogger().logError("Internal Server Error", e);
      }
    }
  }

processRequest()

void org.dartlang.vm.service.VmServiceBase.processRequest ( JsonObject  json )

inlinepackage

Definition at line 428 of file VmServiceBase.java.

                                       {
    final JsonObject response = new JsonObject();
    response.addProperty(JSONRPC, JSONRPC_VERSION);
 
    // Get the consumer associated with this request
    String id;
    try {
      id = json.get(ID).getAsString();
    } catch (Exception e) {
      final String message = "Request malformed " + ID;
      Logging.getLogger().logError(message, e);
      final JsonObject error = new JsonObject();
      error.addProperty(CODE, INVALID_REQUEST);
      error.addProperty(MESSAGE, message);
      response.add(ERROR, error);
      requestSink.add(response);
      return;
    }
 
    response.addProperty(ID, id);
 
    String method;
    try {
      method = json.get(METHOD).getAsString();
    } catch (Exception e) {
      final String message = "Request malformed " + METHOD;
      Logging.getLogger().logError(message, e);
      final JsonObject error = new JsonObject();
      error.addProperty(CODE, INVALID_REQUEST);
      error.addProperty(MESSAGE, message);
      response.add(ERROR, error);
      requestSink.add(response);
      return;
    }
 
    JsonObject params;
    try {
      params = json.get(PARAMS).getAsJsonObject();
    } catch (Exception e) {
      final String message = "Request malformed " + METHOD;
      Logging.getLogger().logError(message, e);
      final JsonObject error = new JsonObject();
      error.addProperty(CODE, INVALID_REQUEST);
      error.addProperty(MESSAGE, message);
      response.add(ERROR, error);
      requestSink.add(response);
      return;
    }
 
    if (!remoteServiceRunners.containsKey(method)) {
      final String message = "Unknown service " + method;
      Logging.getLogger().logError(message);
      final JsonObject error = new JsonObject();
      error.addProperty(CODE, METHOD_NOT_FOUND);
      error.addProperty(MESSAGE, message);
      response.add(ERROR, error);
      requestSink.add(response);
      return;
    }
 
    final RemoteServiceRunner runner = remoteServiceRunners.get(method);
    try {
      runner.run(params, new RemoteServiceCompleter() {
        public void result(JsonObject result) {
          response.add(RESULT, result);
          requestSink.add(response);
        }
 
        public void error(int code, String message, JsonObject data) {
          final JsonObject error = new JsonObject();
          error.addProperty(CODE, code);
          error.addProperty(MESSAGE, message);
          if (data != null) {
            error.add(DATA, data);
          }
          response.add(ERROR, error);
          requestSink.add(response);
        }
      });
    } catch (Exception e) {
      final String message = "Internal Server Error";
      Logging.getLogger().logError(message, e);
      final JsonObject error = new JsonObject();
      error.addProperty(CODE, SERVER_ERROR);
      error.addProperty(MESSAGE, message);
      response.add(ERROR, error);
      requestSink.add(response);
    }
  }

processResponse()

void org.dartlang.vm.service.VmServiceBase.processResponse ( JsonObject  json )

inlinepackage

Definition at line 579 of file VmServiceBase.java.

                                        {
    JsonElement idElem = json.get(ID);
    if (idElem == null) {
      Logging.getLogger().logError("Response missing " + ID);
      return;
    }
 
    // Get the consumer associated with this response
    String id;
    try {
      id = idElem.getAsString();
    } catch (Exception e) {
      Logging.getLogger().logError("Response missing " + ID, e);
      return;
    }
    Consumer consumer = consumerMap.remove(id);
    if (consumer == null) {
      Logging.getLogger().logError("No consumer associated with " + ID + ": " + id);
      return;
    }
 
    // Forward the response if the request was successfully executed
    JsonElement resultElem = json.get(RESULT);
    if (resultElem != null) {
      JsonObject result;
      try {
        result = resultElem.getAsJsonObject();
      } catch (Exception e) {
        Logging.getLogger().logError("Response has invalid " + RESULT, e);
        return;
      }
      String responseType = "";
      if (result.has(TYPE)) {
        responseType = result.get(TYPE).getAsString();
      }
      // ServiceExtensionConsumers do not care about the response type.
      else if (!(consumer instanceof ServiceExtensionConsumer)) {
        Logging.getLogger().logError("Response missing " + TYPE + ": " + result.toString());
        return;
      }
      forwardResponse(consumer, responseType, result);
      return;
    }
 
    // Forward an error if the request failed
    resultElem = json.get(ERROR);
    if (resultElem != null) {
      JsonObject error;
      try {
        error = resultElem.getAsJsonObject();
      } catch (Exception e) {
        Logging.getLogger().logError("Response has invalid " + RESULT, e);
        return;
      }
      consumer.onError(new RPCError(error));
      return;
    }
 
    Logging.getLogger().logError("Response missing " + RESULT + " and " + ERROR);
  }

removeNewLines()

String org.dartlang.vm.service.VmServiceBase.removeNewLines ( String  str )

inlineprotected

Definition at line 575 of file VmServiceBase.java.

                                              {
    return str.replaceAll("\r\n", " ").replaceAll("\n", " ");
  }

removeServiceRunner()

void org.dartlang.vm.service.VmServiceBase.removeServiceRunner ( String  service )

inline

Remove a VM RemoteServiceRunner.

Definition at line 224 of file VmServiceBase.java.

                                                  {
    remoteServiceRunners.remove(service);
  }

removeVmServiceListener()

void org.dartlang.vm.service.VmServiceBase.removeVmServiceListener ( VmServiceListener  listener )

inline

Remove the given listener from the VM.

Definition at line 210 of file VmServiceBase.java.

                                                                  {
    vmListeners.remove(listener);
  }

request()

void org.dartlang.vm.service.VmServiceBase.request ( String  method, JsonObject  params, Consumer  consumer  )

inlineprotected

Sends the request and associates the request with the passed Consumer.

Definition at line 322 of file VmServiceBase.java.

                                                                              {
 
    // Assemble the request
    String id = Integer.toString(nextId.incrementAndGet());
    JsonObject request = new JsonObject();
 
    request.addProperty(JSONRPC, JSONRPC_VERSION);
    request.addProperty(ID, id);
    request.addProperty(METHOD, method);
    request.add(PARAMS, params);
 
    // Cache the consumer to receive the response
    synchronized (consumerMapLock) {
      consumerMap.put(id, consumer);
    }
 
    // Send the request
    requestSink.add(request);
  }

Member Data Documentation

requestSink

RequestSink org.dartlang.vm.service.VmServiceBase.requestSink

package

The channel through which observatory requests are made.

Definition at line 196 of file VmServiceBase.java.

runtimeVersion

Version org.dartlang.vm.service.VmServiceBase.runtimeVersion

package

Definition at line 198 of file VmServiceBase.java.

---

The documentation for this class was generated from the following file:

• third_party/dart-lang/sdk/pkg/vm_service/java/src/org/dartlang/vm/service/VmServiceBase.java