Connectivity Diagnostics API: chrome.diagnostics.sendPacket

chrome/common/extensions/api/diagnostics.idl

+// Copyright (c) 2013 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+namespace diagnostics {
+  dictionary SendPacketOptions {
+    // Target IP address.
+    DOMString ip;
+    // Packet time to live value.
+    long? ttl;
+    // Packet timeout in seconds.
+    long? timeout;
+    // Size of the payload.
+    long? size;

[asargent_no_longer_on_chrome, 2013/06/20 22:51:29]

It would be good mention something in the comments for these 3 optional
parameters about what default values the platform will use if the developer
doesn't specify explicit values (if it's platform specific and not always the
same, you can just say that too). 

[Bei Zhang, 2013/06/21 08:31:07]

Done.

+  };
+
+  dictionary SendPacketResult {
+    DOMString ip;

[asargent_no_longer_on_chrome, 2013/06/20 22:51:29]

nit: It's not clear what the meaning of this field is - can you include a
comment about it's meaning, and under what circumstances it will differ from the
value of the ip passed in the SendPacketOptions dictionary?

[Bei Zhang, 2013/06/21 08:31:07]

Done.

+    double latency;

[asargent_no_longer_on_chrome, 2013/06/20 22:51:29]

nit: Can you add a comment here about the units of latency here? (In addition,
you could rename the field to be self-documenting, e.g. "latencyMs" if this is
in milliseconds). 

[Bei Zhang, 2013/06/21 08:31:07]

Done.

+  };
+
+  callback SendPacketCallback = void(SendPacketResult result);
+
+  interface Functions {
+    // Send a packet of the given type with the given parameters.
+    static void sendPacket(SendPacketOptions options,
+                           SendPacketCallback callback);
+  };
+};