Commit 799f1ec6 authored by tengs@chromium.org's avatar tengs@chromium.org

Update chrome.bluetooth API docs to be clearer on the correct way to use it.

Review URL: https://codereview.chromium.org/119963005

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@244051 0039d316-1c4b-4281-b951-d872f2087c98
parent 70206ac0
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
// found in the LICENSE file. // found in the LICENSE file.
// Use the <code>chrome.bluetooth</code> API to connect to a Bluetooth // Use the <code>chrome.bluetooth</code> API to connect to a Bluetooth
// device. // device. All functions report failures via chrome.runtime.lastError.
namespace bluetooth { namespace bluetooth {
dictionary AdapterState { dictionary AdapterState {
// The address of the adapter, in the format 'XX:XX:XX:XX:XX:XX'. // The address of the adapter, in the format 'XX:XX:XX:XX:XX:XX'.
...@@ -233,9 +233,11 @@ namespace bluetooth { ...@@ -233,9 +233,11 @@ namespace bluetooth {
static void disconnect(DisconnectOptions options, static void disconnect(DisconnectOptions options,
optional ResultCallback callback); optional ResultCallback callback);
// Read data from a Bluetooth connection. // Read data from a Bluetooth connection. The |callback| will be called
// with the current data in the buffer even if it is empty. This function
// should be polled to read incoming data.
// |options| : The options for this function. // |options| : The options for this function.
// |callback| : Called with the data when it is available. // |callback| : Called with the data read from the socket buffer.
static void read(ReadOptions options, static void read(ReadOptions options,
DataCallback callback); DataCallback callback);
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment