Connectivity Diagnostics API: chrome.diagnostics.sendPacket

chrome/browser/extensions/api/diagnostics_private/send_ping_packet.h

+// 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.
+
+#ifndef CHROME_BROWSER_EXTENSIONS_API_DIAGNOSTICS_PRIVATE_SEND_PING_PACKET_H_
+#define CHROME_BROWSER_EXTENSIONS_API_DIAGNOSTICS_PRIVATE_SEND_PING_PACKET_H_
+
+#include <string>
+
+#include "base/callback.h"
+
+namespace extensions {
+
+// Callback for extensions::SendPingPacket
+// |error| is an empty string if there is no error.
+// Otherwise the |ip| and |latency| arguments are not defined.

[stevenjb, 2013/06/18 19:19:28]

This is an odd API (and the comment is kind of confusing). I'd prefer to use a
result code (i.e. an enum 'result' instead of string 'error') here for two
reasons:
1. The code will be more clear.
2. Error messages should be define as consts in the api .cc file (see other
examples of SetError calls).

[Bei Zhang, 2013/06/18 22:04:46]

Done.

+typedef base::Callback<void(const std::string& error,
+                            const std::string& ip,
+                            double latency)>
+  SendPingPacketCallback;
+
+// Sends an ICMP packet with given parameters.
+// Passs NULL for omitted arguments.
+void SendPingPacket(
+    const std::string& ip,
+    const int* ttl,
+    const int* timeout,
+    const int* size,
+    const SendPingPacketCallback& callback);
+
+}  // namespace extensions
+
+#endif  // CHROME_BROWSER_EXTENSIONS_API_DIAGNOSTICS_PRIVATE_SEND_PING_PACKET_H_