--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/battery/tests/submissions/anssik/TODO.txt Tue Oct 02 18:07:01 2012 -0700
@@ -0,0 +1,5 @@
+---+ TODO
+
+ * proper {level | chargingtime | dischargingtime}change tests
+ * async tests for *change when plugged in
+ * validate tests on a real device and tweak timeouts for async tests
\ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/battery/tests/submissions/anssik/battery-charging.html Tue Oct 02 18:07:01 2012 -0700
@@ -0,0 +1,45 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <title>Battery Status API Test Suite</title>
+ <script src="http://www.w3c-test.org/resources/testharness.js"></script>
+ <link rel='stylesheet' href='http://w3c-test.org/resources/testharness.css' media='all'/>
+ </head>
+ <body>
+ <h1>Description</h1>
+ <p>
+ The battery is charging.
+ </p>
+ <h2>Preconditions</h2>
+ <ol>
+ <li>
+ The device is plugged in to the charger before this test case is run.
+ </li>
+ <li>
+ The battery must neither be empty or full, nor reach empty or full capacity during the test.
+ </li>
+ </ol>
+ <div id="log"></div>
+ <script>
+ (function() {
+
+ test(function() {
+ assert_true(navigator.battery.charging);
+ }, 'The charging attribute must be set to true if the battery is charging.');
+
+ test(function() {
+ assert_true(navigator.battery.chargingTime < Infinity);
+ }, 'The chargingTime attribute must be set to the value positive Infinity if the battery is discharging');
+
+ test(function() {
+ assert_true(navigator.battery.dischargingTime === Infinity);
+ }, 'The dischargingTime attribute must be set to the value positive Infinity, if the battery is charging.');
+
+ test(function() {
+ assert_true(0 < navigator.battery.level && navigator.battery.level < 1.0);
+ }, 'The level attribute must be set to the current battery level scaled from 0 to 1.0.');
+
+ })();
+ </script>
+ </body>
+</html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/battery/tests/submissions/anssik/battery-chargingchange.html Tue Oct 02 18:07:01 2012 -0700
@@ -0,0 +1,57 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <title>Battery Status API Test Suite</title>
+ <script src="http://www.w3c-test.org/resources/testharness.js"></script>
+ <link rel='stylesheet' href='http://w3c-test.org/resources/testharness.css' media='all'/>
+ </head>
+ <body>
+ <h1>Description</h1>
+ <p>
+ The battery charging state is updated.
+ </p>
+ <h2>Preconditions</h2>
+ <ol>
+ <li>
+ The device is unplugged from the charger before this test case is run.
+ </li>
+ <li>
+ The battery must not be full or reach full capacity during the time the test is run.
+ </li>
+ </ol>
+ <div id="log"></div>
+ <script>
+ (function() {
+
+ // this is the pattern used for testing event handlers
+
+ /*
+ var onclick_test = async_test('onclick on body');
+ document.querySelector('body').onclick = onclick_test.step_func(function (e) {
+ // assert_xxxx();
+ onclick_test.done();
+ });
+
+ alert('click on body!');
+ */
+
+ // the tests below must be validated on a real implementation, to set proper timeouts etc.
+
+ var onchargingchange_test = async_test('When the battery charging state is updated, must fire a chargingchange event.');
+ navigator.battery.onchargingchange = onchargingchange_test.step_func(function (e) {
+ assert_true(navigator.battery.charging, 'The charging attribute must be set to true, if the battery is charging.')
+ onchargingchange_test.done();
+ });
+
+ var onchargingtimechange_test = async_test('When the battery charging time is updated, must fire a chargingtimechange event.');
+ navigator.battery.onchargingtimechange = onchargingtimechange_test.step_func(function (e) {
+ assert_false(navigator.battery.chargingTime !== Infinity);
+ onchargingchange_test.done();
+ });
+
+ alert('Plug in the charger, and click OK.');
+
+ })();
+ </script>
+ </body>
+</html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/battery/tests/submissions/anssik/battery-created.html Tue Oct 02 18:07:01 2012 -0700
@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <title>Battery Status API Test Suite</title>
+ <script src="http://www.w3c-test.org/resources/testharness.js"></script>
+ <link rel='stylesheet' href='http://w3c-test.org/resources/testharness.css' media='all'/>
+ </head>
+ <body>
+ <h1>Description</h1>
+ <p>
+ <strong>
+ This test is only useful on devices that expose the BatteryManager interface,
+ but lack a backend implementation.
+ </strong>
+ </p>
+ <h2>Preconditions</h2>
+ <ol>
+ <li>
+ The implementation is unable to report the battery's charging state,
+ charging time, level or remaining time respectively.
+ </li>
+ <li>
+ The device is unplugged from the charger before this test case is run.
+ </li>
+ </ol>
+ <div id="log"></div>
+ <script>
+ (function() {
+ test(function() {
+ var b = navigator.battery;
+ assert_true(b.charging === true, 'charging must be set to true');
+ assert_true(b.chargingTime === 0, 'chargingTime must be set to 0');
+ assert_true(b.level === 1.0, 'level must be set to 1.0');
+ assert_true(b.dischargingTime === Infinity, 'dischargingTime must be set to Infinity');
+
+ }, 'When a BatteryManager object is created, charging must be set to true, ' +
+ 'chargingTime to 0, level to 1.0 and dischargingTime to the value positive ' +
+ 'Infinity, if the implementation is unable to report the battery\'s charging ' +
+ 'state, charging time, level or remaining time respectively.');
+ })();
+ </script>
+ </body>
+</html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/battery/tests/submissions/anssik/battery-discharging.html Tue Oct 02 18:07:01 2012 -0700
@@ -0,0 +1,46 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <title>Battery Status API Test Suite</title>
+ <script src="http://www.w3c-test.org/resources/testharness.js"></script>
+ <link rel='stylesheet' href='http://w3c-test.org/resources/testharness.css' media='all'/>
+ </head>
+ <body>
+ <h1>Description</h1>
+ <p>
+ The battery is discharging.
+ </p>
+ <h2>Preconditions</h2>
+ <ol>
+ <li>
+ The device is unplugged from the charger before this test case is run.
+ </li>
+ <li>
+ The battery must neither be empty or full, nor reach empty or full capacity during the test.
+ </li>
+ </ol>
+ <div id="log"></div>
+ <script>
+ (function() {
+
+ test(function() {
+ assert_false(navigator.battery.charging);
+ }, 'The charging attribute must be set to false if the battery is discharging.');
+
+ test(function() {
+ assert_true(navigator.battery.chargingTime === Infinity);
+ }, 'The chargingTime attribute must be set to the value positive Infinity if the battery is discharging');
+
+ test(function() {
+ assert_true(navigator.battery.dischargingTime < Infinity);
+ }, 'The dischargingTime attribute must be set to the time remaining in ' +
+ 'seconds until the system\'s battery is completely discharged.');
+
+ test(function() {
+ assert_true(0 <= navigator.battery.level && navigator.battery.level <= 1.0);
+ }, 'The level attribute must be set to the current battery level scaled from 0 to 1.0');
+
+ })();
+ </script>
+ </body>
+</html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/battery/tests/submissions/anssik/battery-full.html Tue Oct 02 18:07:01 2012 -0700
@@ -0,0 +1,45 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <title>Battery Status API Test Suite</title>
+ <script src="http://www.w3c-test.org/resources/testharness.js"></script>
+ <link rel='stylesheet' href='http://w3c-test.org/resources/testharness.css' media='all'/>
+ </head>
+ <body>
+ <h1>Description</h1>
+ <p>
+ The battery is full.
+ </p>
+ <h2>Preconditions</h2>
+ <ol>
+ <li>
+ The device is plugged in to the charger before this test case is run.
+ </li>
+ <li>
+ The battery is full.
+ </li>
+ </ol>
+ <div id="log"></div>
+ <script>
+ (function() {
+
+ test(function() {
+ assert_true(navigator.battery.charging);
+ }, 'The charging attribute must be set to true if the battery is charging ("or otherwise" condition).');
+
+ test(function() {
+ assert_true(navigator.battery.chargingTime === 0);
+ }, 'The chargingTime attribute must be set to 0, if the battery is full.');
+
+ test(function() {
+ assert_true(navigator.battery.dischargingTime === Infinity);
+ }, 'The dischargingTime attribute must be set to the value positive Infinity if the battery is charging ("or otherwise" condition).');
+
+ test(function() {
+ assert_true(navigator.battery.level === 1.0);
+ }, 'The level attribute must be set to the current battery level scaled from 0 to 1.0.');
+
+ })();
+ </script>
+ </body>
+</html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/battery/tests/submissions/anssik/battery_tests.js Tue Oct 02 18:07:01 2012 -0700
@@ -0,0 +1,393 @@
+/**
+* W3C 3-clause BSD License
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are
+* met:
+* o Redistributions of works must retain the original copyright notice,
+* this list of conditions and the following disclaimer.
+*
+* o Redistributions in binary form must reproduce the original copyright
+* notice, this list of conditions and the following disclaimer in the
+* documentation and/or other materials provided with the distribution.
+*
+* o Neither the name of the W3C nor the names of its contributors may be
+* used to endorse or promote products derived from this work without
+* specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+* POSSIBILITY OF SUCH DAMAGE.
+**/
+
+(function() {
+
+ /**
+ *
+ * Navigator implements NavigatorBattery;
+ *
+ * [NoInterfaceObject]
+ * interface NavigatorBattery {
+ * readonly attribute BatteryManager battery;
+ * };
+ *
+ */
+
+ test(function() {
+ assert_idl_attribute(navigator, 'battery', 'navigator must have battery attribute');
+ }, 'battery is present on navigator');
+
+ test(function() {
+ assert_readonly(navigator, 'battery', 'battery must be readonly')
+ }, 'battery is readonly');
+
+ /**
+ *
+ * [NoInterfaceObject]
+ * interface BatteryManager : EventTarget {
+ * readonly attribute boolean charging;
+ * readonly attribute double chargingTime;
+ * readonly attribute double dischargingTime;
+ * readonly attribute double level;
+ * attribute EventHandler onchargingchange;
+ * attribute EventHandler onchargingtimechange;
+ * attribute EventHandler ondischargingtimechange;
+ * attribute EventHandler onlevelchange;
+ * };
+ *
+ */
+
+ // interface BatteryManager : EventTarget {
+
+ test(function() {
+ assert_true(navigator.battery instanceof EventTarget);
+ }, 'battery inherits from EventTarget');
+
+ // readonly attribute boolean charging;
+
+ test(function() {
+ assert_idl_attribute(navigator.battery, 'charging', 'battery must have charging attribute');
+ }, 'charging attribute exists');
+
+ test(function() {
+ assert_readonly(navigator.battery, 'charging', 'charging must be readonly')
+ }, 'charging attribute is readonly');
+
+ // readonly attribute double chargingTime;
+
+ test(function() {
+ assert_idl_attribute(navigator.battery, 'chargingTime', 'battery must have chargingTime attribute');
+ }, 'chargingTime attribute exists');
+
+ test(function() {
+ assert_readonly(navigator.battery, 'chargingTime', 'chargingTime must be readonly')
+ }, 'chargingTime attribute is readonly');
+
+ // readonly attribute double dischargingTime;
+
+ test(function() {
+ assert_idl_attribute(navigator.battery, 'dischargingTime', 'battery must have dischargingTime attribute');
+ }, 'dischargingTime attribute exists');
+
+ test(function() {
+ assert_readonly(navigator.battery, 'dischargingTime', 'dischargingTime must be readonly')
+ }, 'dischargingTime attribute is readonly');
+
+ // readonly attribute double level;
+
+ test(function() {
+ assert_idl_attribute(navigator.battery, 'level', 'battery must have level attribute');
+ }, 'level attribute exists');
+
+ test(function() {
+ assert_readonly(navigator.battery, 'level', 'level must be readonly')
+ }, 'level attribute is readonly');
+
+ // attribute EventHandler onchargingchange;
+
+ test(function() {
+ assert_idl_attribute(navigator.battery, 'onchargingchange', 'battery must have onchargingchange attribute');
+ }, 'onchargingchange attribute exists');
+
+ test(function() {
+ assert_equals(navigator.battery.onchargingchange, null, 'onchargingchange must be null')
+ }, 'onchargingchange is null');
+
+ test(function() {
+ var desc = 'onchargingchange did not accept callable object',
+ func = function() {},
+ desc = 'Expected to find onchargingchange attribute on battery object';
+ assert_idl_attribute(navigator.battery, 'onchargingchange', desc);
+ window.onchargingchange = func;
+ assert_equals(window.onchargingchange, func, desc);
+ }, 'onchargingchange is set to function');
+
+ test(function() {
+ var desc = 'onchargingchange did not treat noncallable as null';
+ navigator.battery.onchargingchange = function() {};
+ navigator.battery.onchargingchange = {};
+ assert_equals(navigator.battery.onchargingchange, null, desc);
+ }, 'onchargingchange: treat object as null');
+
+ test(function() {
+ var desc = 'onchargingchange did not treat noncallable as null';
+ navigator.battery.onchargingchange = function() {};
+ navigator.battery.onchargingchange = {
+ call: 'test'
+ };
+ assert_equals(navigator.battery.onchargingchange, null, desc);
+ }, 'onchargingchange: treat object with non-callable call property as null');
+
+ test(function() {
+ var desc = 'onchargingchange did not treat noncallable (string) as null';
+ navigator.battery.onchargingchange = function() {};
+ navigator.battery.onchargingchange = 'string';
+ assert_equals(navigator.battery.onchargingchange, null, desc);
+ }, 'onchargingchange: treat string as null');
+
+ test(function() {
+ var desc = 'onchargingchange did not treat noncallable (number) as null';
+ navigator.battery.onchargingchange = function() {};
+ navigator.battery.onchargingchange = 123;
+ assert_equals(navigator.battery.onchargingchange, null, desc);
+ }, 'onchargingchange: treat number as null');
+
+ test(function() {
+ var desc = 'onchargingchange did not treat noncallable (undefined) as null';
+ navigator.battery.onchargingchange = function() {};
+ navigator.battery.onchargingchange = undefined;
+ assert_equals(navigator.battery.onchargingchange, null, desc);
+ }, 'onchargingchange: treat undefined as null');
+
+ test(function() {
+ var desc = 'onchargingchange did not treat noncallable (array) as null';
+ navigator.battery.onchargingchange = function() {};
+ navigator.battery.onchargingchange = [];
+ assert_equals(navigator.battery.onchargingchange, null, desc);
+ }, 'onchargingchange: treat array as null');
+
+ test(function() {
+ var desc = 'onchargingchange did not treat noncallable host object as null';
+ navigator.battery.onchargingchange = function() {};
+ navigator.battery.onchargingchange = Node;
+ assert_equals(navigator.battery.onchargingchange, null, desc);
+ }, 'onchargingchange: treat non-callable host object as null');
+
+ // attribute EventHandler onchargingtimechange;
+
+ test(function() {
+ assert_idl_attribute(navigator.battery, 'onchargingtimechange', 'battery must have onchargingtimechange attribute');
+ }, 'onchargingtimechange attribute exists');
+
+ test(function() {
+ assert_equals(navigator.battery.onchargingtimechange, null, 'onchargingtimechange must be null')
+ }, 'onchargingtimechange is null');
+
+ test(function() {
+ var desc = 'onchargingtimechange did not accept callable object',
+ func = function() {},
+ desc = 'Expected to find onchargingtimechange attribute on battery object';
+ assert_idl_attribute(navigator.battery, 'onchargingtimechange', desc);
+ window.onchargingtimechange = func;
+ assert_equals(window.onchargingtimechange, func, desc);
+ }, 'onchargingtimechange is set to function');
+
+ test(function() {
+ var desc = 'onchargingtimechange did not treat noncallable as null';
+ navigator.battery.onchargingtimechange = function() {};
+ navigator.battery.onchargingtimechange = {};
+ assert_equals(navigator.battery.onchargingtimechange, null, desc);
+ }, 'onchargingtimechange: treat object as null');
+
+ test(function() {
+ var desc = 'onchargingtimechange did not treat noncallable as null';
+ navigator.battery.onchargingtimechange = function() {};
+ navigator.battery.onchargingtimechange = {
+ call: 'test'
+ };
+ assert_equals(navigator.battery.onchargingtimechange, null, desc);
+ }, 'onchargingtimechange: treat object with non-callable call property as null');
+
+ test(function() {
+ var desc = 'onchargingtimechange did not treat noncallable (string) as null';
+ navigator.battery.onchargingtimechange = function() {};
+ navigator.battery.onchargingtimechange = 'string';
+ assert_equals(navigator.battery.onchargingtimechange, null, desc);
+ }, 'onchargingtimechange: treat string as null');
+
+ test(function() {
+ var desc = 'onchargingtimechange did not treat noncallable (number) as null';
+ navigator.battery.onchargingtimechange = function() {};
+ navigator.battery.onchargingtimechange = 123;
+ assert_equals(navigator.battery.onchargingtimechange, null, desc);
+ }, 'onchargingtimechange: treat number as null');
+
+ test(function() {
+ var desc = 'onchargingtimechange did not treat noncallable (undefined) as null';
+ navigator.battery.onchargingtimechange = function() {};
+ navigator.battery.onchargingtimechange = undefined;
+ assert_equals(navigator.battery.onchargingtimechange, null, desc);
+ }, 'onchargingtimechange: treat undefined as null');
+
+ test(function() {
+ var desc = 'onchargingtimechange did not treat noncallable (array) as null';
+ navigator.battery.onchargingtimechange = function() {};
+ navigator.battery.onchargingtimechange = [];
+ assert_equals(navigator.battery.onchargingtimechange, null, desc);
+ }, 'onchargingtimechange: treat array as null');
+
+ test(function() {
+ var desc = 'onchargingtimechange did not treat noncallable host object as null';
+ navigator.battery.onchargingtimechange = function() {};
+ navigator.battery.onchargingtimechange = Node;
+ assert_equals(navigator.battery.onchargingtimechange, null, desc);
+ }, 'onchargingtimechange: treat non-callable host object as null');
+
+ // attribute EventHandler ondischargingtimechange;
+
+ test(function() {
+ assert_idl_attribute(navigator.battery, 'ondischargingtimechange', 'battery must have ondischargingtimechange attribute');
+ }, 'ondischargingtimechange attribute exists');
+
+ test(function() {
+ assert_equals(navigator.battery.ondischargingtimechange, null, 'ondischargingtimechange must be null')
+ }, 'ondischargingtimechange is null');
+
+ test(function() {
+ var desc = 'ondischargingtimechange did not accept callable object',
+ func = function() {},
+ desc = 'Expected to find ondischargingtimechange attribute on battery object';
+ assert_idl_attribute(navigator.battery, 'ondischargingtimechange', desc);
+ window.ondischargingtimechange = func;
+ assert_equals(window.ondischargingtimechange, func, desc);
+ }, 'ondischargingtimechange is set to function');
+
+ test(function() {
+ var desc = 'ondischargingtimechange did not treat noncallable as null';
+ navigator.battery.ondischargingtimechange = function() {};
+ navigator.battery.ondischargingtimechange = {};
+ assert_equals(navigator.battery.ondischargingtimechange, null, desc);
+ }, 'ondischargingtimechange: treat object as null');
+
+ test(function() {
+ var desc = 'ondischargingtimechange did not treat noncallable as null';
+ navigator.battery.ondischargingtimechange = function() {};
+ navigator.battery.ondischargingtimechange = {
+ call: 'test'
+ };
+ assert_equals(navigator.battery.ondischargingtimechange, null, desc);
+ }, 'ondischargingtimechange: treat object with non-callable call property as null');
+
+ test(function() {
+ var desc = 'ondischargingtimechange did not treat noncallable (string) as null';
+ navigator.battery.ondischargingtimechange = function() {};
+ navigator.battery.ondischargingtimechange = 'string';
+ assert_equals(navigator.battery.ondischargingtimechange, null, desc);
+ }, 'ondischargingtimechange: treat string as null');
+
+ test(function() {
+ var desc = 'ondischargingtimechange did not treat noncallable (number) as null';
+ navigator.battery.ondischargingtimechange = function() {};
+ navigator.battery.ondischargingtimechange = 123;
+ assert_equals(navigator.battery.ondischargingtimechange, null, desc);
+ }, 'ondischargingtimechange: treat number as null');
+
+ test(function() {
+ var desc = 'ondischargingtimechange did not treat noncallable (undefined) as null';
+ navigator.battery.ondischargingtimechange = function() {};
+ navigator.battery.ondischargingtimechange = undefined;
+ assert_equals(navigator.battery.ondischargingtimechange, null, desc);
+ }, 'ondischargingtimechange: treat undefined as null');
+
+ test(function() {
+ var desc = 'ondischargingtimechange did not treat noncallable (array) as null';
+ navigator.battery.ondischargingtimechange = function() {};
+ navigator.battery.ondischargingtimechange = [];
+ assert_equals(navigator.battery.ondischargingtimechange, null, desc);
+ }, 'ondischargingtimechange: treat array as null');
+
+ test(function() {
+ var desc = 'ondischargingtimechange did not treat noncallable host object as null';
+ navigator.battery.ondischargingtimechange = function() {};
+ navigator.battery.ondischargingtimechange = Node;
+ assert_equals(navigator.battery.ondischargingtimechange, null, desc);
+ }, 'ondischargingtimechange: treat non-callable host object as null');
+
+ // attribute EventHandler onlevelchange;
+
+ test(function() {
+ assert_idl_attribute(navigator.battery, 'onlevelchange', 'battery must have onlevelchange attribute');
+ }, 'onlevelchange attribute exists');
+
+ test(function() {
+ assert_equals(navigator.battery.onlevelchange, null, 'onlevelchange must be null')
+ }, 'onlevelchange is null');
+
+ test(function() {
+ var desc = 'onlevelchange did not accept callable object',
+ func = function() {},
+ desc = 'Expected to find onlevelchange attribute on battery object';
+ assert_idl_attribute(navigator.battery, 'onlevelchange', desc);
+ window.onlevelchange = func;
+ assert_equals(window.onlevelchange, func, desc);
+ }, 'onlevelchange is set to function');
+
+ test(function() {
+ var desc = 'onlevelchange did not treat noncallable as null';
+ navigator.battery.onlevelchange = function() {};
+ navigator.battery.onlevelchange = {};
+ assert_equals(navigator.battery.onlevelchange, null, desc);
+ }, 'onlevelchange: treat object as null');
+
+ test(function() {
+ var desc = 'onlevelchange did not treat noncallable as null';
+ navigator.battery.onlevelchange = function() {};
+ navigator.battery.onlevelchange = {
+ call: 'test'
+ };
+ assert_equals(navigator.battery.onlevelchange, null, desc);
+ }, 'onlevelchange: treat object with non-callable call property as null');
+
+ test(function() {
+ var desc = 'onlevelchange did not treat noncallable (string) as null';
+ navigator.battery.onlevelchange = function() {};
+ navigator.battery.onlevelchange = 'string';
+ assert_equals(navigator.battery.onlevelchange, null, desc);
+ }, 'onlevelchange: treat string as null');
+
+ test(function() {
+ var desc = 'onlevelchange did not treat noncallable (number) as null';
+ navigator.battery.onlevelchange = function() {};
+ navigator.battery.onlevelchange = 123;
+ assert_equals(navigator.battery.onlevelchange, null, desc);
+ }, 'onlevelchange: treat number as null');
+
+ test(function() {
+ var desc = 'onlevelchange did not treat noncallable (undefined) as null';
+ navigator.battery.onlevelchange = function() {};
+ navigator.battery.onlevelchange = undefined;
+ assert_equals(navigator.battery.onlevelchange, null, desc);
+ }, 'onlevelchange: treat undefined as null');
+
+ test(function() {
+ var desc = 'onlevelchange did not treat noncallable (array) as null';
+ navigator.battery.onlevelchange = function() {};
+ navigator.battery.onlevelchange = [];
+ assert_equals(navigator.battery.onlevelchange, null, desc);
+ }, 'onlevelchange: treat array as null');
+
+ test(function() {
+ var desc = 'onlevelchange did not treat noncallable host object as null';
+ navigator.battery.onlevelchange = function() {};
+ navigator.battery.onlevelchange = Node;
+ assert_equals(navigator.battery.onlevelchange, null, desc);
+ }, 'onlevelchange: treat non-callable host object as null');
+
+})();
\ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/battery/tests/submissions/anssik/index.html Tue Oct 02 18:07:01 2012 -0700
@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>Battery Status API Test Suite</title>
+<script src="http://www.w3c-test.org/resources/testharness.js"></script>
+<script src="battery_tests.js"></script>
+</head>
+<body>
+<h1>Test Suite for Battery Status API (Work in Progress)</h1>
+<div id="log"></div>
+<p>
+ <small>
+ Distributed under both the
+ <a href="http://www.w3.org/Consortium/Legal/2008/04-testsuite-license">
+ W3C Test Suite License</a> and the
+ <a href="http://www.w3.org/Consortium/Legal/2008/03-bsd-license">
+ W3C 3-clause BSD License</a>. To contribute to a W3C Test Suite, see the
+ <a href="http://www.w3.org/2004/10/27-testcases">policies and contribution
+ forms</a>.
+ </small>
+</p>
+</body>
+</html>
\ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/battery/tests/submissions/anssik/manifest.txt Tue Oct 02 18:07:01 2012 -0700
@@ -0,0 +1,6 @@
+index.html Battery Status API Test Suite
+battery-charging.html Battery Status API Test Suite
+battery-chargingchange.html Battery Status API Test Suite
+battery-created.html Battery Status API Test Suite
+battery-discharging.html Battery Status API Test Suite
+battery-full.html Battery Status API Test Suite
--- a/contacts/Overview.html Tue Oct 02 18:05:58 2012 -0700
+++ b/contacts/Overview.html Tue Oct 02 18:07:01 2012 -0700
@@ -16,12 +16,16 @@
{name: "Robin Berjon",
url: "http://berjon.com/",
company: "Robineko",
- companyURL: "http://robineko.com/"}
+ companyURL: "http://robineko.com/"},
+ {name: "송정기(Jungkee Song)",
+ url: "mailto:jungkee.song@samsung.com",
+ company: "Samsung Electronics Co., Ltd.",
+ companyURL: "http://www.samsung.com/sec/"}
],
// previousPublishDate: "2011-06-16",
// lcEnd: "2011-07-14",
// previousMaturity: "LC",
- edDraftURI: "http://w3c-test.org/2009/dap/contacts/",
+ edDraftURI: "http://w3c-test.org/dap/contacts/",
wg: "Device APIs Working Group",
wgURI: "http://www.w3.org/2009/dap/",
wgPublicList: "public-device-apis",
@@ -80,16 +84,14 @@
<p>
A set of <a href="#security-and-privacy-considerations">Security and Privacy Considerations</a> are
presented for the discretion of both implementers of Pick Contacts Intent services and recipients of contact
- information (i.e. Web applications). This specification provides a set of non-normative
- <a href="#user-interaction-guidelines">User Interaction Guidelines</a> demonstrating an example user experience
- that is compliant with the Security and Privacy Considerations described herein.
+ information (i.e. Web applications).
</p>
<p>
The following code illustrates how to obtain contact information from a user's address book:
</p>
<pre class="example highlight">
- var intent = new Intent({ action: "http://webintents.org/pick",
- type: "http://w3.org/type/contact",
+ var intent = new Intent({ action: "http://intents.w3.org/pick",
+ type: "http://intents.w3.org/type/contact",
extras: { fields: ["displayName", "emails"] }});
navigator.startActivity(intent, contactsOK, contactsFail);
@@ -208,10 +210,10 @@
<section>
<h2>Intent Description</h2>
<p>
- The action for this Intent is <code>http://webintents.org/pick</code>.
+ The action for this Intent is <code>http://intents.w3.org/pick</code>.
</p>
<p>
- The type for this Intent is <code>http://w3.org/type/contact</code>.
+ The type for this Intent is <code>http://intents.w3.org/type/contact</code>.
</p>
<p>
When a <a>contact service</a> is matched for delivery using these action and type, it
@@ -240,18 +242,18 @@
The <a>ContactIntentExtras</a> dictionary describes the options that can be applied to contact searching.
</p>
<dl title='dictionary ContactIntentExtras' class='idl'>
- <dt>DOMString? search</dt>
+ <dt>DOMString search</dt>
<dd>
A string which provides a hint to the <a>contact service</a> to facilitate contacts selection by the user.
The exact manner in which this hint is exploited is entirely up to the <a>contact service</a>.
</dd>
- <dt>unsigned long? limit</dt>
+ <dt>unsigned long limit</dt>
<dd>
By default a <a>contact service</a> MAY return as many contacts as the user selects. If <code>limit</code>
is specified, the <a>contact service</a> MUST NOT return more than <code>limit</code> contacts. The
<a>contact service</a> SHOULD enforce this limitation in the user interface that it exposes.
</dd>
- <dt>DOMString[] fields</dt>
+ <dt>sequence<DOMString> fields</dt>
<dd>
An array of field names corresponding to the name of the fields in the <a>Contact</a> dictionary that
the Web application is requesting from the <a>contact service</a>. The <a>contact service</a> MUST
@@ -285,53 +287,53 @@
<dd>
A globally unique identifier for the given <a>Contact</a> object.
</dd>
- <dt>DOMString? displayName</dt>
+ <dt>DOMString displayName</dt>
<dd>
This attribute contains the name of this <a>Contact</a> in a form that is suitable for display
to the user.
</dd>
- <dt>ContactName? name</dt>
+ <dt>ContactName name</dt>
<dd>
This attribute represents the full name of this <a>Contact</a> indicated by the name components
associated with the <a>ContactName</a> dictionary.
</dd>
- <dt>DOMString? nickname</dt>
+ <dt>DOMString nickname</dt>
<dd>
This attribute contains the nickname (or a casual name) for this <a>Contact</a>.
</dd>
- <dt>ContactField[]? phoneNumbers</dt>
+ <dt>sequence<ContactField> phoneNumbers</dt>
<dd>
This attribute captures one or more phone numbers associated with this <a>Contact</a>.
</dd>
- <dt>ContactField[]? emails</dt>
+ <dt>sequence<ContactField> emails</dt>
<dd>
This attribute represents one or more email addresses associated with this <a>Contact</a>.
</dd>
- <dt>ContactAddress[]? addresses</dt>
+ <dt>sequence<ContactAddress> addresses</dt>
<dd>
This attribute represents one or more physical addresses associated with this <a>Contact</a>.
</dd>
- <dt>ContactField[]? ims</dt>
+ <dt>sequence<ContactField> ims</dt>
<dd>
This attribute represents one or more instant messaging identifiers associated with this
<a>Contact</a>.
</dd>
- <dt>ContactOrganization[]? organizations</dt>
+ <dt>sequence<ContactOrganization> organizations</dt>
<dd>
This attribute represents one or more organisations associated with this <a>Contact</a>.
</dd>
- <dt>Date? birthday</dt>
+ <dt>Date birthday</dt>
<dd>
This attribute contains birthday of this <a>Contact</a>. The <a>contact service</a> MAY
set the year value to 0000 when the age of the <a>Contact</a> is private or the year is not
available.
</dd>
- <dt>DOMString? note</dt>
+ <dt>DOMString note</dt>
<dd>
This attribute contains the personal notes (free-text) for this <a>Contact</a> that is managed by the
user of the address book.
</dd>
- <dt>ContactField[]? photos</dt>
+ <dt>sequence<ContactField> photos</dt>
<dd>
<p>
This attribute represents one or more photos associated with this <a>Contact</a>.
@@ -347,12 +349,12 @@
contact.
</p>
</dd>
- <dt>DOMString[]? categories</dt>
+ <dt>sequence<DOMString> categories</dt>
<dd>
This attribute contains one or more user-defined categories/tags/labels associated with this
<a>Contact</a>. e.g. "family", "favourite", "cryptozoologists".
</dd>
- <dt>ContactField[]? urls</dt>
+ <dt>sequence<ContactField> urls</dt>
<dd>
<p>
This attribute represents one or more URLs associated with this <a>Contact</a> e.g. personal web page,
@@ -368,23 +370,23 @@
The <a>ContactName</a> dictionary describes a contact's name in detail.
</p>
<dl title='dictionary ContactName' class='idl'>
- <dt>DOMString? familyName</dt>
+ <dt>DOMString familyName</dt>
<dd>
This attribute contains the family name (also referred to as the last name) of this <a>Contact</a>.
</dd>
- <dt>DOMString? givenName</dt>
+ <dt>DOMString givenName</dt>
<dd>
This attribute contains the given name (also referred to as the first name) of this <a>Contact</a>.
</dd>
- <dt>DOMString? middleName</dt>
+ <dt>DOMString middleName</dt>
<dd>
This attribute contains the middle name of this <a>Contact</a>.
</dd>
- <dt>DOMString? honorificPrefix</dt>
+ <dt>DOMString honorificPrefix</dt>
<dd>
This attribute contains the honorific prefix (or title) of this <a>Contact</a>. E.g. Mr., Dr., Ms., Mrs.
</dd>
- <dt>DOMString? honorificSuffix</dt>
+ <dt>DOMString honorificSuffix</dt>
<dd>
This attribute contains the honorific suffix of this <a>Contact</a>. E.g. Jr., III, Sr.
</dd>
@@ -407,7 +409,7 @@
<code>home</code>, <code>mobile</code>; if the <a>ContactField</a> is representing the <code>ims</code>
property, the type attribute could be set to <code>xmpp</code>, <code>irc</code>, <code>bbm</code>, etc.
</dd>
- <dt>DOMString? value</dt>
+ <dt>DOMString value</dt>
<dd>
This attribute contains the value for this <a>ContactField</a> and its content varies subject to the
contact property this <a>ContactField</a> is representing. For example, if the <a>ContactField</a> is
@@ -436,28 +438,28 @@
This attribute indicates whether this instance of the <code>ContactAddress</code> is the preferred,
or primary, value for the contact. By default, the value is <code>false</code>.
</dd>
- <dt>DOMString? type</dt>
+ <dt>DOMString type</dt>
<dd>
This attribute contains the type of address this object is representing (e.g. <code>work</code>,
<code>home</code>, <code>premises</code>, etc).
</dd>
- <dt>DOMString? streetAddress</dt>
+ <dt>DOMString streetAddress</dt>
<dd>
This attribute contains the street address corresponding to this <a>ContactAddress</a>.
</dd>
- <dt>DOMString? locality</dt>
+ <dt>DOMString locality</dt>
<dd>
This attribute contains the locality (or city) name corresponding to this <a>ContactAddress</a>.
</dd>
- <dt>DOMString? region</dt>
+ <dt>DOMString region</dt>
<dd>
This attribute contains the region (or state/province) name corresponding to this <a>ContactAddress</a>.
</dd>
- <dt>DOMString? postalCode</dt>
+ <dt>DOMString postalCode</dt>
<dd>
This attribute contains the postal code (or zip) corresponding to this <a>ContactAddress</a>.
</dd>
- <dt>DOMString? country</dt>
+ <dt>DOMString country</dt>
<dd>
This attribute contains the country name corresponding to this <a>ContactAddress</a>.
</dd>
@@ -476,19 +478,19 @@
This attribute indicates whether this instance of the <code>ContactOrganization</code> is the preferred, or
primary, value for the contact. By default, the value is <code>false</code>.
</dd>
- <dt>DOMString? type</dt>
+ <dt>DOMString type</dt>
<dd>
This attribute contains the type of organisation this object is representing.
</dd>
- <dt>DOMString? name</dt>
+ <dt>DOMString name</dt>
<dd>
The name of the organisation.
</dd>
- <dt>DOMString? department</dt>
+ <dt>DOMString department</dt>
<dd>
The department within which this <a>Contact</a> works.
</dd>
- <dt>DOMString? title</dt>
+ <dt>DOMString title</dt>
<dd>
The job title that the <a>Contact</a> holds inside this organisation.
</dd>
@@ -514,199 +516,5 @@
</p>
</section>
</section>
- <section class="informative appendix">
- <h2>User Interaction Guidelines</h2>
-
- <p>
- This specification is primarily intended to provide the user with the ability to view and control the
- contact information that may be shared from their unified address book. This annex provides some examples
- of a conformant user experience that this specification enables.
- </p>
-
- <section>
- <h3>Accessing Contact Information - Example #1</h3>
-
- <p>
- A website requests access to a user's address book with the following code:
- </p>
-
- <div class='example'>
- <pre class="sh_javascript">
- <script type="text/javascript">
-
- function successContactFindCallback(contacts) {
- // do something with resulting contact objects
- for (var i in contacts) alert(contacts[i].name);
- // ...
- }
-
- function generalErrorCB(error) {
- // do something with resulting errors
- alert(error.code);
- // ...
- }
-
- // Perform an address book search. Obtain the 'name' and 'emails' properties
- // and initially filter the list to Contact records containing 'Bob':
- navigator.contacts.find(['name', 'emails'],
- successContactFindCallback,
- generalErrorCB,
- { filter: 'Bob', multiple: true }
- );
-
- </script>
- </pre>
- </div>
-
- <p>
- As a result of executing this code, the <a>user agent</a> may provide a non-blocking <dfn>contact
- search notification</dfn> as follows:
- </p>
-
- <p align="center"><img src="contacts_notification.png" alt="Contact Search Notification"><br>
- (<a href="contacts_notification.png">View as PNG</a>)
- </p>
-
- <p>
- If an additional find() operation is called by the current web application before the user has
- clicked 'Select' or 'Cancel' on the current notification, an error will be invoked with a code of
- <a href="#widl-ContactError-PENDING_OPERATION_ERROR"><code>PENDING_OPERATION_ERROR</code></a> if that
- operation was defined with a non-<code>null</code> <code>errorCB</code> parameter.
- </p>
-
- <p>
- If the user clicks 'Cancel', the <code>errorCB</code>, if non-<code>null</code> for the current
- find() operation, will be invoked with an error code of <a href=
- "#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PERMISSION_DENIED_ERROR</code></a>.
- </p>
-
- <p>
- If the user clicks 'Select', the <a>user agent</a> may provide a <dfn>contact picker</dfn>,
- utilizing all of the parameters provided in the find() operation as follows:
- </p>
-
- <p align="center"><img src="contacts_picker.png" alt="Contact Picker"><br>
- (<a href="contacts_picker.png">View as PNG</a>)
- </p>
-
- <p>
- In this dialog, the user is provided with a summary of the sharing that the application is
- requesting and the option to select one or more contacts (as appropriate) from the user interface.
- </p>
-
- <p>
- If an additional find() operation is called by the current web application before the user has
- clicked 'Select' or 'Cancel' on the current notification, an error will be invoked with a code of
- <a href="#widl-ContactError-PENDING_OPERATION_ERROR"><code>PENDING_OPERATION_ERROR</code></a> if that
- operation was defined with a non-<code>null</code> <code>errorCB</code> parameter.
- </p>
-
- <p>
- If the user clicks 'Cancel', the <code>errorCB</code>, if non-<code>null</code> for the current
- find() operation, will be invoked with an error code of <a href=
- "#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PERMISSION_DENIED_ERROR</code></a>.
- </p>
-
- <p>
- If the user clicks 'Select', the <a href="#contactfindcb-interface"><code>ContactFindCB</code></a>
- associated to the current find() operation will be invoked with the contact information selected by the
- user provided as the only parameter.
- </p>
-
- <p>
- Further to this initial sharing of Contact information, the <a href=
- "#security-and-privacy-considerations">Security and Privacy Considerations</a> section expects that the
- user should easily be able to review and revoke access that web applications have to this API
- at a later time.
- </p>
- </section>
-
- <section>
- <h3>Accessing Contact Information - Example #2</h3>
-
- <p>
- A website requests access to a user's address book with the following code:
- </p>
-
- <div class='example'>
- <pre class="sh_javascript">
- <input type="button" value="Share Contacts" onclick="getContacts()" />
-
- <script type="text/javascript">
- function successContactFindCallback(contacts) {
- // do something with resulting contact objects
- for (var i in contacts) alert(contacts[i].name);
- // ...
- }
-
- function generalErrorCB(error) {
- // do something with resulting errors
- alert(error.code);
- // ...
- }
-
- function getContacts() {
- // Perform an address book search. Obtain the 'name' and 'emails' properties
- // and initially filter the list to Contact records containing 'Bob':
- navigator.contacts.find( ['name', 'emails'],
- successContactFindCallback,
- generalErrorCB,
- { filter: 'Bob', multiple: true } );
- }
- </script>
- </pre>
- </div>
-
- <p>
- This code may render as follows within the <a>user agent</a>:
- </p>
-
- <p align="center"><img src="contacts_element.png" alt="Contact Search via DOM Events"><br>
- (<a href="contacts_element.png">View as PNG</a>)
- </p>
-
- <p>
- If the user clicks on the rendered button element then the <a>user agent</a> may directly provide a
- <dfn>contact picker</dfn>, as defined in <a href="#api-invocation-via-dom-events">API Invocation via
- DOM Events</a>, utilizing all of the parameters provided in the <code>find()</code> operation as
- follows:
- </p>
-
- <p align="center"><img src="contacts_picker.png" alt="Contact Picker"><br>
- (<a href="contacts_picker.png">View as PNG</a>)
- </p>
-
- <p>
- In this dialog, the user is provided with a summary of the sharing that the application is
- requesting and the option to select one or more contacts (as appropriate) from the user interface.
- </p>
-
- <p>
- If an additional find() operation is called by the current web application before the user has
- clicked 'Select' or 'Cancel' on the current notification, an error will be invoked with a code of
- <a href="#widl-ContactError-PENDING_OPERATION_ERROR"><code>PENDING_OPERATION_ERROR</code></a> if that
- operation was defined with a non-<code>null</code> <code>errorCB</code> parameter.
- </p>
-
- <p>
- If the user clicks 'Cancel', the <code>errorCB</code>, if non-<code>null</code> for the current
- find() operation, will be invoked with an error code of <a href=
- "#widl-ContactError-PERMISSION_DENIED_ERROR"><code>PERMISSION_DENIED_ERROR</code></a>.
- </p>
-
- <p>
- If the user clicks 'Select', the <a href="#contactfindcb-interface"><code>ContactFindCB</code></a>
- associated to the current find() operation will be invoked with the contact information selected by the
- user provided as the only parameter.
- </p>
-
- <p>
- Further to this initial sharing of Contact information, the <a href=
- "#security-and-privacy-considerations">Security and Privacy Considerations</a> section expects that the
- user should easily be able to review and revoke access that web applications have to this API
- at a later time.
- </p>
- </section>
- </section>
</body>
</html>
--- a/discovery-api/FPWD.html Tue Oct 02 18:05:58 2012 -0700
+++ b/discovery-api/FPWD.html Tue Oct 02 18:07:01 2012 -0700
@@ -1,13 +1,14 @@
<!DOCTYPE html>
<html lang="en" dir="ltr">
<head>
- <title>Networked Service Discovery and Messaging</title>
- <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
+ <title>
+ Network Service Discovery
+ </title>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-
<style type="text/css">
- /* Custom CSS optimizations (Richard Tibbett) */
+/* Custom ReSpec CSS (by Rich Tibbett) */
/* Add better spacing to sections */
section, .section { margin-bottom: 2em; }
@@ -32,6 +33,11 @@
dl.domintro dd p { margin: 0.5em 0; }
dl.domintro code {font-size: inherit; font-style: italic; }
dl.domintro:before { display: table; margin: -1em -0.5em 0.5em auto; width: auto; content: 'This box is non-normative. Implementation requirements are given below this box.'; color: red; border: solid 2px; background: white; padding: 0 0.25em; }
+
+ table { border-collapse:collapse; border-style:hidden hidden none hidden }
+ table thead { border-bottom:solid }
+ table tbody th:first-child { border-left:solid }
+ table td, table th { border-left:solid; border-right:solid; border-bottom:solid thin; vertical-align:top; padding:0.2em }
</style>
<style>/*****************************************************************
* ReSpec 3 CSS
@@ -194,32 +200,33 @@
/* this from google-code-prettify */
.pln{color:#000}@media screen{.str{color:#080}.kwd{color:#008}.com{color:#800}.typ{color:#606}.lit{color:#066}.pun,.opn,.clo{color:#660}.tag{color:#008}.atn{color:#606}.atv{color:#080}.dec,.var{color:#606}.fun{color:red}}@media print,projection{.str{color:#060}.kwd{color:#006;font-weight:bold}.com{color:#600;font-style:italic}.typ{color:#404;font-weight:bold}.lit{color:#044}.pun,.opn,.clo{color:#440}.tag{color:#006;font-weight:bold}.atn{color:#404}.atv{color:#060}}ol.linenums{margin-top:0;margin-bottom:0}li.L0,li.L1,li.L2,li.L3,li.L5,li.L6,li.L7,li.L8{list-style-type:none}li.L1,li.L3,li.L5,li.L7,li.L9{background:#eee}
-</style><link href="http://www.w3.org/StyleSheets/TR/W3C-WD" rel="stylesheet"><!--[if lt IE 9]><script src='undefined://www.w3.org/2008/site/js/html5shiv.js'></script><![endif]--></head>
-
- <body><div class="head">
+</style><link rel="stylesheet" href="http://www.w3.org/StyleSheets/TR/W3C-WD"><!--[if lt IE 9]><script src='undefined://www.w3.org/2008/site/js/html5shiv.js'></script><![endif]--></head><body><div class="head">
<p>
- <a href="http://www.w3.org/"><img src="http://www.w3.org/Icons/w3c_home" alt="W3C" height="48" width="72"></a>
+ <a href="http://www.w3.org/"><img width="72" height="48" src="http://www.w3.org/Icons/w3c_home" alt="W3C"></a>
</p>
- <h1 class="title" id="title">Networked Service Discovery and Messaging</h1>
+ <h1 class="title" id="title">Network Service Discovery</h1>
- <h2 id="w3c-working-draft-07-august-2012"><abbr title="World Wide Web Consortium">W3C</abbr> Working Draft 07 August 2012</h2>
+ <h2 id="w3c-working-draft-04-october-2012"><abbr title="World Wide Web Consortium">W3C</abbr> Working Draft 04 October 2012</h2>
<dl>
<dt>This version:</dt>
- <dd><a href="http://www.w3.org/TR/2012/WD-discovery-api-20120807/">http://www.w3.org/TR/2012/WD-discovery-api-20120807/</a></dd>
+ <dd><a href="http://www.w3.org/TR/2012/WD-discovery-api-20121004/">http://www.w3.org/TR/2012/WD-discovery-api-20121004/</a></dd>
<dt>Latest published version:</dt>
<dd><a href="http://www.w3.org/TR/discovery-api/">http://www.w3.org/TR/discovery-api/</a></dd>
<dt>Latest editor's draft:</dt>
- <dd><a href="http://w3c-test.org/dap/discovery-api/">http://w3c-test.org/dap/discovery-api/</a></dd>
+ <dd><a href="http://dvcs.w3.org/hg/dap/raw-file/tip/discovery-api/Overview.html">http://dvcs.w3.org/hg/dap/raw-file/tip/discovery-api/Overview.html</a></dd>
+ <dt>Previous version:</dt>
+ <dd><a href="http://www.w3.org/TR/2012/WD-discovery-api-20120807/">http://www.w3.org/TR/2012/WD-discovery-api-20120807/</a></dd>
+
<dt>Editors:</dt>
<dd><span>Rich Tibbett</span>, <a href="http://opera.com/">Opera Software ASA</a></dd>
@@ -248,10 +255,11 @@
<hr>
</div>
- <section class="introductory" id="abstract"><h2>Abstract</h2>
+ <section id="abstract" class="introductory"><h2>Abstract</h2>
<p>
- This specification defines a mechanism for an HTML document to discover and subsequently communicate with <abbr title="Hypertext Transfer Protocol">HTTP</abbr>-based services
- advertised via common discovery protocols within a user's network.
+ This specification defines a mechanism for an HTML document to discover and subsequently communicate with
+ <abbr title="Hypertext Transfer Protocol">HTTP</abbr>-based services advertised via common discovery protocols
+ within the current network.
</p>
</section><section id="sotd" class="introductory"><h2>Status of This Document</h2>
@@ -265,12 +273,11 @@
</p>
<p>
- This document represents the early consensus of the group on the scope and features of the proposed
- <abbr title="Application Programming Interface">API</abbr>.
+ This document represents the early consensus of the group on the scope and features of the proposed <abbr title="Application Programming Interface">API</abbr>.
</p>
<p>
- This document was published by the <a href="http://www.w3.org/2009/dap/">Device APIs and Policy Working Group</a> as a First Public Working Draft.
+ This document was published by the <a href="http://www.w3.org/2009/dap/">Device APIs Working Group</a> as a Working Draft.
This document is intended to become a <abbr title="World Wide Web Consortium">W3C</abbr> Recommendation.
@@ -312,55 +319,106 @@
-</section><section id="toc"><h2 class="introductory">Table of Contents</h2><ul class="toc"><li class="tocline"><a class="tocxref" href="#introduction"><span class="secno">1. </span>Introduction</a></li><li class="tocline"><a class="tocxref" href="#conformance"><span class="secno">2. </span>Conformance</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#dependencies"><span class="secno">2.1 </span>Dependencies</a></li></ul></li><li class="tocline"><a class="tocxref" href="#terminology"><span class="secno">3. </span>Terminology</a></li><li class="tocline"><a class="tocxref" href="#requesting-networked-services"><span class="secno">4. </span>Requesting networked services</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#methods"><span class="secno">4.1 </span>Methods</a></li><li class="tocline"><a class="tocxref" href="#error-handling"><span class="secno">4.2 </span>Error Handling</a></li></ul></li><li class="tocline"><a class="tocxref" href="#obtaining-networked-services"><span class="secno">5. </span>Obtaining networked services</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes"><span class="secno">5.1 </span>Attributes</a></li><li class="tocline"><a class="tocxref" href="#methods-1"><span class="secno">5.2 </span>Methods</a></li><li class="tocline"><a class="tocxref" href="#events"><span class="secno">5.3 </span>Events</a></li></ul></li><li class="tocline"><a class="tocxref" href="#communicating-with-a-networked-service"><span class="secno">6. </span>Communicating with a networked service</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#attributes-1"><span class="secno">6.1 </span>Attributes</a></li><li class="tocline"><a class="tocxref" href="#states"><span class="secno">6.2 </span>States</a></li><li class="tocline"><a class="tocxref" href="#events-1"><span class="secno">6.3 </span>Events</a></li></ul></li><li class="tocline"><a class="tocxref" href="#service-discovery"><span class="secno">7. </span>Service Discovery</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#zeroconf-mdns-dns-sd"><span class="secno">7.1 </span>Zeroconf (<abbr title="Multicast DNS">mDNS</abbr> + <abbr title="Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr>)</a></li><li class="tocline"><a class="tocxref" href="#universal-plug-and-play-upnp"><span class="secno">7.2 </span>Universal Plug-and-Play (<abbr title="Universal Plug-and-Play">UPnP</abbr>)</a></li><li class="tocline"><a class="tocxref" href="#network-topology-monitoring"><span class="secno">7.3 </span>Network Topology Monitoring</a></li></ul></li><li class="tocline"><a class="tocxref" href="#garbage-collection"><span class="secno">8. </span>Garbage collection</a></li><li class="tocline"><a class="tocxref" href="#use-cases-and-requirements"><span class="secno">9. </span>Use Cases and Requirements</a></li><li class="tocline"><a class="tocxref" href="#examples"><span class="secno">A. </span>Examples</a></li><li class="tocline"><a class="tocxref" href="#acknowledgements"><span class="secno">B. </span>Acknowledgements</a></li><li class="tocline"><a class="tocxref" href="#references"><span class="secno">C. </span>References</a><ul class="toc"><li class="tocline"><a class="tocxref" href="#normative-references"><span class="secno">C.1 </span>Normative references</a></li><li class="tocline"><a class="tocxref" href="#informative-references"><span class="secno">C.2 </span>Informative references</a></li></ul></li></ul></section>
-
+</section><section id="toc"><h2 class="introductory">Table of Contents</h2><ul class="toc"><li class="tocline"><a href="#introduction" class="tocxref"><span class="secno">1. </span>
+ Introduction
+ </a></li><li class="tocline"><a href="#conformance" class="tocxref"><span class="secno">2. </span>Conformance</a><ul class="toc"><li class="tocline"><a href="#dependencies" class="tocxref"><span class="secno">2.1 </span>
+ Dependencies
+ </a></li></ul></li><li class="tocline"><a href="#terminology" class="tocxref"><span class="secno">3. </span>
+ Terminology
+ </a></li><li class="tocline"><a href="#requesting-networked-services" class="tocxref"><span class="secno">4. </span>
+ Requesting networked services
+ </a><ul class="toc"><li class="tocline"><a href="#methods" class="tocxref"><span class="secno">4.1 </span>
+ Methods
+ </a></li><li class="tocline"><a href="#error-handling" class="tocxref"><span class="secno">4.2 </span>
+ Error Handling
+ </a></li></ul></li><li class="tocline"><a href="#obtaining-networked-services" class="tocxref"><span class="secno">5. </span>
+ Obtaining networked services
+ </a><ul class="toc"><li class="tocline"><a href="#attributes" class="tocxref"><span class="secno">5.1 </span>
+ Attributes
+ </a></li><li class="tocline"><a href="#methods-1" class="tocxref"><span class="secno">5.2 </span>
+ Methods
+ </a></li><li class="tocline"><a href="#events" class="tocxref"><span class="secno">5.3 </span>
+ Events
+ </a></li></ul></li><li class="tocline"><a href="#communicating-with-a-networked-service" class="tocxref"><span class="secno">6. </span>
+ Communicating with a networked service
+ </a><ul class="toc"><li class="tocline"><a href="#attributes-1" class="tocxref"><span class="secno">6.1 </span>
+ Attributes
+ </a></li><li class="tocline"><a href="#states" class="tocxref"><span class="secno">6.2 </span>
+ States
+ </a></li><li class="tocline"><a href="#events-1" class="tocxref"><span class="secno">6.3 </span>
+ Events
+ </a></li></ul></li><li class="tocline"><a href="#service-discovery" class="tocxref"><span class="secno">7. </span>
+ Service Discovery
+ </a><ul class="toc"><li class="tocline"><a href="#zeroconf-mdns-dns-sd" class="tocxref"><span class="secno">7.1 </span>
+ Zeroconf (<abbr title="Multicast DNS">mDNS</abbr> + <abbr title="Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr>)
+ </a></li><li class="tocline"><a href="#simple-service-discovery-protocol-ssdp" class="tocxref"><span class="secno">7.2 </span>
+ Simple Service Discovery Protocol (<abbr title="Simple Service Discovery Protocol">SSDP</abbr>)
+ </a></li><li class="tocline"><a href="#network-topology-monitoring" class="tocxref"><span class="secno">7.3 </span>
+ Network Topology Monitoring
+ </a></li></ul></li><li class="tocline"><a href="#events-summary" class="tocxref"><span class="secno">8. </span>
+ Events Summary
+ </a></li><li class="tocline"><a href="#garbage-collection" class="tocxref"><span class="secno">9. </span>
+ Garbage collection
+ </a></li><li class="tocline"><a href="#use-cases-and-requirements" class="tocxref"><span class="secno">10. </span>
+ Use Cases and Requirements
+ </a></li><li class="tocline"><a href="#examples" class="tocxref"><span class="secno">A. </span>
+ Examples
+ </a></li><li class="tocline"><a href="#acknowledgements" class="tocxref"><span class="secno">B. </span>
+ Acknowledgements
+ </a></li><li class="tocline"><a href="#references" class="tocxref"><span class="secno">C. </span>References</a><ul class="toc"><li class="tocline"><a href="#normative-references" class="tocxref"><span class="secno">C.1 </span>Normative references</a></li></ul></li></ul></section>
-
- <section id="introduction" class="informative">
- <!--OddPage--><h2><span class="secno">1. </span>Introduction</h2><p><em>This section is non-normative.</em></p>
-
- <p>To enable Web pages to connect and communicate with Local-networked Services provided over <abbr title="Hypertext Transfer Protocol">HTTP</abbr>, this specification introduces the
- <a href="#navigatornetworkservice"><code>NavigatorNetworkService</code></a> interface.</p>
-
- <p>
- Using this <abbr title="Application Programming Interface">API</abbr> consists of requesting a well-known service type, known by developers and advertised by Local-networked Devices. User authorization, where the user connects the web page to one or more discovered services,
- is expected before the web page is able to interact with any Local-networked Services.
- </p>
-
- <p>
- A web page creates a request to obtain connectivity to services running in the network by specifying a well-known discovery service type that it wishes to interact with.
- </p>
-
+ <section class="informative" id="introduction">
+ <!--OddPage--><h2><span class="secno">1. </span>
+ Introduction
+ </h2><p><em>This section is non-normative.</em></p>
<p>
- The user agent, having captured all advertised services on the network from the Service Discovery mechanisms included in this recommendation, attempts to match
- the requested service type to a discovered service according to the processing described herein.
+ To enable Web pages to connect and communicate with Local-networked Services provided over <abbr title="Hypertext Transfer Protocol">HTTP</abbr>, this
+ specification introduces the <a href="#navigatornetworkservice"><code>NavigatorNetworkService</code></a>
+ interface.
</p>
-
- <p>
- If a service connectivity request is successful then the Web page is provided with the necessary information to communicate with the authorized Local-networked Service.
- If the request fails then the Web page will receive an error callback containing an error code describing the cause of Local-networked Service connectivity failure.
- </p>
-
<p>
- Once connected to a Local-networked Service the Web page can send requests and receive responses to the Local-networked Service via the messaging format and appropriate channel inferred from the service type
- authorized via the provided <abbr title="Application Programming Interface">API</abbr>.
- The Web page, once connected, can also receive service-pushed events, in the messaging format supported by the Local-networked Device, if such event subscription functionality is provided by the
- connected Local-networked Service.
+ Using this <abbr title="Application Programming Interface">API</abbr> consists of requesting a well-known
+ service type, known by developers and advertised by Local-networked Devices. User authorization, where the user
+ connects the web page to one or more discovered services, is expected before the web page is able to interact
+ with any Local-networked Services.
</p>
-
+ <p>
+ A web page creates a request to obtain connectivity to services running in the network by specifying a
+ well-known discovery service type that it wishes to interact with.
+ </p>
+ <p>
+ The user agent, having captured all advertised services on the network from the Service Discovery mechanisms
+ included in this recommendation, attempts to match the requested service type to a discovered service according
+ to the processing described herein.
+ </p>
+ <p>
+ If a service connectivity request is successful then the Web page is provided with the necessary information to
+ communicate with the authorized Local-networked Service. If the request fails then the Web page will receive an
+ error callback containing an error code describing the cause of Local-networked Service connectivity failure.
+ </p>
+ <p>
+ Once connected to a Local-networked Service the Web page can send requests and receive responses to the
+ Local-networked Service via the messaging format and appropriate channel inferred from the service type
+ authorized via the provided <abbr title="Application Programming Interface">API</abbr>. The Web page, once connected, can also receive service-pushed events, in the
+ messaging format supported by the Local-networked Device, if such event subscription functionality is provided
+ by the connected Local-networked Service.
+ </p>
<div class="example">
- <p>Example of requesting a <abbr title="Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr> advertised service:</p>
- <hr>
- <pre class="highlight prettyprint"><span class="kwd">function</span><span class="pln"> showServices</span><span class="pun">(</span><span class="pln"> services </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ <p>
+ Example of requesting a <abbr title="Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr> advertised service:
+ </p>
+ <hr>
+ <pre class="highlight prettyprint"><span class="kwd">function</span><span class="pln"> showServices</span><span class="pun">(</span><span class="pln"> services </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
</span><span class="com">// Show a list of all the services provided to the web page</span><span class="pln">
</span><span class="kwd">for</span><span class="pun">(</span><span class="kwd">var</span><span class="pln"> i </span><span class="pun">=</span><span class="pln"> </span><span class="lit">0</span><span class="pun">,</span><span class="pln"> l </span><span class="pun">=</span><span class="pln"> services</span><span class="pun">.</span><span class="pln">length</span><span class="pun">;</span><span class="pln"> i </span><span class="pun"><</span><span class="pln"> l</span><span class="pun">;</span><span class="pln"> i</span><span class="pun">++)</span><span class="pln"> console</span><span class="pun">.</span><span class="pln">log</span><span class="pun">(</span><span class="pln"> services</span><span class="pun">[</span><span class="pln">i</span><span class="pun">].</span><span class="pln">name </span><span class="pun">);</span><span class="pln">
</span><span class="pun">}</span><span class="pln">
navigator</span><span class="pun">.</span><span class="pln">getNetworkServices</span><span class="pun">(</span><span class="str">'zeroconf:_boxee-jsonrpc._tcp'</span><span class="pun">,</span><span class="pln"> showServices</span><span class="pun">);</span></pre>
</div>
-
<div class="example">
- <p>Example of requesting a <abbr title="Universal Plug-and-Play">UPnP</abbr> advertised service, also handling error conditions:</p>
+ <p>
+ Example of requesting a UPnP advertised service, also handling error conditions:
+ </p>
<hr>
<pre class="highlight prettyprint"><span class="kwd">function</span><span class="pln"> showServices</span><span class="pun">(</span><span class="pln"> services </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
</span><span class="com">// Show a list of all the services provided to the web page</span><span class="pln">
@@ -373,9 +431,10 @@
navigator</span><span class="pun">.</span><span class="pln">getNetworkServices</span><span class="pun">(</span><span class="str">'upnp:urn:schemas-upnp-org:service:ContentDirectory:1'</span><span class="pun">,</span><span class="pln"> showServices</span><span class="pun">,</span><span class="pln"> error</span><span class="pun">);</span></pre>
</div>
-
<div class="example">
- <p>Example of requesting either a <abbr title="Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr> or <abbr title="Universal Plug-and-Play">UPnP</abbr> advertised service:</p>
+ <p>
+ Example of requesting either a <abbr title="Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr> or UPnP advertised service:
+ </p>
<hr>
<pre class="highlight prettyprint"><span class="kwd">function</span><span class="pln"> showServices</span><span class="pun">(</span><span class="pln"> services </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
</span><span class="com">// Show a list of all the services provided to the web page (+ service type)</span><span class="pln">
@@ -388,10 +447,10 @@
</span><span class="str">'upnp:urn:schemas-upnp-org:service:ContentDirectory:1'</span><span class="pln">
</span><span class="pun">],</span><span class="pln"> showServices</span><span class="pun">);</span></pre>
</div>
-
- <p>For more detailed examples see the <a href="#examples">Examples</a> section.
- </p></section>
-
+ <p>
+ For more detailed examples see the <a href="#examples">Examples</a> section.
+ </p>
+ </section>
<section id="conformance"><!--OddPage--><h2><span class="secno">2. </span>Conformance</h2>
<p>
As well as sections marked as non-normative, all authoring guidelines, diagrams, examples,
@@ -399,83 +458,98 @@
normative.
</p>
<p>
- The key words <em title="must" class="rfc2119">must</em>, <em title="must not" class="rfc2119">must not</em>, <em title="required" class="rfc2119">required</em>, <em title="should" class="rfc2119">should</em>, <em title="should not" class="rfc2119">should not</em>, <em title="recommended" class="rfc2119">recommended</em>, <em title="may" class="rfc2119">may</em>,
- and <em title="optional" class="rfc2119">optional</em> in this specification are to be interpreted as described in [<cite><a href="#bib-RFC2119" class="bibref">RFC2119</a></cite>].
+ The key words <em class="rfc2119" title="must">must</em>, <em class="rfc2119" title="must not">must not</em>, <em class="rfc2119" title="required">required</em>, <em class="rfc2119" title="should">should</em>, <em class="rfc2119" title="should not">should not</em>, <em class="rfc2119" title="recommended">recommended</em>, <em class="rfc2119" title="may">may</em>,
+ and <em class="rfc2119" title="optional">optional</em> in this specification are to be interpreted as described in [<cite><a class="bibref" href="#bib-RFC2119">RFC2119</a></cite>].
</p>
-
- <p>Requirements phrased in the imperative as part of algorithms (such as "strip any leading space characters" or "return false and abort these steps") are to be interpreted with the
- meaning of the key word ("must", "should", "may", etc) used in introducing the algorithm.</p>
-
- <p>
- Some conformance requirements are phrased as requirements on attributes, methods or objects. Such requirements are to be interpreted as requirements on user agents.
- </p>
-
- <p>
- Conformance requirements phrased as algorithms or specific steps may be implemented in any manner, so long as the end result is equivalent. (In particular, the algorithms defined in
- this specification are intended to be easy to follow, and not intended to be performant.)
- </p>
-
- <p>
- The only conformance class defined by this specification is a <dfn id="dfn-user-agent">user agent</dfn>.
- </p>
-
- <p>
- User agents may impose implementation-specific limits on otherwise unconstrained inputs, e.g. to prevent denial of service attacks, to guard against running out of memory, or to work
- around platform-specific limitations.
- </p>
-
- <p>
- When support for a feature is disabled (e.g. as an emergency measure to mitigate a security problem, or to aid in development, or for performance reasons), user agents must act as if
- they had no support for the feature whatsoever, and as if the feature was not mentioned in this specification. For example, if a particular feature is accessed via an attribute in a Web
- IDL interface, the attribute itself would be omitted from the objects that implement that interface - leaving the attribute on the object but making it return null or throw an exception
- is insufficient.
- </p>
-
+ <p>
+ Requirements phrased in the imperative as part of algorithms (such as "strip any leading space characters" or
+ "return false and abort these steps") are to be interpreted with the meaning of the key word ("must", "should",
+ "may", etc) used in introducing the algorithm.
+ </p>
+ <p>
+ Some conformance requirements are phrased as requirements on attributes, methods or objects. Such requirements
+ are to be interpreted as requirements on user agents.
+ </p>
+ <p>
+ Conformance requirements phrased as algorithms or specific steps <em class="rfc2119" title="may">may</em> be implemented in any
+ manner, so long as the end result is equivalent. (In particular, the algorithms defined in this specification
+ are intended to be easy to follow, and not intended to be performant.)
+ </p>
+ <p>
+ The only conformance class defined by this specification is a <dfn id="dfn-user-agent">user agent</dfn>.
+ </p>
+ <p>
+ User agents <em class="rfc2119" title="may">may</em> impose implementation-specific limits on otherwise unconstrained inputs,
+ e.g. to prevent denial of service attacks, to guard against running out of memory, or to work around
+ platform-specific limitations.
+ </p>
+ <p>
+ When support for a feature is disabled (e.g. as an emergency measure to mitigate a security problem, or to aid
+ in development, or for performance reasons), user agents <em class="rfc2119" title="must">must</em> act as if they had no support
+ for the feature whatsoever, and as if the feature was not mentioned in this specification. For example, if a
+ particular feature is accessed via an attribute in a Web IDL interface, the attribute itself would be omitted
+ from the objects that implement that interface - leaving the attribute on the object but making it return null
+ or throw an exception is insufficient.
+ </p>
<section id="dependencies">
- <h3><span class="secno">2.1 </span>Dependencies</h3>
-
- This specification relies on several other underlying specifications.
-
- <dl>
- <dt>HTML</dt>
- <dd>Many fundamental concepts from HTML are used by this specification. [<cite><a href="#bib-HTML5" class="bibref">HTML5</a></cite>]</dd>
- <dt>WebIDL</dt>
- <dd>The IDL blocks in this specification use the semantics of the WebIDL specification. [<cite><a href="#bib-WEBIDL" class="bibref">WEBIDL</a></cite>]</dd>
- </dl>
+ <h3><span class="secno">2.1 </span>
+ Dependencies
+ </h3>This specification relies on several other underlying specifications.
+ <dl>
+ <dt>
+ HTML
+ </dt>
+ <dd>
+ Many fundamental concepts from HTML are used by this specification. [<cite><a class="bibref" href="#bib-HTML5">HTML5</a></cite>]
+ </dd>
+ <dt>
+ WebIDL
+ </dt>
+ <dd>
+ The IDL blocks in this specification use the semantics of the WebIDL specification. [<cite><a class="bibref" href="#bib-WEBIDL">WEBIDL</a></cite>]
+ </dd>
+ </dl>
</section>
</section>
-
<section id="terminology">
- <!--OddPage--><h2><span class="secno">3. </span>Terminology</h2>
-
- <p>
- The construction "a <code>Foo</code> object", where <code>Foo</code> is actually an interface, is sometimes used instead of the more accurate "an object implementing the interface <code>Foo</code>".
- </p>
-
+ <!--OddPage--><h2><span class="secno">3. </span>
+ Terminology
+ </h2>
<p>
- The term DOM is used to refer to the <abbr title="Application Programming Interface">API</abbr> set made available to scripts in Web applications, and does not necessarily imply the existence of an actual <code>Document</code> object or of any
- other <code>Node</code> objects as defined in the DOM Core specifications. [<cite><a href="#bib-DOM4" class="bibref">DOM4</a></cite>]
- </p>
-
- <p>
- An IDL attribute is said to be <em>getting</em> when its value is being retrieved (e.g. by author script), and is said to be <em>setting</em> when a new value is assigned to it.
+ The construction "a <code>Foo</code> object", where <code>Foo</code> is actually an interface, is sometimes
+ used instead of the more accurate "an object implementing the interface <code>Foo</code>".
</p>
-
<p>
- A <dfn id="dfn-valid-service-type">valid service type</dfn> is a string that begins with <code>upnp:</code> or <code>zeroconf:</code> followed by one or more characters in the ranges U+0021, U+0023 to U+0027, U+002A to U+002B, U+002D to U+002E, U+0030 to U+0039, U+0041 to U+005A, U+005E to U+007E.
+ The term DOM is used to refer to the <abbr title="Application Programming Interface">API</abbr> set made available to scripts in Web applications, and does not
+ necessarily imply the existence of an actual <code>Document</code> object or of any other <code>Node</code>
+ objects as defined in the DOM Core specifications. [<cite><a class="bibref" href="#bib-DOM4">DOM4</a></cite>]
</p>
-
<p>
- A <a class="internalDFN" href="#dfn-valid-service-type">valid service type</a> provided in the <code>type</code> attribute of the <code>getNetworkServices()</code> method will be matched against the services currently contained in the <a class="internalDFN" href="#dfn-list-of-available-service-records">list of available service records</a> according to the algorithms defined in this specification.
+ An IDL attribute is said to be <em>getting</em> when its value is being retrieved (e.g. by author script), and
+ is said to be <em>setting</em> when a new value is assigned to it.
+ </p>
+ <p>
+ A <dfn id="dfn-valid-service-type">valid service type</dfn> is a string that begins with <code>upnp:</code> or <code>zeroconf:</code>
+ followed by one or more characters in the ranges U+0021, U+0023 to U+0027, U+002A to U+002B, U+002D to U+002E,
+ U+0030 to U+0039, U+0041 to U+005A, U+005E to U+007E.
+ </p>
+ <p>
+ A <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> provided in the <code>type</code> attribute of the <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> method will be matched against the
+ services currently contained in the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a> according to the algorithms
+ defined in this specification.
+ </p>
+ <p>
+ A <dfn id="dfn-user-agent-generated-callback-url">user-agent generated callback url</dfn> is a Local-network accessible <abbr title="Uniform Resource Locator">URL</abbr> endpoint that a <a href="#dfn-user-agent" class="internalDFN">user
+ agent</a> generates and maintains for receiving <abbr title="Hypertext Transfer Protocol">HTTP</abbr> NOTIFY requests from UPnP Event sources. It is only
+ required when the user agent implements UPnP Service Discovery as defined in this specification.
</p>
</section>
-
<section id="requesting-networked-services">
- <!--OddPage--><h2><span class="secno">4. </span>Requesting networked services</h2>
-
-
-<pre class="widl">[Supplemental, NoInterfaceObject]
+ <!--OddPage--><h2><span class="secno">4. </span>
+ Requesting networked services
+ </h2>
+ <pre class="widl">[Supplemental, NoInterfaceObject]
interface <dfn id="navigatornetworkservice">NavigatorNetworkService</dfn> {
// Obtain a Local-networked Service
void <a href="#dom-navigator-getnetworkservices">getNetworkServices</a>( in any type,
@@ -501,269 +575,214 @@
void handleEvent( in <a href="#navigatornetworkserviceerror">NavigatorNetworkServiceError</a> error );
};
</pre>
-
- <section id="methods">
- <h3><span class="secno">4.1 </span>Methods</h3>
-
- <dl class="domintro">
- <dt>
- <var title="">window</var>
- .
- <code title="dom-navigator">
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/timers.html#navigator">navigator</a>
- </code>
- .
- <code title="dom-navigator-getNetworkServices">
- <a href="#dom-navigator-getnetworkservices">getNetworkServices</a>
- </code>
- (
- <var title="">type</var>
- ,
- <var title="">successCallback</var>
- [,
- <var title="">errorCallback</var>
- ] )
- </dt>
- <dd>
- <p>Prompts the user to select one or more discovered network services that have advertised support for the requested service type.</p>
- <p>
- The
- <var title="">type</var>
- argument contains one or more <a class="internalDFN" href="#dfn-valid-service-type">valid service type</a> tokens that the web page would like to interact with.
- </p>
+ <section id="methods">
+ <h3><span class="secno">4.1 </span>
+ Methods
+ </h3>
+ <dl class="domintro">
+ <dt>
+ <var title="">window</var> . <code title="dom-navigator"><a href="http://www.whatwg.org/specs/web-apps/current-work/complete/timers.html#navigator">navigator</a></code> .
+ <code title="dom-navigator-getNetworkServices"><a href="#dom-navigator-getnetworkservices">getNetworkServices</a></code> ( <var title="">type</var> , <var title="">successCallback</var> [, <var title="">errorCallback</var> ] )
+ </dt>
+ <dd>
+ <p>
+ Prompts the user to select one or more discovered network services that have advertised support for the
+ requested service type.
+ </p>
+ <p>
+ The <var title="">type</var> argument contains one or more <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> tokens that the web
+ page would like to interact with.
+ </p>
+ <p>
+ If the user accepts, the <var title="">successCallback</var> is invoked, with one or more <a href="#networkservice"><code>NetworkService</code></a> objects as its argument.
+ </p>
+ <p>
+ If the user declines, the <var title="">errorCallback</var> (if any) is invoked.
+ </p>
+ </dd>
+ </dl>
+ <div>
<p>
- If the user accepts, the
- <var title="">successCallback</var>
- is
- invoked, with one or more
- <code>
- <a href="#networkservice"><code>NetworkService</code></a>
- </code>
- objects as
- its argument.
- </p>
- <p>
- If the user declines, the
- <var title="">errorCallback</var>
- (if
- any) is invoked.
+ When the <dfn id="dom-navigator-getnetworkservices" title="dom-navigator-getnetworkservices"><code>getNetworkServices(type, successCallback[,
+ errorCallback])</code></dfn> method is called, the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> run the
+ following steps:
</p>
- </dd>
- </dl>
-
- <div>
- <p>
- When the <dfn id="dom-navigator-getnetworkservices" title="dom-navigator-getnetworkservices"><code>getNetworkServices(type, successCallback[, errorCallback])</code></dfn> method is called, the <a class="internalDFN" href="#dfn-user-agent">user agent</a> <em title="must" class="rfc2119">must</em> run the following steps:
- </p>
-
<ol class="rule">
- <li>
- If <var>successCallback</var> is empty or is not an object of type <code>Function</code> then the <a class="internalDFN" href="#dfn-user-agent">user agent</a> <em title="must" class="rfc2119">must</em> abort these steps.
+ <li>Let <var>requested control types</var> be initially set to an empty array.
</li>
-
- <li>
- Let <var>requested control types</var> be initially set to an empty array.
+ <li>If <var>type</var> is an array consisting of one or more <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> tokens, then let
+ <var>requested control types</var> by the value of <var>type</var>, removing any non-<a href="#dfn-valid-service-type" class="internalDFN">valid service
+ type</a> tokens from the resulting array.
</li>
-
- <li>
- If <var>type</var> is an array consisting of one or more <a class="internalDFN" href="#dfn-valid-service-type">valid service type</a> tokens, then let <var>requested control types</var> by the value of <var>type</var>, removing any non-<a class="internalDFN" href="#dfn-valid-service-type">valid service type</a> tokens from the resulting array.
+ <li>If <var>type</var> is a string consisting of one <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> token, then let
+ <var>requested control types</var> be an array containing one item with a value of <var>type</var>.
</li>
-
+ <li>If <var>requested control types</var> is an array that contains at least one or more <a title="valid service type" href="#dfn-valid-service-type" class="internalDFN">valid service type</a> tokens then continue to the step labeled <em>process</em>
+ below. Otherwise, the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an
+ object of type <code>Function</code>, with a new <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose <a href="#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 2
+ (<a href="#dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></a>) as
+ its argument, abort any remaining steps and return.
+ </li>
<li>
- If <var>type</var> is a string consisting of one <a class="internalDFN" href="#dfn-valid-service-type">valid service type</a> token, then let <var>requested control types</var> be an array containing one item with a value of <var>type</var>.
- </li>
-
- <li>
- If <var>requested control types</var> is an array that contains at least one or more <a class="internalDFN" href="#dfn-valid-service-type" title="valid service type">valid service type</a> tokens then continue to the step labeled <em>process</em> below. Otherwise, the <a class="internalDFN" href="#dfn-user-agent">user agent</a> <em title="must" class="rfc2119">must</em> <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an object of type <code>Function</code>, with a new <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose
- <a href="#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 2
- (<a href="#dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></a>) as its argument,
- abort any remaining steps and return.
- </li>
-
- <li>
- <em>Process</em>: Let <var>services found</var> be an empty array.
+ <em>Process</em>: Let <var>services found</var> be an empty array.
</li>
-
- <li>
- For each <var>available service</var> in the <a class="internalDFN" href="#dfn-list-of-available-service-records">list of available service records</a> run the following steps:
- <ol class="rule">
- <li>
- For each <var>requested control type</var> in <var>requested control types</var>: If <var>available service</var>'s <code>type</code> attribute equals the <var>requested control type</var> then let <var>matched service</var> equal the value of <var>available service</var> and continue at the step labeled <var>attach</var> below.
- </li>
- <li>
- Continue at the next <var>available service</var>.
- </li>
- <li>
- <em>Attach</em>: If <var>matched service</var> is not empty then run the following steps:
-
- <ol class="rule">
- <li>
- Let <var>new service object</var> be a new <a href="#networkservice"><code>NetworkService</code></a> object, mapping the parameters of
- <var>matched service</var> to this new object where possible.
- </li>
- <li>
- Append <var>new service object</var> to the <var>services found</var> array.
- </li>
- </ol>
- </li>
- </ol>
+ <li>For each <var>available service</var> in the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a> run the following
+ steps:
+ <ol class="rule">
+ <li>For each <var>requested control type</var> in <var>requested control types</var>: If <var>available
+ service</var>'s <code>type</code> attribute equals the <var>requested control type</var> then let <var>
+ matched service</var> equal the value of <var>available service</var> and continue at the step
+ labeled <var>attach</var> below.
+ </li>
+ <li>Continue at the next <var>available service</var>.
+ </li>
+ <li>
+ <em>Attach</em>: If <var>matched service</var> is not empty then run the following steps:
+ <ol class="rule">
+ <li>Let <var>new service object</var> be a new <a href="#networkservice"><code>NetworkService</code></a> object, mapping the parameters of <var>matched
+ service</var> to this new object where possible.
+ </li>
+ <li>Append <var>new service object</var> to the <var>services found</var> array.
+ </li>
+ </ol>
+ </li>
+ </ol>
</li>
-
- <li>
- If <var>services found</var> is an empty array, then the <a class="internalDFN" href="#dfn-user-agent">user agent</a> <em title="must" class="rfc2119">must</em> <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an object of type <code>Function</code>, with a new <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose
- <a href="#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
- (<a href="#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its argument, abort any remaining steps and return.
- </li>
-
- <li>
- Return, and run the remaining steps asynchronously.
- </li>
-
- <li>
- Optionally, e.g. based on a previously-established user preference, for security reasons, or due to platform limitations, the <a class="internalDFN" href="#dfn-user-agent">user agent</a> <em title="may" class="rfc2119">may</em> <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an object of type <code>Function</code>, with a new <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose
- <a href="#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
- (<a href="#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its argument, abort any remaining steps and return.
+ <li>If <var>services found</var> is an empty array, then the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em>
+ <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an
+ object of type <code>Function</code>, with a new <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose <a href="#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
+ (<a href="#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its
+ argument, abort any remaining steps and return.
</li>
-
- <li>
- The <a class="internalDFN" href="#dfn-user-agent">user agent</a> <em title="must" class="rfc2119">must</em> prompt the user in a user-agent-specific manner for permission to provide the
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/browsers.html#entry-script" class="externalDFN">entry script</a>'s
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/origin-0.html#origin" class="externalDFN">origin</a> with an array of
- <a href="#networkservice"><code>NetworkService</code></a> objects representing the user-authorized subset of <var>services found</var>.
-
- <p>
- If the user grants permission to access one or more networked services then the <a class="internalDFN" href="#dfn-user-agent">user agent</a> <em title="should" class="rfc2119">should</em> include an
- "ongoing local-network communication" indicator.
- </p>
-
- <p>If the user denies permission, then the <a class="internalDFN" href="#dfn-user-agent">user agent</a> <em title="must" class="rfc2119">must</em> <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an object of type <code>Function</code>, with a new <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose
- <a href="#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
- (<a href="#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its argument, abort any remaining steps and return.
+ <li>Return, and run the remaining steps asynchronously.
+ </li>
+ <li>Optionally, e.g. based on a previously-established user preference, for security reasons, or due to
+ platform limitations, the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="may">may</em> <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an
+ object of type <code>Function</code>, with a new <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose <a href="#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
+ (<a href="#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its
+ argument, abort any remaining steps and return.
+ </li>
+ <li>The <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> prompt the user in a user-agent-specific manner for
+ permission to provide the <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/browsers.html#entry-script" class="externalDFN">entry script</a>'s <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/origin-0.html#origin" class="externalDFN">origin</a> with an array of <a href="#networkservice"><code>NetworkService</code></a> objects representing the user-authorized subset of
+ <var>services found</var>.
+ <p>
+ If the user grants permission to access one or more networked services then the <a href="#dfn-user-agent" class="internalDFN">user agent</a>
+ <em class="rfc2119" title="should">should</em> include an "ongoing local-network communication" indicator.
</p>
-
+ <p>
+ If the user denies permission, then the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an
+ object of type <code>Function</code>, with a new <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose <a href="#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
+ (<a href="#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its
+ argument, abort any remaining steps and return.
+ </p>
<p>
If the user never responds, this algorithm stalls on this step.
</p>
-
- </li>
-
- <li>
- Let <var>services</var> be the array of one or more <a href="#networkservice"><code>NetworkService</code></a> objects for which the user granted permission.
- </li>
-
- <li>
- For each Object <var>service</var> in <var>services</var>, run the following substeps:
-
- <ol class="rule">
- <li>
- Add the <var>service</var>'s <code>url</code> parameter to the <a class="internalDFN" href="#dfn-entry-script-origin-s-url-whitelist">entry script origin's <abbr title="Uniform Resource Locator">URL</abbr> whitelist</a>.
- </li>
- <li>
- If <var>service</var> was originally created from a <abbr title="Universal Plug-and-Play">UPnP</abbr> discovery process and the <var>service</var>'s <code>eventsUrl</code> parameter is not empty then <a class="internalDFN" href="#dfn-setup-a-upnp-events-subscription">setup a <abbr title="Universal Plug-and-Play">UPnP</abbr> Events Subscription</a> for <var>service</var>.
- </li>
- </ol>
</li>
-
- <li>
- Let <var>services manager</var> be a new <a href="#networkservices"><code>NetworkServices</code></a> object.
- </li>
-
- <li>
- Set <var>services manager</var>'s <code>servicesAvailable</code> attribute to the length of <var>services</var>.
- </li>
-
- <li>
- Store the set of <var>services</var> as <dfn id="current_authorized_services">current authorized services</dfn> internally against the newly created <var>services manager</var> object.
+ <li>Let <var>services</var> be the array of one or more <a href="#networkservice"><code>NetworkService</code></a> objects for which the user granted permission.
</li>
-
- <li>
- The <a class="internalDFN" href="#dfn-user-agent">user agent</a> <em title="must" class="rfc2119">must</em> <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>successCallback</var> with
- <var>services manager</var> as its argument.
+ <li>For each Object <var>service</var> in <var>services</var>, run the following sub-steps:
+ <ol class="rule">
+ <li>Add the <var>service</var>'s <code>url</code> parameter to the <a href="#dfn-entry-script-origin-s-url-whitelist" class="internalDFN">entry script origin's
+ <abbr title="Uniform Resource Locator">URL</abbr> whitelist</a>.
+ </li>
+ <li>If <var>service</var>'s <code>type</code> parameter begins with the DOMString "<code>upnp:</code>"
+ and the <var>service</var>'s <code>eventsUrl</code> parameter is not empty then <a href="#dfn-setup-a-upnp-events-subscription" class="internalDFN">setup a UPnP Events
+ Subscription</a> for <var>service</var>.
+ </li>
+ </ol>
</li>
-
+ <li>Let <var>services manager</var> be a new <a href="#networkservices"><code>NetworkServices</code></a>
+ object.
+ </li>
+ <li>Set <var>services manager</var>'s <a href="#dom-networkservices-servicesavailable"><code>servicesAvailable</code></a> attribute to the number of
+ services currently found in the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a> whose <code>type</code> property
+ matches any of the tokens requested in <var>requested control types</var>.
+ </li>
+ <li>Add the set of <var>services</var> to the <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a> internally against
+ the newly created <var>services manager</var> object.
+ </li>
+ <li>The <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>successCallback</var> with <var>services
+ manager</var> as its argument.
+ </li>
</ol>
-
- <p>
- The <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#task-source" class="externalDFN">task source</a> for these
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#concept-task" class="externalDFN">tasks</a> is the
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#user-interaction-task-source" class="externalDFN">user interaction task source</a>.
- </p>
-
<p>
- When a <a href="#networkservice"><code>NetworkService</code></a> object is provided to a Web page, the <a class="internalDFN" href="#dfn-user-agent">user agent</a> <em title="must" class="rfc2119">must</em> add the <code>url</code> property
- to the <dfn id="dfn-entry-script-origin-s-url-whitelist">entry script origin's <abbr title="Uniform Resource Locator">URL</abbr> whitelist</dfn>. This list enables the
- Web page to override and initiate cross-site resource requests towards these URLs, and any sub-resources of these URLs, within the current
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/browsers.html#entry-script" class="externalDFN">entry script</a>'s
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/origin-0.html#origin" class="externalDFN">origin</a> via various existing mechanisms (e.g. Web Sockets, Server-Sent Events,
- Web Messaging, XMLHttpRequest).
- </p>
-
- <p>
- If the user navigates away from the current browsing context, the <a class="internalDFN" href="#dfn-user-agent">user agent</a> <em title="must" class="rfc2119">must</em> remove all previously whitelisted urls from the <a class="internalDFN" href="#dfn-entry-script-origin-s-url-whitelist">entry script origin's <abbr title="Uniform Resource Locator">URL</abbr> whitelist</a>.
- There is no persistence to network service selections provided to a web page. It is not possible to access a previously white-listed networked service without the necessary user authorization in all of the following cases:
- </p><ul>
- <li>If the current script is reloaded at any point in the same or different window.</li>
- <li>if the current script reinvokes the <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> method at any point in its execution.</li>
- <li>If the user navigates forward or back in their history to reload the current page.</li>
- <li>If a script is running in a different origin.</li>
- </ul>
- <p></p>
-
- </div>
- </section>
-
- <section id="error-handling">
- <h3><span class="secno">4.2 </span>Error Handling</h3>
-
- <dl class="domintro">
- <dt>
- <var title="">error</var>
- .
- <code title="dom-NavigatorNetworkServiceError-code">
- <a href="#dom-navigatornetworkserviceerror-code">code</a>
- </code>
- </dt>
- <dd>
+ The <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#task-source" class="externalDFN">task source</a> for these <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#concept-task" class="externalDFN">tasks</a> is the <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#user-interaction-task-source" class="externalDFN">user interaction task source</a>.
+ </p>
<p>
- Returns the current error's error code. At the current time, this may be <code>1</code> or <code>2</code>, for which the
- corresponding error constants
- <a href="#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a> and
- <a href="#dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></a> are defined.
+ When a <a href="#networkservice"><code>NetworkService</code></a> object is provided to a Web page, the
+ <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> add the <code>url</code> property to the <dfn id="dfn-entry-script-origin-s-url-whitelist">entry script
+ origin's <abbr title="Uniform Resource Locator">URL</abbr> whitelist</dfn>. This list enables the Web page to override and initiate cross-site resource
+ requests towards these URLs, and any sub-resources of these URLs, within the current <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/browsers.html#entry-script" class="externalDFN">entry script</a>'s <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/origin-0.html#origin" class="externalDFN">origin</a> via various existing mechanisms (e.g. Web Sockets, Server-Sent Events,
+ Web Messaging, XMLHttpRequest).
</p>
- </dd>
- </dl>
-
- <p>
- The <dfn id="dom-navigatornetworkserviceerror-code" title="dom-navigatornetworkserviceerror-code"><code>code</code></dfn> attribute of a
- <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object <em title="must" class="rfc2119">must</em> return the code for the error, which will be one of the following:
- </p>
-
- <dl>
- <dt>
- <dfn id="dom-navigatornetworkserviceerror-permission_denied" title="dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></dfn> (numeric value 1)
- </dt>
- <dd>
- The user denied the page permission to access any services.
- </dd>
- <dt>
- <dfn id="dom-navigatornetworkserviceerror-unknown_type_prefix" title="dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></dfn> (numeric value 2)
- </dt>
- <dd>
- No <a class="internalDFN" href="#dfn-valid-service-type">valid service type</a> tokens were provided in the method invocation.
- </dd>
- </dl>
-
+ <p>
+ If the user navigates away from the current browsing context, the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="ct"><em class="rfc2119" title="must">must</em></em> remove all previously whitelisted urls from the <a href="#dfn-entry-script-origin-s-url-whitelist" class="internalDFN">entry script origin's <abbr title="Uniform Resource Locator">URL</abbr> whitelist</a>.
+ There is no persistence to network service selections provided to a web page. It is not possible to access
+ a previously white-listed networked service without the necessary user authorization in all of the
+ following cases:
+ </p>
+ <ul>
+ <li>If the current script is reloaded at any point in the same or different window.
+ </li>
+ <li>if the current script reinvokes the <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> method at any point in its
+ execution.
+ </li>
+ <li>If the user navigates forward or back in their history to reload the current page.
+ </li>
+ <li>If a script is running in a different origin.
+ </li>
+ </ul>
+ </div>
</section>
-
+ <section id="error-handling">
+ <h3><span class="secno">4.2 </span>
+ Error Handling
+ </h3>
+ <dl class="domintro">
+ <dt>
+ <var title="">error</var> . <code title="dom-NavigatorNetworkServiceError-code"><a href="#dom-navigatornetworkserviceerror-code">code</a></code>
+ </dt>
+ <dd>
+ <p>
+ Returns the current error's error code. At the current time, this will be <code>1</code> or
+ <code>2</code>, for which the corresponding error constants <a href="#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a> and <a href="#dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></a> are
+ defined.
+ </p>
+ </dd>
+ </dl>
+ <p>
+ The <dfn id="dom-navigatornetworkserviceerror-code" title="dom-navigatornetworkserviceerror-code"><code>code</code></dfn> attribute of a <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object <em class="ct"><em class="rfc2119" title="must">must</em></em> return the code for the error, which will be one of the following:
+ </p>
+ <dl>
+ <dt>
+ <dfn id="dom-navigatornetworkserviceerror-permission_denied" title="dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></dfn>
+ (numeric value 1)
+ </dt>
+ <dd>
+ The user or user agent denied the page permission to access any services.
+ </dd>
+ <dt>
+ <dfn id="dom-navigatornetworkserviceerror-unknown_type_prefix" title="dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></dfn>
+ (numeric value 2)
+ </dt>
+ <dd>
+ No <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> tokens were provided in the method invocation.
+ </dd>
+ </dl>
</section>
- <section id="obtaining-networked-services">
- <!--OddPage--><h2><span class="secno">5. </span>Obtaining networked services</h2>
-
+ </section>
+ <section id="obtaining-networked-services">
+ <!--OddPage--><h2><span class="secno">5. </span>
+ Obtaining networked services
+ </h2>
<p>
- The <a href="#networkservices"><code>NetworkServices</code></a> interface is the top-level response object from a call to <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> and provides access to a set of user-authorized <a href="#networkservice"><code>NetworkService</code></a> objects for the given request.
+ The <a href="#networkservices"><code>NetworkServices</code></a> interface is the top-level response object from
+ a call to <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> and provides access
+ to a set of user-authorized <a href="#networkservice"><code>NetworkService</code></a> objects for the given
+ request.
</p>
-
-<pre class="widl">[NoInterfaceObject]
+ <pre class="widl">[NoInterfaceObject]
interface <dfn id="networkservices">NetworkServices</dfn> {
readonly attribute unsigned long <a href="#dom-networkservices-length">length</a>;
getter <a href="#networkservice">NetworkService</a> (unsigned long index);
@@ -779,179 +798,151 @@
<a href="#networkservices">NetworkServices</a> implements <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#interface-eventtarget" class="externalDFN">EventTarget</a>;
</pre>
-
<section id="attributes">
- <h3><span class="secno">5.1 </span>Attributes</h3>
-
+ <h3><span class="secno">5.1 </span>
+ Attributes
+ </h3>
<dl class="domintro">
<dt>
- <code title="dom-networkservices-length">
- <a href="#dom-networkservices-length">length</a>
- </code>
+ <code title="dom-networkservices-length"><a href="#dom-networkservices-length">length</a></code>
</dt>
<dd>
<p>
- Returns the current number of services in the respective object's <a class="internalDFN" href="#current_authorized_services">current authorized services</a>.
+ Returns the current number of services belonging in the respective object's <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service
+ records</a>.
</p>
</dd>
<dt>
- <code title="dom-networkservices-servicesavailable">
- <a href="#dom-networkservices-servicesavailable">servicesAvailable</a>
- </code>
+ <code title="dom-networkservices-servicesavailable"><a href="#dom-networkservices-servicesavailable">servicesAvailable</a></code>
</dt>
<dd>
<p>
- Returns the current number of services matching one of the app-requested <a class="internalDFN" href="#dfn-valid-service-type">valid service type</a> tokens that are actively available within the user's current network.
+ Returns the current number of services matching one of the app-requested <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> tokens
+ in the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>.
</p>
</dd>
</dl>
-
<div>
- <p>
- The <dfn id="dom-networkservices-length"><code>length</code></dfn> attribute <em title="must" class="rfc2119">must</em> return the number of services represented in the object's corresponding <a class="internalDFN" href="#current_authorized_services">current authorized services</a> list at the time of getting.
- </p>
-
- <p>
- The <dfn id="dom-networkservices-servicesavailable"><code>servicesAvailable</code></dfn> attribute <em title="must" class="rfc2119">must</em> return the number of services available in the
- user's network that match the <a class="internalDFN" href="#dfn-valid-service-type">valid service type</a> that was initially used to create the current <a href="#networkservices"><code>NetworkServices</code></a> object.
- By default, <a href="#dom-networkservices-servicesavailable"><code>servicesAvailable</code></a> <em title="must" class="rfc2119">must</em> be set to <code>1</code>.
- </p>
-
- <p>
- When a previously unknown instance of a networked service matching one or the requested <a href="#dfn-valid-service-type">valid service types</a> becomes available on the user's current network, the <a class="internalDFN" href="#dfn-user-agent">user agent</a> <em title="must" class="rfc2119">must</em> fire a new simple
- event at the <a href="#dom-networkservices-onserviceavailable"><code>onserviceavailable</code></a> event handler.
- </p>
-
- <p>
- When a previously known instance of a networked service matching one or the requested <a href="#dfn-valid-service-type">valid service types</a> becomes unavailable on the user's current network, the <a class="internalDFN" href="#dfn-user-agent">user agent</a> <em title="must" class="rfc2119">must</em> fire a new simple
- event at the <a href="#dom-networkservices-onserviceunavailable"><code>onserviceunavailable</code></a> event handler.
- </p>
- </div>
-
- </section>
-
- <section id="methods-1">
- <h3><span class="secno">5.2 </span>Methods</h3>
- <dl class="domintro">
- <dt>
- <code title="networkservices-getter">
- <a href="#networkservices">services</a>
- </code>
- [
- <var title="">index</var>
- ]
- </dt>
- <dd>
<p>
- Returns the specified <a href="#networkservice"><code>NetworkService</code></a> object.
- </p>
- </dd>
- <dt>
- <code title="networkservices-getter">
- <a href="#networkservices">services</a>
- </code>
- .
- <code title="dom-networkservices-getservicebyid">
- <a href="#dom-networkservices-getservicebyid">getServiceById</a>
- </code>
- (
- <var title="">id</var>
- )
- </dt>
- <dd>
- <p>
- Returns the <a href="#networkservice"><code>NetworkService</code></a> object with the given identifier, or null if no
- service has that identifier.
+ The <dfn id="dom-networkservices-length"><code>length</code></dfn> attribute <em class="rfc2119" title="must">must</em>
+ return the number of services represented in the object's corresponding <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service
+ records</a> at the time of getting.
</p>
- </dd>
- </dl>
-
- <p>
- A <a href="#networkservices"><code>NetworkServices</code></a> object represents the current list of zero or more <a class="internalDFN" href="#current_authorized_services">current authorized services</a>, of which zero or more can be available at a time. Each item in <a class="internalDFN" href="#current_authorized_services">current authorized services</a> is represented by a <a href="#networkservice"><code>NetworkService</code></a> object.
- </p>
-
- <div class="note"><div class="note-title"><span>Note</span></div><p class="">
- Each service in a <a href="#networkservices"><code>NetworkServices</code></a> object thus has an index; the first has the index 0, and each subsequent service is numbered one higher than the previous one. If the <a class="internalDFN" href="#dfn-user-agent">user agent</a> dynamically adds or removes network services for any reason, then the indices of the services in <a class="internalDFN" href="#current_authorized_services">current authorized services</a> will change dynamically. If the set of network services changes entirely, then all the previous services will be removed from <a class="internalDFN" href="#current_authorized_services">current authorized services</a> and replaced with new services.
- </p></div>
-
- <p>
- The <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/infrastructure.html#supported-property-indices" class="externalDFN">supported property indices</a> of <a href="#networkservices"><code>NetworkServices</code></a> objects at any instant are the numbers from zero to the number of items in <a class="internalDFN" href="#current_authorized_services">current authorized services</a> represented by the respective object minus one, if any services are represented in <a class="internalDFN" href="#current_authorized_services">current authorized services</a>. If a <a href="#networkservices"><code>NetworkServices</code></a> object represents no <a class="internalDFN" href="#current_authorized_services">current authorized services</a>, it has no <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/infrastructure.html#supported-property-indices" class="externalDFN">supported property indices</a>.
- </p>
-
- <p>
- To <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/infrastructure.html#determine-the-value-of-an-indexed-property" class="externalDFN">determine the value of an indexed property</a> for a given index <var>index</var> in a <a href="#networkservices"><code>NetworkServices</code></a> object's <a class="internalDFN" href="#current_authorized_services">current authorized services</a>, the user agent <em title="must" class="rfc2119">must</em> return the <a href="#networkservice"><code>NetworkService</code></a> object that represents the <var>index</var>th service in <a class="internalDFN" href="#current_authorized_services">current authorized services</a>.
- </p>
-
- <p>
- The <dfn id="dom-networkservices-getservicebyid"><code>getServiceById(id)</code></dfn> method <em title="must" class="rfc2119">must</em> return the first <a href="#networkservice"><code>NetworkService</code></a> object in <a class="internalDFN" href="#current_authorized_services">current authorized services</a> represented by the respective object whose <a href="#dom-networkservice-id"><code>id</code></a> attribute is equal to the value of the <var>id</var> argument.
- When no services in <a class="internalDFN" href="#current_authorized_services">current authorized services</a> match the given argument, the method <em title="must" class="rfc2119">must</em> return null.
- </p>
-
- <p>
- Services available within the local network can connect and disconnect at different times during the execution of a web page. A <a class="internalDFN" href="#dfn-user-agent">user agent</a> can
- inform a web page when the state of networked services matching the requested <a class="internalDFN" href="#dfn-valid-service-type">valid service type</a> change. Web pages can use this information to enable in-page experiences for communicating the state of networked services
- with the ability to change the particular service or set of services the page is connected to by re-invoking the <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> method.
- </p>
-
+ <p>
+ The <dfn id="dom-networkservices-servicesavailable"><code>servicesAvailable</code></dfn> attribute
+ <em class="rfc2119" title="must">must</em> return the number of services in the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>
+ whose <code>type</code> attribute matches any of the <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> tokens that was initially
+ used to create the current <a href="#networkservices"><code>NetworkServices</code></a> object.
+ </p>
+ </div>
</section>
-
+ <section id="methods-1">
+ <h3><span class="secno">5.2 </span>
+ Methods
+ </h3>
+ <dl class="domintro">
+ <dt>
+ <code title="networkservices-getter"><a href="#networkservices">services</a></code> [ <var title="">index</var> ]
+ </dt>
+ <dd>
+ <p>
+ Returns the specified <a href="#networkservice"><code>NetworkService</code></a> object.
+ </p>
+ </dd>
+ <dt>
+ <code title="networkservices-getter"><a href="#networkservices">services</a></code> . <code title="dom-networkservices-getservicebyid"><a href="#dom-networkservices-getservicebyid">getServiceById</a></code> ( <var title="">id</var> )
+ </dt>
+ <dd>
+ <p>
+ Returns the <a href="#networkservice"><code>NetworkService</code></a> object with the given identifier,
+ or null if no service has that identifier.
+ </p>
+ </dd>
+ </dl>
+ <p>
+ A <a href="#networkservices"><code>NetworkServices</code></a> object represents the current list of one or
+ more current authorized services - the <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a>. Each item in the <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of
+ authorized service records</a> is represented by a <a href="#networkservice"><code>NetworkService</code></a>
+ object. The <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a> is <span>immutable</span> meaning that it cannot be
+ modified for the lifetime of a <a href="#networkservices"><code>NetworkServices</code></a> object.
+ </p>
+ <div class="note"><div class="note-title"><span>Note</span></div><p class="">
+ Each service in a <a href="#networkservices"><code>NetworkServices</code></a> object thus has an index; the
+ first has the index 0, and each subsequent service is numbered one higher than the previous one.
+ </p></div>
+ <p>
+ The <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/infrastructure.html#supported-property-indices" class="externalDFN">supported property indices</a> of <a href="#networkservices"><code>NetworkServices</code></a> objects at any instant are the numbers from zero to
+ the number of items in the <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a> represented by the respective object
+ minus one, if any services are represented in the <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a>.
+ </p>
+ <p>
+ To <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/infrastructure.html#determine-the-value-of-an-indexed-property" class="externalDFN">determine the value of an indexed property</a> for a given index <var>index</var> in a
+ <a href="#networkservices"><code>NetworkServices</code></a> object's <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service
+ records</a>, the user agent <em class="rfc2119" title="must">must</em> return the <a href="#networkservice"><code>NetworkService</code></a> object that represents the <var>index</var>th service in
+ the <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a>.
+ </p>
+ <p>
+ The <dfn id="dom-networkservices-getservicebyid"><code>getServiceById(id)</code></dfn> method <em class="ct"><em class="rfc2119" title="must">must</em></em> return the first <a href="#networkservice"><code>NetworkService</code></a> object in the
+ <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a> represented by the respective object whose <a href="#dom-networkservice-id"><code>id</code></a> attribute is equal to the value of the <var>id</var> argument.
+ When no services in the <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a> match the given argument, the method
+ <em class="rfc2119" title="must">must</em> return null.
+ </p>
+ <p>
+ Services available within the local network can connect and disconnect at different times during the
+ execution of a web page. A <a href="#dfn-user-agent" class="internalDFN">user agent</a> can inform a web page when the state of networked services
+ matching the requested <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> change. Web pages can use this information to enable in-page
+ experiences for communicating the state of networked services with the ability to change the particular
+ service or set of services the page is connected to by re-invoking the <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> method.
+ </p>
+ </section>
<section id="events">
- <h3><span class="secno">5.3 </span>Events</h3>
-
- <p>
- The following are the event handlers (and their corresponding event handler event types) that must be supported, as IDL attributes, by all objects implementing the <a href="#networkservices"><code>NetworkServices</code></a> interface:
- </p>
-
- <table border="1">
- <thead>
- <tr>
- <th>
- <span title="event handlers">Event handler</span>
- </th>
- <th>
- <span>Event handler event type</span>
- </th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <dfn id="dom-networkservices-onserviceavailable" title="dom-NetworkServices-onserviceavailable">
- <code>onserviceavailable</code>
- </dfn>
- </td>
- <td>
- <code title="event-serviceavailable">serviceavailable</code>
- </td>
- </tr>
- <tr>
- <td>
- <dfn id="dom-networkservices-onserviceunavailable" title="dom-NetworkServices-onserviceunavailable">
- <code>onserviceunavailable</code>
- </dfn>
- </td>
- <td>
- <code title="event-serviceunavailable">serviceunavailable</code>
- </td>
- </tr>
- </tbody>
- </table>
-
- <p>
- Events with an event type of <code>serviceavailable</code> or <code>serviceunavailable</code> defined in this specification are simple <code>Event</code> objects.
- </p>
-
+ <h3><span class="secno">5.3 </span>
+ Events
+ </h3>
+ <p>
+ The following are the event handlers (and their corresponding event handler event types) that <em class="ct"><em class="rfc2119" title="must">must</em></em> be supported, as IDL attributes, by all objects implementing the <a href="#networkservices"><code>NetworkServices</code></a> interface:
+ </p>
+ <table border="1">
+ <thead>
+ <tr>
+ <th>
+ <span title="event handlers">Event handler</span>
+ </th>
+ <th>
+ <span>Event handler event type</span>
+ </th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <dfn id="dom-networkservices-onserviceavailable" title="dom-NetworkServices-onserviceavailable"><code>onserviceavailable</code></dfn>
+ </td>
+ <td>
+ <a href="#event-serviceavailable"><code>serviceavailable</code></a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="dom-networkservices-onserviceunavailable" title="dom-NetworkServices-onserviceunavailable"><code>onserviceunavailable</code></dfn>
+ </td>
+ <td>
+ <a href="#event-serviceunavailable"><code>serviceunavailable</code></a>
+ </td>
+ </tr>
+ </tbody>
+ </table>
</section>
-
</section>
<section id="communicating-with-a-networked-service">
- <!--OddPage--><h2><span class="secno">6. </span>Communicating with a networked service</h2>
-
-<p>
- The <a href="#networkservice"><code>NetworkService</code></a> interface is used to provide a set of connection information for an <abbr title="Hypertext Transfer Protocol">HTTP</abbr> service endpoint and if available, service events, running on a networked device.
-</p>
-
-<pre class="widl">[NoInterfaceObject]
+ <!--OddPage--><h2><span class="secno">6. </span>
+ Communicating with a networked service
+ </h2>
+ <p>
+ The <a href="#networkservice"><code>NetworkService</code></a> interface is used to provide a set of connection
+ information for an <abbr title="Hypertext Transfer Protocol">HTTP</abbr> service endpoint and if available, service events, running on a networked device.
+ </p>
+ <pre class="widl">[NoInterfaceObject]
interface <dfn id="networkservice">NetworkService</dfn> {
readonly attribute DOMString <a href="#dom-networkservice-id">id</a>;
readonly attribute DOMString <a href="#dom-networkservice-name">name</a>;
@@ -959,644 +950,818 @@
readonly attribute DOMString <a href="#dom-networkservice-url">url</a>;
readonly attribute DOMString <a href="#dom-networkservice-config">config</a>;
- const unsigned short <a href="#dom-networkservice-AVAILABLE">AVAILABLE</a> = 1;
- const unsigned short <a href="#dom-networkservice-UNAVAILABLE">UNAVAILABLE</a> = 2;
- readonly attribute unsigned short <a href="#dom-networkservice-readystate">readyState</a>;
+ readonly attribute boolean <a href="#dom-networkservice-online">online</a>;
// event handler attributes
- attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler" class="externalDFN">EventHandler</a> <a href="#dom-networkservice-onreadystatechange">onreadystatechange</a>;
- attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler" class="externalDFN">EventHandler</a> <a href="#dom-networkservice-onmessage">onmessage</a>;
+ attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler" class="externalDFN">EventHandler</a> <a href="#dom-networkservice-onserviceonline">onserviceonline</a>;
+ attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler" class="externalDFN">EventHandler</a> <a href="#dom-networkservice-onserviceoffline">onserviceoffline</a>;
+
+ attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler" class="externalDFN">EventHandler</a> <a href="#dom-networkservice-onnotify">onnotify</a>;
};
<a href="#networkservice">NetworkService</a> implements <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#interface-eventtarget" class="externalDFN">EventTarget</a>;
</pre>
-
-<section id="attributes-1">
- <h3><span class="secno">6.1 </span>Attributes</h3>
-
- <dl class="domintro">
- <dt>
- <var title="">service</var>
- .
- <code title="dom-networkservice-id">
- <a href="#dom-networkservice-id">id</a>
- </code>
- </dt>
- <dd>
- <p>
- A unique identifier for the given user-selected service instance.
- </p>
- </dd>
- <dt>
- <var title="">service</var>
- .
- <code title="dom-networkservice-name">
- <a href="#dom-networkservice-name">name</a>
- </code>
- </dt>
- <dd>
- <p>
- The name of the user-selected service.
- </p>
- </dd>
- <dt>
- <var title="">service</var>
- .
- <code title="dom-networkservice-type">
- <a href="#dom-networkservice-type">type</a>
- </code>
- </dt>
- <dd>
- <p>
- The <a class="internalDFN" href="#dfn-valid-service-type">valid service type</a> token value of the user-selected service.
- </p>
- </dd>
- <dt>
- <var title="">service</var>
- .
- <code title="dom-networkservice-url">
- <a href="#dom-networkservice-url">url</a>
- </code>
- </dt>
- <dd>
- <p>
- The control <abbr title="Uniform Resource Locator">URL</abbr> endpoint (including any required port information) of the user-selected control service that has been added to the <a class="internalDFN" href="#dfn-entry-script-origin-s-url-whitelist">entry script origin's <abbr title="Uniform Resource Locator">URL</abbr> whitelist</a>.
- </p>
- </dd>
- <dt>
- <var title="">service</var>
- .
- <code title="dom-networkservice-config">
- <a href="#dom-networkservice-config">config</a>
- </code>
- </dt>
- <dd>
- <p>
- The configuration information associated with the service depending on the requested service type.
- </p>
- </dd>
- </dl>
-
+ <section id="attributes-1">
+ <h3><span class="secno">6.1 </span>
+ Attributes
+ </h3>
+ <dl class="domintro">
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-id"><a href="#dom-networkservice-id">id</a></code>
+ </dt>
+ <dd>
+ <p>
+ A unique identifier for the given user-selected service instance.
+ </p>
+ </dd>
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-name"><a href="#dom-networkservice-name">name</a></code>
+ </dt>
+ <dd>
+ <p>
+ The name of the user-selected service.
+ </p>
+ </dd>
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-type"><a href="#dom-networkservice-type">type</a></code>
+ </dt>
+ <dd>
+ <p>
+ The <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> token value of the user-selected service.
+ </p>
+ </dd>
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-url"><a href="#dom-networkservice-url">url</a></code>
+ </dt>
+ <dd>
+ <p>
+ The control <abbr title="Uniform Resource Locator">URL</abbr> endpoint (including any required port information) of the user-selected control service
+ that has been added to the <a href="#dfn-entry-script-origin-s-url-whitelist" class="internalDFN">entry script origin's <abbr title="Uniform Resource Locator">URL</abbr> whitelist</a>.
+ </p>
+ </dd>
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-config"><a href="#dom-networkservice-config">config</a></code>
+ </dt>
+ <dd>
+ <p>
+ The configuration information associated with the service depending on the requested service type.
+ </p>
+ </dd>
+ </dl>
+ <p>
+ The <dfn id="dom-networkservice-id"><code>id</code></dfn> attribute is a unique identifier for the service.
+ The same service provided at different times or on different objects <em class="rfc2119" title="must">must</em> have the same
+ <a href="#dom-networkservice-id"><code>id</code></a> value.
+ </p>
+ <p>
+ The <dfn id="dom-networkservice-name"><code>name</code></dfn> attribute represents a human-readable title for
+ the service.
+ </p>
+ <p>
+ The <dfn id="dom-networkservice-type"><code>type</code></dfn> attribute reflects the value of the <a href="#dfn-valid-service-type" class="internalDFN">valid
+ service type</a> of the service.
+ </p>
+ <p>
+ The <dfn id="dom-networkservice-url"><code>url</code></dfn> attribute is an <a href="http://www.w3.org/TR/html5/urls.html#absolute-url" class="externalDFN">absolute <abbr title="Uniform Resource Locator">URL</abbr></a> pointing to the root <abbr title="Hypertext Transfer Protocol">HTTP</abbr> endpoint for the service that has been
+ added to the <a href="#dfn-entry-script-origin-s-url-whitelist" class="internalDFN">entry script origin's <abbr title="Uniform Resource Locator">URL</abbr> whitelist</a>. Web pages can subsequently use this value for
+ implicit cross-document messaging via various existing mechanisms (e.g. Web Sockets, Server-Sent Events,
+ Web Messaging, XMLHttpRequest).
+ </p>
+ <p>
+ The <dfn id="dom-networkservice-config"><code>config</code></dfn> attribute provides the raw configuration
+ information extracted from the given network service.
+ </p>
+ </section>
+ <section id="states">
+ <h3><span class="secno">6.2 </span>
+ States
+ </h3>
+ <dl class="domintro">
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-online"><a href="#dom-networkservice-online">online</a></code>
+ </dt>
+ <dd>
+ <p>
+ Returns <code>true</code> if the service is reporting that it is accessible on the local network or
+ <code>false</code> if the service is reporting that it is no longer accessible (temporarily or
+ permanently) on the local network.
+ </p>
+ </dd>
+ </dl>
+ <p>
+ The <dfn id="dom-networkservice-online"><code>online</code></dfn> attribute indicates whether the service is
+ reporting itself as being either <var>online</var>, and therefore accessible on the local network, in which
+ case this attribute will return <code>true</code> or, <var>offline</var>, and therefore not accessible on the
+ local network, either temporarily or permanently, in which case this attribute will return
+ <code>false</code>. This attribute <em class="rfc2119" title="must">must</em> default to <code>true</code>.
+ </p>
+ </section>
+ <section id="events-1">
+ <h3><span class="secno">6.3 </span>
+ Events
+ </h3>
+ <p>
+ The following are the event handlers (and their corresponding event handler event types) that <em class="ct"><em class="rfc2119" title="must">must</em></em> be supported, as IDL attributes, by all objects implementing the <a href="#networkservice"><code>NetworkService</code></a> interface:
+ </p>
+ <table border="1">
+ <thead>
+ <tr>
+ <th>
+ <span title="event handlers">Event handler</span>
+ </th>
+ <th>
+ <span>Event handler event type</span>
+ </th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <dfn id="dom-networkservice-onnotify" title="dom-NetworkService-onnotify"><code>onnotify</code></dfn>
+ </td>
+ <td>
+ <a href="#event-notify"><code>notify</code></a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="dom-networkservice-onserviceonline" title="dom-NetworkService-onserviceonline"><code>onserviceonline</code></dfn>
+ </td>
+ <td>
+ <a href="#event-serviceonline"><code>serviceonline</code></a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="dom-networkservice-onserviceoffline" title="dom-NetworkService-onserviceoffline"><code>onserviceoffline</code></dfn>
+ </td>
+ <td>
+ <a href="#event-serviceoffline"><code>serviceoffline</code></a>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+ </section>
+ <section id="service-discovery">
+ <!--OddPage--><h2><span class="secno">7. </span>
+ Service Discovery
+ </h2>
+ <p>
+ A <a href="#dfn-user-agent" class="internalDFN">user agent</a> conforming to this specification <em class="rfc2119" title="may">may</em> implement <abbr title="Simple Service Discovery Protocol">SSDP</abbr> [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>] and Zeroconf [<cite><a class="bibref" href="#bib-DNS-SD">DNS-SD</a></cite>] + [<cite><a class="bibref" href="#bib-MDNS">MDNS</a></cite>]
+ service discovery mechanisms to enable Web pages to request and connect with <abbr title="Hypertext Transfer Protocol">HTTP</abbr> services running on networked
+ devices, discovered via either mechanism, through this <abbr title="Application Programming Interface">API</abbr>. When a <a href="#dfn-user-agent" class="internalDFN">user agent</a> implements either of these
+ service discovery mechanisms, then it <em class="rfc2119" title="must">must</em> conform to the corresponding algorithms provided
+ in this section of the specification.
+ </p>
+ <p>
+ This section presents how the results of these two service discovery mechanisms will be matched to requested
+ service types, how the user agent stores available and active services, how their properties are applied to any
+ resulting <a href="#networkservice"><code>NetworkService</code></a> objects.
+ </p>
+ <p>
+ It is expected that user agents will perform these service discovery mechanisms asynchronously and
+ periodically update the <a>list of networked devices</a> as required. The timing of any service discovery
+ mechanisms is an implementation detail left to the discretion of the implementer (e.g. once on user agent
+ start-up, every X seconds during user agent execution or on invocation of this <abbr title="Application Programming Interface">API</abbr> from a Web page).
+ </p>
+ <p>
+ The <dfn id="dfn-list-of-available-service-records">list of available service records</dfn> is a single dynamic internal lookup table within user agents
+ that is used to track all the services that have been discovered and are available in the current network at
+ any given time. At any point during the running of either of the two service discovery mechanisms then existing
+ entries within this table can be updated, entries can be added and entries can be removed as the status of
+ networked services changes according to the rules defined in this specification.
+ </p>
+ <p>
+ The <dfn id="dfn-list-of-authorized-service-records">list of authorized service records</dfn> is a single dynamic internal lookup table within user agents
+ that is used to track the current services that are being shared with web pages at any given time from the
+ <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>. Each record in the <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a> is
+ associated with a <var>services manager</var> object that is assigned as part of the <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> algorithm.
+ </p>
+ <p>
+ The rule for <dfn id="dfn-adding-an-available-service">adding an available service</dfn> is the process of adding a new service or updating an
+ existing service in the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a> that is generally available on the user's
+ current network. This rule takes one argument, <var>network service record</var>, and consists of running the
+ following steps:
+ </p>
+ <ol class="rule">
+ <li>Let <var>new service registration flag</var> be <code>true</code>.
+ </li>
+ <li>For each <var>existing service record</var> in the current <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>, run
+ the following sub-steps:
+ <ol class="rule">
+ <li>If the <var>existing service record</var>'s <code>id</code> property does not equal <var>network
+ service record</var>'s <code>id</code> property then abort any remaining sub-steps and continue at the next
+ available <var>existing service record</var>.
+ </li>
+ <li>Set <var>new service registration flag</var> to <code>false</code>.
+ </li>
+ <li>Replace the value of <var>existing service record</var> in the current <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service
+ records</a> with the value of <var>network service record</var>.
+ </li>
+ </ol>
+ </li>
+ <li>If <var>new service registration flag</var> is set to <code>true</code> then add <var>network service
+ record</var> to the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a> as a new entry.
+ </li>
+ <li>For each <var>active service</var> in the <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a> run the following
+ steps:
+ <ol class="rule">
+ <li>If <var>network service record</var>'s <code>type</code> property does not equal the current
+ <var>active service</var>'s <code>type</code> attribute then abort any remaining sub-steps for this
+ <var>active service</var> and continue at the next available <var>active service</var>.
+ </li>
+ <li>If the <var>new service registration flag</var> is set to <code>true</code> then increment the
+ <a href="#dom-networkservices-servicesavailable"><code>servicesAvailable</code></a> attribute of the
+ <var>services manager</var> associated with the current <var>active service</var> object by
+ <code>1</code> and then <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to dispatch a newly created event with the name <a href="#event-serviceavailable"><code>serviceavailable</code></a> that uses the <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event" class="externalDFN"><code>Event</code></a> interface, which does not bubble, is not cancellable, and
+ has no default action, at the <var>services manager</var> associated with the current <var>active
+ service</var> object.
+ </li>
+ <li>Set <var>active service</var>'s <a href="#dom-networkservice-online"><code>online</code></a> attribute
+ to <code>true</code> and then <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to dispatch a newly created event with the name <a href="#event-serviceonline"><code>serviceonline</code></a> that uses the <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event" class="externalDFN"><code>Event</code></a> interface, which does not bubble, is not cancellable, and
+ has no default action, at the current <var>active service</var> object.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ <p>
+ The rule for <dfn id="dfn-removing-an-available-service">removing an available service</dfn> is the general process of removing a service from the
+ <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a> that has left the user's current network or has otherwise expired.
+ This rule takes one argument, <var>service identifier</var>, and consists of running the following steps:
+ </p>
+ <ol class="rule">
+ <li>For each <var>existing service record</var> in the current <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>, run
+ the following sub-steps:
+ <ol class="rule">
+ <li>If the <var>existing service record</var>'s <code>id</code> property does not match <var>service
+ identifier</var> then skip any remaining sub-steps for the current <var>existing service record</var> and
+ continue at the next available <var>existing service record</var>.
+ </li>
+ <li>If the <var>existing service record</var>'s <code>type</code> property begins with the DOMString
+ "<code>upnp:</code>" and <var>existing service record</var>'s <code>eventsURL</code> property is set then
+ run the rule to <a href="#dfn-terminate-an-existing-upnp-events-subscription" class="internalDFN">terminate an existing UPnP Events Subscription</a>, if one is currently active (as a
+ result of having previously called <a href="#dfn-setup-a-upnp-events-subscription" class="internalDFN">setup a UPnP Events Subscription</a> against the current
+ <var>existing service record</var>).
+ </li>
+ <li>For each <var>active service</var> in <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a> run the following
+ steps:
+ <ol class="rule">
+ <li>If <var>existing service record</var>'s <code>type</code> property does not equal the current <var>
+ active service</var>'s <code>type</code> attribute then abort any remaining sub-steps for this
+ <var>active service</var> and continue at the next available <var>active service</var>.
+ </li>
+ <li>Decrement the <a href="#dom-networkservices-servicesavailable"><code>servicesAvailable</code></a>
+ attribute of the <var>services manager</var> associated with the current <var>active service</var>
+ object by <code>1</code> and then <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to dispatch a newly created event with the name <a href="#event-serviceunavailable"><code>serviceunavailable</code></a> that uses the <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event" class="externalDFN"><code>Event</code></a> interface, which does not bubble, is not cancellable,
+ and has no default action, at the <var>services manager</var> associated with the current
+ <var>active service</var> object.
+ </li>
+ <li>Set <var>active service</var>'s <a href="#dom-networkservice-online"><code>online</code></a>
+ attribute to <code>false</code> and then <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to dispatch a newly created event with the name <a href="#event-serviceoffline"><code>serviceoffline</code></a> that uses the <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event" class="externalDFN"><code>Event</code></a> interface, which does not bubble, is not cancellable,
+ and has no default action, at the current <var>active service</var> object.
+ </li>
+ </ol>
+ </li>
+ <li>Remove <var>existing service record</var> from the current <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ <p>
+ User agents <em class="rfc2119" title="should">should</em> expire a service record from the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service
+ records</a> when its <code>expiryTimestamp</code> attribute exceeds the current UTC timestamp. When this
+ condition is met the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="should">should</em> run the rule for <a href="#dfn-removing-an-available-service" class="internalDFN">removing an available service</a>, passing in
+ the expired service record's <code>id</code> attribute as the only argument.
+ </p>
+ <section id="zeroconf-mdns-dns-sd">
+ <h3><span class="secno">7.1 </span>
+ Zeroconf (<abbr title="Multicast DNS">mDNS</abbr> + <abbr title="Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr>)
+ </h3>
+ <p>
+ For each <abbr title="Domain Name System">DNS</abbr> response received from a user-agent-initiated Multicast <abbr title="Domain Name System">DNS</abbr> Browse for <abbr title="DNS Pointer Record">PTR</abbr> records with the name <code>_services._dns-sd._udp</code> on the resolved
+ recommended automatic browsing domain [<cite><a class="bibref" href="#bib-MDNS">MDNS</a></cite>], the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> run the
+ following steps:
+ </p>
+ <ol class="rule">
+ <li>Let <var>service <abbr title="Multicast DNS">mDNS</abbr> responses</var> be an array of <abbr title="DNS Pointer Record">PTR</abbr> records received by issuing a Multicast <abbr title="Domain Name System">DNS</abbr>
+ Browse for <abbr title="DNS Pointer Record">PTR</abbr> records with the name of the current discovered service type.
+ </li>
+ <li>For each Object <var>service <abbr title="Multicast DNS">mDNS</abbr> response</var> in <var>service <abbr title="Multicast DNS">mDNS</abbr> responses</var>, run the following
+ steps:
+ <ol>
+ <li>Let <var>network service record</var> be an Object consisting of the following empty properties:
+ <code>id</code>, <code>name</code>, <code>type</code>, <code>url</code>, <code>config</code>,
+ <code>expiryTimestamp</code>.
+ </li>
+ <li>Set <var>network service record</var>'s <code>id</code> property to the value of the full <abbr title="DNS Pointer Record">PTR</abbr> Service
+ Instance Name [<cite><a class="bibref" href="#bib-MDNS">MDNS</a></cite>].
+ </li>
+ <li>Set <var>network service record</var>'s <code>name</code> property to the value of the <abbr title="DNS Pointer Record">PTR</abbr> Service
+ Instance Name's <var>Instance</var> component [<cite><a class="bibref" href="#bib-MDNS">MDNS</a></cite>].
+ </li>
+ <li>Set <var>network service record</var>'s <code>type</code> property to the concatenation of the string
+ <code>zeroconf:</code> followed be the value of the <abbr title="DNS Pointer Record">PTR</abbr> Service Instance Name's <var>Service</var>
+ component [<cite><a class="bibref" href="#bib-MDNS">MDNS</a></cite>].
+ </li>
+ <li>Set <var>network service record</var>'s <code>url</code> property to the resolvable Service <abbr title="Uniform Resource Locator">URL</abbr>
+ obtained from performing an <abbr title="Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr> Lookup [<cite><a class="bibref" href="#bib-DNS-SD">DNS-SD</a></cite>] of the current service from the <abbr title="DNS Pointer Record">PTR</abbr> record provided
+ [<cite><a class="bibref" href="#bib-MDNS">MDNS</a></cite>].
+ </li>
+ <li>Set <var>network service record</var>'s <code>config</code> property to the string value of the
+ contents of the first <abbr title="Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr> TXT record associated with the <var>service <abbr title="Multicast DNS">mDNS</abbr> response</var> as defined
+ in [<cite><a class="bibref" href="#bib-DNS-SD">DNS-SD</a></cite>].
+ </li>
+ <li>Set <var>network service record</var>'s <code>expiryTimestamp</code> property to the value of the
+ current date, in UTC timestamp format, plus a value of <code>120</code> seconds.
+ </li>
+ <li>Run the general rule for <a href="#dfn-adding-an-available-service" class="internalDFN">adding an available service</a>, passing in the current <var>network
+ service record</var> as the only argument.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ </section>
+ <section id="simple-service-discovery-protocol-ssdp">
+ <h3><span class="secno">7.2 </span>
+ Simple Service Discovery Protocol (<abbr title="Simple Service Discovery Protocol">SSDP</abbr>)
+ </h3>
+ <p>
+ A user agent that implements UPnP service discovery <em class="rfc2119" title="must">must</em> issue an <dfn id="dfn-advertisement-for-upnp-root-devices">advertisement for
+ UPnP root devices</dfn> against the user's current local network according to the full normative text and
+ timing provided in 'Section 1.3.2: Search request with M-SEARCH' detailed in [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>].
+ </p>
+ <p>
+ The user agent <em class="rfc2119" title="must">must</em> issue all <a title="advertisement for UPnP root devices" href="#dfn-advertisement-for-upnp-root-devices" class="internalDFN">advertisements for UPnP root devices</a> with a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> request line equal
+ to <code>M-SEARCH * <abbr title="Hypertext Transfer Protocol">HTTP</abbr>/1.1</code>, with a HOST header equal to the reserved multicast address and port of
+ <code>239.255.255.250:1900</code>, a MAN header equal to <code>ssdp:discover</code>, an ST header equal to
+ <code>upnp:rootdevice</code> and a user-agent defined MX header equal to a <dfn id="dfn-maximum-upnp-advertisement-response-wait-time">maximum UPnP advertisement
+ response wait time</dfn> value between <code>1</code> and <code>5</code> seconds.
+ </p>
+ <p>
+ The user agent <em class="rfc2119" title="must">must</em> listen for incoming requests and process any incoming responses to
+ any <a href="#dfn-advertisement-for-upnp-root-devices" class="internalDFN">advertisement for UPnP root devices</a> on the <dfn id="dfn-standard-upnp-address-and-port">standard UPnP address and port</dfn>, on all
+ current local network interface addresses with the port <code>1900</code>, according to the rules defined in
+ this section.
+ </p>
+ <p>
+ For each <dfn id="dfn-http-response"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Response</dfn> following an initial <a href="#dfn-advertisement-for-upnp-root-devices" class="internalDFN">advertisement for UPnP root devices</a> sent on a
+ <a href="#dfn-standard-upnp-address-and-port" class="internalDFN">standard UPnP address and port</a> the user agent <em class="rfc2119" title="must">must</em> run the following steps:
+ </p>
+ <ol class="rule">
+ <li>If the <a href="#dfn-http-response" class="internalDFN"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Response</a> is not a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> 200 OK response then this response is invalid and the user
+ agent <em class="rfc2119" title="must">must</em> discard this response, abort any remaining steps and return. The user agent
+ <em class="rfc2119" title="may">may</em> issue a new <a href="#dfn-advertisement-for-upnp-root-devices" class="internalDFN">advertisement for UPnP root devices</a> as a result of this error
+ occurring.
+ </li>
+ <li>If the <a href="#dfn-maximum-upnp-advertisement-response-wait-time" class="internalDFN">maximum UPnP advertisement response wait time</a> has been exceeded since the initial
+ <a href="#dfn-advertisement-for-upnp-root-devices" class="internalDFN">advertisement for UPnP root devices</a> was sent then the <a href="#dfn-http-response" class="internalDFN"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Response</a> is invalid and the user
+ agent <em class="rfc2119" title="must">must</em> discard this response, abort any remaining steps and return.
+ </li>
+ <li>Let <var>ssdp device</var> be an Object with a property for each <abbr title="Hypertext Transfer Protocol">HTTP</abbr> header received in the <a href="#dfn-http-response" class="internalDFN"><abbr title="Hypertext Transfer Protocol">HTTP</abbr>
+ Response</a>, with each key being the name of a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> response header and each value being that <abbr title="Hypertext Transfer Protocol">HTTP</abbr> response
+ header's value.
+ </li>
+ <li>If <var>ssdp device</var> does not contain at least one <var>CACHE-CONTROL</var> entry, at least one
+ <var>USN</var> entry, at least one <var>ST</var> entry and at least one <var>LOCATION</var> entry or the
+ value of its <var>ST</var> entry is not <code>upnp:rootdevice</code>, then the <a href="#dfn-http-response" class="internalDFN"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Response</a> is
+ invalid and the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> discard this response, abort any remaining steps
+ and return.
+ </li>
+ <li>The user agent <em class="rfc2119" title="must">must</em> run the rule for <a href="#dfn-obtaining-a-upnp-device-description-file" class="internalDFN">obtaining a UPnP Device Description File</a>
+ passing in the first occurrence of <var>LOCATION</var> from <var>ssdp device</var> as the <var>device
+ descriptor <abbr title="Uniform Resource Locator">URL</abbr></var> argument and the first occurrence of <var>USN</var> from <var>ssdp device</var> as the
+ <var>device identifier</var> argument and the first occurrence of <var>CACHE-CONTROL</var> from <var>ssdp
+ device</var> as the <var>device expiry</var> argument.
+ </li>
+ </ol>
+ <p>
+ For each <dfn id="dfn-http-request"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Request</dfn> received on a <a href="#dfn-standard-upnp-address-and-port" class="internalDFN">standard UPnP address and port</a> the user agent
+ <em class="rfc2119" title="must">must</em> run the following steps:
+ </p>
+ <ol class="rule">
+ <li>If the <a href="#dfn-http-request" class="internalDFN"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Request</a> is not a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> NOTIFY request then it is not a valid UPnP Request and the user
+ agent <em class="rfc2119" title="must">must</em> return a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> 200 OK response, discard this request, abort any remaining steps
+ and return.
+ </li>
+ <li>Let <var>ssdp device</var> be an Object with a property for each <abbr title="Hypertext Transfer Protocol">HTTP</abbr> header received in the <a href="#dfn-http-request" class="internalDFN"><abbr title="Hypertext Transfer Protocol">HTTP</abbr>
+ Request</a>, with each key being the name of a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> header and each value being that <abbr title="Hypertext Transfer Protocol">HTTP</abbr> header's value.
+ </li>
+ <li>If <var>ssdp device</var> does not contain at least one <var>CACHE-CONTROL</var> entry, at least one
+ <var>USN</var> entry, at least one <var>NT</var> entry, at least one <var>NTS</var> entry and at least one
+ <var>LOCATION</var> entry or the value of its <var>NT</var> entry is not <code>upnp:rootdevice</code>, then
+ the <a href="#dfn-http-request" class="internalDFN"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Request</a> is a malformed UPnP Request and the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> return
+ a 400 Bad Request response, discard this request, abort any remaining steps and return.
+ </li>
+ <li>If <var>ssdp device</var>'s <var>NTS</var> entry is equal to <code>ssdp:alive</code> or
+ <code>ssdp:update</code> then the user agent <em class="rfc2119" title="must">must</em> run the rule for <a href="#dfn-obtaining-a-upnp-device-description-file" class="internalDFN">obtaining a UPnP
+ Device Description File</a> passing in the first occurrence of <var>LOCATION</var> from <var>ssdp
+ device</var> as the <var>device descriptor <abbr title="Uniform Resource Locator">URL</abbr></var> argument and the first occurrence of <var>USN</var> from
+ <var>ssdp device</var> as the <var>device identifier</var> argument and the first occurrence of
+ <var>CACHE-CONTROL</var> from <var>ssdp device</var> as the <var>device expiry</var>.<br>
+ <br>
+ Otherwise, if <var>ssdp device</var>'s <var>NTS</var> entry is equal to <code>ssdp:byebye</code> then the
+ user agent <em class="rfc2119" title="must">must</em> run the rule for <a href="#dfn-removing-all-services-from-a-registered-upnp-device" class="internalDFN">removing all services from a registered UPnP
+ Device</a> passing in the first occurrence of <var>USN</var> from <var>ssdp device</var> as the <var>device
+ identifier</var> argument.
+ </li>
+ </ol>
+ <p>
+ The rule for <dfn id="dfn-obtaining-a-upnp-device-description-file">obtaining a UPnP Device Description File</dfn> is the process of obtaining the contents of
+ a standard UPnP Device Description [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>] from a <abbr title="Uniform Resource Locator">URL</abbr>-based resource. This rule takes three
+ arguments - <var>device descriptor <abbr title="Uniform Resource Locator">URL</abbr></var>, <var>device identifier</var> and <var>device expiry</var> - and
+ when called the user agent <em class="rfc2119" title="must">must</em> run the following steps:
+ </p>
+ <ol class="rule">
+ <li>Let <var>device descriptor file</var> contain the contents of the file located at the <abbr title="Uniform Resource Locator">URL</abbr> provided in
+ <var>device descriptor <abbr title="Uniform Resource Locator">URL</abbr></var> obtained according to the rules defined in 'Section 2.11: Retrieving a
+ description using <abbr title="Hypertext Transfer Protocol">HTTP</abbr>' in [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>].
+ </li>
+ <li>If the value provided in <var>device descriptor <abbr title="Uniform Resource Locator">URL</abbr></var> cannot be resolved as a reachable <abbr title="Uniform Resource Locator">URL</abbr> on the
+ current network or the <var>root device descriptor file</var> remains empty then it is invalid and the
+ <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> abort any remaining steps and return.
+ </li>
+ <li>Run the rule for <a href="#dfn-processing-a-upnp-device-description-file" class="internalDFN">processing a UPnP Device Description File</a>, passing in the current <var>device
+ descriptor file</var>, <var>device identifier</var> and <var>device expiry</var> arguments.
+ </li>
+ <li>If the current <var>device descriptor file</var> contains a <code><deviceList></code> element then
+ for each <code><device></code> element within <code><deviceList></code> - herein known as an
+ <var>embedded device descriptor file</var> - the user agent <em class="rfc2119" title="must">must</em> run the rule for
+ <a href="#dfn-processing-a-upnp-device-description-file" class="internalDFN">processing a UPnP Device Description File</a>, passing in the current <var>embedded device descriptor
+ file</var> as the <var>device descriptor file</var> argument, along with the common <var>device
+ identifier</var> and <var>device expiry</var> arguments.
+ </li>
+ </ol>
+ <p>
+ The rule for <dfn id="dfn-processing-a-upnp-device-description-file">processing a UPnP Device Description File</dfn> is the process of parsing the contents of a
+ standard UPnP Device Description [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>] and registering the UPnP services contained therein
+ within the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>.
+ </p>
+ <p>
+ The rule for <a href="#dfn-processing-a-upnp-device-description-file" class="internalDFN">processing a UPnP Device Description File</a> takes three arguments - <var>device descriptor
+ file</var>, <var>device identifier</var> and <var>device expiry</var> - and when called the user agent
+ <em class="rfc2119" title="must">must</em> run the following steps:
+ </p>
+ <ol class="rule">
+ <li>Let <var>advertised services</var> be a list of all advertised services obtained from the <var>device
+ descriptor file</var> containing the value of the first occurrence of the <code><serviceList></code>
+ element as it is defined in 'Section 2.3: Device Description' in [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>].
+ </li>
+ <li>For each <code><service></code> element - known as an <var>advertised service</var> - in
+ <var>advertised services</var> run the following steps:
+ <ol class="rule">
+ <li>Let <var>network service record</var> be a new Object consisting of the following empty properties:
+ <code>id</code>, <code>deviceId</code>, <code>name</code>, <code>type</code>, <code>url</code>,
+ <code>eventsUrl</code>, <code>config</code>, <code>expiryTimestamp</code>.
+ </li>
+ <li>Set <var>network service record</var>'s <code>id</code> property to the concatenated string value of
+ <var>device identifier</var> with the <var>advertised service</var>'s <code><serviceId></code>
+ sub-element.
+ </li>
+ <li>Set <var>network service record</var>'s <code>deviceId</code> property to the value of <var>device
+ identifier</var>.
+ </li>
+ <li>Set <var>network service record</var>'s <code>name</code> property to the string value of the first
+ occurrence of the <var>advertised service</var>'s <code><serviceId></code> sub-element.
+ </li>
+ <li>Set <var>network service record</var>'s <code>type</code> property to the concatenation of the string
+ <code>upnp:</code> followed by the string value of the first occurrence of the <var>advertised
+ service</var>'s <code><serviceType></code> sub-element.
+ </li>
+ <li>Set <var>network service record</var>'s <code>url</code> property to the string value of the first
+ occurrence of the <var>advertised service</var>'s <code><controlURL></code> sub-element.
+ </li>
+ <li>Set <var>network service record</var>'s <code>config</code> property to the string value of the
+ contents of the first occurrence of the <code><device></code> element in the <var>device descriptor
+ file</var>.
+ </li>
+ <li>If <var>advertised service</var>'s <code><eventSubURL></code> sub-element is not empty, then
+ set <var>network service record</var>'s <code>eventsUrl</code> property to the string value of the first
+ occurrence of the <var>advertised service</var>'s <code><eventSubURL></code> sub-element.
+ Otherwise, do not set <var>network service record</var>'s <code>eventsUrl</code> property.
+ </li>
+ <li>Set <var>network service record</var>'s <code>expiryTimestamp</code> property to the value of the
+ current date, in UTC timestamp format, plus the value of <var>device expiry</var>.
+ </li>
+ <li>Run the general rule for <a href="#dfn-adding-an-available-service" class="internalDFN">adding an available service</a>, passing in the current <var>network
+ service record</var> as the only argument.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ <p>
+ The rule for <dfn id="dfn-removing-all-services-from-a-registered-upnp-device">removing all services from a registered UPnP Device</dfn> is the process of removing all
+ services associated with a device from the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a> that has left the user's
+ current network or has otherwise timed out or expired. This rule takes one argument, <var>device
+ identifier</var>, and consists of running the following steps:
+ </p>
+ <ol class="rule">
+ <li>For each <var>existing service record</var> in the current <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>, run
+ the following sub-steps:
+ <ol class="rule">
+ <li>If the <var>existing service record</var>'s <code>deviceId</code> property does not match <var>device
+ identifier</var> then skip any remaining sub-steps for the current <var>existing service record</var> and
+ continue at the next available <var>existing service record</var>.
+ </li>
+ <li>Run the general rule for <a href="#dfn-removing-an-available-service" class="internalDFN">removing an available service</a> passing in <var>existing service
+ record</var>'s <code>id</code> property as the only argument.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ <p>
+ When the <a href="#dfn-user-agent" class="internalDFN">user agent</a> is to <dfn id="dfn-setup-a-upnp-events-subscription">setup a UPnP Events Subscription</dfn>, it is to run the following
+ steps with the current <var>network service record</var> object as defined in 'Section 4.1.2: SUBSCRIBE with
+ NT and CALLBACK' in [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>]:
+ </p>
+ <ol class="rule">
+ <li>If <var>network service record</var>'s <code>eventsUrl</code> property is empty then the <a href="#dfn-user-agent" class="internalDFN">user
+ agent</a> <em class="rfc2119" title="must">must</em> abort these steps.
+ </li>
+ <li>Let <var>callback <abbr title="Uniform Resource Locator">URL</abbr></var> be the value of creating a new <a href="#dfn-user-agent-generated-callback-url" class="internalDFN">user-agent generated callback url</a>.
+ </li>
+ <li>Send a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> SUBSCRIBE request with a <em>NT</em> header with a string value of <code>upnp:event</code>, a
+ <em>TIMEOUT</em> header with a user-agent defined timeout value (in the form <code>Second-XX</code> where
+ <code>XX</code> is the user-agent defined timeout value in seconds) and a <em>CALLBACK</em> header with a
+ string value of <var>callback <abbr title="Uniform Resource Locator">URL</abbr></var> towards the <var>network service record</var>'s
+ <code>eventsUrl</code> property.
+ </li>
+ <li>If a non-200 OK response is received from the <abbr title="Hypertext Transfer Protocol">HTTP</abbr> SUBSCRIBE request then the <a href="#dfn-user-agent" class="internalDFN">user agent</a>
+ <em class="rfc2119" title="must">must</em> abort these steps.
+ </li>
+ <li>On receiving a valid 200 OK response, run the following steps:
+ <ol class="rule">
+ <li>Let <var>callback ID</var> equal the string value of the first included <em>SID</em> header, if it
+ exists.
+ </li>
+ <li>Let <var>timeout date</var> equal the sum of the current UTC date value plus the integer value of the
+ first included <em>TIMEOUT</em> header (minus the leading string of <code>Second-</code>), if it exists.
+ </li>
+ <li>Run the following steps asynchronously and continue to the step labeled <em>listen</em> below.
+ </li>
+ <li>
+ <em>Refresh Subscription</em>: Run the following steps at a set interval (X) within the <a href="#dfn-user-agent" class="internalDFN">user
+ agent</a>:
+ <ol class="rule">
+ <li>Let <var>current date</var> equal the current UTC date.
+ </li>
+ <li>If <var>current date</var> is less than the <var>timeout date</var> then continue to the step
+ labeled <em>refresh subscription</em> above.
+ </li>
+ <li>Send a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> SUBSCRIBE request with a <em>SID</em> header with the string value of <var>callback
+ ID</var> and a user-agent defined <em>TIMEOUT</em> header (in the form <code>Second-XX</code> where
+ <code>XX</code> is the user-agent defined timeout value in seconds) towards the <var>network service
+ record</var>'s <code>eventsUrl</code> property.
+ </li>
+ <li>On receiving a valid 200 OK, update <var>callback ID</var> with the string value of the first
+ included <em>SID</em> header, if it exists. All other <abbr title="Hypertext Transfer Protocol">HTTP</abbr> responses should cause the <a href="#dfn-user-agent" class="internalDFN">user
+ agent</a> to continue from the step labeled <em>refresh subscription</em> above.
+ </li>
+ </ol>
+ </li>
+ <li>
+ <em>Listen</em>: For each <abbr title="Hypertext Transfer Protocol">HTTP</abbr> NOTIFY request received at the <var>callback <abbr title="Uniform Resource Locator">URL</abbr></var> the <a href="#dfn-user-agent" class="internalDFN">user
+ agent</a> is to run the following steps:
+ <ol class="rule">
+ <li>Let <var>content clone</var> be the result of obtaining the message body of the <abbr title="Hypertext Transfer Protocol">HTTP</abbr> NOTIFY
+ request. If <var>content clone</var> is empty, then the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em>
+ abort these steps.
+ </li>
+ <li>Let <var>notification event</var> be a new simple event that uses the <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event" class="externalDFN"><code>Event</code></a> interface with the name <a href="#event-notify"><code>notify</code></a>, which does not bubble, is not cancellable, and has no
+ default action.
+ </li>
+ <li>Let the <code>data</code> attribute of <var>notification event</var> have the DOMString value of
+ <var>content clone</var>.
+ </li>
+ <li>
+ <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">Queue a task</a> to dispatch <var>notification event</var> at the current
+ <a href="#networkservice" class="internalDFN"><code>NetworkService</code></a> object.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ </li>
+ </ol>
+ <p>
+ A <a href="#dfn-user-agent" class="internalDFN">user agent</a> can <dfn id="dfn-terminate-an-existing-upnp-events-subscription">terminate an existing UPnP Events Subscription</dfn> at any time for any
+ <var>active service</var> in the <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a> by sending an <abbr title="Hypertext Transfer Protocol">HTTP</abbr> UNSUBSCRIBE
+ request - as defined in 'Section 4.1.4: Cancelling a subscription with UNSUBSCRIBE' in [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>]
+ - with a HOST header set to that <var>active service</var>'s <code>eventsUrl</code> property and a SID header
+ set to the <var>callback ID</var> obtained when the initial <a href="#dfn-setup-a-upnp-events-subscription" class="internalDFN">setup a UPnP Events Subscription</a> action
+ occurred.
+ </p>
+ </section>
+ <section id="network-topology-monitoring">
+ <h3><span class="secno">7.3 </span>
+ Network Topology Monitoring
+ </h3>
+ <div>
<p>
- The <dfn id="dom-networkservice-id"><code>id</code></dfn> attribute is a unique identifier for the service. Two services provided at different times or on different objects <em title="must" class="rfc2119">must</em> have the same <a href="#dom-networkservice-id"><code>id</code></a> value.
- </p>
-
- <p>
- The <dfn id="dom-networkservice-name"><code>name</code></dfn> attribute represents a human-readable title for the service.
- </p>
-
- <p>
- The <dfn id="dom-networkservice-type"><code>type</code></dfn> attribute reflects the value of the <a class="internalDFN" href="#dfn-valid-service-type">valid service type</a> of the service.
- </p>
-
- <p>
- The <dfn id="dom-networkservice-url"><code>url</code></dfn> attribute is an <a href="http://www.w3.org/TR/html5/urls.html#absolute-url" class="externalDFN">absolute <abbr title="Uniform Resource Locator">URL</abbr></a> pointing to the root <abbr title="Hypertext Transfer Protocol">HTTP</abbr>
- endpoint for the service that has been added to the <a class="internalDFN" href="#dfn-entry-script-origin-s-url-whitelist">entry script origin's <abbr title="Uniform Resource Locator">URL</abbr> whitelist</a>. Web pages can subsequently use this value for implicit cross-document messaging via various existing mechanisms (e.g. Web Sockets, Server-Sent Events, Web Messaging, XMLHttpRequest).
- </p>
-
- <p>
- The <dfn id="dom-networkservice-config"><code>config</code></dfn> attribute provides the raw configuration information extracted from the given network service.
- </p>
-
- </section>
-
- <section id="states">
- <h3><span class="secno">6.2 </span>States</h3>
-
- <dl class="domintro">
- <dt>
- <var title="">service</var>
- .
- <code title="dom-networkservice-readystate">
- <a href="#dom-networkservice-readystate">readyState</a>
- </code>
- </dt>
- <dd>
- <p>
- Returns the current state.
+ When the <a href="#dfn-user-agent" class="internalDFN">user agent</a> detects that the user has dropped from their connected network then, for each
+ <var>existing service record</var> in the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>, the user agent
+ <em class="rfc2119" title="must">must</em> run the general rule for <a href="#dfn-removing-an-available-service" class="internalDFN">removing an available service</a> passing in each
+ <var>existing service record</var>'s <code>id</code> property as the only argument for each call.
</p>
- </dd>
- </dl>
-
- A <a href="#networkservice"><code>NetworkService</code></a> object can be in several states. The <dfn id="dom-networkservice-readystate"><code>readyState</code></dfn> attribute <em title="must" class="rfc2119">must</em> return the current state of the networked service,
- which <em title="must" class="rfc2119">must</em> be one of the following values:
-
- <dl>
- <dt>
- <dfn id="dom-networkservice-AVAILABLE" title="dom-networkservice-AVAILABLE">
- <code>AVAILABLE</code>
- </dfn>
- (numeric value
- 1)
-
-
- </dt>
- <dd>
- <p>The object is connected to its service endpoint.
-
- </p>
- </dd>
- <dt>
- <dfn id="dom-networkservice-UNAVAILABLE" title="dom-networkservice-UNAVAILABLE">
- <code>UNAVAILABLE</code>
- </dfn>
- (numeric value
- 2)
- </dt>
- <dd>
- <p>The object is not connected to its service endpoint.
- </p>
- </dd>
- </dl>
-
+ <p>
+ When the <a href="#dfn-user-agent" class="internalDFN">user agent</a> detects that the user has connected to a new network or reconnected to an
+ existing network, then it <em class="rfc2119" title="should">should</em> restart its discovery mechanisms as defined in the
+ <a href="#service-discovery">Service Discovery</a> section of this specification, maintaining the existing
+ <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a> currently in use.
+ </p>
+ </div>
</section>
-
- <section id="events-1">
- <h3><span class="secno">6.3 </span>Events</h3>
-
+ </section>
+ <section id="events-summary">
+ <!--OddPage--><h2><span class="secno">8. </span>
+ Events Summary
+ </h2>
<p>
- The following are the event handlers (and their corresponding event handler event types) that must be supported, as IDL attributes, by all objects implementing the
- <a href="#networkservice"><code>NetworkService</code></a> interface:
- </p>
-
- <table border="1">
+ The following events are dispatched on the <a href="#networkservices"><code>NetworkServices</code></a> and/or
+ <a href="#networkservice"><code>NetworkService</code></a> objects:
+ </p>
+ <table border="1">
<thead>
<tr>
<th>
- <span title="event handlers">Event handler</span>
+ <span>Event name</span>
</th>
<th>
- <span>Event handler event type</span>
+ <span>Interface</span>
+ </th>
+ <th>
+ <span>Dispatched when...</span>
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
- <dfn id="dom-networkservice-onmessage" title="dom-NetworkService-onmessage">
- <code>onmessage</code>
- </dfn>
+ <dfn id="event-serviceavailable"><code>serviceavailable</code></dfn>
</td>
<td>
- <code title="event-message">message</code>
+ <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event" class="externalDFN"><code>Event</code></a>
+ </td>
+ <td>
+ When a new service that matches one of the <a>requested type tokens</a> is found in the current network.
</td>
</tr>
<tr>
<td>
- <dfn id="dom-networkservice-onreadystatechange" title="dom-NetworkService-onreadystatechange">
- <code>onreadystatechange</code>
- </dfn>
+ <dfn id="event-serviceunavailable"><code>serviceunavailable</code></dfn>
</td>
<td>
- <code title="event-onreadystatechange">readystatechange</code>
+ <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event" class="externalDFN"><code>Event</code></a>
+ </td>
+ <td>
+ When an existing service that matches one of the <a>requested type tokens</a> gracefully leaves or
+ expires from the current network.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="event-serviceonline"><code>serviceonline</code></dfn>
+ </td>
+ <td>
+ <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event" class="externalDFN"><code>Event</code></a>
+ </td>
+ <td>
+ When a current service renews its service registration within the current network.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="event-serviceoffline"><code>serviceoffline</code></dfn>
+ </td>
+ <td>
+ <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event" class="externalDFN"><code>Event</code></a>
+ </td>
+ <td>
+ When a current service gracefully leaves or otherwise expires from the current network.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="event-notify"><code>notify</code></dfn>
+ </td>
+ <td>
+ <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event" class="externalDFN"><code>Event</code></a>
+ </td>
+ <td>
+ When a valid UPnP Events Subscription Message is received on a <a href="#dfn-user-agent-generated-callback-url" class="internalDFN">user-agent generated callback url</a>
+ for a current service. This event never fires for Zeroconf-based services.
</td>
</tr>
</tbody>
</table>
-
- <p>
- Events with an event type of <code>message</code> defined in this specification are <a href="http://dev.w3.org/html5/postmsg/#messageevent" class="externalDFN"><code>MessageEvent</code></a> objects as defined in [<cite><a href="#bib-POSTMSG" class="bibref">POSTMSG</a></cite>].
- </p>
-
- <p>
- Events with an event type of <code>readystatechange</code> defined in this specification are simple <code>Event</code> objects.
- </p>
-
- </section>
- </section>
-
- <section id="service-discovery">
- <!--OddPage--><h2><span class="secno">7. </span>Service Discovery</h2>
-
+ </section>
+ <section id="garbage-collection">
+ <!--OddPage--><h2><span class="secno">9. </span>
+ Garbage collection
+ </h2>
<p>
- A <a class="internalDFN" href="#dfn-user-agent">user agent</a> conforming to this specification <em title="may" class="rfc2119">may</em> implement <abbr title="Simple Service Discovery Protocol">SSDP</abbr> [<cite><a href="#bib-UPNP-DEVICEARCH11" class="bibref">UPNP-DEVICEARCH11</a></cite>] and Zeroconf [<cite><a href="#bib-ZEROCONF" class="bibref">ZEROCONF</a></cite>] service discovery mechanisms
- to enable Web pages to request and connect with <abbr title="Hypertext Transfer Protocol">HTTP</abbr> services running on networked devices, discovered via either mechanism, through this <abbr title="Application Programming Interface">API</abbr>. When a <a class="internalDFN" href="#dfn-user-agent">user agent</a> implements either of these service discovery mechanisms, then it <em title="must" class="rfc2119">must</em> conform to the corresponding algorithms provided in this section of the specification.
- </p>
- <p>
- This section presents how the results of these two service discovery
- mechanisms will be matched to requested service types and how their properties will be applied to any resulting <a href="#networkservice"><code>NetworkService</code></a> objects.
- </p>
-
- <p>
- It is expected that user agents will perform these service discovery mechansisms asynchronously and periodically update the <a>list of networked devices</a> as required. The timing of any
- service discovery mechanisms is an implementation detail left to the discretion of the implementer (e.g. once on user agent start-up, every X seconds during user agent execution or on
- invocation of this <abbr title="Application Programming Interface">API</abbr> from a Web page).
- </p>
-
- <p>
- The <dfn id="dfn-list-of-available-service-records">list of available service records</dfn> is a single dynamic internal lookup table within user agents that is used to track the current services available in the network at any given time.
- At any point during the running of either of the two service discovery mechanisms then existing entries within this table can be updated, entries can be added and entries can be removed as the status of networked
- services changes. Each record contained within this table contains the attributes: <code>id</code>, <code>name</code>, <code>type</code>, <code>url</code> and <code>config</code>.
+ Only when the user navigates away from the current browsing context can <a href="#networkservice" class="internalDFN"><code>NetworkService</code></a>
+ objects be garbage-collected, its records in the <a href="#dfn-entry-script-origin-s-url-whitelist" class="internalDFN">entry script origin's <abbr title="Uniform Resource Locator">URL</abbr> whitelist</a> be removed and its
+ corresponding entry in the <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a> be removed according to passing each
+ expired object identifier through the rule for <a href="#dfn-removing-an-available-service" class="internalDFN">removing an available service</a>.
</p>
-
- <section id="zeroconf-mdns-dns-sd">
- <h3><span class="secno">7.1 </span>Zeroconf (<abbr title="Multicast DNS">mDNS</abbr> + <abbr title="Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr>)</h3>
-
- <p>
- For each <abbr title="Domain Name System">DNS</abbr> response received from a user-agent-initiated Multicast <abbr title="Domain Name System">DNS</abbr> Browse for <abbr title="DNS Pointer Record">PTR</abbr> records with the name <code>_services._dns-sd._udp</code> on the resolved recommended automatic browsing
- domain [<cite><a href="#bib-MDNS" class="bibref">MDNS</a></cite>], the <a class="internalDFN" href="#dfn-user-agent">user agent</a> <em title="must" class="rfc2119">must</em> run the following steps:
- </p>
-
- <ol class="rule">
-
- <li>Let <var>service <abbr title="Multicast DNS">mDNS</abbr> responses</var> be an array of <abbr title="DNS Pointer Record">PTR</abbr> records received by issuing a Multicast <abbr title="Domain Name System">DNS</abbr> Browse for <abbr title="DNS Pointer Record">PTR</abbr> records with the name of the current discovered service type.</li>
-
- <li>For each Object <var>service <abbr title="Multicast DNS">mDNS</abbr> response</var> in <var>service <abbr title="Multicast DNS">mDNS</abbr> responses</var>, run the following steps:
- <ol>
-
- <li>
- Let <var>network service record</var> be an Object consisting of the following empty properties: <code>id</code>, <code>name</code>, <code>type</code>, <code>url</code>, <code>config</code>.
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>id</code> property to the value of the full <abbr title="DNS Pointer Record">PTR</abbr> Service Instance Name [<cite><a href="#bib-MDNS" class="bibref">MDNS</a></cite>].
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>name</code> property to the value of the <abbr title="DNS Pointer Record">PTR</abbr> Service Instance Name's <var>Instance</var> component [<cite><a href="#bib-MDNS" class="bibref">MDNS</a></cite>].
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>type</code> property to the concatenation of the string <code>zeroconf:</code> followed by the value of the <abbr title="DNS Pointer Record">PTR</abbr> Service Instance Name's <var>Service</var> component [<cite><a href="#bib-MDNS" class="bibref">MDNS</a></cite>].
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>url</code> property to the resolvable Service <abbr title="Uniform Resource Locator">URL</abbr> obtained from performing an <abbr title="Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr> Lookup [<cite><a href="#bib-DNS-SD" class="bibref">DNS-SD</a></cite>] of the current service from the <abbr title="DNS Pointer Record">PTR</abbr> record provided [<cite><a href="#bib-MDNS" class="bibref">MDNS</a></cite>].
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>config</code> property to the string value of the contents of the first <abbr title="Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr> TXT record associated with the <var>service <abbr title="Multicast DNS">mDNS</abbr> response</var> as defined in [<cite><a href="#bib-DNS-SD" class="bibref">DNS-SD</a></cite>].
- </li>
-
- <li>
- For each Object <var>existing service record</var> in the current <a class="internalDFN" href="#dfn-list-of-available-service-records">list of available service records</a>, run the following sub-steps:
- <ol class="rule">
-
- <li>
- If the <var>existing service record</var>'s <code>id</code> property matches the value of the <var>network service record</var>'s <code>id</code>, then set the
- value of <var>existing service record</var> in the current <a class="internalDFN" href="#dfn-list-of-available-service-records">list of available service records</a> to the value of the
- <var>network service record</var> and skip the next step.
- </li>
- </ol>
- </li>
-
- <li>
- Add <var>network service record</var> to the <a class="internalDFN" href="#dfn-list-of-available-service-records">list of available service records</a>.
- </li>
-
- <li>
- For each non-garbage collected <a href="#networkservice"><code>NetworkService</code></a> object run the following steps:
-
- <ol class="rule">
- <li>
- If the <a href="#networkservice"><code>NetworkService</code></a> object's <code>type</code> attribute does not equal the
- current <a>network service record</a>'s <code>type</code> property then continue at the next available active
- <a href="#networkservice"><code>NetworkService</code></a> object.
- </li>
- <li>
- Increment the <code>servicesAvailable</code> attribute of the <a href="#networkservices"><code>NetworkServices</code></a> object by <code>1</code>.
- </li>
- </ol>
- </li>
- </ol>
- </li>
- </ol>
-
- </section>
-
- <section id="universal-plug-and-play-upnp">
- <h3><span class="secno">7.2 </span>Universal Plug-and-Play (<abbr title="Universal Plug-and-Play">UPnP</abbr>)</h3>
-
- <p>
- For each <abbr title="Simple Service Discovery Protocol">SSDP</abbr> Presence Announcement [<cite><a href="#bib-UPNP-DEVICEARCH11" class="bibref">UPNP-DEVICEARCH11</a></cite>] - a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> NOTIFY request - received from a user-agent-initiated <abbr title="Simple Service Discovery Protocol">SSDP</abbr> Discovery Request [<cite><a href="#bib-UPNP-DEVICEARCH11" class="bibref">UPNP-DEVICEARCH11</a></cite>], the <a class="internalDFN" href="#dfn-user-agent">user agent</a> <em title="must" class="rfc2119">must</em> run the following steps:
- </p>
-
- <ol class="rule">
- <li>
- Let <var>ssdp device</var> be an Object with a property for each <abbr title="Hypertext Transfer Protocol">HTTP</abbr> header received in the received <abbr title="Simple Service Discovery Protocol">SSDP</abbr> Presence Announcement, with each key being the name of a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> header and its
- value being that <abbr title="Hypertext Transfer Protocol">HTTP</abbr> header's accompanying value.
- </li>
-
- <li>
- If <var>ssdp device</var> does not contain at least one <var>NTS</var>, <var>USN</var> and <var>Location</var> parameter, then the <a class="internalDFN" href="#dfn-user-agent">user agent</a> <em title="must" class="rfc2119">must</em> abort these steps.
- </li>
-
- <li>
- If the first occurrence of <var>NTS</var> has a value other than <code>ssdp:alive</code>, then continue to the step labeled <var>update service monitor</var> below.
- </li>
-
- <li>
- Let <var>root device descriptor file</var> contain the contents of the file located at the <abbr title="Uniform Resource Locator">URL</abbr> provided in the first occurrence of <var>Location</var> obtained according to the rules
- defined in the section 'Retrieving a description using <abbr title="Hypertext Transfer Protocol">HTTP</abbr>' [<cite><a href="#bib-UPNP-DEVICEARCH11" class="bibref">UPNP-DEVICEARCH11</a></cite>].
- </li>
-
- <li>
- If <var>root device descriptor file</var> is empty, then the <a class="internalDFN" href="#dfn-user-agent">user agent</a> <em title="must" class="rfc2119">must</em> abort these steps.
- </li>
-
- <li>
- Let <var>advertised services</var> be a <a>list of all advertised services</a> obtained from the <var>root device descriptor file</var> containing all sub-nodes of the <code>serviceList</code> node as described in
- the section 'Device Description' [<cite><a href="#bib-UPNP-DEVICEARCH11" class="bibref">UPNP-DEVICEARCH11</a></cite>].
- </li>
-
- <li>
- For each Object <var>advertised service</var> in <var>advertised services</var> run the following steps:
- <ol class="rule">
-
- <li>
- Let <var>network service record</var> be an Object consisting of the following empty properties: <code>id</code>, <code>name</code>, <code>type</code>, <code>url</code>, <code>eventsUrl</code>, <code>config</code>.
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>id</code> property to the string value of the first occurrence of <var>ssdp device</var>'s <var>USN</var> parameter.
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>name</code> property to the string value of the first occurrence of the <var>service</var>'s <code>serviceId</code> property.
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>type</code> property to the concatenation of the string <code>upnp:</code> followed by the string value of the first occurrence of the <var>service</var>'s <code>serviceType</code> property.
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>url</code> property to the string value of the first occurrence of the <var>service</var>'s <code>controlURL</code> property.
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>config</code> property to the string value of the first occurrence of the <var>device</var> property.
- </li>
-
- <li>
- If <var>service</var>'s <code>eventSubURL</code> property is empty, then continue to the step labeled <em>register</em> below.
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>eventsUrl</code> property to the string value of the first occurrence of the <var>service</var>'s <code>eventSubURL</code> property.
- </li>
-
- <li>
- <em>Register</em>: For each Object <var>existing service record</var> in the current <a class="internalDFN" href="#dfn-list-of-available-service-records">list of available service records</a>, run the following sub-steps:
- <ol class="rule">
-
- <li>
- If the <var>existing service record</var>'s <var>id</var> property matches the value of the first occurrence of <var>USN</var> and the
- <var>existing service record</var>'s <code>type</code> property matches the value of <var>network service record</var>'s <code>type</code>, then set the
- value of <var>existing service record</var> in the current <a class="internalDFN" href="#dfn-list-of-available-service-records">list of available service records</a> to the value of the
- <var>network service record</var> and skip the next step.
- </li>
- </ol>
- </li>
-
- <li>
- Add <var>network service record</var> to the <a class="internalDFN" href="#dfn-list-of-available-service-records">list of available service records</a>.
- </li>
-
- </ol>
+ </section>
+ <section id="use-cases-and-requirements">
+ <!--OddPage--><h2><span class="secno">10. </span>
+ Use Cases and Requirements
+ </h2>
+ <p>
+ This section covers what the requirements are for this <abbr title="Application Programming Interface">API</abbr>, as well as illustrates some use cases.
+ </p>
+ <ul class="rule">
+ <li>Once a user has given permission, user agents should provide the ability for Web pages to communicate
+ directly with a Local-networked Service.
+ <ul class="rule">
+ <li>Example: A web-based TV remote control. A Web page wants to control the current user's TV, changing the
+ programming shown or increasing/decreasing/muting the volume of the Local-networked Device. The Web page
+ requests a service type that is known to be implemented by television sets to which it has the application
+ logic to communicate. Local devices providing the request service types are discovered and presented to the
+ user for authorization. The user selects one or more of the discovered television sets to be accessible to
+ the current Web page and then clicks 'Share'. The Web page can now communicate directly with the
+ user-authorized Local-networked services.
</li>
- <li>
- <em>Update Service Monitor</em>: For each non-garbage collected <a href="#networkservice"><code>NetworkService</code></a> object run the following steps:
-
- <ol class="rule">
- <li>
- If this <a href="#networkservice"><code>NetworkService</code></a> object's <code>type</code> attribute does not equal the
- current <a>network service record</a>'s <code>type</code> property then continue at the next available active
- <a href="#networkservice"><code>NetworkService</code></a> object.
- </li>
- <li>
- If the <var>announcement type</var> equals <code>ssdp:alive</code> then Increment the <code>servicesAvailable</code> attribute of the <a href="#networkservices"><code>NetworkServices</code></a>
- object by <code>1</code>. Otherwise, decrement the <code>servicesAvailable</code> attribute of the <a href="#networkservices"><code>NetworkServices</code></a>
- object by <code>1</code>.
- </li>
- </ol>
- </li>
- </ol>
-
- <p>
- A <dfn id="dfn-user-agent-generated-callback-url">user-agent generated callback url</dfn> is a Local-network accessible <abbr title="Uniform Resource Locator">URL</abbr> endpoint that a <a class="internalDFN" href="#dfn-user-agent">user agent</a> must generate and maintain for receiving <abbr title="Hypertext Transfer Protocol">HTTP</abbr> NOTIFY requests from <abbr title="Universal Plug-and-Play">UPnP</abbr> Event sources.
- </p>
-
- <p>When the <a class="internalDFN" href="#dfn-user-agent">user agent</a> is to <dfn id="dfn-setup-a-upnp-events-subscription">setup a <abbr title="Universal Plug-and-Play">UPnP</abbr> Events Subscription</dfn>, it is to run the following steps with the current <var>network service record</var> object:</p>
-
- <ol class="rule">
- <li>
- If <var>network service record</var>'s <code>eventsUrl</code> property is empty then the <a class="internalDFN" href="#dfn-user-agent">user agent</a> <em title="must" class="rfc2119">must</em> abort these steps.
- </li>
-
- <li>
- Let <var>callback <abbr title="Uniform Resource Locator">URL</abbr></var> be the value of creating a new <a class="internalDFN" href="#dfn-user-agent-generated-callback-url">user-agent generated callback url</a>.
- </li>
-
- <li>
- Send a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> SUBSCRIBE request with a <em>NT</em> header with a string value of <code>upnp:event</code>, a <em>TIMEOUT</em> header with an integer value of
- <code>86400</code> and a <em>CALLBACK</em> header
- with a string value of <var>callback <abbr title="Uniform Resource Locator">URL</abbr></var> towards the <var>network service record</var>'s <code>eventsUrl</code> property.
- </li>
-
- <li>
- If a non-200 OK response is received from the <abbr title="Hypertext Transfer Protocol">HTTP</abbr> SUBSCRIBE request then the <a class="internalDFN" href="#dfn-user-agent">user agent</a> <em title="must" class="rfc2119">must</em> abort these steps.
- </li>
-
- <li>
- On receiving a valid 200 OK response, run the following steps:
-
- <ol class="rule">
- <li>
- Let <var>callback ID</var> equal the string value of the first included <em>SID</em> header, if it exists.
- </li>
- <li>
- Let <var>timeout date</var> equal the sum of the current UTC date value plus the integer value of the first included <em>TIMEOUT</em> header, if it exists.
- </li>
- <li>
- Run the following steps aynchronously and continue to the step labeled <em>listen</em> below.
- </li>
- <li>
- <em>Refresh Subscription</em>: Run the following steps at a set interval (X) within the <a class="internalDFN" href="#dfn-user-agent">user agent</a>:
-
- <ol class="rule">
- <li>
- Let <var>current date</var> equal the current UTC date.
- </li>
- <li>
- If <var>current date</var> is less than the <var>timeout date</var> then continue to the step labeled <em>refresh subscription</em> above.
- </li>
- <li>
- Send a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> SUBSCRIBE request with a <em>SID</em> header with the string value of <var>callback ID</var> and a <em>TIMEOUT</em> header
- with an integer value of <code>86400</code> towards the <var>network service record</var>'s <code>eventsUrl</code> property.
- </li>
- <li>
- On receiving a valid 200 OK, update <var>callback ID</var> with the string value of the first included <em>SID</em> header, if it exists. All other <abbr title="Hypertext Transfer Protocol">HTTP</abbr>
- responses should cause the <a class="internalDFN" href="#dfn-user-agent">user agent</a> to continue from the step labeled <em>refresh subscription</em> above.
- </li>
- </ol>
-
- </li>
-
- <li>
- <em>Listen</em>: For each <abbr title="Hypertext Transfer Protocol">HTTP</abbr> NOTIFY request received at the <var>callback <abbr title="Uniform Resource Locator">URL</abbr></var> the <a class="internalDFN" href="#dfn-user-agent">user agent</a> is to run the following steps:
-
- <ol class="rule">
- <li>
- Let <var>content clone</var> be the result of obtaining the message body of the <abbr title="Hypertext Transfer Protocol">HTTP</abbr> NOTIFY request. If <var>content clone</var> is empty, then the <a class="internalDFN" href="#dfn-user-agent">user agent</a> <em title="must" class="rfc2119">must</em> abort these steps.
- </li>
- <li>
- Create a new <code>message</code> event that uses the <a href="http://dev.w3.org/html5/postmsg/#messageevent" class="externalDFN"><code>MessageEvent</code></a> interface [<cite><a href="#bib-POSTMSG" class="bibref">POSTMSG</a></cite>], with the name <code>message</code>,
- which does not bubble, is not cancelable, and has no default action.
- </li>
- <li>
- Let the <code>data</code> attribute of the event have the DOMString value of <var>content clone</var>.
- </li>
- <li>
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">Queue a task</a> to
- dispatch the newly created event at the current <a class="internalDFN" href="#networkservice"><code>NetworkService</code></a> object.
- </li>
- </ol>
- </li>
-
- </ol>
-
+ </ul>
+ </li>
+ <li>Web pages should be able to communicate with Local-networked Services using the messaging channel supported
+ by those Devices.
+ <ul class="rule">
+ <li>Example: A Web page advertises that it is capable of controlling multiple Home Media Servers. The user
+ can select their Home Media Server type from a drop-down list, at which point the Web page sends a request
+ to the user agent to connect with the associated service type of the Home Media Server. The Media Server
+ selected implements a Web Socket channel for bi-directional service communication and so the Web page opens
+ a web socket to the requested Media Server and can communicate as required via that appropriate channel.
</li>
- </ol>
-
- </section>
-
- <section id="network-topology-monitoring">
- <h3><span class="secno">7.3 </span>Network Topology Monitoring</h3>
-
- <div>
- <p>
- When the <a class="internalDFN" href="#dfn-user-agent">user agent</a> detects that the user has dropped from their connected network, then it <em title="must" class="rfc2119">must</em> run the following steps:
- </p>
-
- <ol class="rule">
- <li>
- Flush all entries from the <a class="internalDFN" href="#dfn-list-of-available-service-records">list of available service records</a>.
- </li>
- <li>
- For each <a href="#networkservice"><code>NetworkService</code></a> object currently active in the <a class="internalDFN" href="#dfn-user-agent">user agent</a> perform the following steps:
-
- <ol class="rule">
- <li>
- Set the <a href="#dom-networkservice-readystate"><code>readyState</code></a> attribute to <code>2</code> (<a href="#dom-networkservice-UNAVAILABLE"><code>UNAVAILABLE</code></a>).
- </li>
- <li>
- Create a new <code>readystatechange</code> event that uses the <code>Event</code> interface which does not bubble, is not cancelable, and has no default action.
- </li>
- <li>
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">Queue a task</a> to
- dispatch the newly created event at the <a href="#networkservice"><code>NetworkService</code></a> object.
- </li>
- </ol>
- </li>
- </ol>
-
- <p>
- When the <a class="internalDFN" href="#dfn-user-agent">user agent</a> detects that the user has connected to a new network, then it <em title="should" class="rfc2119">should</em> run the following steps:
- </p>
-
- <ol class="rule">
- <li>
- Re-issue an <abbr title="Multicast DNS">mDNS</abbr> search and <abbr title="Simple Service Discovery Protocol">SSDP</abbr> discovery search and handle the responses according to the processing defined in <a href="#service-discovery">Section 6: Service Discovery</a>.
- </li>
- </ol>
- </div>
- </section>
- </section>
-
- <section id="garbage-collection">
- <!--OddPage--><h2><span class="secno">8. </span>Garbage collection</h2>
-
- <p>
- A <a class="internalDFN" href="#networkservice"><code>NetworkService</code></a> object containing a <code>url</code> parameter currently in the <a class="internalDFN" href="#dfn-entry-script-origin-s-url-whitelist">entry script origin's <abbr title="Uniform Resource Locator">URL</abbr> whitelist</a> <em title="must not" class="rfc2119">must not</em> be garbage collected.
- </p>
-
- <p>
- Only when the user navigates away from the current browsing context can <a class="internalDFN" href="#networkservice"><code>NetworkService</code></a> objects be garbage-collected and records in the <a class="internalDFN" href="#dfn-entry-script-origin-s-url-whitelist">entry script origin's <abbr title="Uniform Resource Locator">URL</abbr> whitelist</a> be removed.
- </p>
-
- </section>
-
-
- <section id="use-cases-and-requirements">
- <!--OddPage--><h2><span class="secno">9. </span>Use Cases and Requirements</h2>
-
- <p>This section covers what the requirements are for this <abbr title="Application Programming Interface">API</abbr>, as well as illustrates some use cases.</p>
-
- <ul class="rule">
- <li>
- Once a user has given permission, user agents should provide the ability for Web pages to communicate directly with a Local-networked Service.
- <ul class="rule">
- <li>
- Example: A web-based TV remote control. A Web page wants to control the current user's TV, changing the programming shown or increasing/decreasing/muting the
- volume of the Local-networked Device. The Web page requests a service type that is known to be implemented by television sets to which it has the
- application logic to communicate. Local devices providing the request service types are discovered and presented to the user for authorization. The user selects one
- or more of the discovered television sets to be accessible to the current Web page and then clicks 'Share'. The Web page can now communicate directly with
- the user-authorized Local-networked services.
- </li>
- </ul>
- </li>
-
- <li>
- Web pages should be able to communicate with Local-networked Services using the messaging channel supported by those Devices.
- <ul class="rule">
- <li>
- Example: A Web page advertises that it is capable of controlling multiple Home Media Servers. The user can select their Home Media Server type from a drop-down list, at which point the
- Web page sends a request to the user agent to connect with the associated service type of the Home Media Server. The Media Server selected implements a Web Socket channel for
- bi-directional service communication and so the Web page opens a web socket to the requested Media Server and can communicate as required via that appropriate channel.
+ </ul>
+ </li>
+ <li>Web pages should be able to communicate with Local-networked Services using the messaging format supported
+ by those Devices.
+ <ul class="rule">
+ <li>Example: A Web page advertises that it is capable of interacting with and controlling multiple types of
+ Home Media Server. The user can select their Home Media Server type from a drop-down list or known Media
+ Servers, at which point the Web page sends a request to the user agent to connect with the associated
+ service type (and, optionally, the associated event type) of the Home Media Server. The communication
+ protocols supported by Home Media Servers typically vary between UPnP, JSON-RPC, Protocol Buffers or other
+ messaging formats depending on the Home Media Server requested. The Web page is able to communicate with
+ the user-selected Home Media Server in the messaging format supported by that Device, which, in this
+ example is a simple key/value pair text format.
</li>
- </ul>
- </li>
-
- <li>
- Web pages should be able to communicate with Local-networked Services using the messaging format supported by those Devices.
- <ul class="rule">
- <li>
- Example: A Web page advertises that it is capable of interacting with and controlling multiple types of Home Media Server. The user can select their Home Media Server type from a drop-down list or known Media Servers, at which point the
- Web page sends a request to the user agent to connect with the associated service type (and, optionally, the associated event type) of the Home Media Server. The communiciation protocols supported by Home Media Servers typically vary
- between <abbr title="Universal Plug-and-Play">UPnP</abbr>, JSON-RPC, Protocol Buffers or other messaging formats depending on the Home Media Server requested. The Web page is able to communicate with the user-selected Home Media
- Server in the messaging format supported by that Device, which, in this example is a simple key/value pair text format.
+ </ul>
+ </li>
+ <li>Web pages should not be able to communicate with Local-networked Services that have not been authorized by
+ the user thereby maintaining the user's privacy.
+ <ul class="rule">
+ <li>Example: A Web page requests access to one type of Local-networked service. The user authorizes access
+ to that particular service. Other services running on that same device, and on other devices within the
+ network, should not be accessible to the current Web page.
</li>
- </ul>
- </li>
-
- <li>
- Web pages should not be able to communicate with Local-networked Services that have not been authorized by the user thereby maintaining the user's privacy.
- <ul class="rule">
- <li>
- Example: A Web page requests access to one type of Local-networked service. The user authorizes access to that particular service. Other services running on that same device, and on other devices
- within the network, should not be accessible to the current Web page.
+ </ul>
+ </li>
+ <li>A user should be able to share one or more Local-networked Services based on a particular service type
+ request from a Web page.
+ <ul class="rule">
+ <li>Example: A Web page is capable of interacting with a specific profile of Local-networked Service. As
+ such, it makes a request to the user agent to access those services, of which multiple matches are found.
+ The user is capable of selecting one or more of the discovered services to share with the Web page. The Web
+ page can then implement a drag-and-drop interface for the user to drag specific actions on to one or more
+ of the authorized Local-networked Services.
</li>
- </ul>
- </li>
-
- <li>
- A user should be able to share one or more Local-networked Services based on a particular service type request from a Web page.
- <ul class="rule">
- <li>
- Example: A Web page is capable of interacting with a specific profile of Local-networked Service. As such, it makes a request to the user agent to access those services, of which multiple matches
- are found. The user is capable of selecting one or more of the discovered services to share with the Web page. The Web page can then implement a drag-and-drop interface for the user to drag specific
- actions on to one or more of the authorized Local-networked Services.
- </li>
- </ul>
- </li>
-
- <li>
- User agents should provide an <abbr title="Application Programming Interface">API</abbr> exposed to script that exposes the features above. The user is notified by UI anytime interaction with Local-networked Services is requested, giving the user
- full ability to cancel or abort the transaction. The user selects the Local-networked Services to be connected to the current Web page, and can cancel these at any time. No invocations to
- these APIs occur silently without user intervention.
- </li>
+ </ul>
+ </li>
+ <li>User agents should provide an <abbr title="Application Programming Interface">API</abbr> exposed to script that exposes the features above. The user is notified
+ by UI anytime interaction with Local-networked Services is requested, giving the user full ability to cancel or
+ abort the transaction. The user selects the Local-networked Services to be connected to the current Web page,
+ and can cancel these at any time. No invocations to these APIs occur silently without user intervention.
+ </li>
</ul>
</section>
-
- <section id="examples" class="informative appendix">
- <!--OddPage--><h2><span class="secno">A. </span>Examples</h2><p><em>This section is non-normative.</em></p>
-
- <div class="example">
- <p>This sample code exposes a button. When clicked, this button is disabled and the user is prompted to offer a network service. The user may also select multiple network services. When the user has authorized a network service to be connected to the web page then the web page issues a simple command to get a list of all the albums stored on the connected media player service.
- </p><p>The button is re-enabled only when the connected network service disconnects for whatever reason (the service becomes unavailable on the network, the user disconnects from their current network or the user revokes access to the service from the current web page). At this point the user can re-click the button to select a new network service to connect to the web page and the above steps are repeated.</p>
- <p>The provided service type identifier and service interaction used in this example is based on the well-defined service type and messaging format supported by the <a href="http://xbmc.org/about/">XBMC Media Server</a>. </p>
- <hr>
- <pre class="highlight prettyprint"><span class="tag"><input</span><span class="pln"> </span><span class="atn">type</span><span class="pun">=</span><span class="atv">"button"</span><span class="pln"> </span><span class="atn">value</span><span class="pun">=</span><span class="atv">"Start"</span><span class="pln"> </span><span class="atn">onclick</span><span class="pun">=</span><span class="atv">"</span><span class="pln">start</span><span class="pun">()</span><span class="atv">"</span><span class="pln"> </span><span class="atn">id</span><span class="pun">=</span><span class="atv">"startBtn"</span><span class="tag">/></span><span class="pln">
+ <section class="informative appendix" id="examples">
+ <!--OddPage--><h2><span class="secno">A. </span>
+ Examples
+ </h2><p><em>This section is non-normative.</em></p>
+ <div class="example">
+ <p>
+ This sample code exposes a button. When clicked, this button is disabled and the user is prompted to offer a
+ network service. The user may also select multiple network services. When the user has authorized a network
+ service to be connected to the web page then the web page issues a simple command to get a list of all the
+ albums stored on the connected media player service.
+ </p>
+ <p>
+ The button is re-enabled only when the connected network service disconnects for whatever reason (the service
+ becomes unavailable on the network, the user disconnects from their current network or the user revokes
+ access to the service from the current web page). At this point the user can re-click the button to select a
+ new network service to connect to the web page and the above steps are repeated.
+ </p>
+ <p>
+ The provided service type identifier and service interaction used in this example is based on the
+ well-defined service type and messaging format supported by the <a href="http://xbmc.org/about/">XBMC Media
+ Server</a>.
+ </p>
+ <hr>
+ <pre class="highlight prettyprint"><span class="tag"><input</span><span class="pln"> </span><span class="atn">type</span><span class="pun">=</span><span class="atv">"button"</span><span class="pln"> </span><span class="atn">value</span><span class="pun">=</span><span class="atv">"Start"</span><span class="pln"> </span><span class="atn">onclick</span><span class="pun">=</span><span class="atv">"</span><span class="pln">start</span><span class="pun">()</span><span class="atv">"</span><span class="pln"> </span><span class="atn">id</span><span class="pun">=</span><span class="atv">"startBtn"</span><span class="tag">/></span><span class="pln">
</span><span class="tag"><div</span><span class="pln"> </span><span class="atn">id</span><span class="pun">=</span><span class="atv">"debugconsole"</span><span class="tag">></div></span><span class="pln">
</span><span class="tag"><script></span><span class="pln">
@@ -1608,7 +1773,7 @@
navigator</span><span class="pun">.</span><span class="pln">getNetworkServices</span><span class="pun">(</span><span class="str">'zeroconf:_xbmc-jsonrpc._tcp'</span><span class="pun">,</span><span class="pln"> gotXBMCService</span><span class="pun">,</span><span class="pln"> error</span><span class="pun">);</span><span class="pln">
startBtn</span><span class="pun">.</span><span class="pln">disabled </span><span class="pun">=</span><span class="pln"> </span><span class="kwd">true</span><span class="pun">;</span><span class="pln">
</span><span class="pun">}</span><span class="pln"> </span><span class="kwd">else</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
- debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class="pln"> </span><span class="str">"<br>Service Discovery API not supported!"</span><span class="pun">;</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class="pln"> </span><span class="str">"<br>Service Discovery not supported!"</span><span class="pun">;</span><span class="pln">
</span><span class="pun">}</span><span class="pln">
</span><span class="pun">}</span><span class="pln">
@@ -1616,17 +1781,15 @@
</span><span class="com">// Listen for service disconnect messages</span><span class="pln">
- services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class="pln">addEventListener</span><span class="pun">(</span><span class="str">'readystatechange'</span><span class="pun">,</span><span class="pln"> </span><span class="kwd">function</span><span class="pln"> </span><span class="pun">(</span><span class="pln"> e </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
- </span><span class="kwd">if</span><span class="pun">(</span><span class="pln">services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class="pln">readyState </span><span class="pun">===</span><span class="pln"> services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class="pln">UNAVAILABLE</span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class="pln">addEventListener</span><span class="pun">(</span><span class="str">'serviceoffline'</span><span class="pun">,</span><span class="pln"> </span><span class="kwd">function</span><span class="pln"> </span><span class="pun">(</span><span class="pln"> e </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class="pln"> </span><span class="str">"<br>"</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class="pln">name </span><span class="pun">+</span><span class="pln"> </span><span class="str">" disconnected."</span><span class="pun">;</span><span class="pln">
startBtn</span><span class="pun">.</span><span class="pln">disabled </span><span class="pun">=</span><span class="pln"> </span><span class="kwd">false</span><span class="pun">;</span><span class="pln">
- </span><span class="pun">}</span><span class="pln">
</span><span class="pun">},</span><span class="pln"> </span><span class="kwd">false</span><span class="pun">);</span><span class="pln">
</span><span class="com">// Send a service message to get albums list (and process the service response)</span><span class="pln">
</span><span class="kwd">var</span><span class="pln"> svcXhr </span><span class="pun">=</span><span class="pln"> </span><span class="kwd">new</span><span class="pln"> </span><span class="typ">XMLHttpRequest</span><span class="pun">();</span><span class="pln">
- svcXhr</span><span class="pun">.</span><span class="pln">open</span><span class="pun">(</span><span class="str">"POST"</span><span class="pun">,</span><span class="pln"> services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class="pln">url </span><span class="pun">+</span><span class="pln"> </span><span class="str">"/getAlbums"</span><span class="pun">);</span><span class="pln"> </span><span class="com">// services[0].url and its subresources have been</span><span class="pln">
+ svcXhr</span><span class="pun">.</span><span class="pln">open</span><span class="pun">(</span><span class="str">"POST"</span><span class="pun">,</span><span class="pln"> services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class="pln">url </span><span class="pun">+</span><span class="pln"> </span><span class="str">"/getAlbums"</span><span class="pun">);</span><span class="pln"> </span><span class="com">// services[0].url and its sub-resources have been</span><span class="pln">
</span><span class="com">// whitelisted for cross-site XHR use in this</span><span class="pln">
</span><span class="com">// current browsing context.</span><span class="pln">
@@ -1655,18 +1818,21 @@
startBtn</span><span class="pun">.</span><span class="pln">disabled </span><span class="pun">=</span><span class="pln"> </span><span class="kwd">false</span><span class="pun">;</span><span class="pln">
</span><span class="pun">}</span><span class="pln">
</span><span class="tag"></script></span></pre>
- </div>
-
- <div class="example">
- <p>
- This sample exposes a drop-down list containing a number of common Home-based audio devices. When the user selects an audio device from the list provided, they are prompted to authorize a network service
- based on the service type requested. The user may also select multiple network services matching the selected service type.
- In this example, the user selects their make as being <var>Sony</var> and their model as being <var>Bravia S1000</var> from which the Web page can derive a service type
- (<var>urn:schemas-upnp-org:service:RenderingControl:1</var>).
- <br><br>Once the user has authorized the device, the web page sends a simple mute command according to the messaging format supported by the device.
- </p>
- <hr>
- <pre class="highlight prettyprint"><span class="tag"><select</span><span class="pln"> </span><span class="atn">name</span><span class="pun">=</span><span class="atv">"make"</span><span class="pln"> </span><span class="atn">id</span><span class="pun">=</span><span class="atv">"make"</span><span class="tag">></span><span class="pln">
+ </div>
+ <div class="example">
+ <p>
+ This sample exposes a drop-down list containing a number of common Home-based audio devices. When the user
+ selects an audio device from the list provided, they are prompted to authorize a network service based on the
+ service type requested. The user may also select multiple network services matching the selected service
+ type. In this example, the user selects their make as being <var>Sony</var> and their model as being
+ <var>Bravia S1000</var> from which the Web page can derive a service type
+ (<var>urn:schemas-upnp-org:service:RenderingControl:1</var>).<br>
+ <br>
+ Once the user has authorized the device, the web page sends a simple mute command according to the messaging
+ format supported by the device.
+ </p>
+ <hr>
+ <pre class="highlight prettyprint"><span class="tag"><select</span><span class="pln"> </span><span class="atn">name</span><span class="pun">=</span><span class="atv">"make"</span><span class="pln"> </span><span class="atn">id</span><span class="pun">=</span><span class="atv">"make"</span><span class="tag">></span><span class="pln">
</span><span class="tag"><option</span><span class="pln"> </span><span class="atn">selected</span><span class="pun">=</span><span class="atv">"selected"</span><span class="pln"> </span><span class="atn">disabled</span><span class="pun">=</span><span class="atv">"disabled"</span><span class="tag">></span><span class="pln">Select make</span><span class="tag"></option></span><span class="pln">
</span><span class="tag"><option></span><span class="pln">Sony</span><span class="tag"></option></span><span class="pln">
</span><span class="tag"><option></span><span class="pln">Philips</span><span class="tag"></option></span><span class="pln">
@@ -1721,9 +1887,9 @@
</span><span class="tag"><script></span><span class="pln">
</span><span class="kwd">function</span><span class="pln"> successCallback</span><span class="pun">(</span><span class="pln"> services </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
- </span><span class="com">// Listen for service push messages</span><span class="pln">
+ </span><span class="com">// Listen for service push notification messages</span><span class="pln">
- services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class="pln">addEventListener</span><span class="pun">(</span><span class="str">'message'</span><span class="pun">,</span><span class="pln"> </span><span class="kwd">function</span><span class="pln"> </span><span class="pun">(</span><span class="pln"> msg </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class="pln">addEventListener</span><span class="pun">(</span><span class="str">'notify'</span><span class="pun">,</span><span class="pln"> </span><span class="kwd">function</span><span class="pln"> </span><span class="pun">(</span><span class="pln"> msg </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class="pln"> </span><span class="str">"<br>"</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class="pln">name </span><span class="pun">+</span><span class="pln"> </span><span class="str">" event received: "</span><span class="pun">;</span><span class="pln">
debug</span><span class="pun">.</span><span class="pln">textContent </span><span class="pun">+=</span><span class="pln"> msg</span><span class="pun">.</span><span class="pln">data</span><span class="pun">;</span><span class="pln">
</span><span class="pun">},</span><span class="pln"> </span><span class="kwd">false</span><span class="pun">);</span><span class="pln">
@@ -1732,7 +1898,7 @@
</span><span class="kwd">var</span><span class="pln"> svcXhr </span><span class="pun">=</span><span class="pln"> </span><span class="kwd">new</span><span class="pln"> </span><span class="typ">XMLHttpRequest</span><span class="pun">();</span><span class="pln">
svcXhr</span><span class="pun">.</span><span class="pln">open</span><span class="pun">(</span><span class="str">"POST"</span><span class="pun">,</span><span class="pln"> services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class="pln">url</span><span class="pun">);</span><span class="pln"> </span><span class="com">// services[0].url and its</span><span class="pln">
- </span><span class="com">// subresources have been whitelisted for</span><span class="pln">
+ </span><span class="com">// sub-resources have been whitelisted for</span><span class="pln">
</span><span class="com">// cross-site XHR use in this current</span><span class="pln">
</span><span class="com">// browsing context.</span><span class="pln">
@@ -1768,30 +1934,33 @@
debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class="pln"> </span><span class="str">"<br>An error occurred: "</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> error</span><span class="pun">.</span><span class="pln">code</span><span class="pun">;</span><span class="pln">
</span><span class="pun">}</span><span class="pln">
</span><span class="tag"></script></span></pre>
- </div>
-
- </section>
-
+ </div>
+ </section>
<section id="acknowledgements">
- <!--OddPage--><h2><span class="secno">B. </span>Acknowledgements</h2>
-
- <p>Thanks are expressed by the editor to the following individuals for their feedback on this specification to date (in alphabetical order):
- <br><br>
- Gar Bergstedt, Lars-Erik Bolstad, Hari G Kumar, Bob Lund, Giuseppe Pascale, Marcin Simonides, Clarke Stevens, Christian Söderström, Mark Vickers, ...</p>
+ <!--OddPage--><h2><span class="secno">B. </span>
+ Acknowledgements
+ </h2>
+ <p>
+ Thanks are expressed by the editor to the following individuals for their feedback on this specification to
+ date (in alphabetical order):<br>
+ <br>
+ Gar Bergstedt, Lars-Erik Bolstad, Cathy Chan, Hari G Kumar, Bob Lund, Giuseppe Pascale, Marcin Simonides,
+ Clarke Stevens, Christian Söderström, Mark Vickers.
+ </p>
+ <p>
+ Thanks are also expressed by the editor to the following organizations and groups for their support in
+ producing this specification to date (in alphabetical order):<br>
+ <br>
+ CableLabs, Opera Software ASA, <abbr title="World Wide Web Consortium">W3C</abbr> Device APIs Working Group, <abbr title="World Wide Web Consortium">W3C</abbr> Web and TV Interest Group.
+ </p>
+ </section>
+
- <p>Thanks are also expressed by the editor to the following organizations and groups for their support in producing this specification to date (in alphabetical order):
- <br><br>
- CableLabs, Opera Software ASA, <abbr title="World Wide Web Consortium">W3C</abbr> Device APIs Working Group, <abbr title="World Wide Web Consortium">W3C</abbr> Web and TV Interest Group, ...</p>
- </section>
-
-
-<section class="appendix" id="references"><!--OddPage--><h2><span class="secno">C. </span>References</h2><section id="normative-references"><h3><span class="secno">C.1 </span>Normative references</h3><dl class="bibliography"><dt id="bib-DNS-SD">[DNS-SD]</dt><dd>S. Cheshire; M. Krochmal. <a href="http://files.dns-sd.org/draft-cheshire-dnsext-dns-sd.txt"><cite>DNS-Based Service Discovery.</cite></a> 27 February 2011. IETF Draft. URL: <a href="http://files.dns-sd.org/draft-cheshire-dnsext-dns-sd.txt">http://files.dns-sd.org/draft-cheshire-dnsext-dns-sd.txt</a>
+<section id="references" class="appendix"><!--OddPage--><h2><span class="secno">C. </span>References</h2><section id="normative-references"><h3><span class="secno">C.1 </span>Normative references</h3><dl class="bibliography"><dt id="bib-DNS-SD">[DNS-SD]</dt><dd>S. Cheshire; M. Krochmal. <a href="http://files.dns-sd.org/draft-cheshire-dnsext-dns-sd.txt"><cite>DNS-Based Service Discovery.</cite></a> 27 February 2011. IETF Draft. URL: <a href="http://files.dns-sd.org/draft-cheshire-dnsext-dns-sd.txt">http://files.dns-sd.org/draft-cheshire-dnsext-dns-sd.txt</a>
</dd><dt id="bib-DOM4">[DOM4]</dt><dd>Anne van Kesteren; Aryeh Gregor; Ms2ger. <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html/"><cite>DOM4.</cite></a> URL: <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html/">http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html/</a>
-</dd><dt id="bib-HTML5">[HTML5]</dt><dd>Ian Hickson; David Hyatt. <a href="http://www.w3.org/TR/html5"><cite>HTML5.</cite></a> 25 May 2011. W3C Working Draft. (Work in progress.) URL: <a href="http://www.w3.org/TR/html5">http://www.w3.org/TR/html5</a>
+</dd><dt id="bib-HTML5">[HTML5]</dt><dd>Ian Hickson; David Hyatt. <a href="http://www.w3.org/TR/html5"><cite>HTML5.</cite></a> 29 March 2012. W3C Working Draft. (Work in progress.) URL: <a href="http://www.w3.org/TR/html5">http://www.w3.org/TR/html5</a>
</dd><dt id="bib-MDNS">[MDNS]</dt><dd>S. Cheshire; M. Krochmal. <a href="http://files.multicastdns.org/draft-cheshire-dnsext-multicastdns.txt"><cite>Multicast DNS.</cite></a> 14 February 2011. IETF Draft. URL: <a href="http://files.multicastdns.org/draft-cheshire-dnsext-multicastdns.txt">http://files.multicastdns.org/draft-cheshire-dnsext-multicastdns.txt</a>
-</dd><dt id="bib-POSTMSG">[POSTMSG]</dt><dd>Ian Hickson. <a href="http://dev.w3.org/html5/postmsg"><cite>HTML5 Web Messaging.</cite></a> URL: <a href="http://dev.w3.org/html5/postmsg">http://dev.w3.org/html5/postmsg</a>
</dd><dt id="bib-RFC2119">[RFC2119]</dt><dd>S. Bradner. <a href="http://www.ietf.org/rfc/rfc2119.txt"><cite>Key words for use in RFCs to Indicate Requirement Levels.</cite></a> March 1997. Internet RFC 2119. URL: <a href="http://www.ietf.org/rfc/rfc2119.txt">http://www.ietf.org/rfc/rfc2119.txt</a>
</dd><dt id="bib-UPNP-DEVICEARCH11">[UPNP-DEVICEARCH11]</dt><dd><a href="http://upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.1.pdf"><cite>UPnP Device Architecture 1.1</cite></a>. 15 October 2008. UPnP Forum. PDF document. URL: <a href="http://upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.1.pdf">http://upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.1.pdf</a>
</dd><dt id="bib-WEBIDL">[WEBIDL]</dt><dd>Cameron McCormack. <a href="http://www.w3.org/TR/2011/WD-WebIDL-20110927/"><cite>Web IDL.</cite></a> 27 September 2011. W3C Working Draft. (Work in progress.) URL: <a href="http://www.w3.org/TR/2011/WD-WebIDL-20110927/">http://www.w3.org/TR/2011/WD-WebIDL-20110927/</a>
-</dd><dt id="bib-ZEROCONF">[ZEROCONF]</dt><dd>S. Cheshire; B. Aboba; E. Guttman. <a href="http://files.zeroconf.org/rfc3927.txt"><cite>Dynamic Configuration of IPv4 Link-Local Addresses.</cite></a> May 2005. IETF Draft. URL: <a href="http://files.zeroconf.org/rfc3927.txt">http://files.zeroconf.org/rfc3927.txt</a>
-</dd></dl></section><section id="informative-references"><h3><span class="secno">C.2 </span>Informative references</h3><p>No informative references.</p></section></section></body></html>
\ No newline at end of file
+</dd></dl></section></section></body></html>
\ No newline at end of file
--- a/discovery-api/Overview.html Tue Oct 02 18:05:58 2012 -0700
+++ b/discovery-api/Overview.html Tue Oct 02 18:07:01 2012 -0700
@@ -1,366 +1,14 @@
-<!DOCTYPE html PUBLIC '-//W3C//DTD HTML 4.01 Transitional//EN' 'http://www.w3.org/TR/html4/loose.dtd'>
-<html lang="en" dir="ltr" about="" property="dc:language" content="en" prefix="dc: http://purl.org/dc/terms/ bibo: http://purl.org/ontology/bibo/ foaf: http://xmlns.com/foaf/0.1/ xsd: http://www.w3.org/2001/XMLSchema#">
-<head>
- <title>Networked Service Discovery and Messaging</title>
- <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
- <!-- This spec has been compiled with ReSpec v2 -->
-
-
+<!DOCTYPE html>
+<html lang="en"
+ dir="ltr">
+ <head>
+ <title>
+ Network Service Discovery
+ </title>
+ <meta http-equiv="Content-Type"
+ content="text/html; charset=utf-8">
<style type="text/css">
- /**
- * SyntaxHighlighter
- * http://alexgorbatchev.com/SyntaxHighlighter
- *
- * SyntaxHighlighter is donationware. If you are using it, please donate.
- * http://alexgorbatchev.com/SyntaxHighlighter/donate.html
- *
- * @version
- * 3.0.83 (July 02 2010)
- *
- * @copyright
- * Copyright (C) 2004-2010 Alex Gorbatchev.
- *
- * @license
- * Dual licensed under the MIT and GPL licenses.
- */
- .syntaxhighlighter a,
- .syntaxhighlighter div,
- .syntaxhighlighter code,
- .syntaxhighlighter table,
- .syntaxhighlighter table td,
- .syntaxhighlighter table tr,
- .syntaxhighlighter table tbody,
- .syntaxhighlighter table thead,
- .syntaxhighlighter table caption,
- .syntaxhighlighter textarea {
- -moz-border-radius: 0 0 0 0 !important;
- -webkit-border-radius: 0 0 0 0 !important;
- background: none !important;
- border: 0 !important;
- bottom: auto !important;
- float: none !important;
- height: auto !important;
- left: auto !important;
- line-height: 1.1em !important;
- margin: 0 !important;
- outline: 0 !important;
- overflow: visible !important;
- padding: 0 !important;
- position: static !important;
- right: auto !important;
- text-align: left !important;
- top: auto !important;
- vertical-align: baseline !important;
- width: auto !important;
- box-sizing: content-box !important;
- font-family: "Consolas", "Bitstream Vera Sans Mono", "Courier New", Courier, monospace !important;
- font-weight: normal !important;
- font-style: normal !important;
- font-size: 1em !important;
- min-height: inherit !important;
- min-height: auto !important;
- }
-
- .syntaxhighlighter {
- width: 100% !important;
- margin: 1em 0 1em 0 !important;
- position: relative !important;
- overflow: auto !important;
- font-size: 0.8em !important;
- }
- .syntaxhighlighter.source {
- overflow: hidden !important;
- }
- .syntaxhighlighter .bold {
- font-weight: bold !important;
- }
- .syntaxhighlighter .italic {
- font-style: italic !important;
- }
- .syntaxhighlighter .line {
- white-space: pre !important;
- }
- .syntaxhighlighter table {
- width: 100% !important;
- }
- .syntaxhighlighter table caption {
- text-align: left !important;
- padding: .5em 0 0.5em 1em !important;
- }
- .syntaxhighlighter table td.code {
- width: 100% !important;
- }
- .syntaxhighlighter table td.code .container {
- position: relative !important;
- }
- .syntaxhighlighter table td.code .container textarea {
- box-sizing: border-box !important;
- position: absolute !important;
- left: 0 !important;
- top: 0 !important;
- width: 100% !important;
- height: 100% !important;
- border: none !important;
-
- padding-left: 1em !important;
- overflow: hidden !important;
- white-space: pre !important;
- }
- .syntaxhighlighter table td.gutter .line {
- text-align: right !important;
- padding: 0 0.5em 0 1em !important;
- }
- .syntaxhighlighter table td.code .line {
- padding: 0 1em !important;
- }
- .syntaxhighlighter.nogutter td.code .container textarea, .syntaxhighlighter.nogutter td.code .line {
- padding-left: 0em !important;
- }
- .syntaxhighlighter.show {
- display: block !important;
- }
- .syntaxhighlighter.collapsed table {
- display: none !important;
- }
- .syntaxhighlighter.collapsed .toolbar {
- padding: 0.1em 0.8em 0em 0.8em !important;
- font-size: 1em !important;
- position: static !important;
- width: auto !important;
- height: auto !important;
- }
- .syntaxhighlighter.collapsed .toolbar span {
- display: inline !important;
- margin-right: 1em !important;
- }
- .syntaxhighlighter.collapsed .toolbar span a {
- padding: 0 !important;
- display: none !important;
- }
- .syntaxhighlighter.collapsed .toolbar span a.expandSource {
- display: inline !important;
- }
- .syntaxhighlighter .toolbar {
- position: absolute !important;
- right: 1px !important;
- top: 1px !important;
- width: 11px !important;
- height: 11px !important;
- font-size: 10px !important;
- z-index: 10 !important;
- }
- .syntaxhighlighter .toolbar span.title {
- display: inline !important;
- }
- .syntaxhighlighter .toolbar a {
- display: block !important;
- text-align: center !important;
- text-decoration: none !important;
- padding-top: 1px !important;
- }
- .syntaxhighlighter .toolbar a.expandSource {
- display: none !important;
- }
- .syntaxhighlighter.ie {
- font-size: .9em !important;
- padding: 1px 0 1px 0 !important;
- }
- .syntaxhighlighter.ie .toolbar {
- line-height: 8px !important;
- }
- .syntaxhighlighter.ie .toolbar a {
- padding-top: 0px !important;
- }
- .syntaxhighlighter.printing .line.alt1 .content,
- .syntaxhighlighter.printing .line.alt2 .content,
- .syntaxhighlighter.printing .line.highlighted .number,
- .syntaxhighlighter.printing .line.highlighted.alt1 .content,
- .syntaxhighlighter.printing .line.highlighted.alt2 .content {
- background: none !important;
- }
- .syntaxhighlighter.printing .line .number {
- color: #bbbbbb !important;
- }
- .syntaxhighlighter.printing .line .content {
- color: black !important;
- }
- .syntaxhighlighter.printing .toolbar {
- display: none !important;
- }
- .syntaxhighlighter.printing a {
- text-decoration: none !important;
- }
- .syntaxhighlighter.printing .plain, .syntaxhighlighter.printing .plain a {
- color: black !important;
- }
- .syntaxhighlighter.printing .comments, .syntaxhighlighter.printing .comments a {
- color: #008200 !important;
- }
- .syntaxhighlighter.printing .string, .syntaxhighlighter.printing .string a {
- color: blue !important;
- }
- .syntaxhighlighter.printing .keyword {
- color: #006699 !important;
- font-weight: bold !important;
- }
- .syntaxhighlighter.printing .preprocessor {
- color: gray !important;
- }
- .syntaxhighlighter.printing .variable {
- color: #aa7700 !important;
- }
- .syntaxhighlighter.printing .value {
- color: #009900 !important;
- }
- .syntaxhighlighter.printing .functions {
- color: #ff1493 !important;
- }
- .syntaxhighlighter.printing .constants {
- color: #0066cc !important;
- }
- .syntaxhighlighter.printing .script {
- font-weight: bold !important;
- }
- .syntaxhighlighter.printing .color1, .syntaxhighlighter.printing .color1 a {
- color: gray !important;
- }
- .syntaxhighlighter.printing .color2, .syntaxhighlighter.printing .color2 a {
- color: #ff1493 !important;
- }
- .syntaxhighlighter.printing .color3, .syntaxhighlighter.printing .color3 a {
- color: red !important;
- }
- .syntaxhighlighter.printing .break, .syntaxhighlighter.printing .break a {
- color: black !important;
- }
- </style>
- <style type="text/css">
- /**
- * SyntaxHighlighter
- * http://alexgorbatchev.com/SyntaxHighlighter
- *
- * SyntaxHighlighter is donationware. If you are using it, please donate.
- * http://alexgorbatchev.com/SyntaxHighlighter/donate.html
- *
- * @version
- * 3.0.83 (July 02 2010)
- *
- * @copyright
- * Copyright (C) 2004-2010 Alex Gorbatchev.
- *
- * @license
- * Dual licensed under the MIT and GPL licenses.
- */
- .syntaxhighlighter {
- background-color: none !important;
- }
- .syntaxhighlighter .line.alt1 {
- background-color: none !important;
- }
- .syntaxhighlighter .line.alt2 {
- background-color: none !important;
- }
- .syntaxhighlighter .line.highlighted.alt1, .syntaxhighlighter .line.highlighted.alt2 {
- background-color: none !important;
- }
- .syntaxhighlighter .line.highlighted.number {
- color: black !important;
- }
- .syntaxhighlighter table caption {
- color: black !important;
- }
- .syntaxhighlighter .gutter {
- color: #afafaf !important;
- }
- .syntaxhighlighter .gutter .line {
- border-right: 3px solid #6ce26c !important;
- }
- .syntaxhighlighter .gutter .line.highlighted {
- background-color: #6ce26c !important;
- color: white !important;
- }
- .syntaxhighlighter.printing .line .content {
- border: none !important;
- }
- .syntaxhighlighter.collapsed {
- overflow: visible !important;
- }
- .syntaxhighlighter.collapsed .toolbar {
- color: blue !important;
- background: none !important;
- border: 1px solid #6ce26c !important;
- }
- .syntaxhighlighter.collapsed .toolbar a {
- color: blue !important;
- }
- .syntaxhighlighter.collapsed .toolbar a:hover {
- color: red !important;
- }
- .syntaxhighlighter .toolbar {
- color: white !important;
- background: #6ce26c !important;
- border: none !important;
- }
- .syntaxhighlighter .toolbar a {
- color: white !important;
- }
- .syntaxhighlighter .toolbar a:hover {
- color: black !important;
- }
- .syntaxhighlighter .plain, .syntaxhighlighter .plain a {
- color: black !important;
- }
- .syntaxhighlighter .comments, .syntaxhighlighter .comments a {
- color: #008200 !important;
- }
- .syntaxhighlighter .string, .syntaxhighlighter .string a {
- color: blue !important;
- }
- .syntaxhighlighter .keyword {
- color: #006699 !important;
- }
- .syntaxhighlighter .preprocessor {
- color: gray !important;
- }
- .syntaxhighlighter .variable {
- color: #aa7700 !important;
- }
- .syntaxhighlighter .value {
- color: #009900 !important;
- }
- .syntaxhighlighter .functions {
- color: #ff1493 !important;
- }
- .syntaxhighlighter .constants {
- color: #0066cc !important;
- }
- .syntaxhighlighter .script {
- font-weight: bold !important;
- color: #006699 !important;
- background-color: none !important;
- }
- .syntaxhighlighter .color1, .syntaxhighlighter .color1 a {
- color: gray !important;
- }
- .syntaxhighlighter .color2, .syntaxhighlighter .color2 a {
- color: #ff1493 !important;
- }
- .syntaxhighlighter .color3, .syntaxhighlighter .color3 a {
- color: red !important;
- }
-
- .syntaxhighlighter .keyword {
- font-weight: bold !important;
- }
- </style>
-
-
-
-
-
-
- <style type="text/css">
- /* Custom CSS optimizations (Richard Tibbett) */
+/* Custom ReSpec CSS (by Rich Tibbett) */
/* Add better spacing to sections */
section, .section { margin-bottom: 2em; }
@@ -385,621 +33,689 @@
dl.domintro dd p { margin: 0.5em 0; }
dl.domintro code {font-size: inherit; font-style: italic; }
dl.domintro:before { display: table; margin: -1em -0.5em 0.5em auto; width: auto; content: 'This box is non-normative. Implementation requirements are given below this box.'; color: red; border: solid 2px; background: white; padding: 0 0.25em; }
+
+ table { border-collapse:collapse; border-style:hidden hidden none hidden }
+ table thead { border-bottom:solid }
+ table tbody th:first-child { border-left:solid }
+ table td, table th { border-left:solid; border-right:solid; border-bottom:solid thin; vertical-align:top; padding:0.2em }
</style>
- <style type="text/css">
-/*
- XXX this is not up to date with the needs of various other parts, it will require
- to be synched up with the latest developments
- It may be that this will be split up so that only the parts that are acually used
- by the document get to be included (e.g. WebIDL).
-*/
+ <style type="text/css">
+/*****************************************************************
+ * ReSpec 3 CSS
+ * Robin Berjon - http://berjon.com/
+ *****************************************************************/
-/*****************************************************************
- * ReSpec 2 CSS
- * Robin Berjon, 2010-01-04
- *****************************************************************/
-
-/* --- INLINES --- */
-em.rfc2119 {
+ /* --- INLINES --- */
+ em.rfc2119 {
text-transform: lowercase;
font-variant: small-caps;
font-style: normal;
color: #900;
-}
-
-h1 acronym, h2 acronym, h3 acronym, h4 acronym, h5 acronym, h6 acronym, a acronym,
-h1 abbr, h2 abbr, h3 abbr, h4 abbr, h5 abbr, h6 abbr, a abbr {
- border: none;
-}
+ }
-dfn {
+ h1 acronym, h2 acronym, h3 acronym, h4 acronym, h5 acronym, h6 acronym, a acronym,
+ h1 abbr, h2 abbr, h3 abbr, h4 abbr, h5 abbr, h6 abbr, a abbr {
+ border: none;
+ }
+
+ dfn {
font-weight: bold;
-}
+ }
-a.internalDFN {
+ a.internalDFN {
color: inherit;
- border-bottom: medium solid #99c;
+ border-bottom: 1px solid #99c;
text-decoration: none;
-}
+ }
-a.externalDFN {
+ a.externalDFN {
color: inherit;
- border-bottom: medium dotted #ccc;
+ border-bottom: 1px dotted #ccc;
text-decoration: none;
-}
+ }
-a.bibref {
+ a.bibref {
text-decoration: none;
-}
+ }
-code {
+ cite .bibref {
+ font-style: normal;
+ }
+
+ code {
color: #ff4500;
-}
+ }
-/* --- WEB IDL --- */
-pre.idl {
- border-top: 1px solid #90b8de;
- border-bottom: 1px solid #90b8de;
- padding: 1em;
- line-height: 120%;
-}
-
-pre.idl::before {
- content: "WebIDL";
- display: block;
- width: 150px;
- background: #90b8de;
- color: #fff;
- font-family: initial;
- padding: 3px;
- font-weight: bold;
- margin: -1em 0 1em -1em;
-}
-
-.idlType {
- color: #ff4500;
- font-weight: bold;
- text-decoration: none;
-}
-
-/*.idlModule*/
-/*.idlModuleID*/
-/*.idlInterface*/
-.idlInterfaceID {
- font-weight: bold;
- color: #005a9c;
-}
-
-.idlSuperclass {
- font-style: italic;
- color: #005a9c;
-}
-
-/*.idlAttribute*/
-.idlAttrType {
- color: #005a9c;
-}
-.idlAttrName {
- color: #ff4500;
-}
-.idlAttrName a {
- color: #ff4500;
- border-bottom: 1px dotted #ff4500;
- text-decoration: none;
-}
-
-/*.idlMethod*/
-.idlMethType {
- color: #005a9c;
-}
-.idlMethName {
- color: #ff4500;
-}
-.idlMethName a {
- color: #ff4500;
- border-bottom: 1px dotted #ff4500;
- text-decoration: none;
-}
-
-/*.idlParam*/
-.idlParamType {
- color: #005a9c;
-}
-.idlParamName {
- font-style: italic;
-}
-
-.extAttr {
- color: #666;
-}
-
-/*.idlConst*/
-.idlConstType {
- color: #005a9c;
-}
-.idlConstName {
- color: #ff4500;
-}
-.idlConstName a {
- color: #ff4500;
- border-bottom: 1px dotted #ff4500;
- text-decoration: none;
-}
-
-/*.idlException*/
-.idlExceptionID {
- font-weight: bold;
- color: #c00;
-}
-
-.idlTypedefID, .idlTypedefType {
- color: #005a9c;
-}
-
-.idlRaises, .idlRaises a.idlType, .idlRaises a.idlType code, .excName a, .excName a code {
- color: #c00;
- font-weight: normal;
-}
+ /* --- --- */
+ ol.algorithm { counter-reset:numsection; list-style-type: none; }
+ ol.algorithm li { margin: 0.5em 0; }
+ ol.algorithm li:before { font-weight: bold; counter-increment: numsection; content: counters(numsection, ".") ") "; }
-.excName a {
- font-family: monospace;
-}
-
-.idlRaises a.idlType, .excName a.idlType {
- border-bottom: 1px dotted #c00;
-}
-
-.excGetSetTrue, .excGetSetFalse, .prmNullTrue, .prmNullFalse, .prmOptTrue, .prmOptFalse {
- width: 45px;
- text-align: center;
-}
-.excGetSetTrue, .prmNullTrue, .prmOptTrue { color: #0c0; }
-.excGetSetFalse, .prmNullFalse, .prmOptFalse { color: #c00; }
-
-.idlImplements a {
- font-weight: bold;
-}
-
-dl.attributes, dl.methods, dl.constants {
- margin-left: 2em;
-}
-
-.attributes dt, .methods dt, .constants dt {
- font-weight: normal;
-}
-
-.attributes dt code, .methods dt code, .constants dt code {
- font-weight: bold;
- color: #000;
- font-family: monospace;
-}
-
-.attributes dt code {
- background: #ffffd2;
-}
-
-.attributes dt .idlAttrType code {
- color: #005a9c;
- background: transparent;
- font-family: inherit;
- font-weight: normal;
- font-style: italic;
-}
-
-.methods dt code {
- background: #d9e6f8;
-}
-
-.constants dt code {
- background: #ddffd2;
-}
+ /* --- TOC --- */
+ .toc a, .tof a {
+ text-decoration: none;
+ }
-.attributes dd, .methods dd, .constants dd {
- margin-bottom: 1em;
-}
-
-table.parameters, table.exceptions {
- border-spacing: 0;
- border-collapse: collapse;
- margin: 0.5em 0;
- width: 100%;
-}
-table.parameters { border-bottom: 1px solid #90b8de; }
-table.exceptions { border-bottom: 1px solid #deb890; }
-
-.parameters th, .exceptions th {
- color: #fff;
- padding: 3px 5px;
- text-align: left;
- font-family: initial;
- font-weight: normal;
- text-shadow: #666 1px 1px 0;
-}
-.parameters th { background: #90b8de; }
-.exceptions th { background: #deb890; }
+ a .secno, a .figno {
+ color: #000;
+ }
-.parameters td, .exceptions td {
- padding: 3px 10px;
- border-top: 1px solid #ddd;
- vertical-align: top;
-}
-
-.parameters tr:first-child td, .exceptions tr:first-child td {
- border-top: none;
-}
-
-.parameters td.prmName, .exceptions td.excName, .exceptions td.excCodeName {
- width: 100px;
-}
+ ul.tof, ol.tof {
+ list-style: none outside none;
+ }
-.parameters td.prmType {
- width: 120px;
-}
-
-table.exceptions table {
- border-spacing: 0;
- border-collapse: collapse;
- width: 100%;
-}
+ .caption {
+ margin-top: 0.5em;
+ font-style: italic;
+ }
-/* --- TOC --- */
-.toc a {
- text-decoration: none;
-}
-
-a .secno {
- color: #000;
-}
-
-/* --- TABLE --- */
-table.simple {
+ /* --- TABLE --- */
+ table.simple {
border-spacing: 0;
border-collapse: collapse;
border-bottom: 3px solid #005a9c;
-}
+ }
-.simple th {
+ .simple th {
background: #005a9c;
color: #fff;
padding: 3px 5px;
text-align: left;
-}
+ }
-.simple th[scope="row"] {
+ .simple th[scope="row"] {
background: inherit;
color: inherit;
border-top: 1px solid #ddd;
-}
+ }
-.simple td {
+ .simple td {
padding: 3px 10px;
border-top: 1px solid #ddd;
-}
-
-.simple tr:nth-child(even) {
- background: #f0f6ff;
-}
-
-/* --- DL --- */
-.section dd > p:first-child {
- margin-top: 0;
-}
-
-.section dd > p:last-child {
- margin-bottom: 0;
-}
-
-.section dd {
- margin-bottom: 1em;
-}
-
-.section dl.attrs dd, .section dl.eldef dd {
- margin-bottom: 0;
-}
-
-/* --- EXAMPLES --- */
-pre.example {
- border-top: 1px solid #ff4500;
- border-bottom: 1px solid #ff4500;
- padding: 1em;
- margin: 2em 0;
-}
-
-pre.example::before {
- content: "Example";
- display: block;
- width: 150px;
- background: #ff4500;
- color: #fff;
- font-family: initial;
- padding: 3px;
- font-weight: bold;
- margin: -1em 0 1em -1em;
-}
-
-/* --- EDITORIAL NOTES --- */
-.issue {
- padding: 1em;
- border: 1px solid #f00;
- background: #ffc;
-}
-
-.issue::before {
- content: "Issue";
- display: block;
- width: 150px;
- margin: -1.5em 0 0.5em 0;
- font-weight: bold;
- border: 1px solid #f00;
- background: #fff;
- padding: 3px 1em;
-}
-
-.note {
- padding: 1em;
- border: 2px solid #cff6d9;
- background: #e2fff0;
-}
+ }
-.note::before {
- content: "Note";
- display: block;
- width: 150px;
- margin: -1.5em 0 0.5em 0;
- font-weight: bold;
- border: 1px solid #cff6d9;
- background: #fff;
- padding: 3px 1em;
-}
-
-
-/* --- SYNTAX HIGHLIGHTING --- */
-/* Pretty printing styles. Used with prettify.js. */
-.str { color: #080; }
-.kwd { color: #008; }
-.com { color: #800; }
-.typ { color: #606; }
-.lit { color: #066; }
-.pun { color: #660; }
-.pln { color: #000; }
-.tag { color: #008; }
-.atn { color: #606; }
-.atv { color: #080; }
-.dec { color: #606; }
-/*pre.prettyprint { padding: 2px; border: 1px solid #888 }*/
-
-/* Specify class=linenums on a pre to get line numbering */
-ol.linenums { margin-top: 0; margin-bottom: 0 } /* IE indents via margin-left */
-li.L0, li.L1, li.L2, li.L3, li.L5, li.L6, li.L7, li.L8 { list-style-type: none }
-/* Alternate shading for lines */
-li.L1, li.L3, li.L5, li.L7, li.L9 { background: #eee }
+ .simple tr:nth-child(even) {
+ background: #f0f6ff;
+ }
-@media print {
- .str { color: #060; }
- .kwd { color: #006; font-weight: bold; }
- .com { color: #600; font-style: italic; }
- .typ { color: #404; font-weight: bold; }
- .lit { color: #044; }
- .pun { color: #440; }
- .pln { color: #000; }
- .tag { color: #006; font-weight: bold; }
- .atn { color: #404; }
- .atv { color: #060; }
-}
-</style><link rel="stylesheet" href="http://www.w3.org/StyleSheets/TR/w3c-unofficial" type="text/css" media="all" charset="utf-8"></head>
-
- <body><div class="head">
- <p>
-
-
- </p>
- <h1 class="title" id="title" rel="dc:title">Networked Service Discovery and Messaging</h1>
-
- <h2 id="unofficial-draft-02-august-2012">Unofficial Draft 02 August 2012</h2>
- <dl>
-
-
+ /* --- DL --- */
+ .section dd > p:first-child {
+ margin-top: 0;
+ }
- <dt>Previous version:</dt><dd> <a href="" rel="dc:replaces"></a></dd>
-
-
-
-
-
- <dt>Editors:</dt>
-
- <dd class="Editor" rel="bibo:editor"><span typeof="foaf:Person"><span class="name" property="foaf:name">Rich Tibbett</span>,
-
- <a class="company" href="http://opera.com/" rel="foaf:workplaceHomepage">Opera Software ASA</a>
-
-
+ .section dd > p:last-child {
+ margin-bottom: 0;
+ }
-
- </span></dd>
-
- <dd class="Editor" rel="bibo:editor"><span typeof="foaf:Person"><span class="name" property="foaf:name">Clarke Stevens</span>,
-
- <a class="company" href="http://cablelabs.com/" rel="foaf:workplaceHomepage">CableLabs</a>
+ .section dd {
+ margin-bottom: 1em;
+ }
-
-
+ .section dl.attrs dd, .section dl.eldef dd {
+ margin-bottom: 0;
+ }
+ </style>
+ <style type="text/css">
+/* --- ISSUES/NOTES --- */
+ div.issue-title, div.note-title {
+ padding-right: 1em;
+ min-width: 7.5em;
+ color: #b9ab2d;
+ }
+ div.issue-title { color: #e05252; }
+ div.note-title { color: #52e052; }
+ div.issue-title span, div.note-title span {
+ text-transform: uppercase;
+ }
+ div.note, div.issue {
+ margin-top: 1em;
+ margin-bottom: 1em;
+ }
+ .note > p:first-child, .issue > p:first-child { margin-top: 0 }
+ .issue, .note {
+ padding: .5em;
+ border-left-width: .5em;
+ border-left-style: solid;
+ }
+ div.issue, div.note {
+ padding: 0.5em;
+ margin: 1em 0;
+ position: relative;
+ clear: both;
+ }
+ span.note, span.issue { padding: .1em .5em .15em; }
- </span></dd>
-
-
-
+ .issue {
+ border-color: #e05252;
+ background: #fbe9e9;
+ }
+ .note {
+ border-color: #52e052;
+ background: #e9fbe9;
+ }
-
- </dl>
-
-
-
-
-
- <p class="copyright">
-
-
- This document is licensed under a <a class="subfoot" href="http://creativecommons.org/licenses/by/3.0/" rel="license">Creative
- Commons Attribution 3.0 License</a>.
-
-
- </p><hr></div>
- <div id="abstract" class="introductory section" property="dcterms:absract" datatype="" about="#abstract" typeof="bibo:Chapter"><h2>Abstract</h2>
- <p>
- This specification defines a mechanism for an HTML document to discover and subsequently communicate with <acronym title="Hypertext Transfer Protocol"><acronym title="Hypertext Transfer Protocol">HTTP</acronym></acronym>-based services
- advertised via common discovery protocols within a user's network.
- </p>
- </div><div id="sotd" class="introductory section" about="#sotd" typeof="bibo:Chapter"><h2>Status of This Document</h2>
- <p>This document is merely a public working draft of a potential specification. It has
- no official standing of any kind and does not represent the support or consensus of any
- standards organisation.</p></div><div id="toc" about="#toc" typeof="bibo:Chapter" class="section"><h2 class="introductory">Table of Contents</h2><ul class="toc"><li class="tocline"><a href="#introduction" class="tocxref"><span class="secno">1. </span>Introduction</a></li><li class="tocline"><a href="#conformance" class="tocxref"><span class="secno">2. </span>Conformance</a><ul class="toc"><li class="tocline"><a href="#dependencies" class="tocxref"><span class="secno">2.1 </span>Dependencies</a></li></ul></li><li class="tocline"><a href="#terminology" class="tocxref"><span class="secno">3. </span>Terminology</a></li><li class="tocline"><a href="#requesting-networked-services" class="tocxref"><span class="secno">4. </span>Requesting networked services</a><ul class="toc"><li class="tocline"><a href="#methods" class="tocxref"><span class="secno">4.1 </span>Methods</a></li><li class="tocline"><a href="#error-handling" class="tocxref"><span class="secno">4.2 </span>Error Handling</a></li></ul></li><li class="tocline"><a href="#obtaining-networked-services" class="tocxref"><span class="secno">5. </span>Obtaining networked services</a><ul class="toc"><li class="tocline"><a href="#attributes" class="tocxref"><span class="secno">5.1 </span>Attributes</a></li><li class="tocline"><a href="#methods-1" class="tocxref"><span class="secno">5.2 </span>Methods</a></li><li class="tocline"><a href="#events" class="tocxref"><span class="secno">5.3 </span>Events</a></li></ul></li><li class="tocline"><a href="#communicating-with-a-networked-service" class="tocxref"><span class="secno">6. </span>Communicating with a networked service</a><ul class="toc"><li class="tocline"><a href="#attributes-1" class="tocxref"><span class="secno">6.1 </span>Attributes</a></li><li class="tocline"><a href="#states" class="tocxref"><span class="secno">6.2 </span>States</a></li><li class="tocline"><a href="#events-1" class="tocxref"><span class="secno">6.3 </span>Events</a></li></ul></li><li class="tocline"><a href="#service-discovery" class="tocxref"><span class="secno">7. </span>Service Discovery</a><ul class="toc"><li class="tocline"><a href="#zeroconf--mdns---dns-sd" class="tocxref"><span class="secno">7.1 </span>Zeroconf (<acronym title="Multicast DNS"><acronym title="Multicast DNS">mDNS</acronym></acronym> + <acronym title="Domain Name System"><acronym title="Domain Name System">DNS</acronym></acronym>-<acronym title="Service Discovery"><acronym title="Service Discovery">SD</acronym></acronym>)</a></li><li class="tocline"><a href="#universal-plug-and-play--upnp" class="tocxref"><span class="secno">7.2 </span>Universal Plug-and-Play (<acronym title="Universal Plug-and-Play"><acronym title="Universal Plug-and-Play">UPnP</acronym></acronym>)</a></li><li class="tocline"><a href="#network-topology-monitoring" class="tocxref"><span class="secno">7.3 </span>Network Topology Monitoring</a></li></ul></li><li class="tocline"><a href="#garbage-collection" class="tocxref"><span class="secno">8. </span>Garbage collection</a></li><li class="tocline"><a href="#use-cases-and-requirements" class="tocxref"><span class="secno">9. </span>Use Cases and Requirements</a></li><li class="tocline"><a href="#examples" class="tocxref"><span class="secno">A. </span>Examples</a></li><li class="tocline"><a href="#acknowledgements" class="tocxref"><span class="secno">B. </span>Acknowledgements</a></li><li class="tocline"><a href="#references" class="tocxref"><span class="secno">C. </span>References</a><ul class="toc"><li class="tocline"><a href="#normative-references" class="tocxref"><span class="secno">C.1 </span>Normative references</a></li></ul></li></ul></div>
-
-
-
- <div class="informative section" id="introduction" about="#introduction" typeof="bibo:Chapter">
- <!--OddPage--><h2><span class="secno">1. </span>Introduction</h2><em>This section is non-normative.</em>
-
- <p>To enable Web pages to connect and communicate with Local-networked Services provided over <acronym title="Hypertext Transfer Protocol">HTTP</acronym>, this specification introduces the
- <a href="#navigatornetworkservice"><code>NavigatorNetworkService</code></a> interface.</p>
-
- <p>
- Using this <acronym title="Application Programming Interface"><acronym title="Application Programming Interface">API</acronym></acronym> consists of requesting a well-known service type, known by developers and advertised by Local-networked Devices. User authorization, where the user connects the web page to one or more discovered services,
- is expected before the web page is able to interact with any Local-networked Services.
- </p>
-
- <p>
- A web page creates a request to obtain connectivity to services running in the network by specifying a well-known discovery service type that it wishes to interact with.
- </p>
-
- <p>
- The user agent, having captured all advertised services on the network from the Service Discovery mechanisms included in this recommendation, attempts to match
- the requested service type to a discovered service according to the processing described herein.
- </p>
-
- <p>
- If a service connectivity request is successful then the Web page is provided with the necessary information to communicate with the authorized Local-networked Service.
- If the request fails then the Web page will receive an error callback containing an error code describing the cause of Local-networked Service connectivity failure.
- </p>
-
- <p>
- Once connected to a Local-networked Service the Web page can send requests and receive responses to the Local-networked Service via the messaging format and appropriate channel inferred from the service type
- authorized via the provided <acronym title="Application Programming Interface">API</acronym>.
- The Web page, once connected, can also receive service-pushed events, in the messaging format supported by the Local-networked Device, if such event subscription functionality is provided by the
- connected Local-networked Service.
- </p>
-
- <div class="example">
- <p>Example of requesting a <acronym title="Domain Name System">DNS</acronym>-<acronym title="Service Discovery">SD</acronym> advertised service:</p>
- <hr>
- <div><div id="highlighter_631369" class="syntaxhighlighter nogutter js"><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="js keyword">function</code> <code class="js plain">showServices( services ) {</code></div><div class="line number2 index1 alt1"><code class="js spaces"> </code><code class="js comments">// Show a list of all the services provided to the web page</code></div><div class="line number3 index2 alt2"><code class="js spaces"> </code><code class="js keyword">for</code><code class="js plain">(</code><code class="js keyword">var</code> <code class="js plain">i = 0, l = services.length; i < l; i++) console.log( services[i].name );</code></div><div class="line number4 index3 alt1"><code class="js plain">}</code></div><div class="line number5 index4 alt2"> </div><div class="line number6 index5 alt1"><code class="js plain">navigator.getNetworkServices(</code><code class="js string">'zeroconf:_boxee-jsonrpc._tcp'</code><code class="js plain">, showServices);</code></div></div></td></tr></tbody></table></div></div>
- </div>
-
- <div class="example">
- <p>Example of requesting a <acronym title="Universal Plug-and-Play">UPnP</acronym> advertised service, also handling error conditions:</p>
- <hr>
- <div><div id="highlighter_906369" class="syntaxhighlighter nogutter js"><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="js keyword">function</code> <code class="js plain">showServices( services ) {</code></div><div class="line number2 index1 alt1"><code class="js spaces"> </code><code class="js comments">// Show a list of all the services provided to the web page</code></div><div class="line number3 index2 alt2"><code class="js spaces"> </code><code class="js keyword">for</code><code class="js plain">(</code><code class="js keyword">var</code> <code class="js plain">i = 0, l = services.length; i < l; i++) console.log( services[i].name );</code></div><div class="line number4 index3 alt1"><code class="js plain">}</code></div><div class="line number5 index4 alt2"> </div><div class="line number6 index5 alt1"><code class="js keyword">function</code> <code class="js plain">error( e ) {</code></div><div class="line number7 index6 alt2"><code class="js spaces"> </code><code class="js plain">console.log( </code><code class="js string">"Error occurred: "</code> <code class="js plain">+ e.code );</code></div><div class="line number8 index7 alt1"><code class="js plain">}</code></div><div class="line number9 index8 alt2"> </div><div class="line number10 index9 alt1"><code class="js plain">navigator.getNetworkServices(</code><code class="js string">'upnp:urn:schemas-upnp-org:service:ContentDirectory:1'</code><code class="js plain">, showServices, error);</code></div></div></td></tr></tbody></table></div></div>
- </div>
-
- <div class="example">
- <p>Example of requesting either a <acronym title="Domain Name System">DNS</acronym>-<acronym title="Service Discovery">SD</acronym> or <acronym title="Universal Plug-and-Play">UPnP</acronym> advertised service:</p>
- <hr>
- <div><div id="highlighter_284052" class="syntaxhighlighter nogutter js"><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="js keyword">function</code> <code class="js plain">showServices( services ) {</code></div><div class="line number2 index1 alt1"><code class="js spaces"> </code><code class="js comments">// Show a list of all the services provided to the web page (+ service type)</code></div><div class="line number3 index2 alt2"><code class="js spaces"> </code><code class="js keyword">for</code><code class="js plain">(</code><code class="js keyword">var</code> <code class="js plain">i = 0, l = services.length; i < l; i++)</code></div><div class="line number4 index3 alt1"><code class="js spaces"> </code><code class="js plain">console.log( services[i].name + </code><code class="js string">'('</code> <code class="js plain">+ services[i].type + </code><code class="js string">')'</code> <code class="js plain">);</code></div><div class="line number5 index4 alt2"><code class="js plain">}</code></div><div class="line number6 index5 alt1"> </div><div class="line number7 index6 alt2"><code class="js plain">navigator.getNetworkServices([</code></div><div class="line number8 index7 alt1"><code class="js spaces"> </code><code class="js string">'zeroconf:_boxee-jsonrpc._tcp'</code><code class="js plain">,</code></div><div class="line number9 index8 alt2"><code class="js spaces"> </code><code class="js string">'upnp:urn:schemas-upnp-org:service:ContentDirectory:1'</code></div><div class="line number10 index9 alt1"><code class="js plain">], showServices);</code></div></div></td></tr></tbody></table></div></div>
- </div>
-
- <p>For more detailed examples see the <a href="#examples" class="sec-ref">Examples</a> section.
- </p></div>
+ </style>
+ <style type="text/css">
+/* HIGHLIGHTS */
+ code.prettyprint {
+ color: inherit;
+ }
- <div id="conformance" about="#conformance" typeof="bibo:Chapter" class="section"><!--OddPage--><h2><span class="secno">2. </span>Conformance</h2><p>
- As well as sections marked as non-normative, all authoring guidelines, diagrams, examples,
- and notes in this specification are non-normative. Everything else in this specification is
- normative.
- </p>
- <p>
- The key words <em class="rfc2119" title="must">must</em>, <em class="rfc2119" title="must not">must not</em>, <em class="rfc2119" title="required">required</em>, <em class="rfc2119" title="should">should</em>, <em class="rfc2119" title="should not">should not</em>, <em class="rfc2119" title="recommended">recommended</em>, <em class="rfc2119" title="may">may</em>,
- and <em class="rfc2119" title="optional">optional</em> in this specification are to be interpreted as described in [<cite><a class="bibref" rel="biblioentry" href="#bib-RFC2119">RFC2119</a></cite>].
- </p>
-
- <p>Requirements phrased in the imperative as part of algorithms (such as "strip any leading space characters" or "return false and abort these steps") are to be interpreted with the
- meaning of the key word ("must", "should", "may", etc) used in introducing the algorithm.</p>
-
- <p>
- Some conformance requirements are phrased as requirements on attributes, methods or objects. Such requirements are to be interpreted as requirements on user agents.
- </p>
-
- <p>
- Conformance requirements phrased as algorithms or specific steps may be implemented in any manner, so long as the end result is equivalent. (In particular, the algorithms defined in
- this specification are intended to be easy to follow, and not intended to be performant.)
- </p>
-
- <p>
- The only conformance class defined by this specification is a <dfn id="dfn-user-agent">user agent</dfn>.
- </p>
-
- <p>
- User agents may impose implementation-specific limits on otherwise unconstrained inputs, e.g. to prevent denial of service attacks, to guard against running out of memory, or to work
- around platform-specific limitations.
- </p>
-
- <p>
- When support for a feature is disabled (e.g. as an emergency measure to mitigate a security problem, or to aid in development, or for performance reasons), user agents must act as if
- they had no support for the feature whatsoever, and as if the feature was not mentioned in this specification. For example, if a particular feature is accessed via an attribute in a Web
- IDL interface, the attribute itself would be omitted from the objects that implement that interface - leaving the attribute on the object but making it return null or throw an exception
- is insufficient.
- </p>
-
- <section id="dependencies" about="#dependencies" typeof="bibo:Chapter">
- <h3><span class="secno">2.1 </span>Dependencies</h3>
+ /* this from google-code-prettify */
+ .pln{color:#000}@media screen{.str{color:#080}.kwd{color:#008}.com{color:#800}.typ{color:#606}.lit{color:#066}.pun,.opn,.clo{color:#660}.tag{color:#008}.atn{color:#606}.atv{color:#080}.dec,.var{color:#606}.fun{color:red}}@media print,projection{.str{color:#060}.kwd{color:#006;font-weight:bold}.com{color:#600;font-style:italic}.typ{color:#404;font-weight:bold}.lit{color:#044}.pun,.opn,.clo{color:#440}.tag{color:#006;font-weight:bold}.atn{color:#404}.atv{color:#060}}ol.linenums{margin-top:0;margin-bottom:0}li.L0,li.L1,li.L2,li.L3,li.L5,li.L6,li.L7,li.L8{list-style-type:none}li.L1,li.L3,li.L5,li.L7,li.L9{background:#eee}
+ </style>
+ <link rel="stylesheet"
+ href="http://www.w3.org/StyleSheets/TR/W3C-ED"
+ type="text/css">
+ </head>
+ <body>
+ <div class="head">
+ <p>
+ <a href="http://www.w3.org/"><img width="72"
+ height="48"
+ src="http://www.w3.org/Icons/w3c_home"
+ alt="W3C"></a>
+ </p>
+ <h1 class="title"
+ id="title">
+ Network Service Discovery
+ </h1>
+ <h2 id="w3c-editor-s-draft-03-october-2012">
+ <abbr title="World Wide Web Consortium">W3C</abbr> Editor's Draft 03 October 2012
+ </h2>
+ <dl>
+ <dt>
+ This version:
+ </dt>
+ <dd>
+ <a href=
+ "http://dvcs.w3.org/hg/dap/raw-file/tip/discovery-api/Overview.html">http://dvcs.w3.org/hg/dap/raw-file/tip/discovery-api/Overview.html</a>
+ </dd>
+ <dt>
+ Latest published version:
+ </dt>
+ <dd>
+ <a href="http://www.w3.org/TR/discovery-api/">http://www.w3.org/TR/discovery-api/</a>
+ </dd>
+ <dt>
+ Latest editor's draft:
+ </dt>
+ <dd>
+ <a href=
+ "http://dvcs.w3.org/hg/dap/raw-file/tip/discovery-api/Overview.html">http://dvcs.w3.org/hg/dap/raw-file/tip/discovery-api/Overview.html</a>
+ </dd>
+ <dt>
+ Editors:
+ </dt>
+ <dd>
+ <span>Rich Tibbett</span>, <a href="http://opera.com/">Opera Software ASA</a>
+ </dd>
+ <dd>
+ <span>Clarke Stevens</span>, <a href="http://cablelabs.com/">CableLabs</a>
+ </dd>
+ </dl>
+ <p class="copyright">
+ <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright">Copyright</a> © 2012 <a href=
+ "http://www.w3.org/"><abbr title="World Wide Web Consortium">W3C</abbr></a><sup>®</sup> (<a href=
+ "http://www.csail.mit.edu/"><abbr title="Massachusetts Institute of Technology">MIT</abbr></a>, <a href=
+ "http://www.ercim.eu/"><abbr title=
+ "European Research Consortium for Informatics and Mathematics">ERCIM</abbr></a>, <a href=
+ "http://www.keio.ac.jp/">Keio</a>), All Rights Reserved. <abbr title="World Wide Web Consortium">W3C</abbr>
+ <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>, <a href=
+ "http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a> and <a href=
+ "http://www.w3.org/Consortium/Legal/copyright-documents">document use</a> rules apply.
+ </p>
+ <hr>
+ </div>
+ <section id="abstract"
+ class="introductory">
+ <h2>
+ Abstract
+ </h2>
+ <p>
+ This specification defines a mechanism for an HTML document to discover and subsequently communicate with
+ <abbr title="Hypertext Transfer Protocol">HTTP</abbr>-based services advertised via common discovery protocols
+ within the current network.
+ </p>
+ </section>
+ <section id="sotd"
+ class="introductory">
+ <h2>
+ Status of This Document
+ </h2>
+ <p>
+ <em>This section describes the status of this document at the time of its publication. Other documents may
+ supersede this document. A list of current <abbr title="World Wide Web Consortium">W3C</abbr> publications and
+ the latest revision of this technical report can be found in the <a href="http://www.w3.org/TR/"><abbr title=
+ "World Wide Web Consortium">W3C</abbr> technical reports index</a> at http://www.w3.org/TR/.</em>
+ </p>
+ <p>
+ This document represents the early consensus of the group on the scope and features of the proposed
+ <abbr title="Application Programming Interface">API</abbr>.
+ </p>
+ <p>
+ This document was published by the <a href="http://www.w3.org/2009/dap/">Device APIs Working Group</a> as an
+ Editor's Draft. If you wish to make comments regarding this document, please send them to <a href=
+ "mailto:public-device-apis@w3.org">public-device-apis@w3.org</a> (<a href=
+ "mailto:public-device-apis-request@w3.org?subject=subscribe">subscribe</a>, <a href=
+ "http://lists.w3.org/Archives/Public/public-device-apis/">archives</a>). All feedback is welcome.
+ </p>
+ <p>
+ Publication as an Editor's Draft does not imply endorsement by the <abbr title=
+ "World Wide Web Consortium">W3C</abbr> Membership. This is a draft document and may be updated, replaced or
+ obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in
+ progress.
+ </p>
+ <p>
+ This document was produced by a group operating under the <a href=
+ "http://www.w3.org/Consortium/Patent-Policy-20040205/">5 February 2004 <abbr title=
+ "World Wide Web Consortium">W3C</abbr> Patent Policy</a>. <abbr title="World Wide Web Consortium">W3C</abbr>
+ maintains a <a href="http://www.w3.org/2004/01/pp-impl/43696/status"
+ rel="disclosure">public list of any patent disclosures</a> made in connection with the deliverables of the
+ group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge
+ of a patent which the individual believes contains <a href=
+ "http://www.w3.org/Consortium/Patent-Policy-20040205/#def-essential">Essential Claim(s)</a> must disclose
+ the information in accordance with <a href=
+ "http://www.w3.org/Consortium/Patent-Policy-20040205/#sec-Disclosure">section 6 of the <abbr title=
+ "World Wide Web Consortium">W3C</abbr> Patent Policy</a>.
+ </p>
+ </section>
+ <section id="toc">
+ <h2 class="introductory">
+ Table of Contents
+ </h2>
+ <ul class="toc">
+ <li class="tocline">
+ <a href="#introduction"
+ class="tocxref"><span class="secno">1.</span> Introduction</a>
+ </li>
+ <li class="tocline">
+ <a href="#conformance"
+ class="tocxref"><span class="secno">2.</span> Conformance</a>
+ <ul class="toc">
+ <li class="tocline">
+ <a href="#dependencies"
+ class="tocxref"><span class="secno">2.1</span> Dependencies</a>
+ </li>
+ </ul>
+ </li>
+ <li class="tocline">
+ <a href="#terminology"
+ class="tocxref"><span class="secno">3.</span> Terminology</a>
+ </li>
+ <li class="tocline">
+ <a href="#requesting-networked-services"
+ class="tocxref"><span class="secno">4.</span> Requesting networked services</a>
+ <ul class="toc">
+ <li class="tocline">
+ <a href="#methods"
+ class="tocxref"><span class="secno">4.1</span> Methods</a>
+ </li>
+ <li class="tocline">
+ <a href="#error-handling"
+ class="tocxref"><span class="secno">4.2</span> Error Handling</a>
+ </li>
+ </ul>
+ </li>
+ <li class="tocline">
+ <a href="#obtaining-networked-services"
+ class="tocxref"><span class="secno">5.</span> Obtaining networked services</a>
+ <ul class="toc">
+ <li class="tocline">
+ <a href="#attributes"
+ class="tocxref"><span class="secno">5.1</span> Attributes</a>
+ </li>
+ <li class="tocline">
+ <a href="#methods-1"
+ class="tocxref"><span class="secno">5.2</span> Methods</a>
+ </li>
+ <li class="tocline">
+ <a href="#events"
+ class="tocxref"><span class="secno">5.3</span> Events</a>
+ </li>
+ </ul>
+ </li>
+ <li class="tocline">
+ <a href="#communicating-with-a-networked-service"
+ class="tocxref"><span class="secno">6.</span> Communicating with a networked service</a>
+ <ul class="toc">
+ <li class="tocline">
+ <a href="#attributes-1"
+ class="tocxref"><span class="secno">6.1</span> Attributes</a>
+ </li>
+ <li class="tocline">
+ <a href="#states"
+ class="tocxref"><span class="secno">6.2</span> States</a>
+ </li>
+ <li class="tocline">
+ <a href="#events-1"
+ class="tocxref"><span class="secno">6.3</span> Events</a>
+ </li>
+ </ul>
+ </li>
+ <li class="tocline">
+ <a href="#service-discovery"
+ class="tocxref"><span class="secno">7.</span> Service Discovery</a>
+ <ul class="toc">
+ <li class="tocline">
+ <a href="#zeroconf-mdns-dns-sd"
+ class="tocxref"><span class="secno">7.1</span> Zeroconf (<abbr title="Multicast DNS">mDNS</abbr> +
+ <abbr title="Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr>)</a>
+ </li>
+ <li class="tocline">
+ <a href="#simple-service-discovery-protocol-ssdp"
+ class="tocxref"><span class="secno">7.2</span> Simple Service Discovery Protocol (<abbr title=
+ "Simple Service Discovery Protocol">SSDP</abbr>)</a>
+ </li>
+ <li class="tocline">
+ <a href="#network-topology-monitoring"
+ class="tocxref"><span class="secno">7.3</span> Network Topology Monitoring</a>
+ </li>
+ </ul>
+ </li>
+ <li class="tocline">
+ <a href="#events-summary"
+ class="tocxref"><span class="secno">8.</span> Events Summary</a>
+ </li>
+ <li class="tocline">
+ <a href="#garbage-collection"
+ class="tocxref"><span class="secno">9.</span> Garbage collection</a>
+ </li>
+ <li class="tocline">
+ <a href="#use-cases-and-requirements"
+ class="tocxref"><span class="secno">10.</span> Use Cases and Requirements</a>
+ </li>
+ <li class="tocline">
+ <a href="#examples"
+ class="tocxref"><span class="secno">A.</span> Examples</a>
+ </li>
+ <li class="tocline">
+ <a href="#acknowledgements"
+ class="tocxref"><span class="secno">B.</span> Acknowledgements</a>
+ </li>
+ <li class="tocline">
+ <a href="#references"
+ class="tocxref"><span class="secno">C.</span> References</a>
+ <ul class="toc">
+ <li class="tocline">
+ <a href="#normative-references"
+ class="tocxref"><span class="secno">C.1</span> Normative references</a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </section>
+ <section class="informative"
+ id="introduction">
+ <h2>
+ <span class="secno">1.</span> Introduction
+ </h2>
+ <p>
+ <em>This section is non-normative.</em>
+ </p>
+ <p>
+ To enable Web pages to connect and communicate with Local-networked Services provided over <abbr title=
+ "Hypertext Transfer Protocol">HTTP</abbr>, this specification introduces the <a href=
+ "#navigatornetworkservice"><code>NavigatorNetworkService</code></a> interface.
+ </p>
+ <p>
+ Using this <abbr title="Application Programming Interface">API</abbr> consists of requesting a well-known
+ service type, known by developers and advertised by Local-networked Devices. User authorization, where the user
+ connects the web page to one or more discovered services, is expected before the web page is able to interact
+ with any Local-networked Services.
+ </p>
+ <p>
+ A web page creates a request to obtain connectivity to services running in the network by specifying a
+ well-known discovery service type that it wishes to interact with.
+ </p>
+ <p>
+ The user agent, having captured all advertised services on the network from the <a href=
+ "#dfn-service-discovery-mechanisms"
+ class="internalDFN">service discovery mechanisms</a> included in this recommendation, attempts to match the
+ requested service type to a discovered service according to the processing described herein.
+ </p>
+ <p>
+ If a service connectivity request is successful then the Web page is provided with the necessary information to
+ communicate with the authorized Local-networked Service. If the request fails then the Web page will receive an
+ error callback containing an error code describing the cause of Local-networked Service connectivity failure.
+ </p>
+ <p>
+ Once connected to a Local-networked Service the Web page can send requests and receive responses to the
+ Local-networked Service via the messaging format and appropriate channel inferred from the service type
+ authorized via the provided <abbr title="Application Programming Interface">API</abbr>. The Web page, once
+ connected, can also receive service-pushed events, in the messaging format supported by the Local-networked
+ Device, if such event subscription functionality is provided by the connected Local-networked Service.
+ </p>
+ <div class="example">
+ <p>
+ Example of requesting a <abbr title="Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr>
+ advertised service:
+ </p>
+ <hr>
+ <pre class="highlight prettyprint">
+<span class="kwd">function</span><span class="pln"> showServices</span><span class="pun">(</span><span class=
+"pln"> services </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ </span><span class="com">// Show a list of all the services provided to the web page</span><span class="pln">
+ </span><span class="kwd">for</span><span class="pun">(</span><span class="kwd">var</span><span class=
+"pln"> i </span><span class="pun">=</span><span class="pln"> </span><span class="lit">0</span><span class=
+"pun">,</span><span class="pln"> l </span><span class="pun">=</span><span class="pln"> services</span><span class=
+"pun">.</span><span class="pln">length</span><span class="pun">;</span><span class="pln"> i </span><span class=
+"pun"><</span><span class="pln"> l</span><span class="pun">;</span><span class="pln"> i</span><span class=
+"pun">++)</span><span class="pln"> console</span><span class="pun">.</span><span class="pln">log</span><span class=
+"pun">(</span><span class="pln"> services</span><span class="pun">[</span><span class="pln">i</span><span class=
+"pun">].</span><span class="pln">name </span><span class="pun">);</span><span class="pln">
+</span><span class="pun">}</span><span class="pln">
- This specification relies on several other underlying specifications.
+navigator</span><span class="pun">.</span><span class="pln">getNetworkServices</span><span class=
+"pun">(</span><span class="str">'zeroconf:_boxee-jsonrpc._tcp'</span><span class="pun">,</span><span class=
+"pln"> showServices</span><span class="pun">);</span>
+</pre>
+ </div>
+ <div class="example">
+ <p>
+ Example of requesting a UPnP advertised service, also handling error conditions:
+ </p>
+ <hr>
+ <pre class="highlight prettyprint">
+<span class="kwd">function</span><span class="pln"> showServices</span><span class="pun">(</span><span class=
+"pln"> services </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ </span><span class="com">// Show a list of all the services provided to the web page</span><span class="pln">
+ </span><span class="kwd">for</span><span class="pun">(</span><span class="kwd">var</span><span class=
+"pln"> i </span><span class="pun">=</span><span class="pln"> </span><span class="lit">0</span><span class=
+"pun">,</span><span class="pln"> l </span><span class="pun">=</span><span class="pln"> services</span><span class=
+"pun">.</span><span class="pln">length</span><span class="pun">;</span><span class="pln"> i </span><span class=
+"pun"><</span><span class="pln"> l</span><span class="pun">;</span><span class="pln"> i</span><span class=
+"pun">++)</span><span class="pln"> console</span><span class="pun">.</span><span class="pln">log</span><span class=
+"pun">(</span><span class="pln"> services</span><span class="pun">[</span><span class="pln">i</span><span class=
+"pun">].</span><span class="pln">name </span><span class="pun">);</span><span class="pln">
+</span><span class="pun">}</span><span class="pln">
- <dl>
- <dt>HTML</dt>
- <dd>Many fundamental concepts from HTML are used by this specification. [<cite><a class="bibref" rel="biblioentry" href="#bib-HTML5">HTML5</a></cite>]</dd>
- <dt>WebIDL</dt>
- <dd>The IDL blocks in this specification use the semantics of the WebIDL specification. [<cite><a class="bibref" rel="biblioentry" href="#bib-WEBIDL">WEBIDL</a></cite>]</dd>
- </dl>
- </section>
- </div>
+</span><span class="kwd">function</span><span class="pln"> error</span><span class="pun">(</span><span class=
+"pln"> e </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ console</span><span class="pun">.</span><span class="pln">log</span><span class="pun">(</span><span class=
+"pln"> </span><span class="str">"Error occurred: "</span><span class="pln"> </span><span class=
+"pun">+</span><span class="pln"> e</span><span class="pun">.</span><span class="pln">code </span><span class=
+"pun">);</span><span class="pln">
+</span><span class="pun">}</span><span class="pln">
- <div id="terminology" about="#terminology" typeof="bibo:Chapter" class="section">
- <!--OddPage--><h2><span class="secno">3. </span>Terminology</h2>
+navigator</span><span class="pun">.</span><span class="pln">getNetworkServices</span><span class=
+"pun">(</span><span class="str">'upnp:urn:schemas-upnp-org:service:ContentDirectory:1'</span><span class=
+"pun">,</span><span class="pln"> showServices</span><span class="pun">,</span><span class=
+"pln"> error</span><span class="pun">);</span>
+</pre>
+ </div>
+ <div class="example">
+ <p>
+ Example of requesting either a <abbr title="Domain Name System">DNS</abbr>-<abbr title=
+ "Service Discovery">SD</abbr> or UPnP advertised service:
+ </p>
+ <hr>
+ <pre class="highlight prettyprint">
+<span class="kwd">function</span><span class="pln"> showServices</span><span class="pun">(</span><span class=
+"pln"> services </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ </span><span class=
+"com">// Show a list of all the services provided to the web page (+ service type)</span><span class="pln">
+ </span><span class="kwd">for</span><span class="pun">(</span><span class="kwd">var</span><span class=
+"pln"> i </span><span class="pun">=</span><span class="pln"> </span><span class="lit">0</span><span class=
+"pun">,</span><span class="pln"> l </span><span class="pun">=</span><span class="pln"> services</span><span class=
+"pun">.</span><span class="pln">length</span><span class="pun">;</span><span class="pln"> i </span><span class=
+"pun"><</span><span class="pln"> l</span><span class="pun">;</span><span class="pln"> i</span><span class=
+"pun">++)</span><span class="pln">
+ console</span><span class="pun">.</span><span class="pln">log</span><span class="pun">(</span><span class=
+"pln"> services</span><span class="pun">[</span><span class="pln">i</span><span class="pun">].</span><span class=
+"pln">name </span><span class="pun">+</span><span class="pln"> </span><span class="str">'('</span><span class=
+"pln"> </span><span class="pun">+</span><span class="pln"> services</span><span class="pun">[</span><span class=
+"pln">i</span><span class="pun">].</span><span class="pln">type </span><span class="pun">+</span><span class=
+"pln"> </span><span class="str">')'</span><span class="pln"> </span><span class="pun">);</span><span class="pln">
+</span><span class="pun">}</span><span class="pln">
- <p>
- The construction "a <code>Foo</code> object", where <code>Foo</code> is actually an interface, is sometimes used instead of the more accurate "an object implementing the interface <code>Foo</code>".
- </p>
-
+navigator</span><span class="pun">.</span><span class="pln">getNetworkServices</span><span class=
+"pun">([</span><span class="pln">
+ </span><span class="str">'zeroconf:_boxee-jsonrpc._tcp'</span><span class="pun">,</span><span class="pln">
+ </span><span class="str">'upnp:urn:schemas-upnp-org:service:ContentDirectory:1'</span><span class="pln">
+</span><span class="pun">],</span><span class="pln"> showServices</span><span class="pun">);</span>
+</pre>
+ </div>
<p>
- The term DOM is used to refer to the <acronym title="Application Programming Interface">API</acronym> set made available to scripts in Web applications, and does not necessarily imply the existence of an actual <code>Document</code> object or of any
- other <code>Node</code> objects as defined in the DOM Core specifications. [<cite><a class="bibref" rel="biblioentry" href="#bib-DOM-CORE">DOM-CORE</a></cite>]
- </p>
-
- <p>
- An IDL attribute is said to be <em>getting</em> when its value is being retrieved (e.g. by author script), and is said to be <em>setting</em> when a new value is assigned to it.
- </p>
-
- <p>
- A <dfn id="dfn-valid-service-type">valid service type</dfn> is a string that begins with <code>upnp:</code> or <code>zeroconf:</code> followed by one or more characters in the ranges U+0021, U+0023 to U+0027, U+002A to U+002B, U+002D to U+002E, U+0030 to U+0039, U+0041 to U+005A, U+005E to U+007E.
+ For more detailed examples see the <a href="#examples">Examples</a> section.
</p>
-
+ </section>
+ <section id="conformance">
+ <h2>
+ <span class="secno">2.</span> Conformance
+ </h2>
<p>
- A <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> provided in the <code>type</code> attribute of the <code>getNetworkServices()</code> method will be matched against the services currently contained in the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a> according to the algorithms defined in this specification.
+ As well as sections marked as non-normative, all authoring guidelines, diagrams, examples, and notes in this
+ specification are non-normative. Everything else in this specification is normative.
</p>
- </div>
-
- <div id="requesting-networked-services" about="#requesting-networked-services" typeof="bibo:Chapter" class="section">
- <!--OddPage--><h2><span class="secno">4. </span>Requesting networked services</h2>
-
-
-<pre class="widl">[Supplemental, NoInterfaceObject]
+ <p>
+ The key words <em class="rfc2119"
+ title="must">must</em>, <em class="rfc2119"
+ title="must not">must not</em>, <em class="rfc2119"
+ title="required">required</em>, <em class="rfc2119"
+ title="should">should</em>, <em class="rfc2119"
+ title="should not">should not</em>, <em class="rfc2119"
+ title="recommended">recommended</em>, <em class="rfc2119"
+ title="may">may</em>, and <em class="rfc2119"
+ title="optional">optional</em> in this specification are to be interpreted as described in [<cite><a class=
+ "bibref"
+ href="#bib-RFC2119">RFC2119</a></cite>].
+ </p>
+ <p>
+ Requirements phrased in the imperative as part of algorithms (such as "strip any leading space characters" or
+ "return false and abort these steps") are to be interpreted with the meaning of the key word ("must", "should",
+ "may", etc) used in introducing the algorithm.
+ </p>
+ <p>
+ Some conformance requirements are phrased as requirements on attributes, methods or objects. Such requirements
+ are to be interpreted as requirements on user agents.
+ </p>
+ <p>
+ Conformance requirements phrased as algorithms or specific steps <em class="rfc2119"
+ title="may">may</em> be implemented in any manner, so long as the end result is equivalent. (In particular,
+ the algorithms defined in this specification are intended to be easy to follow, and not intended to be
+ performant.)
+ </p>
+ <p>
+ The only conformance class defined by this specification is a <dfn id="dfn-user-agent">user agent</dfn>.
+ </p>
+ <p>
+ User agents <em class="rfc2119"
+ title="may">may</em> impose implementation-specific limits on otherwise unconstrained inputs, e.g. to
+ prevent denial of service attacks, to guard against running out of memory, or to work around
+ platform-specific limitations.
+ </p>
+ <p>
+ When support for a feature is disabled (e.g. as an emergency measure to mitigate a security problem, or to aid
+ in development, or for performance reasons), user agents <em class="rfc2119"
+ title="must">must</em> act as if they had no support for the feature whatsoever, and as if the feature was
+ not mentioned in this specification. For example, if a particular feature is accessed via an attribute in a
+ Web IDL interface, the attribute itself would be omitted from the objects that implement that interface -
+ leaving the attribute on the object but making it return null or throw an exception is insufficient.
+ </p>
+ <section id="dependencies">
+ <h3>
+ <span class="secno">2.1</span> Dependencies
+ </h3>This specification relies on several other underlying specifications.
+ <dl>
+ <dt>
+ HTML
+ </dt>
+ <dd>
+ Many fundamental concepts from HTML are used by this specification. [<cite><a class="bibref"
+ href="#bib-HTML5">HTML5</a></cite>]
+ </dd>
+ <dt>
+ WebIDL
+ </dt>
+ <dd>
+ The IDL blocks in this specification use the semantics of the WebIDL specification. [<cite><a class=
+ "bibref"
+ href="#bib-WEBIDL">WEBIDL</a></cite>]
+ </dd>
+ </dl>
+ </section>
+ </section>
+ <section id="terminology">
+ <h2>
+ <span class="secno">3.</span> Terminology
+ </h2>
+ <p>
+ The construction "a <code>Foo</code> object", where <code>Foo</code> is actually an interface, is sometimes
+ used instead of the more accurate "an object implementing the interface <code>Foo</code>".
+ </p>
+ <p>
+ The term DOM is used to refer to the <abbr title="Application Programming Interface">API</abbr> set made
+ available to scripts in Web applications, and does not necessarily imply the existence of an actual
+ <code>Document</code> object or of any other <code>Node</code> objects as defined in the DOM Core
+ specifications. [<cite><a class="bibref"
+ href="#bib-DOM4">DOM4</a></cite>]
+ </p>
+ <p>
+ An IDL attribute is said to be <em>getting</em> when its value is being retrieved (e.g. by author script), and
+ is said to be <em>setting</em> when a new value is assigned to it.
+ </p>
+ <p>
+ A <dfn id="dfn-valid-service-type">valid service type</dfn> is a string that begins with <code>upnp:</code> or
+ <code>zeroconf:</code> followed by one or more characters in the ranges U+0021, U+0023 to U+0027, U+002A to
+ U+002B, U+002D to U+002E, U+0030 to U+0039, U+0041 to U+005A, U+005E to U+007E.
+ </p>
+ <p>
+ A <a href="#dfn-valid-service-type"
+ class="internalDFN">valid service type</a> provided in the <code>type</code> attribute of the <a href=
+ "#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> method will be matched against the
+ services currently contained in the <a href="#dfn-list-of-available-service-records"
+ class="internalDFN">list of available service records</a> according to the algorithms defined in this
+ specification.
+ </p>
+ <p>
+ A <dfn id="dfn-user-agent-generated-callback-url">user-agent generated callback url</dfn> is a Local-network
+ accessible <abbr title="Uniform Resource Locator">URL</abbr> endpoint that a <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> generates and maintains for receiving <abbr title=
+ "Hypertext Transfer Protocol">HTTP</abbr> NOTIFY requests from UPnP Event sources. It is only required when
+ the user agent implements UPnP Service Discovery as defined in this specification.
+ </p>
+ </section>
+ <section id="requesting-networked-services">
+ <h2>
+ <span class="secno">4.</span> Requesting networked services
+ </h2>
+ <pre class="widl">
+[Supplemental, NoInterfaceObject]
interface <dfn id="navigatornetworkservice">NavigatorNetworkService</dfn> {
// Obtain a Local-networked Service
void <a href="#dom-navigator-getnetworkservices">getNetworkServices</a>( in any type,
- in <a href="#navigatornetworkservicesuccesscallback">NavigatorNetworkServiceSuccessCallback</a> successCallback,
- in optional <a href="#navigatornetworkserviceerrorcallback">NavigatorNetworkServiceErrorCallback</a> errorCallback );
+ in <a href=
+"#navigatornetworkservicesuccesscallback">NavigatorNetworkServiceSuccessCallback</a> successCallback,
+ in optional <a href=
+"#navigatornetworkserviceerrorcallback">NavigatorNetworkServiceErrorCallback</a> errorCallback );
};
-<a class="externalDFN" href="http://www.whatwg.org/specs/web-apps/current-work/complete/timers.html#navigator">Navigator</a> implements <a href="#navigatornetworkservice">NavigatorNetworkService</a>;
+<a class="externalDFN"
+ href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/timers.html#navigator">Navigator</a> implements <a href=
+ "#navigatornetworkservice">NavigatorNetworkService</a>;
[Callback=FunctionOnly, NoInterfaceObject]
interface <dfn id="navigatornetworkservicesuccesscallback">NavigatorNetworkServiceSuccessCallback</dfn> {
@@ -1018,457 +734,506 @@
void handleEvent( in <a href="#navigatornetworkserviceerror">NavigatorNetworkServiceError</a> error );
};
</pre>
-
- <section id="methods" about="#methods" typeof="bibo:Chapter">
- <h3><span class="secno">4.1 </span>Methods</h3>
-
- <dl class="domintro">
- <dt>
- <var title="">window</var>
- .
- <code title="dom-navigator">
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/timers.html#navigator">navigator</a>
- </code>
- .
- <code title="dom-navigator-getNetworkServices">
- <a href="#dom-navigator-getnetworkservices">getNetworkServices</a>
- </code>
- (
- <var title="">type</var>
- ,
- <var title="">successCallback</var>
- [,
- <var title="">errorCallback</var>
- ] )
- </dt>
- <dd>
- <p>Prompts the user to select one or more discovered network services that have advertised support for the requested service type.</p>
- <p>
- The
- <var title="">type</var>
- argument contains one or more <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> tokens that the web page would like to interact with.
- </p>
+ <section id="methods">
+ <h3>
+ <span class="secno">4.1</span> Methods
+ </h3>
+ <dl class="domintro">
+ <dt>
+ <var title="">window</var> . <code title="dom-navigator"><a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/timers.html#navigator">navigator</a></code> .
+ <code title="dom-navigator-getNetworkServices"><a href=
+ "#dom-navigator-getnetworkservices">getNetworkServices</a></code> ( <var title="">type</var> , <var title=
+ "">successCallback</var> [, <var title="">errorCallback</var> ] )
+ </dt>
+ <dd>
+ <p>
+ Prompts the user to select one or more discovered network services that have advertised support for the
+ requested service type.
+ </p>
+ <p>
+ The <var title="">type</var> argument contains one or more <a href="#dfn-valid-service-type"
+ class="internalDFN">valid service type</a> tokens that the web page would like to interact with.
+ </p>
+ <p>
+ If the user accepts, the <var title="">successCallback</var> is invoked, with one or more <a href=
+ "#networkservice"><code>NetworkService</code></a> objects as its argument.
+ </p>
+ <p>
+ If the user declines, the <var title="">errorCallback</var> (if any) is invoked.
+ </p>
+ </dd>
+ </dl>
+ <div>
<p>
- If the user accepts, the
- <var title="">successCallback</var>
- is
- invoked, with one or more
- <code>
- <a href="#networkservice"><code>NetworkService</code></a>
- </code>
- objects as
- its argument.
- </p>
- <p>
- If the user declines, the
- <var title="">errorCallback</var>
- (if
- any) is invoked.
+ When the <dfn id="dom-navigator-getnetworkservices"
+ title="dom-navigator-getnetworkservices"><code>getNetworkServices(type, successCallback[,
+ errorCallback])</code></dfn> method is called, the <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> <em class="rfc2119"
+ title="must">must</em> run the following steps:
</p>
- </dd>
- </dl>
-
- <div>
- <p>
- When the <dfn id="dom-navigator-getnetworkservices" title="dom-navigator-getnetworkservices"><code>getNetworkServices(type, successCallback[, errorCallback])</code></dfn> method is called, the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> run the following steps:
- </p>
-
<ol class="rule">
- <li>
- If <var>successCallback</var> is empty or is not an object of type <code>Function</code> then the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> abort these steps.
+ <li>Let <var>requested control types</var> be initially set to an empty array.
</li>
-
- <li>
- Let <var>requested control types</var> be initially set to an empty array.
+ <li>If <var>type</var> is an array consisting of one or more <a href="#dfn-valid-service-type"
+ class="internalDFN">valid service type</a> tokens, then let <var>requested control types</var> by the
+ value of <var>type</var>, removing any non-<a href="#dfn-valid-service-type"
+ class="internalDFN">valid service type</a> tokens from the resulting array.
</li>
-
- <li>
- If <var>type</var> is an array consisting of one or more <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> tokens, then let <var>requested control types</var> by the value of <var>type</var>, removing any non-<a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> tokens from the resulting array.
+ <li>If <var>type</var> is a string consisting of one <a href="#dfn-valid-service-type"
+ class="internalDFN">valid service type</a> token, then let <var>requested control types</var> be an
+ array containing one item with a value of <var>type</var>.
</li>
-
+ <li>If <var>requested control types</var> is an array that contains at least one or more <a title=
+ "valid service type"
+ href="#dfn-valid-service-type"
+ class="internalDFN">valid service type</a> tokens then continue to the step labeled <em>process</em>
+ below. Otherwise, the <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> <em class="rfc2119"
+ title="must">must</em> <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
+ class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an
+ object of type <code>Function</code>, with a new <a href=
+ "#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose <a href=
+ "#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 2
+ (<a href=
+ "#dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></a>) as
+ its argument, abort any remaining steps and return.
+ </li>
<li>
- If <var>type</var> is a string consisting of one <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> token, then let <var>requested control types</var> be an array containing one item with a value of <var>type</var>.
- </li>
-
- <li>
- If <var>requested control types</var> is an array that contains at least one or more <a title="valid service type" href="#dfn-valid-service-type" class="internalDFN">valid service type</a> tokens then continue to the step labeled <em>process</em> below. Otherwise, the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an object of type <code>Function</code>, with a new <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose
- <a href="#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 2
- (<a href="#dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></a>) as its argument,
- abort any remaining steps and return.
- </li>
-
- <li>
- <em>Process</em>: Let <var>services found</var> be an empty array.
+ <em>Process</em>: Let <var>services found</var> be an empty array.
</li>
-
- <li>
- For each <var>available service</var> in the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a> run the following steps:
- <ol class="rule">
- <li>
- For each <var>requested control type</var> in <var>requested control types</var>: If <var>available service</var>'s <code>type</code> attribute equals the <var>requested control type</var> then let <var>matched service</var> equal the value of <var>available service</var> and continue at the step labeled <var>attach</var> below.
- </li>
- <li>
- Continue at the next <var>available service</var>.
- </li>
- <li>
- <em>Attach</em>: If <var>matched service</var> is not empty then run the following steps:
-
- <ol class="rule">
- <li>
- Let <var>new service object</var> be a new <a href="#networkservice"><code>NetworkService</code></a> object, mapping the parameters of
- <var>matched service</var> to this new object where possible.
- </li>
- <li>
- Append <var>new service object</var> to the <var>services found</var> array.
- </li>
- </ol>
- </li>
- </ol>
+ <li>For each <var>available service</var> in the <a href="#dfn-list-of-available-service-records"
+ class="internalDFN">list of available service records</a> run the following steps:
+ <ol class="rule">
+ <li>For each <var>requested control type</var> in <var>requested control types</var>: If <var>available
+ service</var>'s <code>type</code> attribute equals the <var>requested control type</var> then let <var>
+ matched service</var> equal the value of <var>available service</var> and continue at the step
+ labeled <var>attach</var> below.
+ </li>
+ <li>Continue at the next <var>available service</var>.
+ </li>
+ <li>
+ <em>Attach</em>: If <var>matched service</var> is not empty then run the following steps:
+ <ol class="rule">
+ <li>Let <var>new service object</var> be a new <a href=
+ "#networkservice"><code>NetworkService</code></a> object, mapping the parameters of <var>matched
+ service</var> to this new object where possible.
+ </li>
+ <li>Append <var>new service object</var> to the <var>services found</var> array.
+ </li>
+ </ol>
+ </li>
+ </ol>
</li>
-
- <li>
- If <var>services found</var> is an empty array, then the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an object of type <code>Function</code>, with a new <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose
- <a href="#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
- (<a href="#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its argument, abort any remaining steps and return.
- </li>
-
- <li>
- Return, and run the remaining steps asynchronously.
- </li>
-
- <li>
- Optionally, e.g. based on a previously-established user preference, for security reasons, or due to platform limitations, the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="may">may</em> <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an object of type <code>Function</code>, with a new <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose
- <a href="#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
- (<a href="#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its argument, abort any remaining steps and return.
+ <li>If <var>services found</var> is an empty array, then the <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> <em class="rfc2119"
+ title="must">must</em> <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
+ class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an
+ object of type <code>Function</code>, with a new <a href=
+ "#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose <a href=
+ "#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
+ (<a href=
+ "#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its
+ argument, abort any remaining steps and return.
</li>
-
- <li>
- The <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> prompt the user in a user-agent-specific manner for permission to provide the
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/browsers.html#entry-script" class="externalDFN">entry script</a>'s
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/origin-0.html#origin" class="externalDFN">origin</a> with an array of
- <a href="#networkservice"><code>NetworkService</code></a> objects representing the user-authorized subset of <var>services found</var>.
-
- <p>
- If the user grants permission to access one or more networked services then the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="should">should</em> include an
- "ongoing local-network communication" indicator.
- </p>
-
- <p>If the user denies permission, then the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an object of type <code>Function</code>, with a new <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose
- <a href="#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
- (<a href="#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its argument, abort any remaining steps and return.
+ <li>Return, and run the remaining steps asynchronously.
+ </li>
+ <li>Optionally, e.g. based on a previously-established user preference, for security reasons, or due to
+ platform limitations, the <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> <em class="rfc2119"
+ title="may">may</em> <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
+ class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an
+ object of type <code>Function</code>, with a new <a href=
+ "#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose <a href=
+ "#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
+ (<a href=
+ "#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its
+ argument, abort any remaining steps and return.
+ </li>
+ <li>The <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> <em class="rfc2119"
+ title="must">must</em> prompt the user in a user-agent-specific manner for permission to provide the
+ <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/browsers.html#entry-script"
+ class="externalDFN">entry script</a>'s <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/origin-0.html#origin"
+ class="externalDFN">origin</a> with an array of <a href=
+ "#networkservice"><code>NetworkService</code></a> objects representing the user-authorized subset of
+ <var>services found</var>.
+ <p>
+ If the user grants permission to access one or more networked services then the <a href=
+ "#dfn-user-agent"
+ class="internalDFN">user agent</a> <em class="rfc2119"
+ title="should">should</em> include an "ongoing local-network communication" indicator.
</p>
-
+ <p>
+ If the user denies permission, then the <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> <em class="rfc2119"
+ title="must">must</em> <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
+ class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an
+ object of type <code>Function</code>, with a new <a href=
+ "#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose <a href=
+ "#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
+ (<a href=
+ "#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its
+ argument, abort any remaining steps and return.
+ </p>
<p>
If the user never responds, this algorithm stalls on this step.
</p>
-
- </li>
-
- <li>
- Let <var>services</var> be the array of one or more <a href="#networkservice"><code>NetworkService</code></a> objects for which the user granted permission.
- </li>
-
- <li>
- For each Object <var>service</var> in <var>services</var>, run the following substeps:
-
- <ol class="rule">
- <li>
- Add the <var>service</var>'s <code>url</code> parameter to the <a href="#dfn-entry-script-origin-s-url-whitelist" class="internalDFN">entry script origin's <acronym title="Uniform Resource Locator"><acronym title="Uniform Resource Locator">URL</acronym></acronym> whitelist</a>.
- </li>
- <li>
- If <var>service</var> was originally created from a <acronym title="Universal Plug-and-Play">UPnP</acronym> discovery process and the <var>service</var>'s <code>eventsUrl</code> parameter is not empty then <a href="#dfn-setup-a-upnp-events-subscription" class="internalDFN">setup a <acronym title="Universal Plug-and-Play">UPnP</acronym> Events Subscription</a> for <var>service</var>.
- </li>
- </ol>
</li>
-
- <li>
- Let <var>services manager</var> be a new <a href="#networkservices"><code>NetworkServices</code></a> object.
- </li>
-
- <li>
- Set <var>services manager</var>'s <code>servicesAvailable</code> attribute to the length of <var>services</var>.
- </li>
-
- <li>
- Store the set of <var>services</var> as <dfn id="current_authorized_services">current authorized services</dfn> internally against the newly created <var>services manager</var> object.
+ <li>Let <var>services</var> be the array of one or more <a href=
+ "#networkservice"><code>NetworkService</code></a> objects for which the user granted permission.
</li>
-
- <li>
- The <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>successCallback</var> with
- <var>services manager</var> as its argument.
+ <li>For each Object <var>service</var> in <var>services</var>, run the following sub-steps:
+ <ol class="rule">
+ <li>Add the <var>service</var>'s <code>url</code> parameter to the <a href=
+ "#dfn-entry-script-origin-s-url-whitelist"
+ class="internalDFN">entry script origin's <abbr title="Uniform Resource Locator">URL</abbr>
+ whitelist</a>.
+ </li>
+ <li>If <var>service</var>'s <code>type</code> parameter begins with the DOMString "<code>upnp:</code>"
+ and the <var>service</var>'s <code>eventsUrl</code> parameter is not empty then <a href=
+ "#dfn-setup-a-upnp-events-subscription"
+ class="internalDFN">setup a UPnP Events Subscription</a> for <var>service</var>.
+ </li>
+ </ol>
</li>
-
+ <li>Let <var>services manager</var> be a new <a href="#networkservices"><code>NetworkServices</code></a>
+ object.
+ </li>
+ <li>Set <var>services manager</var>'s <a href=
+ "#dom-networkservices-servicesavailable"><code>servicesAvailable</code></a> attribute to the number of
+ items currently found in the <a href="#dfn-list-of-available-service-records"
+ class="internalDFN">list of available service records</a> whose <code>type</code> property matches
+ any of the tokens requested in <var>requested control types</var>.
+ </li>
+ <li>Add <var>services</var> to the <var>services manager</var> object as its collection of <a href=
+ "#dfn-indexed-properties"
+ class="internalDFN">indexed properties</a>.
+ </li>
+ <li>Set <var>services manager</var>'s <a href="#dom-networkservices-length"><code>length</code></a>
+ attribute to the number of items in <var>services</var>.
+ </li>
+ <li>Add <var>services manager</var> to the <a href="#dfn-list-of-active-service-managers"
+ class="internalDFN">list of active service managers</a>.
+ </li>
+ <li>The <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> <em class="rfc2119"
+ title="must">must</em> <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
+ class="externalDFN">queue a task</a> to invoke <var>successCallback</var> with <var>services
+ manager</var> as its argument.
+ </li>
</ol>
-
- <p>
- The <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#task-source" class="externalDFN">task source</a> for these
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#concept-task" class="externalDFN">tasks</a> is the
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#user-interaction-task-source" class="externalDFN">user interaction task source</a>.
- </p>
-
<p>
- When a <a href="#networkservice"><code>NetworkService</code></a> object is provided to a Web page, the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> add the <code>url</code> property
- to the <dfn id="dfn-entry-script-origin-s-url-whitelist">entry script origin's <acronym title="Uniform Resource Locator">URL</acronym> whitelist</dfn>. This list enables the
- Web page to override and initiate cross-site resource requests towards these URLs, and any sub-resources of these URLs, within the current
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/browsers.html#entry-script" class="externalDFN">entry script</a>'s
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/origin-0.html#origin" class="externalDFN">origin</a> via various existing mechanisms (e.g. Web Sockets, Server-Sent Events,
- Web Messaging, XMLHttpRequest).
- </p>
-
- <p>
- If the user navigates away from the current browsing context, the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> remove all previously whitelisted urls from the <a href="#dfn-entry-script-origin-s-url-whitelist" class="internalDFN">entry script origin's <acronym title="Uniform Resource Locator">URL</acronym> whitelist</a>.
- There is no persistence to network service selections provided to a web page. It is not possible to access a previously white-listed networked service without the necessary user authorization in all of the following cases:
- </p><ul>
- <li>If the current script is reloaded at any point in the same or different window.</li>
- <li>if the current script reinvokes the <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> method at any point in its execution.</li>
- <li>If the user navigates forward or back in their history to reload the current page.</li>
- <li>If a script is running in a different origin.</li>
- </ul>
- <p></p>
-
- </div>
- </section>
-
- <section id="error-handling" about="#error-handling" typeof="bibo:Chapter">
- <h3><span class="secno">4.2 </span>Error Handling</h3>
-
- <dl class="domintro">
- <dt>
- <var title="">error</var>
- .
- <code title="dom-NavigatorNetworkServiceError-code">
- <a href="#dom-navigatornetworkserviceerror-code">code</a>
- </code>
- </dt>
- <dd>
+ The <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#task-source"
+ class="externalDFN">task source</a> for these <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#concept-task"
+ class="externalDFN">tasks</a> is the <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#user-interaction-task-source"
+ class="externalDFN">user interaction task source</a>.
+ </p>
<p>
- Returns the current error's error code. At the current time, this may be <code>1</code> or <code>2</code>, for which the
- corresponding error constants
- <a href="#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a> and
- <a href="#dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></a> are defined.
+ When a <a href="#networkservice"><code>NetworkService</code></a> object is provided to a Web page, the
+ <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> <em class="rfc2119"
+ title="must">must</em> add the <code>url</code> property to the <dfn id=
+ "dfn-entry-script-origin-s-url-whitelist">entry script origin's <abbr title=
+ "Uniform Resource Locator">URL</abbr> whitelist</dfn>. This list enables the Web page to override and
+ initiate cross-site resource requests towards these URLs, and any sub-resources of these URLs, within
+ the current <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/browsers.html#entry-script"
+ class="externalDFN">entry script</a>'s <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/origin-0.html#origin"
+ class="externalDFN">origin</a> via various existing mechanisms (e.g. Web Sockets, Server-Sent Events,
+ Web Messaging, XMLHttpRequest).
</p>
- </dd>
- </dl>
-
- <p>
- The <dfn id="dom-navigatornetworkserviceerror-code" title="dom-navigatornetworkserviceerror-code"><code>code</code></dfn> attribute of a
- <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object <em class="rfc2119" title="must">must</em> return the code for the error, which will be one of the following:
- </p>
-
- <dl>
- <dt>
- <dfn id="dom-navigatornetworkserviceerror-permission_denied" title="dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></dfn> (numeric value 1)
- </dt>
- <dd>
- The user denied the page permission to access any services.
- </dd>
- <dt>
- <dfn id="dom-navigatornetworkserviceerror-unknown_type_prefix" title="dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></dfn> (numeric value 2)
- </dt>
- <dd>
- No <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> tokens were provided in the method invocation.
- </dd>
- </dl>
-
+ <p>
+ If the user navigates away from the current browsing context, the <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> <em class="ct"><em class="rfc2119"
+ title="must">must</em></em> remove all previously whitelisted urls from the <a href=
+ "#dfn-entry-script-origin-s-url-whitelist"
+ class="internalDFN">entry script origin's <abbr title="Uniform Resource Locator">URL</abbr>
+ whitelist</a>. There is no persistence to network service selections provided to a web page. It is not
+ possible to access a previously white-listed networked service without the necessary user authorization
+ in all of the following cases:
+ </p>
+ <ul>
+ <li>If the current script is reloaded at any point in the same or different window.
+ </li>
+ <li>if the current script reinvokes the <a href=
+ "#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> method at any point in its
+ execution.
+ </li>
+ <li>If the user navigates forward or back in their history to reload the current page.
+ </li>
+ <li>If a script is running in a different origin.
+ </li>
+ </ul>
+ </div>
</section>
-
- </div>
- <div id="obtaining-networked-services" about="#obtaining-networked-services" typeof="bibo:Chapter" class="section">
- <!--OddPage--><h2><span class="secno">5. </span>Obtaining networked services</h2>
-
+ <section id="error-handling">
+ <h3>
+ <span class="secno">4.2</span> Error Handling
+ </h3>
+ <dl class="domintro">
+ <dt>
+ <var title="">error</var> . <code title="dom-NavigatorNetworkServiceError-code"><a href=
+ "#dom-navigatornetworkserviceerror-code">code</a></code>
+ </dt>
+ <dd>
+ <p>
+ Returns the current error's error code. At the current time, this will be <code>1</code> or
+ <code>2</code>, for which the corresponding error constants <a href=
+ "#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a> and <a href=
+ "#dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></a> are
+ defined.
+ </p>
+ </dd>
+ </dl>
+ <p>
+ The <dfn id="dom-navigatornetworkserviceerror-code"
+ title="dom-navigatornetworkserviceerror-code"><code>code</code></dfn> attribute of a <a href=
+ "#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object <em class=
+ "ct"><em class="rfc2119"
+ title="must">must</em></em> return the code for the error, which will be one of the following:
+ </p>
+ <dl>
+ <dt>
+ <dfn id="dom-navigatornetworkserviceerror-permission_denied"
+ title="dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></dfn>
+ (numeric value 1)
+ </dt>
+ <dd>
+ The user or user agent denied the page permission to access any services.
+ </dd>
+ <dt>
+ <dfn id="dom-navigatornetworkserviceerror-unknown_type_prefix"
+ title="dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></dfn>
+ (numeric value 2)
+ </dt>
+ <dd>
+ No <a href="#dfn-valid-service-type"
+ class="internalDFN">valid service type</a> tokens were provided in the method invocation.
+ </dd>
+ </dl>
+ </section>
+ </section>
+ <section id="obtaining-networked-services">
+ <h2>
+ <span class="secno">5.</span> Obtaining networked services
+ </h2>
<p>
- The <a href="#networkservices"><code>NetworkServices</code></a> interface is the top-level response object from a call to <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> and provides access to a set of user-authorized <a href="#networkservice"><code>NetworkService</code></a> objects for the given request.
+ The <a href="#networkservices"><code>NetworkServices</code></a> interface is the top-level response object from
+ a call to <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> and provides access
+ to a set of user-authorized <a href="#networkservice"><code>NetworkService</code></a> objects for the given
+ request.
</p>
-
-<pre class="widl">[NoInterfaceObject]
+ <pre class="widl">
+[NoInterfaceObject]
interface <dfn id="networkservices">NetworkServices</dfn> {
readonly attribute unsigned long <a href="#dom-networkservices-length">length</a>;
getter <a href="#networkservice">NetworkService</a> (unsigned long index);
- <a href="#networkservice">NetworkService</a>? <a href="#dom-networkservices-getservicebyid">getServiceById</a>(DOMString id);
+ <a href="#networkservice">NetworkService</a>? <a href=
+"#dom-networkservices-getservicebyid">getServiceById</a>(DOMString id);
readonly attribute unsigned long <a href="#dom-networkservices-servicesavailable">servicesAvailable</a>;
// event handler attributes
- attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler" class="externalDFN">EventHandler</a> <a href="#dom-networkservices-onserviceavailable">onserviceavailable</a>;
- attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler" class="externalDFN">EventHandler</a> <a href="#dom-networkservices-onserviceunavailable">onserviceunavailable</a>;
+ attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler"
+ class="externalDFN">EventHandler</a> <a href="#dom-networkservices-onserviceavailable">onserviceavailable</a>;
+ attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler"
+ class="externalDFN">EventHandler</a> <a href=
+ "#dom-networkservices-onserviceunavailable">onserviceunavailable</a>;
};
-<a href="#networkservices">NetworkServices</a> implements <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#interface-eventtarget" class="externalDFN">EventTarget</a>;
+<a href="#networkservices">NetworkServices</a> implements <a href=
+"http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#interface-eventtarget"
+ class="externalDFN">EventTarget</a>;
</pre>
-
- <section id="attributes" about="#attributes" typeof="bibo:Chapter">
- <h3><span class="secno">5.1 </span>Attributes</h3>
-
+ <section id="attributes">
+ <h3>
+ <span class="secno">5.1</span> Attributes
+ </h3>
<dl class="domintro">
<dt>
- <code title="dom-networkservices-length">
- <a href="#dom-networkservices-length">length</a>
- </code>
+ <code title="dom-networkservices-length"><a href="#dom-networkservices-length">length</a></code>
</dt>
<dd>
<p>
- Returns the current number of services in the respective object's <a href="#current_authorized_services" class="internalDFN">current authorized services</a>.
+ Returns the current number of items in the current object's collection of <a href=
+ "#networkservice"><code>NetworkService</code></a> objects.
</p>
</dd>
<dt>
- <code title="dom-networkservices-servicesavailable">
- <a href="#dom-networkservices-servicesavailable">servicesAvailable</a>
- </code>
+ <code title="dom-networkservices-servicesavailable"><a href=
+ "#dom-networkservices-servicesavailable">servicesAvailable</a></code>
</dt>
<dd>
<p>
- Returns the current number of services matching one of the app-requested <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> tokens that are actively available within the user's current network.
+ Returns the current number of items matching one of the app-requested <a href="#dfn-valid-service-type"
+ class="internalDFN">valid service type</a> tokens in the <a href=
+ "#dfn-list-of-available-service-records"
+ class="internalDFN">list of available service records</a>.
</p>
</dd>
</dl>
-
<div>
- <p>
- The <dfn id="dom-networkservices-length"><code>length</code></dfn> attribute <em class="rfc2119" title="must">must</em> return the number of services represented in the object's corresponding <a href="#current_authorized_services" class="internalDFN">current authorized services</a> list at the time of getting.
- </p>
-
- <p>
- The <dfn id="dom-networkservices-servicesavailable"><code>servicesAvailable</code></dfn> attribute <em class="rfc2119" title="must">must</em> return the number of services available in the
- user's network that match the <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> that was initially used to create the current <a href="#networkservices"><code>NetworkServices</code></a> object.
- By default, <a href="#dom-networkservices-servicesavailable"><code>servicesAvailable</code></a> <em class="rfc2119" title="must">must</em> be set to <code>1</code>.
- </p>
-
- <p>
- When a previously unknown instance of a networked service matching one or the requested <a href="#dfn-valid-service-type">valid service types</a> becomes available on the user's current network, the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> fire a new simple
- event at the <a href="#dom-networkservices-onserviceavailable"><code>onserviceavailable</code></a> event handler.
- </p>
-
- <p>
- When a previously known instance of a networked service matching one or the requested <a href="#dfn-valid-service-type">valid service types</a> becomes unavailable on the user's current network, the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> fire a new simple
- event at the <a href="#dom-networkservices-onserviceunavailable"><code>onserviceunavailable</code></a> event handler.
- </p>
+ <p>
+ The <dfn id="dom-networkservices-length"><code>length</code></dfn> attribute <em class="rfc2119"
+ title="must">must</em> return the number of <a href="#networkservice"><code>NetworkService</code></a>
+ objects represented by the collection.
+ </p>
+ <p>
+ The <dfn id="dom-networkservices-servicesavailable"><code>servicesAvailable</code></dfn> attribute
+ <em class="rfc2119"
+ title="must">must</em> return the number of services in the <a href=
+ "#dfn-list-of-available-service-records"
+ class="internalDFN">list of available service records</a> whose <code>type</code> attribute matches any
+ of the <a href="#dfn-valid-service-type"
+ class="internalDFN">valid service type</a> tokens that was initially used to create the current <a href=
+ "#networkservices"><code>NetworkServices</code></a> object.
+ </p>
</div>
-
</section>
-
- <section id="methods-1" about="#methods-1" typeof="bibo:Chapter">
- <h3><span class="secno">5.2 </span>Methods</h3>
+ <section id="methods-1">
+ <h3>
+ <span class="secno">5.2</span> Methods
+ </h3>
<dl class="domintro">
- <dt>
- <code title="networkservices-getter">
- <a href="#networkservices">services</a>
- </code>
- [
- <var title="">index</var>
- ]
- </dt>
- <dd>
- <p>
- Returns the specified <a href="#networkservice"><code>NetworkService</code></a> object.
+ <dt>
+ <code title="networkservices-getter"><a href="#networkservices">services</a></code> [ <var title=
+ "">index</var> ]
+ </dt>
+ <dd>
+ <p>
+ Returns the specified <a href="#networkservice"><code>NetworkService</code></a> object.
+ </p>
+ </dd>
+ <dt>
+ <code title="networkservices-getter"><a href="#networkservices">services</a></code> . <code title=
+ "dom-networkservices-getservicebyid"><a href=
+ "#dom-networkservices-getservicebyid">getServiceById</a></code> ( <var title="">id</var> )
+ </dt>
+ <dd>
+ <p>
+ Returns the <a href="#networkservice"><code>NetworkService</code></a> object with the given identifier,
+ or null if no service has that identifier.
+ </p>
+ </dd>
+ </dl>
+ <p>
+ A <a href="#networkservices"><code>NetworkServices</code></a> object represents the current collection of one
+ or more <a href="#networkservice"><code>NetworkService</code></a> objects. A <a href=
+ "#networkservices"><code>NetworkServices</code></a> object is <span>immutable</span> meaning that it cannot
+ be modified.
+ </p>
+ <div class="note">
+ <div class="note-title">
+ <span>Note</span>
+ </div>
+ <p class="">
+ Each service in a <a href="#networkservices"><code>NetworkServices</code></a> object thus has an index; the
+ first has the index 0, and each subsequent service is numbered one higher than the previous one.
</p>
- </dd>
- <dt>
- <code title="networkservices-getter">
- <a href="#networkservices">services</a>
- </code>
- .
- <code title="dom-networkservices-getservicebyid">
- <a href="#dom-networkservices-getservicebyid">getServiceById</a>
- </code>
- (
- <var title="">id</var>
- )
- </dt>
- <dd>
- <p>
- Returns the <a href="#networkservice"><code>NetworkService</code></a> object with the given identifier, or null if no
- service has that identifier.
- </p>
- </dd>
- </dl>
-
+ </div>
+ <p>
+ The <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/multipage/infrastructure.html#supported-property-indices"
+ class="externalDFN">supported property indices</a> of <a href=
+ "#networkservices"><code>NetworkServices</code></a> objects at any instant are the numbers from zero to
+ the number of the <a href="#networkservice"><code>NetworkService</code></a> objects in the collection
+ minus one.
+ </p>
+ <p>
+ To <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/multipage/infrastructure.html#determine-the-value-of-an-indexed-property"
+ class="externalDFN">determine the value of an indexed property</a> for a given index <var>index</var> in a
+ <a href="#networkservices"><code>NetworkServices</code></a> object the user agent <em class="rfc2119"
+ title="must">must</em> return the <a href="#networkservice"><code>NetworkService</code></a> object that
+ represents the <var>index</var>th item in the collection.
+ </p>
+ <p>
+ The <dfn id="dom-networkservices-getservicebyid"><code>getServiceById(id)</code></dfn> method <em class=
+ "ct"><em class="rfc2119"
+ title="must">must</em></em> return the first <a href="#networkservice"><code>NetworkService</code></a>
+ object in the collection whose <a href="#dom-networkservice-id"><code>id</code></a> attribute is equal to
+ the value of the <var>id</var> argument provided. When no <a href=
+ "#networkservice"><code>NetworkService</code></a> objects match the given argument, the method <em class=
+ "rfc2119"
+ title="must">must</em> return null.
+ </p>
+ <p>
+ Services available within the local network can connect and disconnect at different times during the
+ execution of a web page. A <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> can inform a web page when the state of networked services matching the
+ requested <a href="#dfn-valid-service-type"
+ class="internalDFN">valid service type</a> change. Web pages can use this information to enable in-page
+ experiences for communicating the state of networked services with the ability to change the particular
+ service or set of services the page is connected to by re-invoking the <a href=
+ "#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> method.
+ </p>
+ </section>
+ <section id="events">
+ <h3>
+ <span class="secno">5.3</span> Events
+ </h3>
+ <p>
+ The following are the event handlers (and their corresponding event handler event types) that <em class=
+ "ct"><em class="rfc2119"
+ title="must">must</em></em> be supported, as IDL attributes, by all objects implementing the <a href=
+ "#networkservices"><code>NetworkServices</code></a> interface:
+ </p>
+ <table border="1">
+ <thead>
+ <tr>
+ <th>
+ <span title="event handlers">Event handler</span>
+ </th>
+ <th>
+ <span>Event handler event type</span>
+ </th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <dfn id="dom-networkservices-onserviceavailable"
+ title="dom-NetworkServices-onserviceavailable"><code>onserviceavailable</code></dfn>
+ </td>
+ <td>
+ <a href="#event-serviceavailable"><code>serviceavailable</code></a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="dom-networkservices-onserviceunavailable"
+ title="dom-NetworkServices-onserviceunavailable"><code>onserviceunavailable</code></dfn>
+ </td>
+ <td>
+ <a href="#event-serviceunavailable"><code>serviceunavailable</code></a>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+ </section>
+ <section id="communicating-with-a-networked-service">
+ <h2>
+ <span class="secno">6.</span> Communicating with a networked service
+ </h2>
<p>
- A <a href="#networkservices"><code>NetworkServices</code></a> object represents the current list of zero or more <a href="#current_authorized_services" class="internalDFN">current authorized services</a>, of which zero or more can be available at a time. Each item in <a href="#current_authorized_services" class="internalDFN">current authorized services</a> is represented by a <a href="#networkservice"><code>NetworkService</code></a> object.
- </p>
-
- <p class="note">
- Each service in a <a href="#networkservices"><code>NetworkServices</code></a> object thus has an index; the first has the index 0, and each subsequent service is numbered one higher than the previous one. If the <a href="#dfn-user-agent" class="internalDFN">user agent</a> dynamically adds or removes network services for any reason, then the indices of the services in <a href="#current_authorized_services" class="internalDFN">current authorized services</a> will change dynamically. If the set of network services changes entirely, then all the previous services will be removed from <a href="#current_authorized_services" class="internalDFN">current authorized services</a> and replaced with new services.
- </p>
-
- <p>
- The <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/infrastructure.html#supported-property-indices" class="externalDFN">supported property indices</a> of <a href="#networkservices"><code>NetworkServices</code></a> objects at any instant are the numbers from zero to the number of items in <a href="#current_authorized_services" class="internalDFN">current authorized services</a> represented by the respective object minus one, if any services are represented in <a href="#current_authorized_services" class="internalDFN">current authorized services</a>. If a <a href="#networkservices"><code>NetworkServices</code></a> object represents no <a href="#current_authorized_services" class="internalDFN">current authorized services</a>, it has no <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/infrastructure.html#supported-property-indices" class="externalDFN">supported property indices</a>.
+ The <a href="#networkservice"><code>NetworkService</code></a> interface is used to provide a set of connection
+ information for an <abbr title="Hypertext Transfer Protocol">HTTP</abbr> service endpoint and if available,
+ service events, running on a networked device.
</p>
-
- <p>
- To <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/infrastructure.html#determine-the-value-of-an-indexed-property" class="externalDFN">determine the value of an indexed property</a> for a given index <var>index</var> in a <a href="#networkservices"><code>NetworkServices</code></a> object's <a href="#current_authorized_services" class="internalDFN">current authorized services</a>, the user agent <em class="rfc2119" title="must">must</em> return the <a href="#networkservice"><code>NetworkService</code></a> object that represents the <var>index</var>th service in <a href="#current_authorized_services" class="internalDFN">current authorized services</a>.
- </p>
-
- <p>
- The <dfn id="dom-networkservices-getservicebyid"><code>getServiceById(id)</code></dfn> method <em class="rfc2119" title="must">must</em> return the first <a href="#networkservice"><code>NetworkService</code></a> object in <a href="#current_authorized_services" class="internalDFN">current authorized services</a> represented by the respective object whose <a href="#dom-networkservice-id"><code>id</code></a> attribute is equal to the value of the <var>id</var> argument.
- When no services in <a href="#current_authorized_services" class="internalDFN">current authorized services</a> match the given argument, the method <em class="rfc2119" title="must">must</em> return null.
- </p>
-
- <p>
- Services available within the local network can connect and disconnect at different times during the execution of a web page. A <a href="#dfn-user-agent" class="internalDFN">user agent</a> can
- inform a web page when the state of networked services matching the requested <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> change. Web pages can use this information to enable in-page experiences for communicating the state of networked services
- with the ability to change the particular service or set of services the page is connected to by re-invoking the <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> method.
- </p>
-
- </section>
-
- <section id="events" about="#events" typeof="bibo:Chapter">
- <h3><span class="secno">5.3 </span>Events</h3>
-
- <p>
- The following are the event handlers (and their corresponding event handler event types) that must be supported, as IDL attributes, by all objects implementing the <a href="#networkservices"><code>NetworkServices</code></a> interface:
- </p>
-
- <table border="1">
- <thead>
- <tr>
- <th>
- <span title="event handlers">Event handler</span>
- </th>
- <th>
- <span>Event handler event type</span>
- </th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <dfn id="dom-networkservices-onserviceavailable" title="dom-NetworkServices-onserviceavailable">
- <code>onserviceavailable</code>
- </dfn>
- </td>
- <td>
- <code title="event-serviceavailable">serviceavailable</code>
- </td>
- </tr>
- <tr>
- <td>
- <dfn id="dom-networkservices-onserviceunavailable" title="dom-NetworkServices-onserviceunavailable">
- <code>onserviceunavailable</code>
- </dfn>
- </td>
- <td>
- <code title="event-serviceunavailable">serviceunavailable</code>
- </td>
- </tr>
- </tbody>
- </table>
-
- <p>
- Events with an event type of <code>serviceavailable</code> or <code>serviceunavailable</code> defined in this specification are simple <code>Event</code> objects.
- </p>
-
- </section>
-
- </div>
- <div id="communicating-with-a-networked-service" about="#communicating-with-a-networked-service" typeof="bibo:Chapter" class="section">
- <!--OddPage--><h2><span class="secno">6. </span>Communicating with a networked service</h2>
-
-<p>
- The <a href="#networkservice"><code>NetworkService</code></a> interface is used to provide a set of connection information for an <acronym title="Hypertext Transfer Protocol">HTTP</acronym> service endpoint and if available, service events, running on a networked device.
-</p>
-
-<pre class="widl">[NoInterfaceObject]
+ <pre class="widl">
+[NoInterfaceObject]
interface <dfn id="networkservice">NetworkService</dfn> {
readonly attribute DOMString <a href="#dom-networkservice-id">id</a>;
readonly attribute DOMString <a href="#dom-networkservice-name">name</a>;
@@ -1476,674 +1241,1592 @@
readonly attribute DOMString <a href="#dom-networkservice-url">url</a>;
readonly attribute DOMString <a href="#dom-networkservice-config">config</a>;
- const unsigned short <a href="#dom-networkservice-AVAILABLE">AVAILABLE</a> = 1;
- const unsigned short <a href="#dom-networkservice-UNAVAILABLE">UNAVAILABLE</a> = 2;
- readonly attribute unsigned short <a href="#dom-networkservice-readystate">readyState</a>;
+ readonly attribute boolean <a href="#dom-networkservice-online">online</a>;
// event handler attributes
- attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler" class="externalDFN">EventHandler</a> <a href="#dom-networkservice-onreadystatechange">onreadystatechange</a>;
- attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler" class="externalDFN">EventHandler</a> <a href="#dom-networkservice-onmessage">onmessage</a>;
+ attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler"
+ class="externalDFN">EventHandler</a> <a href="#dom-networkservice-onserviceonline">onserviceonline</a>;
+ attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler"
+ class="externalDFN">EventHandler</a> <a href="#dom-networkservice-onserviceoffline">onserviceoffline</a>;
+
+ attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler"
+ class="externalDFN">EventHandler</a> <a href="#dom-networkservice-onnotify">onnotify</a>;
};
-<a href="#networkservice">NetworkService</a> implements <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#interface-eventtarget" class="externalDFN">EventTarget</a>;
+<a href="#networkservice">NetworkService</a> implements <a href=
+"http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#interface-eventtarget"
+ class="externalDFN">EventTarget</a>;
</pre>
-
-<section id="attributes-1" about="#attributes-1" typeof="bibo:Chapter">
- <h3><span class="secno">6.1 </span>Attributes</h3>
-
- <dl class="domintro">
- <dt>
- <var title="">service</var>
- .
- <code title="dom-networkservice-id">
- <a href="#dom-networkservice-id">id</a>
- </code>
- </dt>
- <dd>
- <p>
- A unique identifier for the given user-selected service instance.
- </p>
- </dd>
- <dt>
- <var title="">service</var>
- .
- <code title="dom-networkservice-name">
- <a href="#dom-networkservice-name">name</a>
- </code>
- </dt>
- <dd>
- <p>
- The name of the user-selected service.
- </p>
- </dd>
- <dt>
- <var title="">service</var>
- .
- <code title="dom-networkservice-type">
- <a href="#dom-networkservice-type">type</a>
- </code>
- </dt>
- <dd>
- <p>
- The <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> token value of the user-selected service.
- </p>
- </dd>
- <dt>
- <var title="">service</var>
- .
- <code title="dom-networkservice-url">
- <a href="#dom-networkservice-url">url</a>
- </code>
- </dt>
- <dd>
- <p>
- The control <acronym title="Uniform Resource Locator">URL</acronym> endpoint (including any required port information) of the user-selected control service that has been added to the <a href="#dfn-entry-script-origin-s-url-whitelist" class="internalDFN">entry script origin's <acronym title="Uniform Resource Locator">URL</acronym> whitelist</a>.
- </p>
- </dd>
- <dt>
- <var title="">service</var>
- .
- <code title="dom-networkservice-config">
- <a href="#dom-networkservice-config">config</a>
- </code>
- </dt>
- <dd>
- <p>
- The configuration information associated with the service depending on the requested service type.
- </p>
- </dd>
- </dl>
-
+ <section id="attributes-1">
+ <h3>
+ <span class="secno">6.1</span> Attributes
+ </h3>
+ <dl class="domintro">
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-id"><a href=
+ "#dom-networkservice-id">id</a></code>
+ </dt>
+ <dd>
+ <p>
+ A unique identifier for the given user-selected service instance.
+ </p>
+ </dd>
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-name"><a href=
+ "#dom-networkservice-name">name</a></code>
+ </dt>
+ <dd>
+ <p>
+ The name of the user-selected service.
+ </p>
+ </dd>
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-type"><a href=
+ "#dom-networkservice-type">type</a></code>
+ </dt>
+ <dd>
+ <p>
+ The <a href="#dfn-valid-service-type"
+ class="internalDFN">valid service type</a> token value of the user-selected service.
+ </p>
+ </dd>
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-url"><a href=
+ "#dom-networkservice-url">url</a></code>
+ </dt>
+ <dd>
+ <p>
+ The control <abbr title="Uniform Resource Locator">URL</abbr> endpoint (including any required port
+ information) of the user-selected control service that has been added to the <a href=
+ "#dfn-entry-script-origin-s-url-whitelist"
+ class="internalDFN">entry script origin's <abbr title="Uniform Resource Locator">URL</abbr>
+ whitelist</a>.
+ </p>
+ </dd>
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-config"><a href=
+ "#dom-networkservice-config">config</a></code>
+ </dt>
+ <dd>
+ <p>
+ The configuration information associated with the service depending on the requested service type.
+ </p>
+ </dd>
+ </dl>
+ <p>
+ The <dfn id="dom-networkservice-id"><code>id</code></dfn> attribute is a unique identifier for the service.
+ The same service provided at different times or on different objects <em class="rfc2119"
+ title="must">must</em> have the same <a href="#dom-networkservice-id"><code>id</code></a> value.
+ </p>
+ <p>
+ The <dfn id="dom-networkservice-name"><code>name</code></dfn> attribute represents a human-readable title for
+ the service.
+ </p>
+ <p>
+ The <dfn id="dom-networkservice-type"><code>type</code></dfn> attribute reflects the value of the <a href=
+ "#dfn-valid-service-type"
+ class="internalDFN">valid service type</a> of the service.
+ </p>
+ <p>
+ The <dfn id="dom-networkservice-url"><code>url</code></dfn> attribute is an <a href=
+ "http://www.w3.org/TR/html5/urls.html#absolute-url"
+ class="externalDFN">absolute <abbr title="Uniform Resource Locator">URL</abbr></a> pointing to the root
+ <abbr title="Hypertext Transfer Protocol">HTTP</abbr> endpoint for the service that has been added to the
+ <a href="#dfn-entry-script-origin-s-url-whitelist"
+ class="internalDFN">entry script origin's <abbr title="Uniform Resource Locator">URL</abbr> whitelist</a>.
+ Web pages can subsequently use this value for implicit cross-document messaging via various existing
+ mechanisms (e.g. Web Sockets, Server-Sent Events, Web Messaging, XMLHttpRequest).
+ </p>
+ <p>
+ The <dfn id="dom-networkservice-config"><code>config</code></dfn> attribute provides the raw configuration
+ information extracted from the given network service.
+ </p>
+ </section>
+ <section id="states">
+ <h3>
+ <span class="secno">6.2</span> States
+ </h3>
+ <dl class="domintro">
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-online"><a href=
+ "#dom-networkservice-online">online</a></code>
+ </dt>
+ <dd>
+ <p>
+ Returns <code>true</code> if the service is reporting that it is accessible on the local network or
+ <code>false</code> if the service is reporting that it is no longer accessible (temporarily or
+ permanently) on the local network.
+ </p>
+ </dd>
+ </dl>
+ <p>
+ The <dfn id="dom-networkservice-online"><code>online</code></dfn> attribute indicates whether the service is
+ reporting itself as being either <var>online</var>, and therefore accessible on the local network, in which
+ case this attribute will return <code>true</code> or, <var>offline</var>, and therefore not accessible on the
+ local network, either temporarily or permanently, in which case this attribute will return
+ <code>false</code>. This attribute <em class="rfc2119"
+ title="must">must</em> default to <code>true</code>.
+ </p>
+ </section>
+ <section id="events-1">
+ <h3>
+ <span class="secno">6.3</span> Events
+ </h3>
+ <p>
+ The following are the event handlers (and their corresponding event handler event types) that <em class=
+ "ct"><em class="rfc2119"
+ title="must">must</em></em> be supported, as IDL attributes, by all objects implementing the <a href=
+ "#networkservice"><code>NetworkService</code></a> interface:
+ </p>
+ <table border="1">
+ <thead>
+ <tr>
+ <th>
+ <span title="event handlers">Event handler</span>
+ </th>
+ <th>
+ <span>Event handler event type</span>
+ </th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <dfn id="dom-networkservice-onnotify"
+ title="dom-NetworkService-onnotify"><code>onnotify</code></dfn>
+ </td>
+ <td>
+ <a href="#event-notify"><code>notify</code></a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="dom-networkservice-onserviceonline"
+ title="dom-NetworkService-onserviceonline"><code>onserviceonline</code></dfn>
+ </td>
+ <td>
+ <a href="#event-serviceonline"><code>serviceonline</code></a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="dom-networkservice-onserviceoffline"
+ title="dom-NetworkService-onserviceoffline"><code>onserviceoffline</code></dfn>
+ </td>
+ <td>
+ <a href="#event-serviceoffline"><code>serviceoffline</code></a>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+ </section>
+ <section id="service-discovery">
+ <h2>
+ <span class="secno">7.</span> Service Discovery
+ </h2>
+ <p>
+ A <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> conforming to this specification <em class="rfc2119"
+ title="may">may</em> implement <abbr title="Simple Service Discovery Protocol">SSDP</abbr> [<cite><a class=
+ "bibref"
+ href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>] and Zeroconf [<cite><a class="bibref"
+ href="#bib-DNS-SD">DNS-SD</a></cite>] + [<cite><a class="bibref"
+ href="#bib-MDNS">MDNS</a></cite>] <dfn id="dfn-service-discovery-mechanisms">service discovery
+ mechanisms</dfn> - the requirements detailed in this section of the specification - to enable Web pages to
+ request and connect with <abbr title="Hypertext Transfer Protocol">HTTP</abbr> services running on networked
+ devices, discovered via either mechanism, through this <abbr title=
+ "Application Programming Interface">API</abbr>. When a <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> implements either of these <a href="#dfn-service-discovery-mechanisms"
+ class="internalDFN">service discovery mechanisms</a>, then it <em class="rfc2119"
+ title="must">must</em> conform to the corresponding algorithms provided in this section of the
+ specification.
+ </p>
+ <p>
+ This section presents how the results of these two <a href="#dfn-service-discovery-mechanisms"
+ class="internalDFN">service discovery mechanisms</a> will be matched to requested service types, how the
+ user agent stores available and active services, how their properties are applied to any resulting <a href=
+ "#networkservice"><code>NetworkService</code></a> objects.
+ </p>
+ <p>
+ It is expected that user agents will perform these <a href="#dfn-service-discovery-mechanisms"
+ class="internalDFN">service discovery mechanisms</a> asynchronously and periodically update the <a href=
+ "#dfn-list-of-available-service-records"
+ class="internalDFN">list of available service records</a> as required. The timing of any <a href=
+ "#dfn-service-discovery-mechanisms"
+ class="internalDFN">service discovery mechanisms</a> is an implementation detail left to the discretion of
+ the implementer (e.g. by continuously monitoring the network as a background process or on invocation of
+ this <abbr title="Application Programming Interface">API</abbr> from a Web page).
+ </p>
+ <p>
+ The <dfn id="dfn-list-of-available-service-records">list of available service records</dfn> is a single dynamic
+ internal lookup table within user agents that is used to track all the services that have been discovered and
+ are available in the current network at any given time. At any point during the running of either of the two
+ <a href="#dfn-service-discovery-mechanisms"
+ class="internalDFN">service discovery mechanisms</a> then existing entries within this table can be updated,
+ entries can be added and entries can be removed as the status of networked services changes according to the
+ rules defined in this specification.
+ </p>
+ <p>
+ The <dfn id="dfn-list-of-active-service-managers">list of active service managers</dfn> is an internal list
+ within user agents that is used to track all <a href="#networkservices"><code>NetworkServices</code></a>
+ objects currently being shared with any web pages at the current time. Each <a href=
+ "#networkservices"><code>NetworkServices</code></a> object in the <a href=
+ "#dfn-list-of-active-service-managers"
+ class="internalDFN">list of active service managers</a> represents a collection of one or more <a href=
+ "#networkservice"><code>NetworkService</code></a> objects - known as its <dfn id=
+ "dfn-indexed-properties">indexed properties</dfn>. <a href="#networkservice"><code>NetworkService</code></a>
+ objects are attached as the <a href="#dfn-indexed-properties"
+ class="internalDFN">indexed properties</a> of a <a href="#networkservices"><code>NetworkServices</code></a>
+ object as part of the <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a>
+ algorithm.
+ </p>
+ <p>
+ The rule for <dfn id="dfn-adding-an-available-service">adding an available service</dfn> is the process of
+ adding a new service or updating an existing service in the <a href="#dfn-list-of-available-service-records"
+ class="internalDFN">list of available service records</a> that is generally available on the user's current
+ network. This rule takes one argument, <var>network service record</var>, and consists of running the
+ following steps:
+ </p>
+ <ol class="rule">
+ <li>Let <var>new service registration flag</var> be <code>true</code>.
+ </li>
+ <li>For each <var>existing service record</var> in the current <a href="#dfn-list-of-available-service-records"
+ class="internalDFN">list of available service records</a>, run the following sub-steps:
+ <ol class="rule">
+ <li>If the <var>existing service record</var>'s <code>id</code> property does not equal <var>network
+ service record</var>'s <code>id</code> property then abort any remaining sub-steps and continue at the next
+ available <var>existing service record</var>.
+ </li>
+ <li>Set <var>new service registration flag</var> to <code>false</code>.
+ </li>
+ <li>Replace the value of <var>existing service record</var> in the current <a href=
+ "#dfn-list-of-available-service-records"
+ class="internalDFN">list of available service records</a> with the value of <var>network service
+ record</var>.
+ </li>
+ </ol>
+ </li>
+ <li>If <var>new service registration flag</var> is set to <code>true</code> then add <var>network service
+ record</var> to the <a href="#dfn-list-of-available-service-records"
+ class="internalDFN">list of available service records</a> as a new item.
+ </li>
+ <li>For each <var>service manager</var> in the <a href="#dfn-list-of-active-service-managers"
+ class="internalDFN">list of active service managers</a> run the following steps:
+ <ol class="rule">
+ <li>Let <var>service type in current service manager flag</var> be <code>false</code>.
+ </li>
+ <li>For each <var>active service</var> in <var>service manager</var> run the following steps:
+ <ol class="rule">
+ <li>If <var>network service record</var>'s <code>type</code> property does not equal <var>active
+ service</var>'s <code>type</code> attribute then abort any remaining sub-steps for this <var>active
+ service</var> and continue at the next available <var>active service</var>.
+ </li>
+ <li>Set the <var>service type in current service manager flag</var> to <code>true</code>.
+ </li>
+ <li>If the <var>new service registration flag</var> is set to <code>false</code>, the <var>network
+ service record</var>'s <code>id</code> property equals the <var>active service</var>'s <code>id</code>
+ attribute and <var>active service</var>'s <a href="#dom-networkservice-online"><code>online</code></a>
+ attribute is currently set to <code>false</code> then set <var>active service</var>'s <a href=
+ "#dom-networkservice-online"><code>online</code></a> attribute to <code>true</code> and then <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
+ class="externalDFN">queue a task</a> to dispatch a newly created event with the name <a href=
+ "#event-serviceonline"><code>serviceonline</code></a> that uses the <a href=
+ "http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
+ class="externalDFN"><code>Event</code></a> interface, which does not bubble, is not cancellable,
+ and has no default action, at the current <var>active service</var> object.
+ </li>
+ </ol>
+ </li>
+ <li>If the <var>new service registration flag</var> is set to <code>true</code> and the <var>service type
+ in current service manager flag</var> is also set to <code>true</code> then increment <var>service
+ manager</var>'s <a href="#dom-networkservices-servicesavailable"><code>servicesAvailable</code></a>
+ attribute by <code>1</code> and then <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
+ class="externalDFN">queue a task</a> to dispatch a newly created event with the name <a href=
+ "#event-serviceavailable"><code>serviceavailable</code></a> that uses the <a href=
+ "http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
+ class="externalDFN"><code>Event</code></a> interface, which does not bubble, is not cancellable, and
+ has no default action, at the current <var>service manager</var> object.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ <p>
+ The rule for <dfn id="dfn-removing-an-available-service">removing an available service</dfn> is the general
+ process of removing a service from the <a href="#dfn-list-of-available-service-records"
+ class="internalDFN">list of available service records</a> that has left the user's current network or has
+ otherwise expired. This rule takes one argument, <var>service identifier</var>, and consists of running the
+ following steps:
+ </p>
+ <ol class="rule">
+ <li>For each <var>existing service record</var> in the current <a href="#dfn-list-of-available-service-records"
+ class="internalDFN">list of available service records</a>, run the following sub-steps:
+ <ol class="rule">
+ <li>If the <var>existing service record</var>'s <code>id</code> property does not match <var>service
+ identifier</var> then skip any remaining sub-steps for the current <var>existing service record</var> and
+ continue at the next available <var>existing service record</var>.
+ </li>
+ <li>If the <var>existing service record</var>'s <code>type</code> property begins with the DOMString
+ "<code>upnp:</code>" and <var>existing service record</var>'s <code>eventsURL</code> property is set then
+ run the rule to <a href="#dfn-terminate-an-existing-upnp-events-subscription"
+ class="internalDFN">terminate an existing UPnP Events Subscription</a>, if one is currently active
+ (as a result of having previously called <a href="#dfn-setup-a-upnp-events-subscription"
+ class="internalDFN">setup a UPnP Events Subscription</a> against the current <var>existing service
+ record</var>).
+ </li>
+ <li>For each <var>service manager</var> in the <a href="#dfn-list-of-active-service-managers"
+ class="internalDFN">list of active service managers</a> run the following steps:
+ <ol class="rule">
+ <li>Let <var>service type in current service manager flag</var> be <code>false</code>.
+ </li>
+ <li>For each <var>active service</var> in <var>service manager</var> run the following steps:
+ <ol class="rule">
+ <li>If <var>existing service record</var>'s <code>type</code> property does not equal the
+ <var>active service</var>'s <code>type</code> attribute then abort any remaining sub-steps for this
+ <var>active service</var> and continue at the next available <var>active service</var>.
+ </li>
+ <li>Set the <var>service type in current service manager flag</var> to <code>true</code>.
+ </li>
+ <li>If <var>existing service record</var>'s <code>id</code> property equals the <var>active
+ service</var>'s <code>id</code> attribute and <var>active service</var>'s <a href=
+ "#dom-networkservice-online"><code>online</code></a> attribute is currently set to
+ <code>true</code> then set <var>active service</var>'s <a href="#dom-networkservice-online"><code>
+ online</code></a> attribute to <code>false</code> and then <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
+ class="externalDFN">queue a task</a> to dispatch a newly created event with the name <a href=
+ "#event-serviceoffline"><code>serviceoffline</code></a> that uses the <a href=
+ "http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
+ class="externalDFN"><code>Event</code></a> interface, which does not bubble, is not
+ cancellable, and has no default action, at the current <var>active service</var>.
+ </li>
+ </ol>
+ </li>
+ <li>If the <var>service type in current service manager flag</var> is set to <code>true</code> then
+ decrement <var>service manager</var>'s <a href=
+ "#dom-networkservices-servicesavailable"><code>servicesAvailable</code></a> attribute by <code>1</code>
+ and then <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
+ class="externalDFN">queue a task</a> to dispatch a newly created event with the name <a href=
+ "#event-serviceunavailable"><code>serviceunavailable</code></a> that uses the <a href=
+ "http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
+ class="externalDFN"><code>Event</code></a> interface, which does not bubble, is not cancellable,
+ and has no default action, at the current <var>service manager</var> object.
+ </li>
+ </ol>
+ </li>
+ <li>Remove <var>existing service record</var> from the current <a href=
+ "#dfn-list-of-available-service-records"
+ class="internalDFN">list of available service records</a>.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ <p>
+ User agents <em class="rfc2119"
+ title="should">should</em> expire a service record from the <a href="#dfn-list-of-available-service-records"
+ class="internalDFN">list of available service records</a> when its <code>expiryTimestamp</code> attribute
+ exceeds the current UTC timestamp. When this condition is met the <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> <em class="rfc2119"
+ title="should">should</em> run the rule for <a href="#dfn-removing-an-available-service"
+ class="internalDFN">removing an available service</a>, passing in the expired service record's
+ <code>id</code> attribute as the only argument.
+ </p>
+ <section id="zeroconf-mdns-dns-sd">
+ <h3>
+ <span class="secno">7.1</span> Zeroconf (<abbr title="Multicast DNS">mDNS</abbr> + <abbr title=
+ "Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr>)
+ </h3>
+ <p>
+ For each <abbr title="Domain Name System">DNS</abbr> response received from a user-agent-initiated Multicast
+ <abbr title="Domain Name System">DNS</abbr> Browse for <abbr title="DNS Pointer Record">PTR</abbr> records
+ with the name <code>_services._dns-sd._udp</code> on the resolved recommended automatic browsing domain
+ [<cite><a class="bibref"
+ href="#bib-MDNS">MDNS</a></cite>], the <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> <em class="rfc2119"
+ title="must">must</em> run the following steps:
+ </p>
+ <ol class="rule">
+ <li>Let <var>service <abbr title="Multicast DNS">mDNS</abbr> responses</var> be an array of <abbr title=
+ "DNS Pointer Record">PTR</abbr> records received by issuing a Multicast <abbr title=
+ "Domain Name System">DNS</abbr> Browse for <abbr title="DNS Pointer Record">PTR</abbr> records with the name
+ of the current discovered service type.
+ </li>
+ <li>For each Object <var>service <abbr title="Multicast DNS">mDNS</abbr> response</var> in <var>service
+ <abbr title="Multicast DNS">mDNS</abbr> responses</var>, run the following steps:
+ <ol>
+ <li>Let <var>network service record</var> be an Object consisting of the following empty properties:
+ <code>id</code>, <code>name</code>, <code>type</code>, <code>url</code>, <code>config</code>,
+ <code>expiryTimestamp</code>.
+ </li>
+ <li>Set <var>network service record</var>'s <code>id</code> property to the value of the full
+ <abbr title="DNS Pointer Record">PTR</abbr> Service Instance Name [<cite><a class="bibref"
+ href="#bib-MDNS">MDNS</a></cite>].
+ </li>
+ <li>Set <var>network service record</var>'s <code>name</code> property to the value of the <abbr title=
+ "DNS Pointer Record">PTR</abbr> Service Instance Name's <var>Instance</var> component [<cite><a class=
+ "bibref"
+ href="#bib-MDNS">MDNS</a></cite>].
+ </li>
+ <li>Set <var>network service record</var>'s <code>type</code> property to the concatenation of the string
+ <code>zeroconf:</code> followed be the value of the <abbr title="DNS Pointer Record">PTR</abbr> Service
+ Instance Name's <var>Service</var> component [<cite><a class="bibref"
+ href="#bib-MDNS">MDNS</a></cite>].
+ </li>
+ <li>Set <var>network service record</var>'s <code>url</code> property to the resolvable Service
+ <abbr title="Uniform Resource Locator">URL</abbr> obtained from performing an <abbr title=
+ "Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr> Lookup [<cite><a class="bibref"
+ href="#bib-DNS-SD">DNS-SD</a></cite>] of the current service from the <abbr title=
+ "DNS Pointer Record">PTR</abbr> record provided [<cite><a class="bibref"
+ href="#bib-MDNS">MDNS</a></cite>].
+ </li>
+ <li>Set <var>network service record</var>'s <code>config</code> property to the string value of the
+ contents of the first <abbr title="Domain Name System">DNS</abbr>-<abbr title=
+ "Service Discovery">SD</abbr> TXT record associated with the <var>service <abbr title=
+ "Multicast DNS">mDNS</abbr> response</var> as defined in [<cite><a class="bibref"
+ href="#bib-DNS-SD">DNS-SD</a></cite>].
+ </li>
+ <li>Set <var>network service record</var>'s <code>expiryTimestamp</code> property to the value of the
+ current date, in UTC timestamp format, plus a value of <code>120</code> seconds.
+ </li>
+ <li>Run the general rule for <a href="#dfn-adding-an-available-service"
+ class="internalDFN">adding an available service</a>, passing in the current <var>network service
+ record</var> as the only argument.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ </section>
+ <section id="simple-service-discovery-protocol-ssdp">
+ <h3>
+ <span class="secno">7.2</span> Simple Service Discovery Protocol (<abbr title=
+ "Simple Service Discovery Protocol">SSDP</abbr>)
+ </h3>
+ <p>
+ A user agent that implements UPnP service discovery <em class="rfc2119"
+ title="must">must</em> issue a <dfn id="dfn-search-request-for-upnp-root-devices">search request for UPnP
+ root devices</dfn> against the user's current local network according to the full normative text and
+ timing provided in 'Section 1.3.2: Search request with M-SEARCH' detailed in [<cite><a class="bibref"
+ href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>].
+ </p>
+ <p>
+ The user agent <em class="rfc2119"
+ title="must">must</em> issue all <a title="search request for UPnP root devices"
+ href="#dfn-search-request-for-upnp-root-devices"
+ class="internalDFN">search requests for UPnP root devices</a> with a <abbr title=
+ "Hypertext Transfer Protocol">HTTP</abbr> request line equal to <code>M-SEARCH * <abbr title=
+ "Hypertext Transfer Protocol">HTTP</abbr>/1.1</code>, with a HOST header equal to the reserved multicast
+ address and port of <code>239.255.255.250:1900</code>, a MAN header equal to <code>ssdp:discover</code>,
+ an ST header equal to <code>upnp:rootdevice</code> and a user-agent defined MX header equal to a <dfn id=
+ "dfn-maximum-upnp-advertisement-response-wait-time">maximum UPnP advertisement response wait time</dfn>
+ value between <code>1</code> and <code>5</code> seconds.
+ </p>
+ <p>
+ The user agent <em class="rfc2119"
+ title="must">must</em> listen for any incoming responses to any <a href=
+ "#dfn-search-request-for-upnp-root-devices"
+ class="internalDFN">search request for UPnP root devices</a>.
+ </p>
+ <p>
+ For each <dfn id="dfn-http-response"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Response</dfn>
+ following an initial <a href="#dfn-search-request-for-upnp-root-devices"
+ class="internalDFN">search request for UPnP root devices</a> sent on a <a href=
+ "#dfn-standard-upnp-address-and-port"
+ class="internalDFN">standard UPnP address and port</a> the user agent <em class="rfc2119"
+ title="must">must</em> run the following steps:
+ </p>
+ <ol class="rule">
+ <li>If the <a href="#dfn-http-response"
+ class="internalDFN"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Response</a> is not a
+ <abbr title="Hypertext Transfer Protocol">HTTP</abbr> 200 OK response then this response is invalid and
+ the user agent <em class="rfc2119"
+ title="must">must</em> discard this response, abort any remaining steps and return. The user agent
+ <em class="rfc2119"
+ title="may">may</em> issue a new <a href="#dfn-search-request-for-upnp-root-devices"
+ class="internalDFN">search request for UPnP root devices</a> as a result of this error occurring.
+ </li>
+ <li>If the <a href="#dfn-maximum-upnp-advertisement-response-wait-time"
+ class="internalDFN">maximum UPnP advertisement response wait time</a> has been exceeded since the
+ initial <a href="#dfn-search-request-for-upnp-root-devices"
+ class="internalDFN">search request for UPnP root devices</a> was sent then the <a href=
+ "#dfn-http-response"
+ class="internalDFN"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Response</a> is invalid and
+ the user agent <em class="rfc2119"
+ title="must">must</em> discard this response, abort any remaining steps and return. The user agent
+ <em class="rfc2119"
+ title="may">may</em> stop listening for responses from the current <a href=
+ "#dfn-search-request-for-upnp-root-devices"
+ class="internalDFN">search request for UPnP root devices</a> as a result of this error occurring.
+ Equally, the user agent <em class="rfc2119"
+ title="may">may</em> issue a new <a href="#dfn-search-request-for-upnp-root-devices"
+ class="internalDFN">search request for UPnP root devices</a> as a result of this error occurring.
+ </li>
+ <li>Let <var>ssdp device</var> be an Object with a property for each <abbr title=
+ "Hypertext Transfer Protocol">HTTP</abbr> header received in the <a href="#dfn-http-response"
+ class="internalDFN"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Response</a>, with each key
+ being the name of a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> response header and each
+ value being that <abbr title="Hypertext Transfer Protocol">HTTP</abbr> response header's value.
+ </li>
+ <li>If <var>ssdp device</var> does not contain at least one <var>CACHE-CONTROL</var> entry, at least one
+ <var>USN</var> entry, at least one <var>ST</var> entry and at least one <var>LOCATION</var> entry or the
+ value of its <var>ST</var> entry is not <code>upnp:rootdevice</code>, then the <a href="#dfn-http-response"
+ class="internalDFN"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Response</a> is invalid and
+ the <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> <em class="rfc2119"
+ title="must">must</em> discard this response, abort any remaining steps and return.
+ </li>
+ <li>The user agent <em class="rfc2119"
+ title="must">must</em> run the rule for <a href="#dfn-obtaining-a-upnp-device-description-file"
+ class="internalDFN">obtaining a UPnP Device Description File</a> passing in the first occurrence of
+ <var>LOCATION</var> from <var>ssdp device</var> as the <var>device descriptor <abbr title=
+ "Uniform Resource Locator">URL</abbr></var> argument and the first occurrence of <var>USN</var> from
+ <var>ssdp device</var> as the <var>device identifier</var> argument and the first occurrence of
+ <var>CACHE-CONTROL</var> from <var>ssdp device</var> (minus the leading string of
+ <code>max-age=</code>) as the <var>device expiry</var> argument.
+ </li>
+ </ol>
+ <p>
+ The user agent <em class="rfc2119"
+ title="must">must</em> listen for incoming requests on the <dfn id=
+ "dfn-standard-upnp-address-and-port">standard UPnP address and port</dfn> on all current local network
+ interface addresses with the port <code>1900</code>.
+ </p>
+ <p>
+ For each <dfn id="dfn-http-request"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Request</dfn>
+ received on a <a href="#dfn-standard-upnp-address-and-port"
+ class="internalDFN">standard UPnP address and port</a> the user agent <em class="rfc2119"
+ title="must">must</em> run the following steps:
+ </p>
+ <ol class="rule">
+ <li>If the <a href="#dfn-http-request"
+ class="internalDFN"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Request</a> is not a
+ <abbr title="Hypertext Transfer Protocol">HTTP</abbr> NOTIFY request then it is not a valid UPnP
+ Request and the user agent <em class="rfc2119"
+ title="must">must</em> discard this request, abort any remaining steps and return.
+ </li>
+ <li>Let <var>ssdp device</var> be an Object with a property for each <abbr title=
+ "Hypertext Transfer Protocol">HTTP</abbr> header received in the <a href="#dfn-http-request"
+ class="internalDFN"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Request</a>, with each key
+ being the name of a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> header and each value being
+ that <abbr title="Hypertext Transfer Protocol">HTTP</abbr> header's value.
+ </li>
+ <li>If <var>ssdp device</var> does not contain at least one <var>CACHE-CONTROL</var> entry, at least one
+ <var>USN</var> entry, at least one <var>NT</var> entry, at least one <var>NTS</var> entry and at least one
+ <var>LOCATION</var> entry or the value of its <var>NT</var> entry is not <code>upnp:rootdevice</code>, then
+ the <a href="#dfn-http-request"
+ class="internalDFN"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Request</a> is a malformed
+ UPnP Request and the <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> <em class="rfc2119"
+ title="must">must</em> discard this request, abort any remaining steps and return.
+ </li>
+ <li>If <var>ssdp device</var>'s <var>NTS</var> entry is equal to <code>ssdp:alive</code> then the user agent
+ <em class="rfc2119"
+ title="must">must</em> run the rule for <a href="#dfn-obtaining-a-upnp-device-description-file"
+ class="internalDFN">obtaining a UPnP Device Description File</a> passing in the first occurrence of
+ <var>LOCATION</var> from <var>ssdp device</var> as the <var>device descriptor <abbr title=
+ "Uniform Resource Locator">URL</abbr></var> argument and the first occurrence of <var>USN</var> from
+ <var>ssdp device</var> as the <var>device identifier</var> argument and the first occurrence of
+ <var>CACHE-CONTROL</var> from <var>ssdp device</var> (minus the leading string of
+ <code>max-age=</code>) as the <var>device expiry</var>.<br>
+ <br>
+ Otherwise, if <var>ssdp device</var>'s <var>NTS</var> entry is equal to <code>ssdp:byebye</code> then the
+ user agent <em class="rfc2119"
+ title="must">must</em> run the rule for <a href=
+ "#dfn-removing-all-services-from-a-registered-upnp-device"
+ class="internalDFN">removing all services from a registered UPnP Device</a> passing in the first
+ occurrence of <var>USN</var> from <var>ssdp device</var> as the <var>device identifier</var> argument.
+ </li>
+ </ol>
+ <p>
+ The rule for <dfn id="dfn-obtaining-a-upnp-device-description-file">obtaining a UPnP Device Description
+ File</dfn> is the process of obtaining the contents of a standard UPnP Device Description [<cite><a class=
+ "bibref"
+ href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>] from a <abbr title=
+ "Uniform Resource Locator">URL</abbr>-based resource. This rule takes three arguments - <var>device
+ descriptor <abbr title="Uniform Resource Locator">URL</abbr></var>, <var>device identifier</var> and
+ <var>device expiry</var> - and when called the user agent <em class="rfc2119"
+ title="must">must</em> run the following steps:
+ </p>
+ <ol class="rule">
+ <li>Let <var>device descriptor file</var> contain the contents of the file located at the <abbr title=
+ "Uniform Resource Locator">URL</abbr> provided in <var>device descriptor <abbr title=
+ "Uniform Resource Locator">URL</abbr></var> obtained according to the rules defined in 'Section 2.11:
+ Retrieving a description using <abbr title="Hypertext Transfer Protocol">HTTP</abbr>' in [<cite><a class=
+ "bibref"
+ href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>].
+ </li>
+ <li>If the value provided in <var>device descriptor <abbr title="Uniform Resource Locator">URL</abbr></var>
+ cannot be resolved as a reachable <abbr title="Uniform Resource Locator">URL</abbr> on the current network or
+ the <var>device descriptor file</var> remains empty then it is invalid and the <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> <em class="rfc2119"
+ title="must">must</em> abort any remaining steps and return.
+ </li>
+ <li>Run the rule for <a href="#dfn-processing-a-upnp-device-description-file"
+ class="internalDFN">processing a UPnP Device Description File</a>, passing in the current <var>device
+ descriptor file</var>, <var>device identifier</var> and <var>device expiry</var> arguments.
+ </li>
+ </ol>
+ <p>
+ The rule for <dfn id="dfn-processing-a-upnp-device-description-file">processing a UPnP Device Description
+ File</dfn> is the process of parsing the contents of a standard UPnP Device Description [<cite><a class=
+ "bibref"
+ href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>] and registering the UPnP services contained
+ therein within the <a href="#dfn-list-of-available-service-records"
+ class="internalDFN">list of available service records</a>.
+ </p>
+ <p>
+ The rule for <a href="#dfn-processing-a-upnp-device-description-file"
+ class="internalDFN">processing a UPnP Device Description File</a> takes three arguments - <var>device
+ descriptor file</var>, <var>device identifier</var> and <var>device expiry</var> - and when called the
+ user agent <em class="rfc2119"
+ title="must">must</em> run the following steps:
+ </p>
+ <ol class="rule">
+ <li>Let <var>advertised services</var> be a list of all advertised services obtained from the <var>device
+ descriptor file</var> containing the value of the first occurrence of the <code><serviceList></code>
+ element as it is defined in 'Section 2.3: Device Description' in [<cite><a class="bibref"
+ href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>].
+ </li>
+ <li>For each <code><service></code> element - known as an <var>advertised service</var> - in
+ <var>advertised services</var> run the following steps:
+ <ol class="rule">
+ <li>Let <var>network service record</var> be a new Object consisting of the following empty properties:
+ <code>id</code>, <code>deviceId</code>, <code>name</code>, <code>type</code>, <code>url</code>,
+ <code>eventsUrl</code>, <code>config</code>, <code>expiryTimestamp</code>.
+ </li>
+ <li>Set <var>network service record</var>'s <code>id</code> property to the concatenated string value of
+ the first occurrence of the <code><UDN></code> element in the <var>device descriptor file</var>
+ with the <var>advertised service</var>'s <code><serviceId></code> sub-element.
+ </li>
+ <li>Set <var>network service record</var>'s <code>deviceId</code> property to the value of <var>device
+ identifier</var>.
+ </li>
+ <li>Set <var>network service record</var>'s <code>name</code> property to the string value of the first
+ occurrence of the <var>advertised service</var>'s <code><serviceId></code> sub-element.
+ </li>
+ <li>Set <var>network service record</var>'s <code>type</code> property to the concatenation of the string
+ <code>upnp:</code> followed by the string value of the first occurrence of the <var>advertised
+ service</var>'s <code><serviceType></code> sub-element.
+ </li>
+ <li>Set <var>network service record</var>'s <code>url</code> property to the string value of the first
+ occurrence of the <var>advertised service</var>'s <code><controlURL></code> sub-element.
+ </li>
+ <li>Set <var>network service record</var>'s <code>config</code> property to the string value of the
+ contents of the first occurrence of the <code><device></code> element in the <var>device descriptor
+ file</var>.
+ </li>
+ <li>If <var>advertised service</var>'s <code><eventSubURL></code> sub-element is not empty, then
+ set <var>network service record</var>'s <code>eventsUrl</code> property to the string value of the first
+ occurrence of the <var>advertised service</var>'s <code><eventSubURL></code> sub-element.
+ Otherwise, do not set <var>network service record</var>'s <code>eventsUrl</code> property.
+ </li>
+ <li>Set <var>network service record</var>'s <code>expiryTimestamp</code> property to the value of the
+ current date, in UTC timestamp format, plus the value of <var>device expiry</var>.
+ </li>
+ <li>Run the general rule for <a href="#dfn-adding-an-available-service"
+ class="internalDFN">adding an available service</a>, passing in the current <var>network service
+ record</var> as the only argument.
+ </li>
+ </ol>
+ </li>
+ <li>If <var>device descriptor file</var> contains a <code><deviceList></code> element then for each
+ <code><device></code> element within <code><deviceList></code> - herein known as an <var>embedded
+ device descriptor file</var> - the user agent <em class="rfc2119"
+ title="must">must</em> run the rule for <a href="#dfn-processing-a-upnp-device-description-file"
+ class="internalDFN">processing a UPnP Device Description File</a>, passing in the current <var>embedded
+ device descriptor file</var> as the <var>device descriptor file</var> argument, along with the current
+ <var>device identifier</var> and <var>device expiry</var> arguments.
+ </li>
+ </ol>
+ <p>
+ The rule for <dfn id="dfn-removing-all-services-from-a-registered-upnp-device">removing all services from a
+ registered UPnP Device</dfn> is the process of removing all services associated with a device from the
+ <a href="#dfn-list-of-available-service-records"
+ class="internalDFN">list of available service records</a> that has left the user's current network or has
+ otherwise timed out or expired. This rule takes one argument, <var>device identifier</var>, and consists
+ of running the following steps:
+ </p>
+ <ol class="rule">
+ <li>For each <var>existing service record</var> in the current <a href=
+ "#dfn-list-of-available-service-records"
+ class="internalDFN">list of available service records</a>, run the following sub-steps:
+ <ol class="rule">
+ <li>If the <var>existing service record</var>'s <code>deviceId</code> property does not match <var>device
+ identifier</var> then skip any remaining sub-steps for the current <var>existing service record</var> and
+ continue at the next available <var>existing service record</var>.
+ </li>
+ <li>Run the general rule for <a href="#dfn-removing-an-available-service"
+ class="internalDFN">removing an available service</a> passing in <var>existing service
+ record</var>'s <code>id</code> property as the only argument.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ <p>
+ When the <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> is to <dfn id="dfn-setup-a-upnp-events-subscription">setup a UPnP
+ Events Subscription</dfn>, it is to run the following steps with the current <var>network service
+ record</var> object as defined in 'Section 4.1.2: SUBSCRIBE with NT and CALLBACK' in [<cite><a class=
+ "bibref"
+ href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>]:
+ </p>
+ <ol class="rule">
+ <li>If <var>network service record</var>'s <code>eventsUrl</code> property is empty then the <a href=
+ "#dfn-user-agent"
+ class="internalDFN">user agent</a> <em class="rfc2119"
+ title="must">must</em> abort these steps.
+ </li>
+ <li>Let <var>callback <abbr title="Uniform Resource Locator">URL</abbr></var> be the value of creating a new
+ <a href="#dfn-user-agent-generated-callback-url"
+ class="internalDFN">user-agent generated callback url</a>.
+ </li>
+ <li>Send a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> SUBSCRIBE request with a <em>NT</em> header
+ with a string value of <code>upnp:event</code>, a <em>TIMEOUT</em> header with a user-agent defined timeout
+ value (in the form <code>Second-XX</code> where <code>XX</code> is the user-agent defined timeout value in
+ seconds) and a <em>CALLBACK</em> header with a string value of <var>callback <abbr title=
+ "Uniform Resource Locator">URL</abbr></var> towards the <var>network service record</var>'s
+ <code>eventsUrl</code> property.
+ </li>
+ <li>If a non-200 OK response is received from the <abbr title="Hypertext Transfer Protocol">HTTP</abbr>
+ SUBSCRIBE request then the <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> <em class="rfc2119"
+ title="must">must</em> abort these steps.
+ </li>
+ <li>On receiving a valid 200 OK response, run the following steps:
+ <ol class="rule">
+ <li>Let <var>callback ID</var> equal the string value of the first included <em>SID</em> header, if it
+ exists.
+ </li>
+ <li>Let <var>timeout date</var> equal the sum of the current UTC date value plus the integer value of the
+ first included <em>TIMEOUT</em> header (minus the leading string of <code>Second-</code>), if it exists.
+ </li>
+ <li>Run the following steps asynchronously and continue to the step labeled <em>listen</em> below.
+ </li>
+ <li>
+ <em>Refresh Subscription</em>: Run the following steps at a set interval (X) within the <a href=
+ "#dfn-user-agent"
+ class="internalDFN">user agent</a>:
+ <ol class="rule">
+ <li>Let <var>current date</var> equal the current UTC date.
+ </li>
+ <li>If <var>current date</var> is less than the <var>timeout date</var> then continue to the step
+ labeled <em>refresh subscription</em> above.
+ </li>
+ <li>Send a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> SUBSCRIBE request with a
+ <em>SID</em> header with the string value of <var>callback ID</var> and a user-agent defined
+ <em>TIMEOUT</em> header (in the form <code>Second-XX</code> where <code>XX</code> is the user-agent
+ defined timeout value in seconds) towards the <var>network service record</var>'s
+ <code>eventsUrl</code> property.
+ </li>
+ <li>On receiving a valid 200 OK, update <var>callback ID</var> with the string value of the first
+ included <em>SID</em> header and set <var>timeout date</var> to the sum of the current UTC date value
+ plus the integer value of the first included <em>TIMEOUT</em> header (minus the leading string of
+ <code>Second-</code>), if it exists. If the current date is greater than or equal to <var>timeout
+ date</var> then the <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> <em class="rfc2119"
+ title="should">should</em> continue from the step labeled <em>refresh subscription</em> above.
+ For all non 200 OK responses the <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> <em class="rfc2119"
+ title="should">should</em> continue from the step labeled <em>refresh subscription</em> above.
+ </li>
+ </ol>
+ </li>
+ <li>
+ <em>Listen</em>: For each <abbr title="Hypertext Transfer Protocol">HTTP</abbr> NOTIFY request received
+ at the <var>callback <abbr title="Uniform Resource Locator">URL</abbr></var> the <a href=
+ "#dfn-user-agent"
+ class="internalDFN">user agent</a> is to run the following steps:
+ <ol class="rule">
+ <li>Let <var>content clone</var> be the result of obtaining the message body of the <abbr title=
+ "Hypertext Transfer Protocol">HTTP</abbr> NOTIFY request. If <var>content clone</var> is empty, then
+ the <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> <em class="rfc2119"
+ title="must">must</em> abort these steps.
+ </li>
+ <li>Let <var>notification event</var> be a new simple event that uses the <a href=
+ "http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
+ class="externalDFN"><code>Event</code></a> interface with the name <a href=
+ "#event-notify"><code>notify</code></a>, which does not bubble, is not cancellable, and has no
+ default action.
+ </li>
+ <li>Let the <code>data</code> attribute of <var>notification event</var> have the DOMString value of
+ <var>content clone</var>.
+ </li>
+ <li>
+ <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
+ class="externalDFN">Queue a task</a> to dispatch <var>notification event</var> at the current
+ <a href="#networkservice"
+ class="internalDFN"><code>NetworkService</code></a> object.
+ </li>
+ <li>Return a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> 200 OK response to the sender of
+ the <abbr title="Hypertext Transfer Protocol">HTTP</abbr> NOTIFY request.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ </li>
+ </ol>
+ <p>
+ A <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> can <dfn id=
+ "dfn-terminate-an-existing-upnp-events-subscription">terminate an existing UPnP Events Subscription</dfn>
+ at any time for a <var>network service record</var> by sending an <abbr title=
+ "Hypertext Transfer Protocol">HTTP</abbr> UNSUBSCRIBE request - as defined in 'Section 4.1.4: Cancelling a
+ subscription with UNSUBSCRIBE' in [<cite><a class="bibref"
+ href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>] - with a HOST header set to that <var>active
+ service</var>'s <code>eventsUrl</code> property and a SID header set to the <var>callback ID</var>
+ obtained when the initial <a href="#dfn-setup-a-upnp-events-subscription"
+ class="internalDFN">setup a UPnP Events Subscription</a> action occurred.
+ </p>
+ </section>
+ <section id="network-topology-monitoring">
+ <h3>
+ <span class="secno">7.3</span> Network Topology Monitoring
+ </h3>
+ <div>
<p>
- The <dfn id="dom-networkservice-id"><code>id</code></dfn> attribute is a unique identifier for the service. Two services provided at different times or on different objects <em class="rfc2119" title="must">must</em> have the same <a href="#dom-networkservice-id"><code>id</code></a> value.
- </p>
-
- <p>
- The <dfn id="dom-networkservice-name"><code>name</code></dfn> attribute represents a human-readable title for the service.
- </p>
-
- <p>
- The <dfn id="dom-networkservice-type"><code>type</code></dfn> attribute reflects the value of the <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> of the service.
- </p>
-
- <p>
- The <dfn id="dom-networkservice-url"><code>url</code></dfn> attribute is an <a href="http://www.w3.org/TR/html5/urls.html#absolute-url" class="externalDFN">absolute <acronym title="Uniform Resource Locator">URL</acronym></a> pointing to the root <acronym title="Hypertext Transfer Protocol">HTTP</acronym>
- endpoint for the service that has been added to the <a href="#dfn-entry-script-origin-s-url-whitelist" class="internalDFN">entry script origin's <acronym title="Uniform Resource Locator">URL</acronym> whitelist</a>. Web pages can subsequently use this value for implicit cross-document messaging via various existing mechanisms (e.g. Web Sockets, Server-Sent Events, Web Messaging, XMLHttpRequest).
- </p>
-
- <p>
- The <dfn id="dom-networkservice-config"><code>config</code></dfn> attribute provides the raw configuration information extracted from the given network service.
- </p>
-
- </section>
-
- <section id="states" about="#states" typeof="bibo:Chapter">
- <h3><span class="secno">6.2 </span>States</h3>
-
- <dl class="domintro">
- <dt>
- <var title="">service</var>
- .
- <code title="dom-networkservice-readystate">
- <a href="#dom-networkservice-readystate">readyState</a>
- </code>
- </dt>
- <dd>
- <p>
- Returns the current state.
+ When the <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> detects that the user has dropped from their connected network then,
+ for each <var>existing service record</var> in the <a href="#dfn-list-of-available-service-records"
+ class="internalDFN">list of available service records</a>, the user agent <em class="rfc2119"
+ title="must">must</em> run the general rule for <a href="#dfn-removing-an-available-service"
+ class="internalDFN">removing an available service</a> passing in each <var>existing service
+ record</var>'s <code>id</code> property as the only argument for each call.
</p>
- </dd>
- </dl>
-
- A <a href="#networkservice"><code>NetworkService</code></a> object can be in several states. The <dfn id="dom-networkservice-readystate"><code>readyState</code></dfn> attribute <em class="rfc2119" title="must">must</em> return the current state of the networked service,
- which <em class="rfc2119" title="must">must</em> be one of the following values:
-
- <dl>
- <dt>
- <dfn id="dom-networkservice-AVAILABLE" title="dom-networkservice-AVAILABLE">
- <code>AVAILABLE</code>
- </dfn>
- (numeric value
- 1)
-
-
- </dt>
- <dd>
- <p>The object is connected to its service endpoint.
-
- </p>
- </dd>
- <dt>
- <dfn id="dom-networkservice-UNAVAILABLE" title="dom-networkservice-UNAVAILABLE">
- <code>UNAVAILABLE</code>
- </dfn>
- (numeric value
- 2)
- </dt>
- <dd>
- <p>The object is not connected to its service endpoint.
- </p>
- </dd>
- </dl>
-
+ <p>
+ When the <a href="#dfn-user-agent"
+ class="internalDFN">user agent</a> detects that the user has connected to a new network or reconnected
+ to an existing network, then it <em class="rfc2119"
+ title="should">should</em> restart its discovery mechanisms as defined in the <a href=
+ "#service-discovery">Service Discovery</a> section of this specification, maintaining the existing
+ <a href="#dfn-list-of-active-service-managers"
+ class="internalDFN">list of active service managers</a> currently in use.
+ </p>
+ </div>
</section>
-
- <section id="events-1" about="#events-1" typeof="bibo:Chapter">
- <h3><span class="secno">6.3 </span>Events</h3>
-
+ </section>
+ <section id="events-summary">
+ <h2>
+ <span class="secno">8.</span> Events Summary
+ </h2>
<p>
- The following are the event handlers (and their corresponding event handler event types) that must be supported, as IDL attributes, by all objects implementing the
- <a href="#networkservice"><code>NetworkService</code></a> interface:
- </p>
-
- <table border="1">
+ The following events are dispatched on the <a href="#networkservices"><code>NetworkServices</code></a> and/or
+ <a href="#networkservice"><code>NetworkService</code></a> objects:
+ </p>
+ <table border="1">
<thead>
<tr>
<th>
- <span title="event handlers">Event handler</span>
+ <span>Event name</span>
</th>
<th>
- <span>Event handler event type</span>
+ <span>Interface</span>
+ </th>
+ <th>
+ <span>Dispatched when...</span>
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
- <dfn id="dom-networkservice-onmessage" title="dom-NetworkService-onmessage">
- <code>onmessage</code>
- </dfn>
+ <dfn id="event-serviceavailable"><code>serviceavailable</code></dfn>
</td>
<td>
- <code title="event-message">message</code>
+ <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
+ class="externalDFN"><code>Event</code></a>
+ </td>
+ <td>
+ When a new service that matches one of the <a>requested type tokens</a> is found in the current network.
</td>
</tr>
<tr>
<td>
- <dfn id="dom-networkservice-onreadystatechange" title="dom-NetworkService-onreadystatechange">
- <code>onreadystatechange</code>
- </dfn>
+ <dfn id="event-serviceunavailable"><code>serviceunavailable</code></dfn>
</td>
<td>
- <code title="event-onreadystatechange">readystatechange</code>
+ <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
+ class="externalDFN"><code>Event</code></a>
+ </td>
+ <td>
+ When an existing service that matches one of the <a>requested type tokens</a> gracefully leaves or
+ expires from the current network.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="event-serviceonline"><code>serviceonline</code></dfn>
+ </td>
+ <td>
+ <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
+ class="externalDFN"><code>Event</code></a>
+ </td>
+ <td>
+ When a current service renews its service registration within the current network.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="event-serviceoffline"><code>serviceoffline</code></dfn>
+ </td>
+ <td>
+ <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
+ class="externalDFN"><code>Event</code></a>
+ </td>
+ <td>
+ When a current service gracefully leaves or otherwise expires from the current network.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="event-notify"><code>notify</code></dfn>
+ </td>
+ <td>
+ <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
+ class="externalDFN"><code>Event</code></a>
+ </td>
+ <td>
+ When a valid UPnP Events Subscription Message is received on a <a href=
+ "#dfn-user-agent-generated-callback-url"
+ class="internalDFN">user-agent generated callback url</a> for a current service. This event never
+ fires for Zeroconf-based services.
</td>
</tr>
</tbody>
</table>
-
- <p>
- Events with an event type of <code>message</code> defined in this specification are <a href="http://dev.w3.org/html5/postmsg/#messageevent" class="externalDFN"><code>MessageEvent</code></a> objects as defined in [<cite><a class="bibref" rel="biblioentry" href="#bib-WEBMESSAGING">WEBMESSAGING</a></cite>].
- </p>
-
+ </section>
+ <section id="garbage-collection">
+ <h2>
+ <span class="secno">9.</span> Garbage collection
+ </h2>
<p>
- Events with an event type of <code>readystatechange</code> defined in this specification are simple <code>Event</code> objects.
- </p>
-
- </section>
- </div>
-
- <div id="service-discovery" about="#service-discovery" typeof="bibo:Chapter" class="section">
- <!--OddPage--><h2><span class="secno">7. </span>Service Discovery</h2>
-
- <p>
- A <a href="#dfn-user-agent" class="internalDFN">user agent</a> conforming to this specification <em class="rfc2119" title="may">may</em> implement <acronym title="Simple Service Discovery Protocol"><acronym title="Simple Service Discovery Protocol">SSDP</acronym></acronym> [<cite><a class="bibref" rel="biblioentry" href="#bib-UPNP">UPNP</a></cite>] and Zeroconf [<cite><a class="bibref" rel="biblioentry" href="#bib-ZEROCONF">ZEROCONF</a></cite>] service discovery mechanisms
- to enable Web pages to request and connect with <acronym title="Hypertext Transfer Protocol">HTTP</acronym> services running on networked devices, discovered via either mechanism, through this <acronym title="Application Programming Interface">API</acronym>. When a <a href="#dfn-user-agent" class="internalDFN">user agent</a> implements either of these service discovery mechanisms, then it <em class="rfc2119" title="must">must</em> conform to the corresponding algorithms provided in this section of the specification.
+ A user agent <em class="rfc2119"
+ title="must">must</em> only garbage collect a <a href="#networkservices"
+ class="internalDFN"><code>NetworkServices</code></a> object and remove its entry from the <a href=
+ "#dfn-list-of-active-service-managers"
+ class="internalDFN">list of active service managers</a> when the user has navigated away from the browsing
+ context in which that <a href="#networkservices"
+ class="internalDFN"><code>NetworkServices</code></a> object was provided.
</p>
<p>
- This section presents how the results of these two service discovery
- mechanisms will be matched to requested service types and how their properties will be applied to any resulting <a href="#networkservice"><code>NetworkService</code></a> objects.
- </p>
-
- <p>
- It is expected that user agents will perform these service discovery mechansisms asynchronously and periodically update the <a>list of networked devices</a> as required. The timing of any
- service discovery mechanisms is an implementation detail left to the discretion of the implementer (e.g. once on user agent start-up, every X seconds during user agent execution or on
- invocation of this <acronym title="Application Programming Interface">API</acronym> from a Web page).
- </p>
-
- <p>
- The <dfn id="dfn-list-of-available-service-records">list of available service records</dfn> is a single dynamic internal lookup table within user agents that is used to track the current services available in the network at any given time.
- At any point during the running of either of the two service discovery mechanisms then existing entries within this table can be updated, entries can be added and entries can be removed as the status of networked
- services changes. Each record contained within this table contains the attributes: <code>id</code>, <code>name</code>, <code>type</code>, <code>url</code> and <code>config</code>.
+ A user agent <em class="rfc2119"
+ title="must not">must not</em> garbage collect individual <a href="#networkservice"
+ class="internalDFN"><code>NetworkService</code></a> objects until their parent <a href="#networkservices"
+ class="internalDFN"><code>NetworkServices</code></a> object has been garbage collected.
</p>
-
- <section id="zeroconf--mdns---dns-sd" about="#zeroconf--mdns---dns-sd" typeof="bibo:Chapter">
- <h3><span class="secno">7.1 </span>Zeroconf (<acronym title="Multicast DNS"><acronym title="Multicast DNS">mDNS</acronym></acronym> + <acronym title="Domain Name System"><acronym title="Domain Name System">DNS</acronym></acronym>-<acronym title="Service Discovery"><acronym title="Service Discovery">SD</acronym></acronym>)</h3>
-
- <p>
- For each <acronym title="Domain Name System">DNS</acronym> response received from a user-agent-initiated Multicast <acronym title="Domain Name System">DNS</acronym> Browse for <acronym title="DNS Pointer Record"><acronym title="DNS Pointer Record">PTR</acronym></acronym> records with the name <code>_services._dns-sd._udp</code> on the resolved recommended automatic browsing
- domain [<cite><a class="bibref" rel="biblioentry" href="#bib-MDNS">MDNS</a></cite>], the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> run the following steps:
- </p>
-
- <ol class="rule">
-
- <li>Let <var>service <acronym title="Multicast DNS">mDNS</acronym> responses</var> be an array of <acronym title="DNS Pointer Record">PTR</acronym> records received by issuing a Multicast <acronym title="Domain Name System">DNS</acronym> Browse for <acronym title="DNS Pointer Record">PTR</acronym> records with the name of the current discovered service type.</li>
-
- <li>For each Object <var>service <acronym title="Multicast DNS">mDNS</acronym> response</var> in <var>service <acronym title="Multicast DNS">mDNS</acronym> responses</var>, run the following steps:
- <ol>
-
- <li>
- Let <var>network service record</var> be an Object consisting of the following empty properties: <code>id</code>, <code>name</code>, <code>type</code>, <code>url</code>, <code>config</code>.
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>id</code> property to the value of the full <acronym title="DNS Pointer Record">PTR</acronym> Service Instance Name [<cite><a class="bibref" rel="biblioentry" href="#bib-MDNS">MDNS</a></cite>].
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>name</code> property to the value of the <acronym title="DNS Pointer Record">PTR</acronym> Service Instance Name's <var>Instance</var> component [<cite><a class="bibref" rel="biblioentry" href="#bib-MDNS">MDNS</a></cite>].
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>type</code> property to the concatenation of the string <code>zeroconf:</code> followed by the value of the <acronym title="DNS Pointer Record">PTR</acronym> Service Instance Name's <var>Service</var> component [<cite><a class="bibref" rel="biblioentry" href="#bib-MDNS">MDNS</a></cite>].
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>url</code> property to the resolvable Service <acronym title="Uniform Resource Locator">URL</acronym> obtained from performing an <acronym title="Domain Name System">DNS</acronym>-<acronym title="Service Discovery">SD</acronym> Lookup [<cite><a class="bibref" rel="biblioentry" href="#bib-DNS-SD">DNS-SD</a></cite>] of the current service from the <acronym title="DNS Pointer Record">PTR</acronym> record provided [<cite><a class="bibref" rel="biblioentry" href="#bib-MDNS">MDNS</a></cite>].
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>config</code> property to the string value of the contents of the first <acronym title="Domain Name System">DNS</acronym>-<acronym title="Service Discovery">SD</acronym> TXT record associated with the <var>service <acronym title="Multicast DNS">mDNS</acronym> response</var> as defined in [<cite><a class="bibref" rel="biblioentry" href="#bib-DNS-SD">DNS-SD</a></cite>].
- </li>
-
- <li>
- For each Object <var>existing service record</var> in the current <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>, run the following sub-steps:
- <ol class="rule">
-
- <li>
- If the <var>existing service record</var>'s <code>id</code> property matches the value of the <var>network service record</var>'s <code>id</code>, then set the
- value of <var>existing service record</var> in the current <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a> to the value of the
- <var>network service record</var> and skip the next step.
- </li>
- </ol>
- </li>
-
- <li>
- Add <var>network service record</var> to the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>.
- </li>
-
- <li>
- For each non-garbage collected <a href="#networkservice"><code>NetworkService</code></a> object run the following steps:
-
- <ol class="rule">
- <li>
- If the <a href="#networkservice"><code>NetworkService</code></a> object's <code>type</code> attribute does not equal the
- current <a>network service record</a>'s <code>type</code> property then continue at the next available active
- <a href="#networkservice"><code>NetworkService</code></a> object.
- </li>
- <li>
- Increment the <code>servicesAvailable</code> attribute of the <a href="#networkservices"><code>NetworkServices</code></a> object by <code>1</code>.
- </li>
- </ol>
- </li>
- </ol>
- </li>
- </ol>
-
- </section>
-
- <section id="universal-plug-and-play--upnp" about="#universal-plug-and-play--upnp" typeof="bibo:Chapter">
- <h3><span class="secno">7.2 </span>Universal Plug-and-Play (<acronym title="Universal Plug-and-Play"><acronym title="Universal Plug-and-Play">UPnP</acronym></acronym>)</h3>
-
- <p>
- For each <acronym title="Simple Service Discovery Protocol">SSDP</acronym> Presence Announcement [<cite><a class="bibref" rel="biblioentry" href="#bib-UPNP">UPNP</a></cite>] - a <acronym title="Hypertext Transfer Protocol">HTTP</acronym> NOTIFY request - received from a user-agent-initiated <acronym title="Simple Service Discovery Protocol">SSDP</acronym> Discovery Request [<cite><a class="bibref" rel="biblioentry" href="#bib-UPNP">UPNP</a></cite>], the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> run the following steps:
- </p>
-
- <ol class="rule">
- <li>
- Let <var>ssdp device</var> be an Object with a property for each <acronym title="Hypertext Transfer Protocol">HTTP</acronym> header received in the received <acronym title="Simple Service Discovery Protocol">SSDP</acronym> Presence Announcement, with each key being the name of a <acronym title="Hypertext Transfer Protocol">HTTP</acronym> header and its
- value being that <acronym title="Hypertext Transfer Protocol">HTTP</acronym> header's accompanying value.
- </li>
-
- <li>
- If <var>ssdp device</var> does not contain at least one <var>NTS</var>, <var>USN</var> and <var>Location</var> parameter, then the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> abort these steps.
- </li>
-
- <li>
- If the first occurrence of <var>NTS</var> has a value other than <code>ssdp:alive</code>, then continue to the step labeled <var>update service monitor</var> below.
+ <p>
+ A user agent <em class="rfc2119"
+ title="must">must</em> garbage collect the <a href="#networkservice"
+ class="internalDFN"><code>NetworkService</code></a> <a href="#dfn-indexed-properties"
+ class="internalDFN">indexed properties</a> of a <a href="#networkservices"
+ class="internalDFN"><code>NetworkServices</code></a> object when that <a href="#networkservices"
+ class="internalDFN"><code>NetworkServices</code></a> object itself has been garbage-collected.
+ </p>
+ </section>
+ <section id="use-cases-and-requirements">
+ <h2>
+ <span class="secno">10.</span> Use Cases and Requirements
+ </h2>
+ <p>
+ This section covers what the requirements are for this <abbr title=
+ "Application Programming Interface">API</abbr>, as well as illustrates some use cases.
+ </p>
+ <ul class="rule">
+ <li>Once a user has given permission, user agents should provide the ability for Web pages to communicate
+ directly with a Local-networked Service.
+ <ul class="rule">
+ <li>Example: A web-based TV remote control. A Web page wants to control the current user's TV, changing the
+ programming shown or increasing/decreasing/muting the volume of the Local-networked Device. The Web page
+ requests a service type that is known to be implemented by television sets to which it has the application
+ logic to communicate. Local devices providing the request service types are discovered and presented to the
+ user for authorization. The user selects one or more of the discovered television sets to be accessible to
+ the current Web page and then clicks 'Share'. The Web page can now communicate directly with the
+ user-authorized Local-networked services.
</li>
-
- <li>
- Let <var>root device descriptor file</var> contain the contents of the file located at the <acronym title="Uniform Resource Locator">URL</acronym> provided in the first occurrence of <var>Location</var> obtained according to the rules
- defined in the section 'Retrieving a description using <acronym title="Hypertext Transfer Protocol">HTTP</acronym>' [<cite><a class="bibref" rel="biblioentry" href="#bib-UPNP">UPNP</a></cite>].
- </li>
-
- <li>
- If <var>root device descriptor file</var> is empty, then the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> abort these steps.
- </li>
-
- <li>
- Let <var>advertised services</var> be a <a>list of all advertised services</a> obtained from the <var>root device descriptor file</var> containing all sub-nodes of the <code>serviceList</code> node as described in
- the section 'Device Description' [<cite><a class="bibref" rel="biblioentry" href="#bib-UPNP">UPNP</a></cite>].
+ </ul>
+ </li>
+ <li>Web pages should be able to communicate with Local-networked Services using the messaging channel supported
+ by those Devices.
+ <ul class="rule">
+ <li>Example: A Web page advertises that it is capable of controlling multiple Home Media Servers. The user
+ can select their Home Media Server type from a drop-down list, at which point the Web page sends a request
+ to the user agent to connect with the associated service type of the Home Media Server. The Media Server
+ selected implements a Web Socket channel for bi-directional service communication and so the Web page opens
+ a web socket to the requested Media Server and can communicate as required via that appropriate channel.
</li>
-
- <li>
- For each Object <var>advertised service</var> in <var>advertised services</var> run the following steps:
- <ol class="rule">
-
- <li>
- Let <var>network service record</var> be an Object consisting of the following empty properties: <code>id</code>, <code>name</code>, <code>type</code>, <code>url</code>, <code>eventsUrl</code>, <code>config</code>.
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>id</code> property to the string value of the first occurrence of <var>ssdp device</var>'s <var>USN</var> parameter.
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>name</code> property to the string value of the first occurrence of the <var>service</var>'s <code>serviceId</code> property.
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>type</code> property to the concatenation of the string <code>upnp:</code> followed by the string value of the first occurrence of the <var>service</var>'s <code>serviceType</code> property.
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>url</code> property to the string value of the first occurrence of the <var>service</var>'s <code>controlURL</code> property.
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>config</code> property to the string value of the first occurrence of the <var>device</var> property.
- </li>
-
- <li>
- If <var>service</var>'s <code>eventSubURL</code> property is empty, then continue to the step labeled <em>register</em> below.
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>eventsUrl</code> property to the string value of the first occurrence of the <var>service</var>'s <code>eventSubURL</code> property.
- </li>
-
- <li>
- <em>Register</em>: For each Object <var>existing service record</var> in the current <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>, run the following sub-steps:
- <ol class="rule">
-
- <li>
- If the <var>existing service record</var>'s <var>id</var> property matches the value of the first occurrence of <var>USN</var> and the
- <var>existing service record</var>'s <code>type</code> property matches the value of <var>network service record</var>'s <code>type</code>, then set the
- value of <var>existing service record</var> in the current <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a> to the value of the
- <var>network service record</var> and skip the next step.
- </li>
- </ol>
- </li>
-
- <li>
- Add <var>network service record</var> to the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>.
- </li>
-
- </ol>
+ </ul>
+ </li>
+ <li>Web pages should be able to communicate with Local-networked Services using the messaging format supported
+ by those Devices.
+ <ul class="rule">
+ <li>Example: A Web page advertises that it is capable of interacting with and controlling multiple types of
+ Home Media Server. The user can select their Home Media Server type from a drop-down list or known Media
+ Servers, at which point the Web page sends a request to the user agent to connect with the associated
+ service type (and, optionally, the associated event type) of the Home Media Server. The communication
+ protocols supported by Home Media Servers typically vary between UPnP, JSON-RPC, Protocol Buffers or other
+ messaging formats depending on the Home Media Server requested. The Web page is able to communicate with
+ the user-selected Home Media Server in the messaging format supported by that Device, which, in this
+ example is a simple key/value pair text format.
</li>
- <li>
- <em>Update Service Monitor</em>: For each non-garbage collected <a href="#networkservice"><code>NetworkService</code></a> object run the following steps:
-
- <ol class="rule">
- <li>
- If this <a href="#networkservice"><code>NetworkService</code></a> object's <code>type</code> attribute does not equal the
- current <a>network service record</a>'s <code>type</code> property then continue at the next available active
- <a href="#networkservice"><code>NetworkService</code></a> object.
- </li>
- <li>
- If the <var>announcement type</var> equals <code>ssdp:alive</code> then Increment the <code>servicesAvailable</code> attribute of the <a href="#networkservices"><code>NetworkServices</code></a>
- object by <code>1</code>. Otherwise, decrement the <code>servicesAvailable</code> attribute of the <a href="#networkservices"><code>NetworkServices</code></a>
- object by <code>1</code>.
- </li>
- </ol>
+ </ul>
+ </li>
+ <li>Web pages should not be able to communicate with Local-networked Services that have not been authorized by
+ the user thereby maintaining the user's privacy.
+ <ul class="rule">
+ <li>Example: A Web page requests access to one type of Local-networked service. The user authorizes access
+ to that particular service. Other services running on that same device, and on other devices within the
+ network, should not be accessible to the current Web page.
</li>
- </ol>
-
- <p>
- A <dfn id="dfn-user-agent-generated-callback-url">user-agent generated callback url</dfn> is a Local-network accessible <acronym title="Uniform Resource Locator">URL</acronym> endpoint that a <a href="#dfn-user-agent" class="internalDFN">user agent</a> must generate and maintain for receiving <acronym title="Hypertext Transfer Protocol">HTTP</acronym> NOTIFY requests from <acronym title="Universal Plug-and-Play">UPnP</acronym> Event sources.
- </p>
-
- <p>When the <a href="#dfn-user-agent" class="internalDFN">user agent</a> is to <dfn id="dfn-setup-a-upnp-events-subscription">setup a <acronym title="Universal Plug-and-Play">UPnP</acronym> Events Subscription</dfn>, it is to run the following steps with the current <var>network service record</var> object:</p>
-
- <ol class="rule">
- <li>
- If <var>network service record</var>'s <code>eventsUrl</code> property is empty then the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> abort these steps.
+ </ul>
+ </li>
+ <li>A user should be able to share one or more Local-networked Services based on a particular service type
+ request from a Web page.
+ <ul class="rule">
+ <li>Example: A Web page is capable of interacting with a specific profile of Local-networked Service. As
+ such, it makes a request to the user agent to access those services, of which multiple matches are found.
+ The user is capable of selecting one or more of the discovered services to share with the Web page. The Web
+ page can then implement a drag-and-drop interface for the user to drag specific actions on to one or more
+ of the authorized Local-networked Services.
</li>
-
- <li>
- Let <var>callback <acronym title="Uniform Resource Locator">URL</acronym></var> be the value of creating a new <a href="#dfn-user-agent-generated-callback-url" class="internalDFN">user-agent generated callback url</a>.
- </li>
-
- <li>
- Send a <acronym title="Hypertext Transfer Protocol">HTTP</acronym> SUBSCRIBE request with a <em>NT</em> header with a string value of <code>upnp:event</code>, a <em>TIMEOUT</em> header with an integer value of
- <code>86400</code> and a <em>CALLBACK</em> header
- with a string value of <var>callback <acronym title="Uniform Resource Locator">URL</acronym></var> towards the <var>network service record</var>'s <code>eventsUrl</code> property.
- </li>
-
- <li>
- If a non-200 OK response is received from the <acronym title="Hypertext Transfer Protocol">HTTP</acronym> SUBSCRIBE request then the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> abort these steps.
- </li>
-
- <li>
- On receiving a valid 200 OK response, run the following steps:
+ </ul>
+ </li>
+ <li>User agents should provide an <abbr title="Application Programming Interface">API</abbr> exposed to script
+ that exposes the features above. The user is notified by UI anytime interaction with Local-networked Services
+ is requested, giving the user full ability to cancel or abort the transaction. The user selects the
+ Local-networked Services to be connected to the current Web page, and can cancel these at any time. No
+ invocations to these APIs occur silently without user intervention.
+ </li>
+ </ul>
+ </section>
+ <section class="informative appendix"
+ id="examples">
+ <h2>
+ <span class="secno">A.</span> Examples
+ </h2>
+ <p>
+ <em>This section is non-normative.</em>
+ </p>
+ <div class="example">
+ <p>
+ This sample code exposes a button. When clicked, this button is disabled and the user is prompted to offer a
+ network service. The user may also select multiple network services. When the user has authorized a network
+ service to be connected to the web page then the web page issues a simple command to get a list of all the
+ albums stored on the connected media player service.
+ </p>
+ <p>
+ The button is re-enabled only when the connected network service disconnects for whatever reason (the service
+ becomes unavailable on the network, the user disconnects from their current network or the user revokes
+ access to the service from the current web page). At this point the user can re-click the button to select a
+ new network service to connect to the web page and the above steps are repeated.
+ </p>
+ <p>
+ The provided service type identifier and service interaction used in this example is based on the
+ well-defined service type and messaging format supported by the <a href="http://xbmc.org/about/">XBMC Media
+ Server</a>.
+ </p>
+ <hr>
+ <pre class="highlight prettyprint">
+<span class="tag"><input</span><span class="pln"> </span><span class="atn">type</span><span class=
+"pun">=</span><span class="atv">"button"</span><span class="pln"> </span><span class="atn">value</span><span class=
+"pun">=</span><span class="atv">"Start"</span><span class="pln"> </span><span class="atn">onclick</span><span class=
+"pun">=</span><span class="atv">"</span><span class="pln">start</span><span class="pun">()</span><span class=
+"atv">"</span><span class="pln"> </span><span class="atn">id</span><span class="pun">=</span><span class=
+"atv">"startBtn"</span><span class="tag">/></span><span class="pln">
+</span><span class="tag"><div</span><span class="pln"> </span><span class="atn">id</span><span class=
+"pun">=</span><span class="atv">"debugconsole"</span><span class="tag">></div></span><span class="pln">
- <ol class="rule">
- <li>
- Let <var>callback ID</var> equal the string value of the first included <em>SID</em> header, if it exists.
- </li>
- <li>
- Let <var>timeout date</var> equal the sum of the current UTC date value plus the integer value of the first included <em>TIMEOUT</em> header, if it exists.
- </li>
- <li>
- Run the following steps aynchronously and continue to the step labeled <em>listen</em> below.
- </li>
- <li>
- <em>Refresh Subscription</em>: Run the following steps at a set interval (X) within the <a href="#dfn-user-agent" class="internalDFN">user agent</a>:
-
- <ol class="rule">
- <li>
- Let <var>current date</var> equal the current UTC date.
- </li>
- <li>
- If <var>current date</var> is less than the <var>timeout date</var> then continue to the step labeled <em>refresh subscription</em> above.
- </li>
- <li>
- Send a <acronym title="Hypertext Transfer Protocol">HTTP</acronym> SUBSCRIBE request with a <em>SID</em> header with the string value of <var>callback ID</var> and a <em>TIMEOUT</em> header
- with an integer value of <code>86400</code> towards the <var>network service record</var>'s <code>eventsUrl</code> property.
- </li>
- <li>
- On receiving a valid 200 OK, update <var>callback ID</var> with the string value of the first included <em>SID</em> header, if it exists. All other <acronym title="Hypertext Transfer Protocol">HTTP</acronym>
- responses should cause the <a href="#dfn-user-agent" class="internalDFN">user agent</a> to continue from the step labeled <em>refresh subscription</em> above.
- </li>
- </ol>
-
- </li>
-
- <li>
- <em>Listen</em>: For each <acronym title="Hypertext Transfer Protocol">HTTP</acronym> NOTIFY request received at the <var>callback <acronym title="Uniform Resource Locator">URL</acronym></var> the <a href="#dfn-user-agent" class="internalDFN">user agent</a> is to run the following steps:
-
- <ol class="rule">
- <li>
- Let <var>content clone</var> be the result of obtaining the message body of the <acronym title="Hypertext Transfer Protocol">HTTP</acronym> NOTIFY request. If <var>content clone</var> is empty, then the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> abort these steps.
- </li>
- <li>
- Create a new <code>message</code> event that uses the <a href="http://dev.w3.org/html5/postmsg/#messageevent" class="externalDFN"><code>MessageEvent</code></a> interface [<cite><a class="bibref" rel="biblioentry" href="#bib-WEBMESSAGING">WEBMESSAGING</a></cite>], with the name <code>message</code>,
- which does not bubble, is not cancelable, and has no default action.
- </li>
- <li>
- Let the <code>data</code> attribute of the event have the DOMString value of <var>content clone</var>.
- </li>
- <li>
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">Queue a task</a> to
- dispatch the newly created event at the current <a href="#networkservice" class="internalDFN"><code>NetworkService</code></a> object.
- </li>
- </ol>
- </li>
-
- </ol>
-
- </li>
- </ol>
-
- </section>
-
- <section id="network-topology-monitoring" about="#network-topology-monitoring" typeof="bibo:Chapter">
- <h3><span class="secno">7.3 </span>Network Topology Monitoring</h3>
-
- <div>
- <p>
- When the <a href="#dfn-user-agent" class="internalDFN">user agent</a> detects that the user has dropped from their connected network, then it <em class="rfc2119" title="must">must</em> run the following steps:
- </p>
-
- <ol class="rule">
- <li>
- Flush all entries from the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>.
- </li>
- <li>
- For each <a href="#networkservice"><code>NetworkService</code></a> object currently active in the <a href="#dfn-user-agent" class="internalDFN">user agent</a> perform the following steps:
-
- <ol class="rule">
- <li>
- Set the <a href="#dom-networkservice-readystate"><code>readyState</code></a> attribute to <code>2</code> (<a href="#dom-networkservice-UNAVAILABLE"><code>UNAVAILABLE</code></a>).
- </li>
- <li>
- Create a new <code>readystatechange</code> event that uses the <code>Event</code> interface which does not bubble, is not cancelable, and has no default action.
- </li>
- <li>
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">Queue a task</a> to
- dispatch the newly created event at the <a href="#networkservice"><code>NetworkService</code></a> object.
- </li>
- </ol>
- </li>
- </ol>
-
- <p>
- When the <a href="#dfn-user-agent" class="internalDFN">user agent</a> detects that the user has connected to a new network, then it <em class="rfc2119" title="should">should</em> run the following steps:
- </p>
-
- <ol class="rule">
- <li>
- Re-issue an <acronym title="Multicast DNS">mDNS</acronym> search and <acronym title="Simple Service Discovery Protocol">SSDP</acronym> discovery search and handle the responses according to the processing defined in <a href="#service-discovery" class="sec-ref">Section 6: Service Discovery</a>.
- </li>
- </ol>
- </div>
- </section>
- </div>
-
- <div id="garbage-collection" about="#garbage-collection" typeof="bibo:Chapter" class="section">
- <!--OddPage--><h2><span class="secno">8. </span>Garbage collection</h2>
-
- <p>
- A <a href="#networkservice" class="internalDFN"><code>NetworkService</code></a> object containing a <code>url</code> parameter currently in the <a href="#dfn-entry-script-origin-s-url-whitelist" class="internalDFN">entry script origin's <acronym title="Uniform Resource Locator">URL</acronym> whitelist</a> <em class="rfc2119" title="must not">must not</em> be garbage collected.
- </p>
-
- <p>
- Only when the user navigates away from the current browsing context can <a href="#networkservice" class="internalDFN"><code>NetworkService</code></a> objects be garbage-collected and records in the <a href="#dfn-entry-script-origin-s-url-whitelist" class="internalDFN">entry script origin's <acronym title="Uniform Resource Locator">URL</acronym> whitelist</a> be removed.
- </p>
+</span><span class="tag"><script></span><span class="pln">
+ </span><span class="kwd">var</span><span class="pln"> startBtn </span><span class="pun">=</span><span class=
+"pln"> document</span><span class="pun">.</span><span class="pln">getElementById</span><span class=
+"pun">(</span><span class="str">'startBtn'</span><span class="pun">),</span><span class="pln">
+ debug </span><span class="pun">=</span><span class="pln"> document</span><span class="pun">.</span><span class=
+"pln">getElementById</span><span class="pun">(</span><span class="str">'debugconsole'</span><span class=
+"pun">);</span><span class="pln">
- </div>
-
-
- <div id="use-cases-and-requirements" about="#use-cases-and-requirements" typeof="bibo:Chapter" class="section">
- <!--OddPage--><h2><span class="secno">9. </span>Use Cases and Requirements</h2>
-
- <p>This section covers what the requirements are for this <acronym title="Application Programming Interface">API</acronym>, as well as illustrates some use cases.</p>
-
- <ul class="rule">
- <li>
- Once a user has given permission, user agents should provide the ability for Web pages to communicate directly with a Local-networked Service.
- <ul class="rule">
- <li>
- Example: A web-based TV remote control. A Web page wants to control the current user's TV, changing the programming shown or increasing/decreasing/muting the
- volume of the Local-networked Device. The Web page requests a service type that is known to be implemented by television sets to which it has the
- application logic to communicate. Local devices providing the request service types are discovered and presented to the user for authorization. The user selects one
- or more of the discovered television sets to be accessible to the current Web page and then clicks 'Share'. The Web page can now communicate directly with
- the user-authorized Local-networked services.
- </li>
- </ul>
- </li>
-
- <li>
- Web pages should be able to communicate with Local-networked Services using the messaging channel supported by those Devices.
- <ul class="rule">
- <li>
- Example: A Web page advertises that it is capable of controlling multiple Home Media Servers. The user can select their Home Media Server type from a drop-down list, at which point the
- Web page sends a request to the user agent to connect with the associated service type of the Home Media Server. The Media Server selected implements a Web Socket channel for
- bi-directional service communication and so the Web page opens a web socket to the requested Media Server and can communicate as required via that appropriate channel.
- </li>
- </ul>
- </li>
-
- <li>
- Web pages should be able to communicate with Local-networked Services using the messaging format supported by those Devices.
- <ul class="rule">
- <li>
- Example: A Web page advertises that it is capable of interacting with and controlling multiple types of Home Media Server. The user can select their Home Media Server type from a drop-down list or known Media Servers, at which point the
- Web page sends a request to the user agent to connect with the associated service type (and, optionally, the associated event type) of the Home Media Server. The communiciation protocols supported by Home Media Servers typically vary
- between <acronym title="Universal Plug-and-Play">UPnP</acronym>, JSON-RPC, Protocol Buffers or other messaging formats depending on the Home Media Server requested. The Web page is able to communicate with the user-selected Home Media
- Server in the messaging format supported by that Device, which, in this example is a simple key/value pair text format.
- </li>
- </ul>
- </li>
-
- <li>
- Web pages should not be able to communicate with Local-networked Services that have not been authorized by the user thereby maintaining the user's privacy.
- <ul class="rule">
- <li>
- Example: A Web page requests access to one type of Local-networked service. The user authorizes access to that particular service. Other services running on that same device, and on other devices
- within the network, should not be accessible to the current Web page.
- </li>
- </ul>
- </li>
+ </span><span class="kwd">function</span><span class="pln"> start</span><span class="pun">()</span><span class=
+"pln"> </span><span class="pun">{</span><span class="pln">
+ </span><span class="kwd">if</span><span class="pun">(</span><span class="pln">navigator</span><span class=
+"pun">.</span><span class="pln">getNetworkServices</span><span class="pun">)</span><span class=
+"pln"> </span><span class="pun">{</span><span class="pln">
+ navigator</span><span class="pun">.</span><span class="pln">getNetworkServices</span><span class=
+"pun">(</span><span class="str">'zeroconf:_xbmc-jsonrpc._tcp'</span><span class="pun">,</span><span class=
+"pln"> gotXBMCService</span><span class="pun">,</span><span class="pln"> error</span><span class=
+"pun">);</span><span class="pln">
+ startBtn</span><span class="pun">.</span><span class="pln">disabled </span><span class="pun">=</span><span class=
+"pln"> </span><span class="kwd">true</span><span class="pun">;</span><span class="pln">
+ </span><span class="pun">}</span><span class="pln"> </span><span class="kwd">else</span><span class=
+"pln"> </span><span class="pun">{</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class=
+"pln"> </span><span class="str">"<br>Service Discovery not supported!"</span><span class=
+"pun">;</span><span class="pln">
+ </span><span class="pun">}</span><span class="pln">
+ </span><span class="pun">}</span><span class="pln">
- <li>
- A user should be able to share one or more Local-networked Services based on a particular service type request from a Web page.
- <ul class="rule">
- <li>
- Example: A Web page is capable of interacting with a specific profile of Local-networked Service. As such, it makes a request to the user agent to access those services, of which multiple matches
- are found. The user is capable of selecting one or more of the discovered services to share with the Web page. The Web page can then implement a drag-and-drop interface for the user to drag specific
- actions on to one or more of the authorized Local-networked Services.
- </li>
- </ul>
- </li>
-
- <li>
- User agents should provide an <acronym title="Application Programming Interface">API</acronym> exposed to script that exposes the features above. The user is notified by UI anytime interaction with Local-networked Services is requested, giving the user
- full ability to cancel or abort the transaction. The user selects the Local-networked Services to be connected to the current Web page, and can cancel these at any time. No invocations to
- these APIs occur silently without user intervention.
- </li>
- </ul>
- </div>
-
- <div class="informative appendix section" id="examples" about="#examples" typeof="bibo:Chapter">
- <!--OddPage--><h2><span class="secno">A. </span>Examples</h2><em>This section is non-normative.</em>
-
- <div class="example">
- <p>This sample code exposes a button. When clicked, this button is disabled and the user is prompted to offer a network service. The user may also select multiple network services. When the user has authorized a network service to be connected to the web page then the web page issues a simple command to get a list of all the albums stored on the connected media player service.
- </p><p>The button is re-enabled only when the connected network service disconnects for whatever reason (the service becomes unavailable on the network, the user disconnects from their current network or the user revokes access to the service from the current web page). At this point the user can re-click the button to select a new network service to connect to the web page and the above steps are repeated.</p>
- <p>The provided service type identifier and service interaction used in this example is based on the well-defined service type and messaging format supported by the <a href="http://xbmc.org/about/">XBMC Media Server</a>. </p>
- <hr>
- <div><div id="highlighter_169377" class="syntaxhighlighter nogutter js"><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="js plain"><input type=</code><code class="js string">"button"</code> <code class="js plain">value=</code><code class="js string">"Start"</code> <code class="js plain">onclick=</code><code class="js string">"start()"</code> <code class="js plain">id=</code><code class="js string">"startBtn"</code><code class="js plain">/></code></div><div class="line number2 index1 alt1"><code class="js plain"><div id=</code><code class="js string">"debugconsole"</code><code class="js plain">></div></code></div><div class="line number3 index2 alt2"> </div><div class="line number4 index3 alt1"><code class="js plain"><script></code></div><div class="line number5 index4 alt2"><code class="js spaces"> </code><code class="js keyword">var</code> <code class="js plain">startBtn = document.getElementById(</code><code class="js string">'startBtn'</code><code class="js plain">),</code></div><div class="line number6 index5 alt1"><code class="js spaces"> </code><code class="js plain">debug = document.getElementById(</code><code class="js string">'debugconsole'</code><code class="js plain">);</code></div><div class="line number7 index6 alt2"> </div><div class="line number8 index7 alt1"><code class="js spaces"> </code><code class="js keyword">function</code> <code class="js plain">start() {</code></div><div class="line number9 index8 alt2"><code class="js spaces"> </code><code class="js keyword">if</code><code class="js plain">(navigator.getNetworkServices) {</code></div><div class="line number10 index9 alt1"><code class="js spaces"> </code><code class="js plain">navigator.getNetworkServices(</code><code class="js string">'zeroconf:_xbmc-jsonrpc._tcp'</code><code class="js plain">, gotXBMCService, error);</code></div><div class="line number11 index10 alt2"><code class="js spaces"> </code><code class="js plain">startBtn.disabled = </code><code class="js keyword">true</code><code class="js plain">;</code></div><div class="line number12 index11 alt1"><code class="js spaces"> </code><code class="js plain">} </code><code class="js keyword">else</code> <code class="js plain">{</code></div><div class="line number13 index12 alt2"><code class="js spaces"> </code><code class="js plain">debug.innerHTML += </code><code class="js string">"<br>Service Discovery <acronym title="</code><code class="js plain">Application Programming Interface</code><code class="js string">">API</acronym> not supported!"</code><code class="js plain">;</code></div><div class="line number14 index13 alt1"><code class="js spaces"> </code><code class="js plain">}</code></div><div class="line number15 index14 alt2"><code class="js spaces"> </code><code class="js plain">}</code></div><div class="line number16 index15 alt1"> </div><div class="line number17 index16 alt2"><code class="js spaces"> </code><code class="js keyword">function</code> <code class="js plain">gotXBMCService(services) {</code></div><div class="line number18 index17 alt1"> </div><div class="line number19 index18 alt2"><code class="js comments">// Listen for service disconnect messages</code></div><div class="line number20 index19 alt1"> </div><div class="line number21 index20 alt2"><code class="js spaces"> </code><code class="js plain">services[0].addEventListener(</code><code class="js string">'readystatechange'</code><code class="js plain">, </code><code class="js keyword">function</code> <code class="js plain">( e ) {</code></div><div class="line number22 index21 alt1"><code class="js spaces"> </code><code class="js keyword">if</code><code class="js plain">(services[0].readyState === services[0].UNAVAILABLE) {</code></div><div class="line number23 index22 alt2"><code class="js spaces"> </code><code class="js plain">debug.innerHTML += </code><code class="js string">"<br>"</code> <code class="js plain">+ services[0].name + </code><code class="js string">" disconnected."</code><code class="js plain">;</code></div><div class="line number24 index23 alt1"><code class="js spaces"> </code><code class="js plain">startBtn.disabled = </code><code class="js keyword">false</code><code class="js plain">;</code></div><div class="line number25 index24 alt2"><code class="js spaces"> </code><code class="js plain">}</code></div><div class="line number26 index25 alt1"><code class="js spaces"> </code><code class="js plain">}, </code><code class="js keyword">false</code><code class="js plain">);</code></div><div class="line number27 index26 alt2"> </div><div class="line number28 index27 alt1"><code class="js comments">// Send a service message to get albums list (and process the service response)</code></div><div class="line number29 index28 alt2"> </div><div class="line number30 index29 alt1"><code class="js spaces"> </code><code class="js keyword">var</code> <code class="js plain">svcXhr = </code><code class="js keyword">new</code> <code class="js plain">XMLHttpRequest();</code></div><div class="line number31 index30 alt2"><code class="js spaces"> </code><code class="js plain">svcXhr.open(</code><code class="js string">"POST"</code><code class="js plain">, services[0].url + </code><code class="js string">"/getAlbums"</code><code class="js plain">); </code><code class="js comments">// services[0].url and its subresources have been</code></div><div class="line number32 index31 alt1"><code class="js spaces"> </code><code class="js comments">// whitelisted for cross-site XHR use in this</code></div><div class="line number33 index32 alt2"><code class="js spaces"> </code><code class="js comments">// current browsing context.</code></div><div class="line number34 index33 alt1"> </div><div class="line number35 index34 alt2"><code class="js spaces"> </code><code class="js plain">svcXhr.setRequestHeader(</code><code class="js string">'Content-Type'</code><code class="js plain">, </code><code class="js string">'application/json-rpc'</code><code class="js plain">);</code></div><div class="line number36 index35 alt1"> </div><div class="line number37 index36 alt2"><code class="js spaces"> </code><code class="js plain">svcXhr.addEventListener(</code><code class="js string">'readystatechange'</code><code class="js plain">, </code><code class="js keyword">function</code> <code class="js plain">( response ) {</code></div><div class="line number38 index37 alt1"><code class="js spaces"> </code><code class="js keyword">if</code><code class="js plain">( response.readyState != 4 || response.status != 200 )</code></div><div class="line number39 index38 alt2"><code class="js spaces"> </code><code class="js keyword">return</code><code class="js plain">;</code></div><div class="line number40 index39 alt1"><code class="js spaces"> </code><code class="js plain">debug.innerHTML += </code><code class="js string">"<br>"</code> <code class="js plain">+ services[0].name + </code><code class="js string">" response received: "</code><code class="js plain">;</code></div><div class="line number41 index40 alt2"><code class="js spaces"> </code><code class="js plain">debug.textContent += JSON.parse(response.responseText);</code></div><div class="line number42 index41 alt1"><code class="js spaces"> </code><code class="js plain">}, </code><code class="js keyword">false</code><code class="js plain">);</code></div><div class="line number43 index42 alt2"> </div><div class="line number44 index43 alt1"><code class="js spaces"> </code><code class="js keyword">var</code> <code class="js plain">svcMsg = [</code></div><div class="line number45 index44 alt2"><code class="js spaces"> </code><code class="js plain">{ </code><code class="js string">"jsonrpc"</code><code class="js plain">: </code><code class="js string">"2.0"</code><code class="js plain">, </code><code class="js string">"method"</code><code class="js plain">: </code><code class="js string">"AudioLibrary.GetAlbums"</code><code class="js plain">, </code><code class="js string">"params"</code><code class="js plain">: { </code><code class="js string">"genreid"</code><code class="js plain">: -1,</code></div><div class="line number46 index45 alt1"><code class="js spaces"> </code><code class="js string">"artistid"</code><code class="js plain">: -1, </code><code class="js string">"start"</code><code class="js plain">: -1, </code><code class="js string">"end"</code><code class="js plain">: -1 }, </code><code class="js string">"id"</code><code class="js plain">: </code><code class="js string">"1"</code> <code class="js plain">}</code></div><div class="line number47 index46 alt2"><code class="js spaces"> </code><code class="js plain">];</code></div><div class="line number48 index47 alt1"> </div><div class="line number49 index48 alt2"><code class="js spaces"> </code><code class="js plain">svcXhr.send(JSON.stringify(svcMsg));</code></div><div class="line number50 index49 alt1"><code class="js spaces"> </code><code class="js plain">debug.innerHTML += </code><code class="js string">"<br>"</code> <code class="js plain">+ services[0].name + </code><code class="js string">" request sent: "</code><code class="js plain">;</code></div><div class="line number51 index50 alt2"><code class="js spaces"> </code><code class="js plain">debug.textContent += JSON.stringify(svcMsg);</code></div><div class="line number52 index51 alt1"> </div><div class="line number53 index52 alt2"><code class="js spaces"> </code><code class="js plain">}</code></div><div class="line number54 index53 alt1"> </div><div class="line number55 index54 alt2"><code class="js spaces"> </code><code class="js keyword">function</code> <code class="js plain">error( err ) {</code></div><div class="line number56 index55 alt1"><code class="js spaces"> </code><code class="js plain">debug.innerHTML += </code><code class="js string">"<br>An error occurred obtaining a local network service."</code><code class="js plain">;</code></div><div class="line number57 index56 alt2"><code class="js spaces"> </code><code class="js plain">startBtn.disabled = </code><code class="js keyword">false</code><code class="js plain">;</code></div><div class="line number58 index57 alt1"><code class="js spaces"> </code><code class="js plain">}</code></div><div class="line number59 index58 alt2"><code class="js plain"></script></code></div></div></td></tr></tbody></table></div></div>
- </div>
+ </span><span class="kwd">function</span><span class="pln"> gotXBMCService</span><span class="pun">(</span><span class=
+"pln">services</span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
- <div class="example">
- <p>
- This sample exposes a drop-down list containing a number of common Home-based audio devices. When the user selects an audio device from the list provided, they are prompted to authorize a network service
- based on the service type requested. The user may also select multiple network services matching the selected service type.
- In this example, the user selects their make as being <var>Sony</var> and their model as being <var>Bravia S1000</var> from which the Web page can derive a service type
- (<var>urn:schemas-upnp-org:service:RenderingControl:1</var>).
- <br><br>Once the user has authorized the device, the web page sends a simple mute command according to the messaging format supported by the device.
- </p>
- <hr>
- <div><div id="highlighter_978421" class="syntaxhighlighter nogutter js"><table border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="code"><div class="container"><div class="line number1 index0 alt2"><code class="js plain"><select name=</code><code class="js string">"make"</code> <code class="js plain">id=</code><code class="js string">"make"</code><code class="js plain">></code></div><div class="line number2 index1 alt1"><code class="js spaces"> </code><code class="js plain"><option selected=</code><code class="js string">"selected"</code> <code class="js plain">disabled=</code><code class="js string">"disabled"</code><code class="js plain">>Select make</option></code></div><div class="line number3 index2 alt2"><code class="js spaces"> </code><code class="js plain"><option>Sony</option></code></div><div class="line number4 index3 alt1"><code class="js spaces"> </code><code class="js plain"><option>Philips</option></code></div><div class="line number5 index4 alt2"><code class="js spaces"> </code><code class="js plain"><option>Alba</option></code></div><div class="line number6 index5 alt1"><code class="js plain"></select></code></div><div class="line number7 index6 alt2"><code class="js plain"><select name=</code><code class="js string">"model"</code> <code class="js plain">id=</code><code class="js string">"model"</code><code class="js plain">></select></code></div><div class="line number8 index7 alt1"><code class="js plain"><div id=</code><code class="js string">"debugconsole"</code><code class="js plain">></div></code></div><div class="line number9 index8 alt2"> </div><div class="line number10 index9 alt1"><code class="js plain"><script></code></div><div class="line number11 index10 alt2"><code class="js spaces"> </code><code class="js keyword">var</code> <code class="js plain">debug = document.getElementById(</code><code class="js string">'debugconsole'</code><code class="js plain">);</code></div><div class="line number12 index11 alt1"> </div><div class="line number13 index12 alt2"><code class="js spaces"> </code><code class="js keyword">var</code> <code class="js plain">models = {</code></div><div class="line number14 index13 alt1"><code class="js spaces"> </code><code class="js string">"Sony"</code><code class="js plain">: [</code></div><div class="line number15 index14 alt2"><code class="js spaces"> </code><code class="js plain">{</code><code class="js string">"name"</code><code class="js plain">: </code><code class="js string">"Bravia TV S1000"</code><code class="js plain">, </code><code class="js string">"type"</code><code class="js plain">: </code><code class="js string">"upnp"</code><code class="js plain">, </code><code class="js string">"service"</code><code class="js plain">: </code><code class="js string">"urn:schemas-upnp-org:service:RenderingControl:1"</code> <code class="js plain">},</code></div><div class="line number16 index15 alt1"><code class="js spaces"> </code><code class="js plain">{</code><code class="js string">"name"</code><code class="js plain">: </code><code class="js string">"Bravia TV S2000"</code><code class="js plain">, </code><code class="js string">"type"</code><code class="js plain">: </code><code class="js string">"zeroconf"</code><code class="js plain">, </code><code class="js string">"service"</code><code class="js plain">: </code><code class="js string">"_mediarenderer._http._tcp"</code> <code class="js plain">},</code></div><div class="line number17 index16 alt2"><code class="js spaces"> </code><code class="js plain">{</code><code class="js string">"name"</code><code class="js plain">: </code><code class="js string">"HiFi WD10"</code><code class="js plain">, </code><code class="js string">"type"</code><code class="js plain">: </code><code class="js string">"upnp"</code><code class="js plain">, </code><code class="js string">"service"</code><code class="js plain">: </code><code class="js string">"urn:schemas-upnp-org:service:RenderingControl:1"</code> <code class="js plain">}</code></div><div class="line number18 index17 alt1"><code class="js spaces"> </code><code class="js plain">],</code></div><div class="line number19 index18 alt2"><code class="js spaces"> </code><code class="js string">"Philips"</code><code class="js plain">: [ </code><code class="js comments">/* ... */</code> <code class="js plain">],</code></div><div class="line number20 index19 alt1"><code class="js spaces"> </code><code class="js string">"Alba"</code><code class="js plain">: [ </code><code class="js comments">/* ... */</code> <code class="js plain">]</code></div><div class="line number21 index20 alt2"><code class="js spaces"> </code><code class="js plain">};</code></div><div class="line number22 index21 alt1"> </div><div class="line number23 index22 alt2"><code class="js spaces"> </code><code class="js keyword">var</code> <code class="js plain">makeEl = document.getElementById(</code><code class="js string">"make"</code><code class="js plain">),</code></div><div class="line number24 index23 alt1"><code class="js spaces"> </code><code class="js plain">modelEl = document.getElementById(</code><code class="js string">"model"</code><code class="js plain">);</code></div><div class="line number25 index24 alt2"> </div><div class="line number26 index25 alt1"><code class="js spaces"> </code><code class="js plain">makeEl.addEventListener(</code><code class="js string">'change'</code><code class="js plain">, </code><code class="js keyword">function</code><code class="js plain">() {</code></div><div class="line number27 index26 alt2"><code class="js spaces"> </code><code class="js plain">modelEl.innerHTML = </code><code class="js string">""</code><code class="js plain">; </code><code class="js comments">// reset</code></div><div class="line number28 index27 alt1"><code class="js spaces"> </code><code class="js keyword">var</code> <code class="js plain">defaultOption = document.createElement(</code><code class="js string">"option"</code><code class="js plain">);</code></div><div class="line number29 index28 alt2"><code class="js spaces"> </code><code class="js plain">defaultOption.textContent = </code><code class="js string">"Select model"</code><code class="js plain">;</code></div><div class="line number30 index29 alt1"><code class="js spaces"> </code><code class="js plain">defaultOption.setAttribute(</code><code class="js string">"disabled"</code><code class="js plain">, </code><code class="js string">"disabled"</code><code class="js plain">);</code></div><div class="line number31 index30 alt2"><code class="js spaces"> </code><code class="js plain">defaultOption.setAttribute(</code><code class="js string">"selected"</code><code class="js plain">, </code><code class="js string">"selected"</code><code class="js plain">);</code></div><div class="line number32 index31 alt1"><code class="js spaces"> </code><code class="js plain">modelEl.appendChild(defaultOption);</code></div><div class="line number33 index32 alt2"><code class="js spaces"> </code><code class="js keyword">for</code><code class="js plain">(</code><code class="js keyword">var</code> <code class="js plain">i = 0, l = models[makeEl.value].length; i < l; i++) {</code></div><div class="line number34 index33 alt1"><code class="js spaces"> </code><code class="js keyword">var</code> <code class="js plain">option = document.createElement(</code><code class="js string">"option"</code><code class="js plain">);</code></div><div class="line number35 index34 alt2"><code class="js spaces"> </code><code class="js plain">option.textContent = models[makeEl.value][i][</code><code class="js string">"name"</code><code class="js plain">];</code></div><div class="line number36 index35 alt1"><code class="js spaces"> </code><code class="js plain">option.setAttribute(</code><code class="js string">"value"</code><code class="js plain">, models[makeEl.value][i][</code><code class="js string">"type"</code><code class="js plain">] + </code><code class="js string">":"</code> <code class="js plain">+ models[makeEl.value][i][</code><code class="js string">"service"</code><code class="js plain">]);</code></div><div class="line number37 index36 alt2"><code class="js spaces"> </code><code class="js plain">modelEl.appendChild(option);</code></div><div class="line number38 index37 alt1"><code class="js spaces"> </code><code class="js plain">}</code></div><div class="line number39 index38 alt2"><code class="js spaces"> </code><code class="js plain">}, </code><code class="js keyword">false</code><code class="js plain">);</code></div><div class="line number40 index39 alt1"> </div><div class="line number41 index40 alt2"><code class="js spaces"> </code><code class="js plain">modelEl.addEventListener(</code><code class="js string">'change'</code><code class="js plain">, </code><code class="js keyword">function</code><code class="js plain">() {</code></div><div class="line number42 index41 alt1"><code class="js spaces"> </code><code class="js keyword">if</code><code class="js plain">(navigator.getNetworkServices &&</code></div><div class="line number43 index42 alt2"><code class="js spaces"> </code><code class="js plain">modelEl.value == </code><code class="js string">"upnp:urn:schemas-upnp-org:service:RenderingControl:1"</code><code class="js plain">) {</code></div><div class="line number44 index43 alt1"><code class="js spaces"> </code><code class="js plain">navigator.getNetworkServices(modelEl.value, successCallback, errorCallback);</code></div><div class="line number45 index44 alt2"><code class="js spaces"> </code><code class="js plain">} </code><code class="js keyword">else</code> <code class="js keyword">if</code> <code class="js plain">(modelEl.value == </code><code class="js string">"zeroconf:_mediarenderer._http._tcp"</code><code class="js plain">) {</code></div><div class="line number46 index45 alt1"><code class="js spaces"> </code><code class="js plain">debug.innerHTML += </code><code class="js string">"<br>Service type is not implemented by this application."</code><code class="js plain">;</code></div><div class="line number47 index46 alt2"><code class="js spaces"> </code><code class="js plain">} </code><code class="js keyword">else</code> <code class="js plain">{</code></div><div class="line number48 index47 alt1"><code class="js spaces"> </code><code class="js plain">debug.innerHTML += </code><code class="js string">"<br>Service Discovery is not supported!"</code><code class="js plain">;</code></div><div class="line number49 index48 alt2"><code class="js spaces"> </code><code class="js plain">}</code></div><div class="line number50 index49 alt1"><code class="js spaces"> </code><code class="js plain">}, </code><code class="js keyword">false</code><code class="js plain">);</code></div><div class="line number51 index50 alt2"><code class="js plain"></script></code></div><div class="line number52 index51 alt1"> </div><div class="line number53 index52 alt2"><code class="js plain"><script></code></div><div class="line number54 index53 alt1"><code class="js spaces"> </code><code class="js keyword">function</code> <code class="js plain">successCallback( services ) {</code></div><div class="line number55 index54 alt2"> </div><div class="line number56 index55 alt1"><code class="js spaces"> </code><code class="js comments">// Listen for service push messages</code></div><div class="line number57 index56 alt2"> </div><div class="line number58 index57 alt1"><code class="js spaces"> </code><code class="js plain">services[0].addEventListener(</code><code class="js string">'message'</code><code class="js plain">, </code><code class="js keyword">function</code> <code class="js plain">( msg ) {</code></div><div class="line number59 index58 alt2"><code class="js spaces"> </code><code class="js plain">debug.innerHTML += </code><code class="js string">"<br>"</code> <code class="js plain">+ services[0].name + </code><code class="js string">" event received: "</code><code class="js plain">;</code></div><div class="line number60 index59 alt1"><code class="js spaces"> </code><code class="js plain">debug.textContent += msg.data;</code></div><div class="line number61 index60 alt2"><code class="js spaces"> </code><code class="js plain">}, </code><code class="js keyword">false</code><code class="js plain">);</code></div><div class="line number62 index61 alt1"> </div><div class="line number63 index62 alt2"><code class="js spaces"> </code><code class="js comments">// Send a control signal to mute the service audio</code></div><div class="line number64 index63 alt1"> </div><div class="line number65 index64 alt2"><code class="js spaces"> </code><code class="js keyword">var</code> <code class="js plain">svcXhr = </code><code class="js keyword">new</code> <code class="js plain">XMLHttpRequest();</code></div><div class="line number66 index65 alt1"><code class="js spaces"> </code><code class="js plain">svcXhr.open(</code><code class="js string">"POST"</code><code class="js plain">, services[0].url); </code><code class="js comments">// services[0].url and its</code></div><div class="line number67 index66 alt2"><code class="js spaces"> </code><code class="js comments">// subresources have been whitelisted for</code></div><div class="line number68 index67 alt1"><code class="js spaces"> </code><code class="js comments">// cross-site XHR use in this current</code></div><div class="line number69 index68 alt2"><code class="js spaces"> </code><code class="js comments">// browsing context.</code></div><div class="line number70 index69 alt1"> </div><div class="line number71 index70 alt2"><code class="js spaces"> </code><code class="js plain">svcXhr.setRequestHeader(</code><code class="js string">'SOAPAction'</code><code class="js plain">, </code><code class="js string">'urn:schemas-upnp-org:service:RenderingControl:1#SetMute'</code><code class="js plain">);</code></div><div class="line number72 index71 alt1"><code class="js spaces"> </code><code class="js plain">svcXhr.setRequestHeader(</code><code class="js string">'Content-Type'</code><code class="js plain">, </code><code class="js string">'text/xml; charset="utf-8";'</code><code class="js plain">);</code></div><div class="line number73 index72 alt2"> </div><div class="line number74 index73 alt1"><code class="js spaces"> </code><code class="js plain">svcXhr.onreadystatechange = </code><code class="js keyword">function</code> <code class="js plain">( response ) {</code></div><div class="line number75 index74 alt2"><code class="js spaces"> </code><code class="js keyword">if</code><code class="js plain">( response.readyState != 4 || response.status != 200 )</code></div><div class="line number76 index75 alt1"><code class="js spaces"> </code><code class="js keyword">return</code><code class="js plain">;</code></div><div class="line number77 index76 alt2"><code class="js spaces"> </code><code class="js plain">debug.innerHTML += </code><code class="js string">"<br>"</code> <code class="js plain">+ services[0].name + </code><code class="js string">" response received: "</code><code class="js plain">;</code></div><div class="line number78 index77 alt1"><code class="js spaces"> </code><code class="js plain">debug.textContent += response.responseXML;</code></div><div class="line number79 index78 alt2"><code class="js spaces"> </code><code class="js plain">}</code></div><div class="line number80 index79 alt1"> </div><div class="line number81 index80 alt2"><code class="js spaces"> </code><code class="js comments">// Service messaging to mute the provided service</code></div><div class="line number82 index81 alt1"><code class="js spaces"> </code><code class="js keyword">var</code> <code class="js plain">svcMsg = </code><code class="js string">'<?xml version="1.0" encoding="utf-8"?>'</code> <code class="js plain">+</code></div><div class="line number83 index82 alt2"><code class="js spaces"> </code><code class="js string">'<s:Envelope s:encodingStyle="<a href="http://schemas.xmlsoap.org/soap/encoding/">http://schemas.xmlsoap.org/soap/encoding/</a>" '</code> <code class="js plain">+</code></div><div class="line number84 index83 alt1"><code class="js spaces"> </code><code class="js string">'xmlns:s="<a href="http://schemas.xmlsoap.org/soap/envelope/">http://schemas.xmlsoap.org/soap/envelope/</a>">'</code> <code class="js plain">+</code></div><div class="line number85 index84 alt2"><code class="js spaces"> </code><code class="js string">'<s:Body>'</code> <code class="js plain">+</code></div><div class="line number86 index85 alt1"><code class="js spaces"> </code><code class="js string">'<u:SetMute xmlns:u="urn:schemas-upnp-org:service:RenderingControl:1">'</code> <code class="js plain">+</code></div><div class="line number87 index86 alt2"><code class="js spaces"> </code><code class="js string">'<InstanceID>0</InstanceID>'</code> <code class="js plain">+</code></div><div class="line number88 index87 alt1"><code class="js spaces"> </code><code class="js string">'<Channel>Master</Channel>'</code> <code class="js plain">+</code></div><div class="line number89 index88 alt2"><code class="js spaces"> </code><code class="js string">'<DesiredMute>true</DesiredMute>'</code> <code class="js plain">+</code></div><div class="line number90 index89 alt1"><code class="js spaces"> </code><code class="js string">'</u:SetMute>'</code> <code class="js plain">+</code></div><div class="line number91 index90 alt2"><code class="js spaces"> </code><code class="js string">'</s:Body>'</code> <code class="js plain">+</code></div><div class="line number92 index91 alt1"><code class="js spaces"> </code><code class="js string">'</s:Envelope>'</code><code class="js plain">;</code></div><div class="line number93 index92 alt2"> </div><div class="line number94 index93 alt1"><code class="js spaces"> </code><code class="js plain">svcXhr.send(svcMsg);</code></div><div class="line number95 index94 alt2"><code class="js spaces"> </code><code class="js plain">debug.innerHTML += </code><code class="js string">"<br>"</code> <code class="js plain">+ services[0].name + </code><code class="js string">" request sent: "</code><code class="js plain">;</code></div><div class="line number96 index95 alt1"><code class="js spaces"> </code><code class="js plain">debug.textContent += svcMsg;</code></div><div class="line number97 index96 alt2"><code class="js spaces"> </code><code class="js plain">}</code></div><div class="line number98 index97 alt1"> </div><div class="line number99 index98 alt2"><code class="js spaces"> </code><code class="js keyword">function</code> <code class="js plain">errorCallback( error ) {</code></div><div class="line number100 index99 alt1"><code class="js spaces"> </code><code class="js plain">debug.innerHTML += </code><code class="js string">"<br>An error occurred: "</code> <code class="js plain">+ error.code;</code></div><div class="line number101 index100 alt2"><code class="js spaces"> </code><code class="js plain">}</code></div><div class="line number102 index101 alt1"><code class="js plain"></script></code></div></div></td></tr></tbody></table></div></div>
- </div>
-
- </div>
+</span><span class="com">// Listen for service disconnect messages</span><span class="pln">
- <div id="acknowledgements" about="#acknowledgements" typeof="bibo:Chapter" class="section">
- <!--OddPage--><h2><span class="secno">B. </span>Acknowledgements</h2>
-
- <p>Thanks are expressed by the editor to the following individuals for their feedback on this specification to date (in alphabetical order):
- <br><br>
- Gar Bergstedt, Lars-Erik Bolstad, Hari G Kumar, Bob Lund, Giuseppe Pascale, Marcin Simonides, Clarke Stevens, Christian Söderström, Mark Vickers, ...</p>
+ services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class=
+"pln">addEventListener</span><span class="pun">(</span><span class="str">'serviceoffline'</span><span class=
+"pun">,</span><span class="pln"> </span><span class="kwd">function</span><span class="pln"> </span><span class=
+"pun">(</span><span class="pln"> e </span><span class="pun">)</span><span class="pln"> </span><span class=
+"pun">{</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class=
+"pln"> </span><span class="str">"<br>"</span><span class="pln"> </span><span class="pun">+</span><span class=
+"pln"> services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class=
+"pln">name </span><span class="pun">+</span><span class="pln"> </span><span class=
+"str">" disconnected."</span><span class="pun">;</span><span class="pln">
+ startBtn</span><span class="pun">.</span><span class="pln">disabled </span><span class=
+"pun">=</span><span class="pln"> </span><span class="kwd">false</span><span class="pun">;</span><span class="pln">
+ </span><span class="pun">},</span><span class="pln"> </span><span class="kwd">false</span><span class=
+"pun">);</span><span class="pln">
- <p>Thanks are also expressed by the editor to the following organizations and groups for their support in producing this specification to date (in alphabetical order):
- <br><br>
- CableLabs, Opera Software ASA, W3C Device APIs Working Group, W3C Web and TV Interest Group, ...</p>
- </div>
+</span><span class=
+"com">// Send a service message to get albums list (and process the service response)</span><span class="pln">
-
+ </span><span class="kwd">var</span><span class="pln"> svcXhr </span><span class="pun">=</span><span class=
+"pln"> </span><span class="kwd">new</span><span class="pln"> </span><span class="typ">XMLHttpRequest</span><span class=
+"pun">();</span><span class="pln">
+ svcXhr</span><span class="pun">.</span><span class="pln">open</span><span class="pun">(</span><span class=
+"str">"POST"</span><span class="pun">,</span><span class="pln"> services</span><span class="pun">[</span><span class=
+"lit">0</span><span class="pun">].</span><span class="pln">url </span><span class="pun">+</span><span class=
+"pln"> </span><span class="str">"/getAlbums"</span><span class="pun">);</span><span class="pln"> </span><span class=
+"com">// services[0].url and its sub-resources have been</span><span class="pln">
+ </span><span class=
+"com">// whitelisted for cross-site XHR use in this</span><span class="pln">
+ </span><span class=
+"com">// current browsing context.</span><span class="pln">
+ svcXhr</span><span class="pun">.</span><span class="pln">setRequestHeader</span><span class=
+"pun">(</span><span class="str">'Content-Type'</span><span class="pun">,</span><span class="pln"> </span><span class=
+"str">'application/json-rpc'</span><span class="pun">);</span><span class="pln">
+ svcXhr</span><span class="pun">.</span><span class="pln">addEventListener</span><span class=
+"pun">(</span><span class="str">'readystatechange'</span><span class="pun">,</span><span class=
+"pln"> </span><span class="kwd">function</span><span class="pln"> </span><span class="pun">(</span><span class=
+"pln"> response </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ </span><span class="kwd">if</span><span class="pun">(</span><span class="pln"> response</span><span class=
+"pun">.</span><span class="pln">readyState </span><span class="pun">!=</span><span class="pln"> </span><span class=
+"lit">4</span><span class="pln"> </span><span class="pun">||</span><span class="pln"> response</span><span class=
+"pun">.</span><span class="pln">status </span><span class="pun">!=</span><span class="pln"> </span><span class=
+"lit">200</span><span class="pln"> </span><span class="pun">)</span><span class="pln">
+ </span><span class="kwd">return</span><span class="pun">;</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class=
+"pln"> </span><span class="str">"<br>"</span><span class="pln"> </span><span class="pun">+</span><span class=
+"pln"> services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class=
+"pln">name </span><span class="pun">+</span><span class="pln"> </span><span class=
+"str">" response received: "</span><span class="pun">;</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">textContent </span><span class="pun">+=</span><span class=
+"pln"> JSON</span><span class="pun">.</span><span class="pln">parse</span><span class="pun">(</span><span class=
+"pln">response</span><span class="pun">.</span><span class="pln">responseText</span><span class=
+"pun">);</span><span class="pln">
+ </span><span class="pun">},</span><span class="pln"> </span><span class="kwd">false</span><span class=
+"pun">);</span><span class="pln">
-<div id="references" class="appendix section" about="#references" typeof="bibo:Chapter"><!--OddPage--><h2><span class="secno">C. </span>References</h2><section id="normative-references" about="#normative-references" typeof="bibo:Chapter"><h3><span class="secno">C.1 </span>Normative references</h3><dl class="bibliography" about=""><dt id="bib-DNS-SD">[DNS-SD]</dt><dd rel="dc:requires">S. Cheshire; M. Krochmal. <a href="http://files.dns-sd.org/draft-cheshire-dnsext-dns-sd.txt"><cite>DNS-Based Service Discovery.</cite></a> 27 February 2011. IETF Draft. URL: <a href="http://files.dns-sd.org/draft-cheshire-dnsext-dns-sd.txt">http://files.dns-sd.org/draft-cheshire-dnsext-dns-sd.txt</a></dd><dt id="bib-DOM-CORE">[DOM-CORE]</dt><dd rel="dc:requires">Anne van Kesteren; et al. <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html/"><cite>Web DOM Core</cite></a>. W3C Working Draft. (Work in progress.) URL: <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html/">http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html</a> </dd><dt id="bib-HTML5">[HTML5]</dt><dd rel="dc:requires">Ian Hickson; David Hyatt. <a href="http://www.w3.org/TR/2010/WD-html5-20100304/"><cite>HTML 5.</cite></a> 4 March 2010. W3C Working Draft. (Work in progress.) URL: <a href="http://www.w3.org/TR/2010/WD-html5-20100304/">http://www.w3.org/TR/2010/WD-html5-20100304/</a> </dd><dt id="bib-MDNS">[MDNS]</dt><dd rel="dc:requires">S. Cheshire; M. Krochmal. <a href="http://files.multicastdns.org/draft-cheshire-dnsext-multicastdns.txt"><cite>Multicast DNS.</cite></a> 14 February 2011. IETF Draft. URL: <a href="http://files.multicastdns.org/draft-cheshire-dnsext-multicastdns.txt">http://files.multicastdns.org/draft-cheshire-dnsext-multicastdns.txt</a></dd><dt id="bib-RFC2119">[RFC2119]</dt><dd rel="dc:requires">S. Bradner. <a href="http://www.ietf.org/rfc/rfc2119.txt"><cite>Key words for use in RFCs to Indicate Requirement Levels.</cite></a> March 1997. Internet RFC 2119. URL: <a href="http://www.ietf.org/rfc/rfc2119.txt">http://www.ietf.org/rfc/rfc2119.txt</a> </dd><dt id="bib-UPNP">[UPNP]</dt><dd rel="dc:requires">UPnP Forum. <a href="http://upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.1.pdf"><cite>UPnP Device Architecture. Version 1.1.</cite></a>. URL: <a href="http://upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.1.pdf">http://upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.1.pdf</a></dd><dt id="bib-WEBIDL">[WEBIDL]</dt><dd rel="dc:requires">Cameron McCormack. <a href="http://www.w3.org/TR/2008/WD-WebIDL-20081219"><cite>Web IDL.</cite></a> 19 December 2008. W3C Working Draft. (Work in progress.) URL: <a href="http://www.w3.org/TR/2008/WD-WebIDL-20081219">http://www.w3.org/TR/2008/WD-WebIDL-20081219</a> </dd><dt id="bib-WEBMESSAGING">[WEBMESSAGING]</dt><dd rel="dc:requires">Ian Hickson. <cite><a href="http://dev.w3.org/html5/postmsg/">HTML5 Web Messaging</a></cite>. W3C Working Draft. (Work in progress.) URL: <a href="http://dev.w3.org/html5/postmsg/">http://dev.w3.org/html5/postmsg/</a> </dd><dt id="bib-ZEROCONF">[ZEROCONF]</dt><dd rel="dc:requires">S. Cheshire; B. Aboba; E. Guttman. <a href="http://files.zeroconf.org/rfc3927.txt"><cite>Dynamic Configuration of IPv4 Link-Local Addresses.</cite></a> May 2005. IETF Draft. URL: <a href="http://files.zeroconf.org/rfc3927.txt">http://files.zeroconf.org/rfc3927.txt</a></dd></dl></section></div></body></html>
\ No newline at end of file
+ </span><span class="kwd">var</span><span class="pln"> svcMsg </span><span class="pun">=</span><span class=
+"pln"> </span><span class="pun">[</span><span class="pln">
+ </span><span class="pun">{</span><span class="pln"> </span><span class="str">"jsonrpc"</span><span class=
+"pun">:</span><span class="pln"> </span><span class="str">"2.0"</span><span class="pun">,</span><span class=
+"pln"> </span><span class="str">"method"</span><span class="pun">:</span><span class="pln"> </span><span class=
+"str">"AudioLibrary.GetAlbums"</span><span class="pun">,</span><span class="pln"> </span><span class=
+"str">"params"</span><span class="pun">:</span><span class="pln"> </span><span class="pun">{</span><span class=
+"pln"> </span><span class="str">"genreid"</span><span class="pun">:</span><span class="pln"> </span><span class=
+"pun">-</span><span class="lit">1</span><span class="pun">,</span><span class="pln">
+ </span><span class="str">"artistid"</span><span class="pun">:</span><span class="pln"> </span><span class=
+"pun">-</span><span class="lit">1</span><span class="pun">,</span><span class="pln"> </span><span class=
+"str">"start"</span><span class="pun">:</span><span class="pln"> </span><span class="pun">-</span><span class=
+"lit">1</span><span class="pun">,</span><span class="pln"> </span><span class="str">"end"</span><span class=
+"pun">:</span><span class="pln"> </span><span class="pun">-</span><span class="lit">1</span><span class=
+"pln"> </span><span class="pun">},</span><span class="pln"> </span><span class="str">"id"</span><span class=
+"pun">:</span><span class="pln"> </span><span class="str">"1"</span><span class="pln"> </span><span class=
+"pun">}</span><span class="pln">
+ </span><span class="pun">];</span><span class="pln">
+
+ svcXhr</span><span class="pun">.</span><span class="pln">send</span><span class="pun">(</span><span class=
+"pln">JSON</span><span class="pun">.</span><span class="pln">stringify</span><span class="pun">(</span><span class=
+"pln">svcMsg</span><span class="pun">));</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class=
+"pln"> </span><span class="str">"<br>"</span><span class="pln"> </span><span class="pun">+</span><span class=
+"pln"> services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class=
+"pln">name </span><span class="pun">+</span><span class="pln"> </span><span class=
+"str">" request sent: "</span><span class="pun">;</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">textContent </span><span class="pun">+=</span><span class=
+"pln"> JSON</span><span class="pun">.</span><span class="pln">stringify</span><span class="pun">(</span><span class=
+"pln">svcMsg</span><span class="pun">);</span><span class="pln">
+
+ </span><span class="pun">}</span><span class="pln">
+
+ </span><span class="kwd">function</span><span class="pln"> error</span><span class="pun">(</span><span class=
+"pln"> err </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class=
+"pln"> </span><span class="str">"<br>An error occurred obtaining a local network service."</span><span class=
+"pun">;</span><span class="pln">
+ startBtn</span><span class="pun">.</span><span class="pln">disabled </span><span class="pun">=</span><span class=
+"pln"> </span><span class="kwd">false</span><span class="pun">;</span><span class="pln">
+ </span><span class="pun">}</span><span class="pln">
+</span><span class="tag"></script></span>
+</pre>
+ </div>
+ <div class="example">
+ <p>
+ This sample exposes a drop-down list containing a number of common Home-based audio devices. When the user
+ selects an audio device from the list provided, they are prompted to authorize a network service based on the
+ service type requested. The user may also select multiple network services matching the selected service
+ type. In this example, the user selects their make as being <var>Sony</var> and their model as being
+ <var>Bravia S1000</var> from which the Web page can derive a service type
+ (<var>urn:schemas-upnp-org:service:RenderingControl:1</var>).<br>
+ <br>
+ Once the user has authorized the device, the web page sends a simple mute command according to the messaging
+ format supported by the device.
+ </p>
+ <hr>
+ <pre class="highlight prettyprint">
+<span class="tag"><select</span><span class="pln"> </span><span class="atn">name</span><span class=
+"pun">=</span><span class="atv">"make"</span><span class="pln"> </span><span class="atn">id</span><span class=
+"pun">=</span><span class="atv">"make"</span><span class="tag">></span><span class="pln">
+ </span><span class="tag"><option</span><span class="pln"> </span><span class="atn">selected</span><span class=
+"pun">=</span><span class="atv">"selected"</span><span class="pln"> </span><span class=
+"atn">disabled</span><span class="pun">=</span><span class="atv">"disabled"</span><span class=
+"tag">></span><span class="pln">Select make</span><span class="tag"></option></span><span class="pln">
+ </span><span class="tag"><option></span><span class="pln">Sony</span><span class=
+"tag"></option></span><span class="pln">
+ </span><span class="tag"><option></span><span class="pln">Philips</span><span class=
+"tag"></option></span><span class="pln">
+ </span><span class="tag"><option></span><span class="pln">Alba</span><span class=
+"tag"></option></span><span class="pln">
+</span><span class="tag"></select></span><span class="pln">
+</span><span class="tag"><select</span><span class="pln"> </span><span class="atn">name</span><span class=
+"pun">=</span><span class="atv">"model"</span><span class="pln"> </span><span class="atn">id</span><span class=
+"pun">=</span><span class="atv">"model"</span><span class="tag">></select></span><span class="pln">
+</span><span class="tag"><div</span><span class="pln"> </span><span class="atn">id</span><span class=
+"pun">=</span><span class="atv">"debugconsole"</span><span class="tag">></div></span><span class="pln">
+
+</span><span class="tag"><script></span><span class="pln">
+ </span><span class="kwd">var</span><span class="pln"> debug </span><span class="pun">=</span><span class=
+"pln"> document</span><span class="pun">.</span><span class="pln">getElementById</span><span class=
+"pun">(</span><span class="str">'debugconsole'</span><span class="pun">);</span><span class="pln">
+
+ </span><span class="kwd">var</span><span class="pln"> models </span><span class="pun">=</span><span class=
+"pln"> </span><span class="pun">{</span><span class="pln">
+ </span><span class="str">"Sony"</span><span class="pun">:</span><span class="pln"> </span><span class=
+"pun">[</span><span class="pln">
+ </span><span class="pun">{</span><span class="str">"name"</span><span class="pun">:</span><span class=
+"pln"> </span><span class="str">"Bravia TV S1000"</span><span class="pun">,</span><span class=
+"pln"> </span><span class="str">"type"</span><span class="pun">:</span><span class="pln"> </span><span class=
+"str">"upnp"</span><span class="pun">,</span><span class="pln"> </span><span class="str">"service"</span><span class=
+"pun">:</span><span class="pln"> </span><span class=
+"str">"urn:schemas-upnp-org:service:RenderingControl:1"</span><span class="pln"> </span><span class=
+"pun">},</span><span class="pln">
+ </span><span class="pun">{</span><span class="str">"name"</span><span class="pun">:</span><span class=
+"pln"> </span><span class="str">"Bravia TV S2000"</span><span class="pun">,</span><span class=
+"pln"> </span><span class="str">"type"</span><span class="pun">:</span><span class="pln"> </span><span class=
+"str">"zeroconf"</span><span class="pun">,</span><span class="pln"> </span><span class=
+"str">"service"</span><span class="pun">:</span><span class="pln"> </span><span class=
+"str">"_mediarenderer._http._tcp"</span><span class="pln"> </span><span class="pun">},</span><span class="pln">
+ </span><span class="pun">{</span><span class="str">"name"</span><span class="pun">:</span><span class=
+"pln"> </span><span class="str">"HiFi WD10"</span><span class="pun">,</span><span class="pln"> </span><span class=
+"str">"type"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"upnp"</span><span class=
+"pun">,</span><span class="pln"> </span><span class="str">"service"</span><span class="pun">:</span><span class=
+"pln"> </span><span class="str">"urn:schemas-upnp-org:service:RenderingControl:1"</span><span class=
+"pln"> </span><span class="pun">}</span><span class="pln">
+ </span><span class="pun">],</span><span class="pln">
+ </span><span class="str">"Philips"</span><span class="pun">:</span><span class="pln"> </span><span class=
+"pun">[</span><span class="pln"> </span><span class="com">/* ... */</span><span class="pln"> </span><span class=
+"pun">],</span><span class="pln">
+ </span><span class="str">"Alba"</span><span class="pun">:</span><span class="pln"> </span><span class=
+"pun">[</span><span class="pln"> </span><span class="com">/* ... */</span><span class="pln"> </span><span class=
+"pun">]</span><span class="pln">
+ </span><span class="pun">};</span><span class="pln">
+
+ </span><span class="kwd">var</span><span class="pln"> makeEl </span><span class="pun">=</span><span class=
+"pln"> document</span><span class="pun">.</span><span class="pln">getElementById</span><span class=
+"pun">(</span><span class="str">"make"</span><span class="pun">),</span><span class="pln">
+ modelEl </span><span class="pun">=</span><span class="pln"> document</span><span class="pun">.</span><span class=
+"pln">getElementById</span><span class="pun">(</span><span class="str">"model"</span><span class=
+"pun">);</span><span class="pln">
+
+ makeEl</span><span class="pun">.</span><span class="pln">addEventListener</span><span class=
+"pun">(</span><span class="str">'change'</span><span class="pun">,</span><span class="pln"> </span><span class=
+"kwd">function</span><span class="pun">()</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ modelEl</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">=</span><span class=
+"pln"> </span><span class="str">""</span><span class="pun">;</span><span class="pln"> </span><span class=
+"com">// reset</span><span class="pln">
+ </span><span class="kwd">var</span><span class="pln"> defaultOption </span><span class="pun">=</span><span class=
+"pln"> document</span><span class="pun">.</span><span class="pln">createElement</span><span class=
+"pun">(</span><span class="str">"option"</span><span class="pun">);</span><span class="pln">
+ defaultOption</span><span class="pun">.</span><span class="pln">textContent </span><span class=
+"pun">=</span><span class="pln"> </span><span class="str">"Select model"</span><span class="pun">;</span><span class=
+"pln">
+ defaultOption</span><span class="pun">.</span><span class="pln">setAttribute</span><span class=
+"pun">(</span><span class="str">"disabled"</span><span class="pun">,</span><span class="pln"> </span><span class=
+"str">"disabled"</span><span class="pun">);</span><span class="pln">
+ defaultOption</span><span class="pun">.</span><span class="pln">setAttribute</span><span class=
+"pun">(</span><span class="str">"selected"</span><span class="pun">,</span><span class="pln"> </span><span class=
+"str">"selected"</span><span class="pun">);</span><span class="pln">
+ modelEl</span><span class="pun">.</span><span class="pln">appendChild</span><span class="pun">(</span><span class=
+"pln">defaultOption</span><span class="pun">);</span><span class="pln">
+ </span><span class="kwd">for</span><span class="pun">(</span><span class="kwd">var</span><span class=
+"pln"> i </span><span class="pun">=</span><span class="pln"> </span><span class="lit">0</span><span class=
+"pun">,</span><span class="pln"> l </span><span class="pun">=</span><span class="pln"> models</span><span class=
+"pun">[</span><span class="pln">makeEl</span><span class="pun">.</span><span class="pln">value</span><span class=
+"pun">].</span><span class="pln">length</span><span class="pun">;</span><span class="pln"> i </span><span class=
+"pun"><</span><span class="pln"> l</span><span class="pun">;</span><span class="pln"> i</span><span class=
+"pun">++)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ </span><span class="kwd">var</span><span class="pln"> option </span><span class="pun">=</span><span class=
+"pln"> document</span><span class="pun">.</span><span class="pln">createElement</span><span class=
+"pun">(</span><span class="str">"option"</span><span class="pun">);</span><span class="pln">
+ option</span><span class="pun">.</span><span class="pln">textContent </span><span class=
+"pun">=</span><span class="pln"> models</span><span class="pun">[</span><span class="pln">makeEl</span><span class=
+"pun">.</span><span class="pln">value</span><span class="pun">][</span><span class="pln">i</span><span class=
+"pun">][</span><span class="str">"name"</span><span class="pun">];</span><span class="pln">
+ option</span><span class="pun">.</span><span class="pln">setAttribute</span><span class=
+"pun">(</span><span class="str">"value"</span><span class="pun">,</span><span class="pln"> models</span><span class=
+"pun">[</span><span class="pln">makeEl</span><span class="pun">.</span><span class="pln">value</span><span class=
+"pun">][</span><span class="pln">i</span><span class="pun">][</span><span class="str">"type"</span><span class=
+"pun">]</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> </span><span class=
+"str">":"</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> models</span><span class=
+"pun">[</span><span class="pln">makeEl</span><span class="pun">.</span><span class="pln">value</span><span class=
+"pun">][</span><span class="pln">i</span><span class="pun">][</span><span class="str">"service"</span><span class=
+"pun">]);</span><span class="pln">
+ modelEl</span><span class="pun">.</span><span class="pln">appendChild</span><span class=
+"pun">(</span><span class="pln">option</span><span class="pun">);</span><span class="pln">
+ </span><span class="pun">}</span><span class="pln">
+ </span><span class="pun">},</span><span class="pln"> </span><span class="kwd">false</span><span class=
+"pun">);</span><span class="pln">
+
+ modelEl</span><span class="pun">.</span><span class="pln">addEventListener</span><span class=
+"pun">(</span><span class="str">'change'</span><span class="pun">,</span><span class="pln"> </span><span class=
+"kwd">function</span><span class="pun">()</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ </span><span class="kwd">if</span><span class="pun">(</span><span class="pln">navigator</span><span class=
+"pun">.</span><span class="pln">getNetworkServices </span><span class="pun">&&</span><span class="pln">
+ modelEl</span><span class="pun">.</span><span class="pln">value </span><span class="pun">==</span><span class=
+"pln"> </span><span class="str">"upnp:urn:schemas-upnp-org:service:RenderingControl:1"</span><span class=
+"pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ navigator</span><span class="pun">.</span><span class="pln">getNetworkServices</span><span class=
+"pun">(</span><span class="pln">modelEl</span><span class="pun">.</span><span class="pln">value</span><span class=
+"pun">,</span><span class="pln"> successCallback</span><span class="pun">,</span><span class=
+"pln"> errorCallback</span><span class="pun">);</span><span class="pln">
+ </span><span class="pun">}</span><span class="pln"> </span><span class="kwd">else</span><span class=
+"pln"> </span><span class="kwd">if</span><span class="pln"> </span><span class="pun">(</span><span class=
+"pln">modelEl</span><span class="pun">.</span><span class="pln">value </span><span class="pun">==</span><span class=
+"pln"> </span><span class="str">"zeroconf:_mediarenderer._http._tcp"</span><span class="pun">)</span><span class=
+"pln"> </span><span class="pun">{</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class=
+"pln"> </span><span class="str">"<br>Service type is not implemented by this application."</span><span class=
+"pun">;</span><span class="pln">
+ </span><span class="pun">}</span><span class="pln"> </span><span class="kwd">else</span><span class=
+"pln"> </span><span class="pun">{</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class=
+"pln"> </span><span class="str">"<br>Service Discovery is not supported!"</span><span class=
+"pun">;</span><span class="pln">
+ </span><span class="pun">}</span><span class="pln">
+ </span><span class="pun">},</span><span class="pln"> </span><span class="kwd">false</span><span class=
+"pun">);</span><span class="pln">
+</span><span class="tag"></script></span><span class="pln">
+
+</span><span class="tag"><script></span><span class="pln">
+ </span><span class="kwd">function</span><span class="pln"> successCallback</span><span class=
+"pun">(</span><span class="pln"> services </span><span class="pun">)</span><span class="pln"> </span><span class=
+"pun">{</span><span class="pln">
+
+ </span><span class="com">// Listen for service push notification messages</span><span class="pln">
+
+ services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class=
+"pln">addEventListener</span><span class="pun">(</span><span class="str">'notify'</span><span class=
+"pun">,</span><span class="pln"> </span><span class="kwd">function</span><span class="pln"> </span><span class=
+"pun">(</span><span class="pln"> msg </span><span class="pun">)</span><span class="pln"> </span><span class=
+"pun">{</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class=
+"pun">+=</span><span class="pln"> </span><span class="str">"<br>"</span><span class="pln"> </span><span class=
+"pun">+</span><span class="pln"> services</span><span class="pun">[</span><span class="lit">0</span><span class=
+"pun">].</span><span class="pln">name </span><span class="pun">+</span><span class="pln"> </span><span class=
+"str">" event received: "</span><span class="pun">;</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">textContent </span><span class=
+"pun">+=</span><span class="pln"> msg</span><span class="pun">.</span><span class="pln">data</span><span class=
+"pun">;</span><span class="pln">
+ </span><span class="pun">},</span><span class="pln"> </span><span class="kwd">false</span><span class=
+"pun">);</span><span class="pln">
+
+ </span><span class="com">// Send a control signal to mute the service audio</span><span class="pln">
+
+ </span><span class="kwd">var</span><span class="pln"> svcXhr </span><span class="pun">=</span><span class=
+"pln"> </span><span class="kwd">new</span><span class="pln"> </span><span class="typ">XMLHttpRequest</span><span class=
+"pun">();</span><span class="pln">
+ svcXhr</span><span class="pun">.</span><span class="pln">open</span><span class="pun">(</span><span class=
+"str">"POST"</span><span class="pun">,</span><span class="pln"> services</span><span class="pun">[</span><span class=
+"lit">0</span><span class="pun">].</span><span class="pln">url</span><span class="pun">);</span><span class=
+"pln"> </span><span class="com">// services[0].url and its</span><span class="pln">
+ </span><span class=
+"com">// sub-resources have been whitelisted for</span><span class="pln">
+ </span><span class=
+"com">// cross-site XHR use in this current</span><span class="pln">
+ </span><span class="com">// browsing context.</span><span class="pln">
+
+ svcXhr</span><span class="pun">.</span><span class="pln">setRequestHeader</span><span class=
+"pun">(</span><span class="str">'SOAPAction'</span><span class="pun">,</span><span class="pln"> </span><span class=
+"str">'urn:schemas-upnp-org:service:RenderingControl:1#SetMute'</span><span class="pun">);</span><span class="pln">
+ svcXhr</span><span class="pun">.</span><span class="pln">setRequestHeader</span><span class=
+"pun">(</span><span class="str">'Content-Type'</span><span class="pun">,</span><span class="pln"> </span><span class=
+"str">'text/xml; charset="utf-8";'</span><span class="pun">);</span><span class="pln">
+
+ svcXhr</span><span class="pun">.</span><span class="pln">onreadystatechange </span><span class=
+"pun">=</span><span class="pln"> </span><span class="kwd">function</span><span class="pln"> </span><span class=
+"pun">(</span><span class="pln"> response </span><span class="pun">)</span><span class="pln"> </span><span class=
+"pun">{</span><span class="pln">
+ </span><span class="kwd">if</span><span class="pun">(</span><span class="pln"> response</span><span class=
+"pun">.</span><span class="pln">readyState </span><span class="pun">!=</span><span class="pln"> </span><span class=
+"lit">4</span><span class="pln"> </span><span class="pun">||</span><span class="pln"> response</span><span class=
+"pun">.</span><span class="pln">status </span><span class="pun">!=</span><span class="pln"> </span><span class=
+"lit">200</span><span class="pln"> </span><span class="pun">)</span><span class="pln">
+ </span><span class="kwd">return</span><span class="pun">;</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class=
+"pln"> </span><span class="str">"<br>"</span><span class="pln"> </span><span class="pun">+</span><span class=
+"pln"> services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class=
+"pln">name </span><span class="pun">+</span><span class="pln"> </span><span class=
+"str">" response received: "</span><span class="pun">;</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">textContent </span><span class=
+"pun">+=</span><span class="pln"> response</span><span class="pun">.</span><span class=
+"pln">responseXML</span><span class="pun">;</span><span class="pln">
+ </span><span class="pun">}</span><span class="pln">
+
+ </span><span class="com">// Service messaging to mute the provided service</span><span class="pln">
+ </span><span class="kwd">var</span><span class="pln"> svcMsg </span><span class="pun">=</span><span class=
+"pln"> </span><span class="str">'<?xml version="1.0" encoding="utf-8"?>'</span><span class=
+"pln"> </span><span class="pun">+</span><span class="pln">
+ </span><span class=
+"str">'<s:Envelope s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" '</span><span class=
+"pln"> </span><span class="pun">+</span><span class="pln">
+ </span><span class=
+"str">'xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">'</span><span class="pln"> </span><span class=
+"pun">+</span><span class="pln">
+ </span><span class="str">'<s:Body>'</span><span class="pln"> </span><span class=
+"pun">+</span><span class="pln">
+ </span><span class=
+"str">'<u:SetMute xmlns:u="urn:schemas-upnp-org:service:RenderingControl:1">'</span><span class=
+"pln"> </span><span class="pun">+</span><span class="pln">
+ </span><span class="str">'<InstanceID>0</InstanceID>'</span><span class=
+"pln"> </span><span class="pun">+</span><span class="pln">
+ </span><span class="str">'<Channel>Master</Channel>'</span><span class=
+"pln"> </span><span class="pun">+</span><span class="pln">
+ </span><span class="str">'<DesiredMute>true</DesiredMute>'</span><span class=
+"pln"> </span><span class="pun">+</span><span class="pln">
+ </span><span class="str">'</u:SetMute>'</span><span class="pln"> </span><span class=
+"pun">+</span><span class="pln">
+ </span><span class="str">'</s:Body>'</span><span class="pln"> </span><span class=
+"pun">+</span><span class="pln">
+ </span><span class="str">'</s:Envelope>'</span><span class="pun">;</span><span class="pln">
+
+ svcXhr</span><span class="pun">.</span><span class="pln">send</span><span class="pun">(</span><span class=
+"pln">svcMsg</span><span class="pun">);</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class=
+"pln"> </span><span class="str">"<br>"</span><span class="pln"> </span><span class="pun">+</span><span class=
+"pln"> services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class=
+"pln">name </span><span class="pun">+</span><span class="pln"> </span><span class=
+"str">" request sent: "</span><span class="pun">;</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">textContent </span><span class="pun">+=</span><span class=
+"pln"> svcMsg</span><span class="pun">;</span><span class="pln">
+ </span><span class="pun">}</span><span class="pln">
+
+ </span><span class="kwd">function</span><span class="pln"> errorCallback</span><span class="pun">(</span><span class=
+"pln"> error </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class=
+"pln"> </span><span class="str">"<br>An error occurred: "</span><span class="pln"> </span><span class=
+"pun">+</span><span class="pln"> error</span><span class="pun">.</span><span class="pln">code</span><span class=
+"pun">;</span><span class="pln">
+ </span><span class="pun">}</span><span class="pln">
+</span><span class="tag"></script></span>
+</pre>
+ </div>
+ </section>
+ <section id="acknowledgements">
+ <h2>
+ <span class="secno">B.</span> Acknowledgements
+ </h2>
+ <p>
+ Thanks are expressed by the editor to the following individuals for their feedback on this specification to
+ date (in alphabetical order):<br>
+ <br>
+ Gar Bergstedt, Lars-Erik Bolstad, Cathy Chan, Hari G Kumar, Bob Lund, Giuseppe Pascale, Marcin Simonides,
+ Clarke Stevens, Christian Söderström, Mark Vickers.
+ </p>
+ <p>
+ Thanks are also expressed by the editor to the following organizations and groups for their support in
+ producing this specification to date (in alphabetical order):<br>
+ <br>
+ CableLabs, Opera Software ASA, <abbr title="World Wide Web Consortium">W3C</abbr> Device APIs Working Group,
+ <abbr title="World Wide Web Consortium">W3C</abbr> Web and TV Interest Group.
+ </p>
+ </section>
+ <section id="references"
+ class="appendix">
+ <h2>
+ <span class="secno">C.</span> References
+ </h2>
+ <section id="normative-references">
+ <h3>
+ <span class="secno">C.1</span> Normative references
+ </h3>
+ <dl class="bibliography">
+ <dt id="bib-DNS-SD">
+ [DNS-SD]
+ </dt>
+ <dd>
+ S. Cheshire; M. Krochmal. <a href=
+ "http://files.dns-sd.org/draft-cheshire-dnsext-dns-sd.txt"><cite>DNS-Based Service Discovery.</cite></a> 27
+ February 2011. IETF Draft. URL: <a href=
+ "http://files.dns-sd.org/draft-cheshire-dnsext-dns-sd.txt">http://files.dns-sd.org/draft-cheshire-dnsext-dns-sd.txt</a>
+ </dd>
+ <dt id="bib-DOM4">
+ [DOM4]
+ </dt>
+ <dd>
+ Anne van Kesteren; Aryeh Gregor; Ms2ger. <a href=
+ "http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html/"><cite>DOM4.</cite></a> URL: <a href=
+ "http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html/">http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html/</a>
+ </dd>
+ <dt id="bib-HTML5">
+ [HTML5]
+ </dt>
+ <dd>
+ Ian Hickson; David Hyatt. <a href="http://www.w3.org/TR/html5"><cite>HTML5.</cite></a> 29 March 2012. W3C
+ Working Draft. (Work in progress.) URL: <a href="http://www.w3.org/TR/html5">http://www.w3.org/TR/html5</a>
+ </dd>
+ <dt id="bib-MDNS">
+ [MDNS]
+ </dt>
+ <dd>
+ S. Cheshire; M. Krochmal. <a href=
+ "http://files.multicastdns.org/draft-cheshire-dnsext-multicastdns.txt"><cite>Multicast DNS.</cite></a> 14
+ February 2011. IETF Draft. URL: <a href=
+ "http://files.multicastdns.org/draft-cheshire-dnsext-multicastdns.txt">http://files.multicastdns.org/draft-cheshire-dnsext-multicastdns.txt</a>
+ </dd>
+ <dt id="bib-RFC2119">
+ [RFC2119]
+ </dt>
+ <dd>
+ S. Bradner. <a href="http://www.ietf.org/rfc/rfc2119.txt"><cite>Key words for use in RFCs to Indicate
+ Requirement Levels.</cite></a> March 1997. Internet RFC 2119. URL: <a href=
+ "http://www.ietf.org/rfc/rfc2119.txt">http://www.ietf.org/rfc/rfc2119.txt</a>
+ </dd>
+ <dt id="bib-UPNP-DEVICEARCH11">
+ [UPNP-DEVICEARCH11]
+ </dt>
+ <dd>
+ <a href="http://upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.1.pdf"><cite>UPnP Device Architecture
+ 1.1</cite></a>. 15 October 2008. UPnP Forum. PDF document. URL: <a href=
+ "http://upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.1.pdf">http://upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.1.pdf</a>
+ </dd>
+ <dt id="bib-WEBIDL">
+ [WEBIDL]
+ </dt>
+ <dd>
+ Cameron McCormack. <a href="http://www.w3.org/TR/2011/WD-WebIDL-20110927/"><cite>Web IDL.</cite></a> 27
+ September 2011. W3C Working Draft. (Work in progress.) URL: <a href=
+ "http://www.w3.org/TR/2011/WD-WebIDL-20110927/">http://www.w3.org/TR/2011/WD-WebIDL-20110927/</a>
+ </dd>
+ </dl>
+ </section>
+ </section>
+ </body>
+</html>
--- a/discovery-api/Overview.src.html Tue Oct 02 18:05:58 2012 -0700
+++ b/discovery-api/Overview.src.html Tue Oct 02 18:07:01 2012 -0700
@@ -1,36 +1,73 @@
<!DOCTYPE html>
+<!--
+
+ THIS IS THE WORKING VERSION OF THE CURRENT SPECIFICATION!
+
+ This specification is built using ReSpec.js <http://dev.w3.org/2009/dap/ReSpec.js/documentation.html>
+
+ From time to time it's necessary to HTML5 Tidy this document using the tool @ <http://w3c.github.com/tidy-html5/>.
+
+ The command used to format this document (Overview.src.html) is as follows (replacing all = signs with - signs!):
+
+ @> tidy ==new-blocklevel-tags section ==char-encoding utf8 ==tidy-mark no ==indent yes ==indent-spaces 2 ==indent-attributes yes ==wrap 120 ==fix-bad-comments yes -m Overview.src.html
+
+ To publish a new compiled version (Overview.html), we need to open this file (Overview.src.html) in any web browser.
+ Once it has loaded we press 'Ctrl + Shift + S' (or 'Cmd' + 'Shift' + 'S' on Mac) and then select
+ 'Save as HTML (Source)' from the resulting menu.
+
+ We then replace Overview.html with the produced HTML source of this process.
+
+ Next we run HTML5 Tidy over our new Overview.html file with the following command (replacing all = signs with - signs!):
+
+ @> tidy ==new-blocklevel-tags section ==char-encoding utf8 ==tidy-mark no ==indent yes ==indent-spaces 2 ==indent-attributes yes ==wrap 120 ==hide-comments yes -m Overview.html
+
+ Now the specification is ready to be published :)
+
+-->
<html>
<head>
- <title>Networked Service Discovery and Messaging</title>
- <meta http-equiv='Content-Type' content='text/html;charset=utf-8'/>
- <script type="text/javascript" class='remove'>
- var respecConfig = {
- specStatus: "ED",
- shortName: "discovery-api",
- edDraftURI: "http://w3c-test.org/dap/discovery-api/",
+ <title>
+ Network Service Discovery
+ </title>
+ <meta http-equiv='Content-Type'
+ content='text/html; charset=utf-8'>
+ <script type="text/javascript"
+ class='remove'>
+var respecConfig = {
+ specStatus: "ED",
+ //publishDate: "2012-10-09",
+ shortName: "discovery-api",
+ edDraftURI: "http://dvcs.w3.org/hg/dap/raw-file/tip/discovery-api/Overview.html",
+ previousMaturity: "FPWD",
+ previousPublishDate: "2012-08-07",
editors: [
- { name: "Rich Tibbett",
- //url: "http://richt.me/",
- company: "Opera Software ASA",
- companyURL: "http://opera.com/" },
- { name: "Clarke Stevens",
- //url: "",
- company: "CableLabs",
- companyURL: "http://cablelabs.com/"
- }
+ {
+ name: "Rich Tibbett",
+ //url: "http://richt.me/",
+ company: "Opera Software ASA",
+ companyURL: "http://opera.com/"
+ },
+ {
+ name: "Clarke Stevens",
+ //url: "",
+ company: "CableLabs",
+ companyURL: "http://cablelabs.com/"
+ }
],
- noIDLIn: true,
-
- wg: "Device APIs and Policy Working Group",
+ noIDLIn: true,
+ wg: "Device APIs Working Group",
wgURI: "http://www.w3.org/2009/dap/",
wgPublicList: "public-device-apis",
- wgPatentURI: "http://www.w3.org/2004/01/pp-impl/43696/status",
+ wgPatentURI: "http://www.w3.org/2004/01/pp-impl/43696/status"
};
</script>
-
- <script src='http://www.w3.org/Tools/respec/respec-w3c-common' type="text/javascript" class='remove' async></script>
+ <script src='http://www.w3.org/Tools/respec/respec-w3c-common'
+ type="text/javascript"
+ class='remove'
+ async="">
+</script>
<style type="text/css">
- /* Custom CSS optimizations (Richard Tibbett) */
+/* Custom ReSpec CSS (by Rich Tibbett) */
/* Add better spacing to sections */
section, .section { margin-bottom: 2em; }
@@ -55,182 +92,218 @@
dl.domintro dd p { margin: 0.5em 0; }
dl.domintro code {font-size: inherit; font-style: italic; }
dl.domintro:before { display: table; margin: -1em -0.5em 0.5em auto; width: auto; content: 'This box is non-normative. Implementation requirements are given below this box.'; color: red; border: solid 2px; background: white; padding: 0 0.25em; }
+
+ table { border-collapse:collapse; border-style:hidden hidden none hidden }
+ table thead { border-bottom:solid }
+ table tbody th:first-child { border-left:solid }
+ table td, table th { border-left:solid; border-right:solid; border-bottom:solid thin; vertical-align:top; padding:0.2em }
</style>
</head>
-
<body>
<section id='abstract'>
<p>
- This specification defines a mechanism for an HTML document to discover and subsequently communicate with <abbr title="Hypertext Transfer Protocol">HTTP</abbr>-based services
- advertised via common discovery protocols within a user's network.
- </p>
- </section>
-
- <section id='sotd'>
- <p>
- This document represents the early consensus of the group on the scope and features of the proposed
- API.
+ This specification defines a mechanism for an HTML document to discover and subsequently communicate with
+ <abbr title="Hypertext Transfer Protocol">HTTP</abbr>-based services advertised via common discovery protocols
+ within the current network.
</p>
</section>
-
- <section class="informative">
- <h3>Introduction</h3>
-
- <p>To enable Web pages to connect and communicate with Local-networked Services provided over HTTP, this specification introduces the
- <a href="#navigatornetworkservice"><code>NavigatorNetworkService</code></a> interface.</p>
-
- <p>
- Using this <abbr title="Application Programming Interface">API</abbr> consists of requesting a well-known service type, known by developers and advertised by Local-networked Devices. User authorization, where the user connects the web page to one or more discovered services,
- is expected before the web page is able to interact with any Local-networked Services.
- </p>
-
- <p>
- A web page creates a request to obtain connectivity to services running in the network by specifying a well-known discovery service type that it wishes to interact with.
- </p>
-
+ <section id='sotd'>
<p>
- The user agent, having captured all advertised services on the network from the Service Discovery mechanisms included in this recommendation, attempts to match
- the requested service type to a discovered service according to the processing described herein.
+ This document represents the early consensus of the group on the scope and features of the proposed API.
</p>
-
- <p>
- If a service connectivity request is successful then the Web page is provided with the necessary information to communicate with the authorized Local-networked Service.
- If the request fails then the Web page will receive an error callback containing an error code describing the cause of Local-networked Service connectivity failure.
- </p>
-
+ </section>
+ <section class="informative">
+ <h3>
+ Introduction
+ </h3>
<p>
- Once connected to a Local-networked Service the Web page can send requests and receive responses to the Local-networked Service via the messaging format and appropriate channel inferred from the service type
- authorized via the provided API.
- The Web page, once connected, can also receive service-pushed events, in the messaging format supported by the Local-networked Device, if such event subscription functionality is provided by the
- connected Local-networked Service.
+ To enable Web pages to connect and communicate with Local-networked Services provided over HTTP, this
+ specification introduces the <a href="#navigatornetworkservice"><code>NavigatorNetworkService</code></a>
+ interface.
</p>
-
+ <p>
+ Using this <abbr title="Application Programming Interface">API</abbr> consists of requesting a well-known
+ service type, known by developers and advertised by Local-networked Devices. User authorization, where the user
+ connects the web page to one or more discovered services, is expected before the web page is able to interact
+ with any Local-networked Services.
+ </p>
+ <p>
+ A web page creates a request to obtain connectivity to services running in the network by specifying a
+ well-known discovery service type that it wishes to interact with.
+ </p>
+ <p>
+ The user agent, having captured all advertised services on the network from the <a>service discovery
+ mechanisms</a> included in this recommendation, attempts to match the requested service type to a discovered
+ service according to the processing described herein.
+ </p>
+ <p>
+ If a service connectivity request is successful then the Web page is provided with the necessary information to
+ communicate with the authorized Local-networked Service. If the request fails then the Web page will receive an
+ error callback containing an error code describing the cause of Local-networked Service connectivity failure.
+ </p>
+ <p>
+ Once connected to a Local-networked Service the Web page can send requests and receive responses to the
+ Local-networked Service via the messaging format and appropriate channel inferred from the service type
+ authorized via the provided API. The Web page, once connected, can also receive service-pushed events, in the
+ messaging format supported by the Local-networked Device, if such event subscription functionality is provided
+ by the connected Local-networked Service.
+ </p>
<div class="example">
- <p>Example of requesting a DNS-SD advertised service:</p>
- <hr />
- <pre class="highlight">function showServices( services ) {
+ <p>
+ Example of requesting a DNS-SD advertised service:
+ </p>
+ <hr>
+ <pre class="highlight">
+function showServices( services ) {
// Show a list of all the services provided to the web page
- for(var i = 0, l = services.length; i < l; i++) console.log( services[i].name );
+ for(var i = 0, l = services.length; i < l; i++) console.log( services[i].name );
}
-navigator.getNetworkServices('zeroconf:_boxee-jsonrpc._tcp', showServices);</pre>
+navigator.getNetworkServices('zeroconf:_boxee-jsonrpc._tcp', showServices);
+</pre>
</div>
-
<div class="example">
- <p>Example of requesting a UPnP advertised service, also handling error conditions:</p>
- <hr />
- <pre class="highlight">function showServices( services ) {
+ <p>
+ Example of requesting a UPnP advertised service, also handling error conditions:
+ </p>
+ <hr>
+ <pre class="highlight">
+function showServices( services ) {
// Show a list of all the services provided to the web page
- for(var i = 0, l = services.length; i < l; i++) console.log( services[i].name );
+ for(var i = 0, l = services.length; i < l; i++) console.log( services[i].name );
}
function error( e ) {
console.log( "Error occurred: " + e.code );
}
-navigator.getNetworkServices('upnp:urn:schemas-upnp-org:service:ContentDirectory:1', showServices, error);</pre>
+navigator.getNetworkServices('upnp:urn:schemas-upnp-org:service:ContentDirectory:1', showServices, error);
+</pre>
</div>
-
<div class="example">
- <p>Example of requesting either a DNS-SD or UPnP advertised service:</p>
- <hr />
- <pre class="highlight">function showServices( services ) {
+ <p>
+ Example of requesting either a DNS-SD or UPnP advertised service:
+ </p>
+ <hr>
+ <pre class="highlight">
+function showServices( services ) {
// Show a list of all the services provided to the web page (+ service type)
- for(var i = 0, l = services.length; i < l; i++)
+ for(var i = 0, l = services.length; i < l; i++)
console.log( services[i].name + '(' + services[i].type + ')' );
}
navigator.getNetworkServices([
'zeroconf:_boxee-jsonrpc._tcp',
'upnp:urn:schemas-upnp-org:service:ContentDirectory:1'
-], showServices);</pre>
+], showServices);
+</pre>
</div>
-
- <p>For more detailed examples see the <a href="#examples">Examples</a> section.
+ <p>
+ For more detailed examples see the <a href="#examples">Examples</a> section.
+ </p>
</section>
-
- <section
- id='conformance'>
-
- <p>Requirements phrased in the imperative as part of algorithms (such as "strip any leading space characters" or "return false and abort these steps") are to be interpreted with the
- meaning of the key word ("must", "should", "may", etc) used in introducing the algorithm.</p>
-
- <p>
- Some conformance requirements are phrased as requirements on attributes, methods or objects. Such requirements are to be interpreted as requirements on user agents.
- </p>
-
- <p>
- Conformance requirements phrased as algorithms or specific steps may be implemented in any manner, so long as the end result is equivalent. (In particular, the algorithms defined in
- this specification are intended to be easy to follow, and not intended to be performant.)
- </p>
-
- <p>
- The only conformance class defined by this specification is a <dfn>user agent</dfn>.
- </p>
-
- <p>
- User agents may impose implementation-specific limits on otherwise unconstrained inputs, e.g. to prevent denial of service attacks, to guard against running out of memory, or to work
- around platform-specific limitations.
- </p>
-
- <p>
- When support for a feature is disabled (e.g. as an emergency measure to mitigate a security problem, or to aid in development, or for performance reasons), user agents must act as if
- they had no support for the feature whatsoever, and as if the feature was not mentioned in this specification. For example, if a particular feature is accessed via an attribute in a Web
- IDL interface, the attribute itself would be omitted from the objects that implement that interface - leaving the attribute on the object but making it return null or throw an exception
- is insufficient.
- </p>
-
+ <section id='conformance'>
+ <p>
+ Requirements phrased in the imperative as part of algorithms (such as "strip any leading space characters" or
+ "return false and abort these steps") are to be interpreted with the meaning of the key word ("must", "should",
+ "may", etc) used in introducing the algorithm.
+ </p>
+ <p>
+ Some conformance requirements are phrased as requirements on attributes, methods or objects. Such requirements
+ are to be interpreted as requirements on user agents.
+ </p>
+ <p>
+ Conformance requirements phrased as algorithms or specific steps MAY be implemented in any manner, so long as
+ the end result is equivalent. (In particular, the algorithms defined in this specification are intended to be
+ easy to follow, and not intended to be performant.)
+ </p>
+ <p>
+ The only conformance class defined by this specification is a <dfn>user agent</dfn>.
+ </p>
+ <p>
+ User agents MAY impose implementation-specific limits on otherwise unconstrained inputs, e.g. to prevent denial
+ of service attacks, to guard against running out of memory, or to work around platform-specific limitations.
+ </p>
+ <p>
+ When support for a feature is disabled (e.g. as an emergency measure to mitigate a security problem, or to aid
+ in development, or for performance reasons), user agents MUST act as if they had no support for the feature
+ whatsoever, and as if the feature was not mentioned in this specification. For example, if a particular feature
+ is accessed via an attribute in a Web IDL interface, the attribute itself would be omitted from the objects
+ that implement that interface - leaving the attribute on the object but making it return null or throw an
+ exception is insufficient.
+ </p>
<section>
- <h3>Dependencies</h3>
-
- This specification relies on several other underlying specifications.
-
- <dl>
- <dt>HTML</dt>
- <dd>Many fundamental concepts from HTML are used by this specification. [[!HTML5]]</dd>
- <dt>WebIDL</dt>
- <dd>The IDL blocks in this specification use the semantics of the WebIDL specification. [[!WEBIDL]]</dd>
- </dl>
+ <h3>
+ Dependencies
+ </h3>This specification relies on several other underlying specifications.
+ <dl>
+ <dt>
+ HTML
+ </dt>
+ <dd>
+ Many fundamental concepts from HTML are used by this specification. [[!HTML5]]
+ </dd>
+ <dt>
+ WebIDL
+ </dt>
+ <dd>
+ The IDL blocks in this specification use the semantics of the WebIDL specification. [[!WEBIDL]]
+ </dd>
+ </dl>
</section>
</section>
-
<section>
- <h3>Terminology</h3>
-
- <p>
- The construction "a <code>Foo</code> object", where <code>Foo</code> is actually an interface, is sometimes used instead of the more accurate "an object implementing the interface <code>Foo</code>".
- </p>
-
+ <h3>
+ Terminology
+ </h3>
<p>
- The term DOM is used to refer to the API set made available to scripts in Web applications, and does not necessarily imply the existence of an actual <code>Document</code> object or of any
- other <code>Node</code> objects as defined in the DOM Core specifications. [[!DOM4]]
- </p>
-
- <p>
- An IDL attribute is said to be <em>getting</em> when its value is being retrieved (e.g. by author script), and is said to be <em>setting</em> when a new value is assigned to it.
+ The construction "a <code>Foo</code> object", where <code>Foo</code> is actually an interface, is sometimes
+ used instead of the more accurate "an object implementing the interface <code>Foo</code>".
</p>
-
<p>
- A <dfn>valid service type</dfn> is a string that begins with <code>upnp:</code> or <code>zeroconf:</code> followed by one or more characters in the ranges U+0021, U+0023 to U+0027, U+002A to U+002B, U+002D to U+002E, U+0030 to U+0039, U+0041 to U+005A, U+005E to U+007E.
+ The term DOM is used to refer to the API set made available to scripts in Web applications, and does not
+ necessarily imply the existence of an actual <code>Document</code> object or of any other <code>Node</code>
+ objects as defined in the DOM Core specifications. [[!DOM4]]
</p>
-
<p>
- A <a>valid service type</a> provided in the <code>type</code> attribute of the <code>getNetworkServices()</code> method will be matched against the services currently contained in the <a>list of available service records</a> according to the algorithms defined in this specification.
+ An IDL attribute is said to be <em>getting</em> when its value is being retrieved (e.g. by author script), and
+ is said to be <em>setting</em> when a new value is assigned to it.
+ </p>
+ <p>
+ A <dfn>valid service type</dfn> is a string that begins with <code>upnp:</code> or <code>zeroconf:</code>
+ followed by one or more characters in the ranges U+0021, U+0023 to U+0027, U+002A to U+002B, U+002D to U+002E,
+ U+0030 to U+0039, U+0041 to U+005A, U+005E to U+007E.
+ </p>
+ <p>
+ A <a>valid service type</a> provided in the <code>type</code> attribute of the <a href=
+ "#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> method will be matched against the
+ services currently contained in the <a>list of available service records</a> according to the algorithms
+ defined in this specification.
+ </p>
+ <p>
+ A <dfn>user-agent generated callback url</dfn> is a Local-network accessible URL endpoint that a <a>user
+ agent</a> generates and maintains for receiving HTTP NOTIFY requests from UPnP Event sources. It is only
+ required when the user agent implements UPnP Service Discovery as defined in this specification.
</p>
</section>
-
<section>
- <h2>Requesting networked services</h2>
-
-
-<pre class="widl">[Supplemental, NoInterfaceObject]
+ <h2>
+ Requesting networked services
+ </h2>
+ <pre class="widl">
+[Supplemental, NoInterfaceObject]
interface <dfn id="navigatornetworkservice">NavigatorNetworkService</dfn> {
// Obtain a Local-networked Service
void <a href="#dom-navigator-getnetworkservices">getNetworkServices</a>( in any type,
- in <a href="#navigatornetworkservicesuccesscallback">NavigatorNetworkServiceSuccessCallback</a> successCallback,
- in optional <a href="#navigatornetworkserviceerrorcallback">NavigatorNetworkServiceErrorCallback</a> errorCallback );
+ in <a href=
+"#navigatornetworkservicesuccesscallback">NavigatorNetworkServiceSuccessCallback</a> successCallback,
+ in optional <a href=
+"#navigatornetworkserviceerrorcallback">NavigatorNetworkServiceErrorCallback</a> errorCallback );
};
-<a class="externalDFN" href="http://www.whatwg.org/specs/web-apps/current-work/complete/timers.html#navigator">Navigator</a> implements <a href="#navigatornetworkservice">NavigatorNetworkService</a>;
+<a class="externalDFN"
+ href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/timers.html#navigator">Navigator</a> implements <a href=
+ "#navigatornetworkservice">NavigatorNetworkService</a>;
[Callback=FunctionOnly, NoInterfaceObject]
interface <dfn id="navigatornetworkservicesuccesscallback">NavigatorNetworkServiceSuccessCallback</dfn> {
@@ -249,458 +322,451 @@
void handleEvent( in <a href="#navigatornetworkserviceerror">NavigatorNetworkServiceError</a> error );
};
</pre>
-
- <section>
- <h2>Methods</h2>
-
- <dl class="domintro">
- <dt>
- <var title="">window</var>
- .
- <code title="dom-navigator">
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/timers.html#navigator">navigator</a>
- </code>
- .
- <code title="dom-navigator-getNetworkServices">
- <a href="#dom-navigator-getnetworkservices">getNetworkServices</a>
- </code>
- (
- <var title="">type</var>
- ,
- <var title="">successCallback</var>
- [,
- <var title="">errorCallback</var>
- ] )
- </dt>
- <dd>
- <p>Prompts the user to select one or more discovered network services that have advertised support for the requested service type.</p>
- <p>
- The
- <var title="">type</var>
- argument contains one or more <a>valid service type</a> tokens that the web page would like to interact with.
- </p>
+ <section>
+ <h2>
+ Methods
+ </h2>
+ <dl class="domintro">
+ <dt>
+ <var title="">window</var> . <code title="dom-navigator"><a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/timers.html#navigator">navigator</a></code> .
+ <code title="dom-navigator-getNetworkServices"><a href=
+ "#dom-navigator-getnetworkservices">getNetworkServices</a></code> ( <var title="">type</var> , <var title=
+ "">successCallback</var> [, <var title="">errorCallback</var> ] )
+ </dt>
+ <dd>
+ <p>
+ Prompts the user to select one or more discovered network services that have advertised support for the
+ requested service type.
+ </p>
+ <p>
+ The <var title="">type</var> argument contains one or more <a>valid service type</a> tokens that the web
+ page would like to interact with.
+ </p>
+ <p>
+ If the user accepts, the <var title="">successCallback</var> is invoked, with one or more <a href=
+ "#networkservice"><code>NetworkService</code></a> objects as its argument.
+ </p>
+ <p>
+ If the user declines, the <var title="">errorCallback</var> (if any) is invoked.
+ </p>
+ </dd>
+ </dl>
+ <div>
<p>
- If the user accepts, the
- <var title="">successCallback</var>
- is
- invoked, with one or more
- <code>
- <a href="#networkservice"><code>NetworkService</code></a>
- </code>
- objects as
- its argument.
- </p>
- <p>
- If the user declines, the
- <var title="">errorCallback</var>
- (if
- any) is invoked.
+ When the <dfn id="dom-navigator-getnetworkservices"
+ title="dom-navigator-getnetworkservices"><code>getNetworkServices(type, successCallback[,
+ errorCallback])</code></dfn> method is called, the <a>user agent</a> MUST run the following steps:
</p>
- </dd>
- </dl>
-
- <div>
- <p>
- When the <dfn id="dom-navigator-getnetworkservices" title="dom-navigator-getnetworkservices"><code>getNetworkServices(type, successCallback[, errorCallback])</code></dfn> method is called, the <a>user agent</a> MUST run the following steps:
- </p>
-
<ol class="rule">
- <li>
- If <var>successCallback</var> is empty or is not an object of type <code>Function</code> then the <a>user agent</a> MUST abort these steps.
+ <li>Let <var>requested control types</var> be initially set to an empty array.
</li>
-
- <li>
- Let <var>requested control types</var> be initially set to an empty array.
+ <li>If <var>type</var> is an array consisting of one or more <a>valid service type</a> tokens, then let
+ <var>requested control types</var> by the value of <var>type</var>, removing any non-<a>valid service
+ type</a> tokens from the resulting array.
</li>
-
- <li>
- If <var>type</var> is an array consisting of one or more <a>valid service type</a> tokens, then let <var>requested control types</var> by the value of <var>type</var>, removing any non-<a>valid service type</a> tokens from the resulting array.
+ <li>If <var>type</var> is a string consisting of one <a>valid service type</a> token, then let
+ <var>requested control types</var> be an array containing one item with a value of <var>type</var>.
</li>
-
+ <li>If <var>requested control types</var> is an array that contains at least one or more <a title=
+ "valid service type">valid service type</a> tokens then continue to the step labeled <em>process</em>
+ below. Otherwise, the <a>user agent</a> MUST <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
+ class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an
+ object of type <code>Function</code>, with a new <a href=
+ "#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose <a href=
+ "#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 2
+ (<a href=
+ "#dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></a>) as
+ its argument, abort any remaining steps and return.
+ </li>
<li>
- If <var>type</var> is a string consisting of one <a>valid service type</a> token, then let <var>requested control types</var> be an array containing one item with a value of <var>type</var>.
- </li>
-
- <li>
- If <var>requested control types</var> is an array that contains at least one or more <a title="valid service type">valid service type</a> tokens then continue to the step labeled <em>process</em> below. Otherwise, the <a>user agent</a> MUST <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an object of type <code>Function</code>, with a new <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose
- <a href="#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 2
- (<a href="#dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></a>) as its argument,
- abort any remaining steps and return.
- </li>
-
- <li>
- <em>Process</em>: Let <var>services found</var> be an empty array.
+ <em>Process</em>: Let <var>services found</var> be an empty array.
</li>
-
- <li>
- For each <var>available service</var> in the <a>list of available service records</a> run the following steps:
- <ol class="rule">
- <li>
- For each <var>requested control type</var> in <var>requested control types</var>: If <var>available service</var>'s <code>type</code> attribute equals the <var>requested control type</var> then let <var>matched service</var> equal the value of <var>available service</var> and continue at the step labeled <var>attach</var> below.
- </li>
- <li>
- Continue at the next <var>available service</var>.
- </li>
- <li>
- <em>Attach</em>: If <var>matched service</var> is not empty then run the following steps:
-
- <ol class="rule">
- <li>
- Let <var>new service object</var> be a new <a href="#networkservice"><code>NetworkService</code></a> object, mapping the parameters of
- <var>matched service</var> to this new object where possible.
- </li>
- <li>
- Append <var>new service object</var> to the <var>services found</var> array.
- </li>
- </ol>
- </li>
- </ol>
+ <li>For each <var>available service</var> in the <a>list of available service records</a> run the following
+ steps:
+ <ol class="rule">
+ <li>For each <var>requested control type</var> in <var>requested control types</var>: If <var>available
+ service</var>'s <code>type</code> attribute equals the <var>requested control type</var> then let <var>
+ matched service</var> equal the value of <var>available service</var> and continue at the step
+ labeled <var>attach</var> below.
+ </li>
+ <li>Continue at the next <var>available service</var>.
+ </li>
+ <li>
+ <em>Attach</em>: If <var>matched service</var> is not empty then run the following steps:
+ <ol class="rule">
+ <li>Let <var>new service object</var> be a new <a href=
+ "#networkservice"><code>NetworkService</code></a> object, mapping the parameters of <var>matched
+ service</var> to this new object where possible.
+ </li>
+ <li>Append <var>new service object</var> to the <var>services found</var> array.
+ </li>
+ </ol>
+ </li>
+ </ol>
</li>
-
- <li>
- If <var>services found</var> is an empty array, then the <a>user agent</a> MUST <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an object of type <code>Function</code>, with a new <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose
- <a href="#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
- (<a href="#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its argument, abort any remaining steps and return.
- </li>
-
- <li>
- Return, and run the remaining steps asynchronously.
- </li>
-
- <li>
- Optionally, e.g. based on a previously-established user preference, for security reasons, or due to platform limitations, the <a>user agent</a> MAY <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an object of type <code>Function</code>, with a new <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose
- <a href="#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
- (<a href="#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its argument, abort any remaining steps and return.
+ <li>If <var>services found</var> is an empty array, then the <a>user agent</a> MUST <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
+ class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an
+ object of type <code>Function</code>, with a new <a href=
+ "#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose <a href=
+ "#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
+ (<a href=
+ "#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its
+ argument, abort any remaining steps and return.
</li>
-
- <li>
- The <a>user agent</a> MUST prompt the user in a user-agent-specific manner for permission to provide the
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/browsers.html#entry-script" class="externalDFN">entry script</a>'s
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/origin-0.html#origin" class="externalDFN">origin</a> with an array of
- <a href="#networkservice"><code>NetworkService</code></a> objects representing the user-authorized subset of <var>services found</var>.
-
- <p>
- If the user grants permission to access one or more networked services then the <a>user agent</a> SHOULD include an
- "ongoing local-network communication" indicator.
- </p>
-
- <p>If the user denies permission, then the <a>user agent</a> MUST <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an object of type <code>Function</code>, with a new <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose
- <a href="#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
- (<a href="#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its argument, abort any remaining steps and return.
+ <li>Return, and run the remaining steps asynchronously.
+ </li>
+ <li>Optionally, e.g. based on a previously-established user preference, for security reasons, or due to
+ platform limitations, the <a>user agent</a> MAY <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
+ class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an
+ object of type <code>Function</code>, with a new <a href=
+ "#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose <a href=
+ "#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
+ (<a href=
+ "#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its
+ argument, abort any remaining steps and return.
+ </li>
+ <li>The <a>user agent</a> MUST prompt the user in a user-agent-specific manner for permission to provide
+ the <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/browsers.html#entry-script"
+ class="externalDFN">entry script</a>'s <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/origin-0.html#origin"
+ class="externalDFN">origin</a> with an array of <a href=
+ "#networkservice"><code>NetworkService</code></a> objects representing the user-authorized subset of
+ <var>services found</var>.
+ <p>
+ If the user grants permission to access one or more networked services then the <a>user agent</a>
+ SHOULD include an "ongoing local-network communication" indicator.
</p>
-
+ <p>
+ If the user denies permission, then the <a>user agent</a> MUST <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
+ class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an
+ object of type <code>Function</code>, with a new <a href=
+ "#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose <a href=
+ "#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
+ (<a href=
+ "#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its
+ argument, abort any remaining steps and return.
+ </p>
<p>
If the user never responds, this algorithm stalls on this step.
</p>
-
- </li>
-
- <li>
- Let <var>services</var> be the array of one or more <a href="#networkservice"><code>NetworkService</code></a> objects for which the user granted permission.
- </li>
-
- <li>
- For each Object <var>service</var> in <var>services</var>, run the following substeps:
-
- <ol class="rule">
- <li>
- Add the <var>service</var>'s <code>url</code> parameter to the <a>entry script origin's <abbr title="Uniform Resource Locator">URL</abbr> whitelist</a>.
- </li>
- <li>
- If <var>service</var> was originally created from a UPnP discovery process and the <var>service</var>'s <code>eventsUrl</code> parameter is not empty then <a>setup a UPnP Events Subscription</a> for <var>service</var>.
- </li>
- </ol>
</li>
-
- <li>
- Let <var>services manager</var> be a new <a href="#networkservices"><code>NetworkServices</code></a> object.
- </li>
-
- <li>
- Set <var>services manager</var>'s <code>servicesAvailable</code> attribute to the length of <var>services</var>.
- </li>
-
- <li>
- Store the set of <var>services</var> as <dfn id="current_authorized_services">current authorized services</dfn> internally against the newly created <var>services manager</var> object.
+ <li>Let <var>services</var> be the array of one or more <a href=
+ "#networkservice"><code>NetworkService</code></a> objects for which the user granted permission.
</li>
-
- <li>
- The <a>user agent</a> MUST <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>successCallback</var> with
- <var>services manager</var> as its argument.
+ <li>For each Object <var>service</var> in <var>services</var>, run the following sub-steps:
+ <ol class="rule">
+ <li>Add the <var>service</var>'s <code>url</code> parameter to the <a>entry script origin's
+ <abbr title="Uniform Resource Locator">URL</abbr> whitelist</a>.
+ </li>
+ <li>If <var>service</var>'s <code>type</code> parameter begins with the DOMString "<code>upnp:</code>"
+ and the <var>service</var>'s <code>eventsUrl</code> parameter is not empty then <a>setup a UPnP Events
+ Subscription</a> for <var>service</var>.
+ </li>
+ </ol>
</li>
-
+ <li>Let <var>services manager</var> be a new <a href="#networkservices"><code>NetworkServices</code></a>
+ object.
+ </li>
+ <li>Set <var>services manager</var>'s <a href=
+ "#dom-networkservices-servicesavailable"><code>servicesAvailable</code></a> attribute to the number of
+ items currently found in the <a>list of available service records</a> whose <code>type</code> property
+ matches any of the tokens requested in <var>requested control types</var>.
+ </li>
+ <li>Add <var>services</var> to the <var>services manager</var> object as its collection of <a>indexed
+ properties</a>.
+ </li>
+ <li>Set <var>services manager</var>'s <a href="#dom-networkservices-length"><code>length</code></a>
+ attribute to the number of items in <var>services</var>.
+ </li>
+ <li>Add <var>services manager</var> to the <a>list of active service managers</a>.
+ </li>
+ <li>The <a>user agent</a> MUST <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
+ class="externalDFN">queue a task</a> to invoke <var>successCallback</var> with <var>services
+ manager</var> as its argument.
+ </li>
</ol>
-
- <p>
- The <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#task-source" class="externalDFN">task source</a> for these
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#concept-task" class="externalDFN">tasks</a> is the
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#user-interaction-task-source" class="externalDFN">user interaction task source</a>.
- </p>
-
<p>
- When a <a href="#networkservice"><code>NetworkService</code></a> object is provided to a Web page, the <a>user agent</a> MUST add the <code>url</code> property
- to the <dfn>entry script origin's URL whitelist</dfn>. This list enables the
- Web page to override and initiate cross-site resource requests towards these URLs, and any sub-resources of these URLs, within the current
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/browsers.html#entry-script" class="externalDFN">entry script</a>'s
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/origin-0.html#origin" class="externalDFN">origin</a> via various existing mechanisms (e.g. Web Sockets, Server-Sent Events,
- Web Messaging, XMLHttpRequest).
- </p>
-
- <p>
- If the user navigates away from the current browsing context, the <a>user agent</a> MUST remove all previously whitelisted urls from the <a>entry script origin's URL whitelist</a>.
- There is no persistence to network service selections provided to a web page. It is not possible to access a previously white-listed networked service without the necessary user authorization in all of the following cases:
- <ul>
- <li>If the current script is reloaded at any point in the same or different window.</li>
- <li>if the current script reinvokes the <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> method at any point in its execution.</li>
- <li>If the user navigates forward or back in their history to reload the current page.</li>
- <li>If a script is running in a different origin.</li>
- </ul>
- </p>
-
- </div>
- </section>
-
- <section>
- <h3>Error Handling</h3>
-
- <dl class="domintro">
- <dt>
- <var title="">error</var>
- .
- <code title="dom-NavigatorNetworkServiceError-code">
- <a href="#dom-navigatornetworkserviceerror-code">code</a>
- </code>
- </dt>
- <dd>
+ The <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#task-source"
+ class="externalDFN">task source</a> for these <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#concept-task"
+ class="externalDFN">tasks</a> is the <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#user-interaction-task-source"
+ class="externalDFN">user interaction task source</a>.
+ </p>
<p>
- Returns the current error's error code. At the current time, this may be <code>1</code> or <code>2</code>, for which the
- corresponding error constants
- <a href="#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a> and
- <a href="#dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></a> are defined.
+ When a <a href="#networkservice"><code>NetworkService</code></a> object is provided to a Web page, the
+ <a>user agent</a> MUST add the <code>url</code> property to the <dfn>entry script origin's URL
+ whitelist</dfn>. This list enables the Web page to override and initiate cross-site resource requests
+ towards these URLs, and any sub-resources of these URLs, within the current <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/browsers.html#entry-script"
+ class="externalDFN">entry script</a>'s <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/origin-0.html#origin"
+ class="externalDFN">origin</a> via various existing mechanisms (e.g. Web Sockets, Server-Sent Events,
+ Web Messaging, XMLHttpRequest).
</p>
- </dd>
- </dl>
-
- <p>
- The <dfn id="dom-navigatornetworkserviceerror-code" title="dom-navigatornetworkserviceerror-code"><code>code</code></dfn> attribute of a
- <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object MUST return the code for the error, which will be one of the following:
- </p>
-
- <dl>
- <dt>
- <dfn id="dom-navigatornetworkserviceerror-permission_denied" title="dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></dfn> (numeric value 1)
- </dt>
- <dd>
- The user denied the page permission to access any services.
- </dd>
- <dt>
- <dfn id="dom-navigatornetworkserviceerror-unknown_type_prefix" title="dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></dfn> (numeric value 2)
- </dt>
- <dd>
- No <a>valid service type</a> tokens were provided in the method invocation.
- </dd>
- </dl>
-
- </section>
-
+ <p>
+ If the user navigates away from the current browsing context, the <a>user agent</a> <em class=
+ "ct">MUST</em> remove all previously whitelisted urls from the <a>entry script origin's URL whitelist</a>.
+ There is no persistence to network service selections provided to a web page. It is not possible to access
+ a previously white-listed networked service without the necessary user authorization in all of the
+ following cases:
+ </p>
+ <ul>
+ <li>If the current script is reloaded at any point in the same or different window.
+ </li>
+ <li>if the current script reinvokes the <a href=
+ "#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> method at any point in its
+ execution.
+ </li>
+ <li>If the user navigates forward or back in their history to reload the current page.
+ </li>
+ <li>If a script is running in a different origin.
+ </li>
+ </ul>
+ </div>
</section>
<section>
- <h2>Obtaining networked services</h2>
-
+ <h3>
+ Error Handling
+ </h3>
+ <dl class="domintro">
+ <dt>
+ <var title="">error</var> . <code title="dom-NavigatorNetworkServiceError-code"><a href=
+ "#dom-navigatornetworkserviceerror-code">code</a></code>
+ </dt>
+ <dd>
+ <p>
+ Returns the current error's error code. At the current time, this will be <code>1</code> or
+ <code>2</code>, for which the corresponding error constants <a href=
+ "#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a> and <a href=
+ "#dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></a> are
+ defined.
+ </p>
+ </dd>
+ </dl>
+ <p>
+ The <dfn id="dom-navigatornetworkserviceerror-code"
+ title="dom-navigatornetworkserviceerror-code"><code>code</code></dfn> attribute of a <a href=
+ "#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object <em class=
+ "ct">MUST</em> return the code for the error, which will be one of the following:
+ </p>
+ <dl>
+ <dt>
+ <dfn id="dom-navigatornetworkserviceerror-permission_denied"
+ title="dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></dfn>
+ (numeric value 1)
+ </dt>
+ <dd>
+ The user or user agent denied the page permission to access any services.
+ </dd>
+ <dt>
+ <dfn id="dom-navigatornetworkserviceerror-unknown_type_prefix"
+ title="dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></dfn>
+ (numeric value 2)
+ </dt>
+ <dd>
+ No <a>valid service type</a> tokens were provided in the method invocation.
+ </dd>
+ </dl>
+ </section>
+ </section>
+ <section>
+ <h2>
+ Obtaining networked services
+ </h2>
<p>
- The <a href="#networkservices"><code>NetworkServices</code></a> interface is the top-level response object from a call to <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> and provides access to a set of user-authorized <a href="#networkservice"><code>NetworkService</code></a> objects for the given request.
+ The <a href="#networkservices"><code>NetworkServices</code></a> interface is the top-level response object from
+ a call to <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> and provides access
+ to a set of user-authorized <a href="#networkservice"><code>NetworkService</code></a> objects for the given
+ request.
</p>
-
-<pre class="widl">
+ <pre class="widl">
[NoInterfaceObject]
interface <dfn id="networkservices">NetworkServices</dfn> {
readonly attribute unsigned long <a href="#dom-networkservices-length">length</a>;
getter <a href="#networkservice">NetworkService</a> (unsigned long index);
- <a href="#networkservice">NetworkService</a>? <a href="#dom-networkservices-getservicebyid">getServiceById</a>(DOMString id);
+ <a href="#networkservice">NetworkService</a>? <a href=
+"#dom-networkservices-getservicebyid">getServiceById</a>(DOMString id);
readonly attribute unsigned long <a href="#dom-networkservices-servicesavailable">servicesAvailable</a>;
// event handler attributes
- attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler" class="externalDFN">EventHandler</a> <a href="#dom-networkservices-onserviceavailable">onserviceavailable</a>;
- attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler" class="externalDFN">EventHandler</a> <a href="#dom-networkservices-onserviceunavailable">onserviceunavailable</a>;
+ attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler"
+ class="externalDFN">EventHandler</a> <a href="#dom-networkservices-onserviceavailable">onserviceavailable</a>;
+ attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler"
+ class="externalDFN">EventHandler</a> <a href=
+ "#dom-networkservices-onserviceunavailable">onserviceunavailable</a>;
};
-<a href="#networkservices">NetworkServices</a> implements <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#interface-eventtarget" class="externalDFN">EventTarget</a>;
+<a href="#networkservices">NetworkServices</a> implements <a href=
+"http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#interface-eventtarget"
+ class="externalDFN">EventTarget</a>;
</pre>
-
<section>
- <h2>Attributes</h2>
-
+ <h2>
+ Attributes
+ </h2>
<dl class="domintro">
<dt>
- <code title="dom-networkservices-length">
- <a href="#dom-networkservices-length">length</a>
- </code>
+ <code title="dom-networkservices-length"><a href="#dom-networkservices-length">length</a></code>
</dt>
<dd>
<p>
- Returns the current number of services in the respective object's <a>current authorized services</a>.
+ Returns the current number of items in the current object's collection of <a href=
+ "#networkservice"><code>NetworkService</code></a> objects.
</p>
</dd>
<dt>
- <code title="dom-networkservices-servicesavailable">
- <a href="#dom-networkservices-servicesavailable">servicesAvailable</a>
- </code>
+ <code title="dom-networkservices-servicesavailable"><a href=
+ "#dom-networkservices-servicesavailable">servicesAvailable</a></code>
</dt>
<dd>
<p>
- Returns the current number of services matching one of the app-requested <a>valid service type</a> tokens that are actively available within the user's current network.
+ Returns the current number of items matching one of the app-requested <a>valid service type</a> tokens in
+ the <a>list of available service records</a>.
</p>
</dd>
</dl>
-
<div>
- <p>
- The <dfn id="dom-networkservices-length"><code>length</code></dfn> attribute MUST return the number of services represented in the object's corresponding <a>current authorized services</a> list at the time of getting.
- </p>
-
- <p>
- The <dfn id="dom-networkservices-servicesavailable"><code>servicesAvailable</code></dfn> attribute MUST return the number of services available in the
- user's network that match the <a>valid service type</a> that was initially used to create the current <a href="#networkservices"><code>NetworkServices</code></a> object.
- By default, <a href="#dom-networkservices-servicesavailable"><code>servicesAvailable</code></a> MUST be set to <code>1</code>.
- </p>
-
- <p>
- When a previously unknown instance of a networked service matching one or the requested <a href="#dfn-valid-service-type">valid service types</a> becomes available on the user's current network, the <a>user agent</a> MUST fire a new simple
- event at the <a href="#dom-networkservices-onserviceavailable"><code>onserviceavailable</code></a> event handler.
- </p>
-
- <p>
- When a previously known instance of a networked service matching one or the requested <a href="#dfn-valid-service-type">valid service types</a> becomes unavailable on the user's current network, the <a>user agent</a> MUST fire a new simple
- event at the <a href="#dom-networkservices-onserviceunavailable"><code>onserviceunavailable</code></a> event handler.
- </p>
- </div>
-
- </section>
-
- <section>
- <h2>Methods</h2>
- <dl class="domintro">
- <dt>
- <code title="networkservices-getter">
- <a href="#networkservices">services</a>
- </code>
- [
- <var title="">index</var>
- ]
- </dt>
- <dd>
<p>
- Returns the specified <a href="#networkservice"><code>NetworkService</code></a> object.
- </p>
- </dd>
- <dt>
- <code title="networkservices-getter">
- <a href="#networkservices">services</a>
- </code>
- .
- <code title="dom-networkservices-getservicebyid">
- <a href="#dom-networkservices-getservicebyid">getServiceById</a>
- </code>
- (
- <var title="">id</var>
- )
- </dt>
- <dd>
- <p>
- Returns the <a href="#networkservice"><code>NetworkService</code></a> object with the given identifier, or null if no
- service has that identifier.
+ The <dfn id="dom-networkservices-length"><code>length</code></dfn> attribute MUST return the number of
+ <a href="#networkservice"><code>NetworkService</code></a> objects represented by the collection.
</p>
- </dd>
- </dl>
-
- <p>
- A <a href="#networkservices"><code>NetworkServices</code></a> object represents the current list of zero or more <a>current authorized services</a>, of which zero or more can be available at a time. Each item in <a>current authorized services</a> is represented by a <a href="#networkservice"><code>NetworkService</code></a> object.
- </p>
-
- <p class="note">
- Each service in a <a href="#networkservices"><code>NetworkServices</code></a> object thus has an index; the first has the index 0, and each subsequent service is numbered one higher than the previous one. If the <a>user agent</a> dynamically adds or removes network services for any reason, then the indices of the services in <a>current authorized services</a> will change dynamically. If the set of network services changes entirely, then all the previous services will be removed from <a>current authorized services</a> and replaced with new services.
- </p>
-
- <p>
- The <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/infrastructure.html#supported-property-indices" class="externalDFN">supported property indices</a> of <a href="#networkservices"><code>NetworkServices</code></a> objects at any instant are the numbers from zero to the number of items in <a>current authorized services</a> represented by the respective object minus one, if any services are represented in <a>current authorized services</a>. If a <a href="#networkservices"><code>NetworkServices</code></a> object represents no <a>current authorized services</a>, it has no <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/infrastructure.html#supported-property-indices" class="externalDFN">supported property indices</a>.
- </p>
-
- <p>
- To <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/infrastructure.html#determine-the-value-of-an-indexed-property" class="externalDFN">determine the value of an indexed property</a> for a given index <var>index</var> in a <a href="#networkservices"><code>NetworkServices</code></a> object's <a>current authorized services</a>, the user agent MUST return the <a href="#networkservice"><code>NetworkService</code></a> object that represents the <var>index</var>th service in <a>current authorized services</a>.
- </p>
-
- <p>
- The <dfn id="dom-networkservices-getservicebyid"><code>getServiceById(id)</code></dfn> method MUST return the first <a href="#networkservice"><code>NetworkService</code></a> object in <a>current authorized services</a> represented by the respective object whose <a href="#dom-networkservice-id"><code>id</code></a> attribute is equal to the value of the <var>id</var> argument.
- When no services in <a>current authorized services</a> match the given argument, the method MUST return null.
- </p>
-
- <p>
- Services available within the local network can connect and disconnect at different times during the execution of a web page. A <a>user agent</a> can
- inform a web page when the state of networked services matching the requested <a>valid service type</a> change. Web pages can use this information to enable in-page experiences for communicating the state of networked services
- with the ability to change the particular service or set of services the page is connected to by re-invoking the <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> method.
- </p>
-
+ <p>
+ The <dfn id="dom-networkservices-servicesavailable"><code>servicesAvailable</code></dfn> attribute MUST
+ return the number of services in the <a>list of available service records</a> whose <code>type</code>
+ attribute matches any of the <a>valid service type</a> tokens that was initially used to create the current
+ <a href="#networkservices"><code>NetworkServices</code></a> object.
+ </p>
+ </div>
</section>
-
<section>
- <h2>Events</h2>
-
- <p>
- The following are the event handlers (and their corresponding event handler event types) that must be supported, as IDL attributes, by all objects implementing the <a href="#networkservices"><code>NetworkServices</code></a> interface:
- </p>
-
- <table border="1">
- <thead>
- <tr>
- <th>
- <span title="event handlers">Event handler</span>
- </th>
- <th>
- <span>Event handler event type</span>
- </th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <dfn id="dom-networkservices-onserviceavailable" title="dom-NetworkServices-onserviceavailable">
- <code>onserviceavailable</code>
- </dfn>
- </td>
- <td>
- <code title="event-serviceavailable">serviceavailable</code>
- </td>
- </tr>
- <tr>
- <td>
- <dfn id="dom-networkservices-onserviceunavailable" title="dom-NetworkServices-onserviceunavailable">
- <code>onserviceunavailable</code>
- </dfn>
- </td>
- <td>
- <code title="event-serviceunavailable">serviceunavailable</code>
- </td>
- </tr>
- </tbody>
- </table>
-
- <p>
- Events with an event type of <code>serviceavailable</code> or <code>serviceunavailable</code> defined in this specification are simple <code>Event</code> objects.
- </p>
-
+ <h2>
+ Methods
+ </h2>
+ <dl class="domintro">
+ <dt>
+ <code title="networkservices-getter"><a href="#networkservices">services</a></code> [ <var title=
+ "">index</var> ]
+ </dt>
+ <dd>
+ <p>
+ Returns the specified <a href="#networkservice"><code>NetworkService</code></a> object.
+ </p>
+ </dd>
+ <dt>
+ <code title="networkservices-getter"><a href="#networkservices">services</a></code> . <code title=
+ "dom-networkservices-getservicebyid"><a href=
+ "#dom-networkservices-getservicebyid">getServiceById</a></code> ( <var title="">id</var> )
+ </dt>
+ <dd>
+ <p>
+ Returns the <a href="#networkservice"><code>NetworkService</code></a> object with the given identifier,
+ or null if no service has that identifier.
+ </p>
+ </dd>
+ </dl>
+ <p>
+ A <a href="#networkservices"><code>NetworkServices</code></a> object represents the current collection of one
+ or more <a href="#networkservice"><code>NetworkService</code></a> objects. A <a href=
+ "#networkservices"><code>NetworkServices</code></a> object is <span>immutable</span> meaning that it cannot
+ be modified.
+ </p>
+ <p class="note">
+ Each service in a <a href="#networkservices"><code>NetworkServices</code></a> object thus has an index; the
+ first has the index 0, and each subsequent service is numbered one higher than the previous one.
+ </p>
+ <p>
+ The <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/multipage/infrastructure.html#supported-property-indices"
+ class="externalDFN">supported property indices</a> of <a href=
+ "#networkservices"><code>NetworkServices</code></a> objects at any instant are the numbers from zero to
+ the number of the <a href="#networkservice"><code>NetworkService</code></a> objects in the collection
+ minus one.
+ </p>
+ <p>
+ To <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/multipage/infrastructure.html#determine-the-value-of-an-indexed-property"
+ class="externalDFN">determine the value of an indexed property</a> for a given index <var>index</var> in a
+ <a href="#networkservices"><code>NetworkServices</code></a> object the user agent MUST return the <a href=
+ "#networkservice"><code>NetworkService</code></a> object that represents the <var>index</var>th item in
+ the collection.
+ </p>
+ <p>
+ The <dfn id="dom-networkservices-getservicebyid"><code>getServiceById(id)</code></dfn> method <em class=
+ "ct">MUST</em> return the first <a href="#networkservice"><code>NetworkService</code></a> object in the
+ collection whose <a href="#dom-networkservice-id"><code>id</code></a> attribute is equal to the value of the
+ <var>id</var> argument provided. When no <a href="#networkservice"><code>NetworkService</code></a> objects
+ match the given argument, the method MUST return null.
+ </p>
+ <p>
+ Services available within the local network can connect and disconnect at different times during the
+ execution of a web page. A <a>user agent</a> can inform a web page when the state of networked services
+ matching the requested <a>valid service type</a> change. Web pages can use this information to enable in-page
+ experiences for communicating the state of networked services with the ability to change the particular
+ service or set of services the page is connected to by re-invoking the <a href=
+ "#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> method.
+ </p>
</section>
-
+ <section>
+ <h2>
+ Events
+ </h2>
+ <p>
+ The following are the event handlers (and their corresponding event handler event types) that <em class=
+ "ct">MUST</em> be supported, as IDL attributes, by all objects implementing the <a href=
+ "#networkservices"><code>NetworkServices</code></a> interface:
+ </p>
+ <table border="1">
+ <thead>
+ <tr>
+ <th>
+ <span title="event handlers">Event handler</span>
+ </th>
+ <th>
+ <span>Event handler event type</span>
+ </th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <dfn id="dom-networkservices-onserviceavailable"
+ title="dom-NetworkServices-onserviceavailable"><code>onserviceavailable</code></dfn>
+ </td>
+ <td>
+ <a href="#event-serviceavailable"><code>serviceavailable</code></a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="dom-networkservices-onserviceunavailable"
+ title="dom-NetworkServices-onserviceunavailable"><code>onserviceunavailable</code></dfn>
+ </td>
+ <td>
+ <a href="#event-serviceunavailable"><code>serviceunavailable</code></a>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
</section>
<section>
- <h2>Communicating with a networked service</h3>
-
-<p>
- The <a href="#networkservice"><code>NetworkService</code></a> interface is used to provide a set of connection information for an HTTP service endpoint and if available, service events, running on a networked device.
-</p>
-
-<pre class="widl">
+ <h2>
+ Communicating with a networked service
+ </h2>
+ <p>
+ The <a href="#networkservice"><code>NetworkService</code></a> interface is used to provide a set of connection
+ information for an HTTP service endpoint and if available, service events, running on a networked device.
+ </p>
+ <pre class="widl">
[NoInterfaceObject]
interface <dfn id="networkservice">NetworkService</dfn> {
readonly attribute DOMString <a href="#dom-networkservice-id">id</a>;
@@ -709,647 +775,910 @@
readonly attribute DOMString <a href="#dom-networkservice-url">url</a>;
readonly attribute DOMString <a href="#dom-networkservice-config">config</a>;
- const unsigned short <a href="#dom-networkservice-AVAILABLE">AVAILABLE</a> = 1;
- const unsigned short <a href="#dom-networkservice-UNAVAILABLE">UNAVAILABLE</a> = 2;
- readonly attribute unsigned short <a href="#dom-networkservice-readystate">readyState</a>;
+ readonly attribute boolean <a href="#dom-networkservice-online">online</a>;
// event handler attributes
- attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler" class="externalDFN">EventHandler</a> <a href="#dom-networkservice-onreadystatechange">onreadystatechange</a>;
- attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler" class="externalDFN">EventHandler</a> <a href="#dom-networkservice-onmessage">onmessage</a>;
+ attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler"
+ class="externalDFN">EventHandler</a> <a href="#dom-networkservice-onserviceonline">onserviceonline</a>;
+ attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler"
+ class="externalDFN">EventHandler</a> <a href="#dom-networkservice-onserviceoffline">onserviceoffline</a>;
+
+ attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler"
+ class="externalDFN">EventHandler</a> <a href="#dom-networkservice-onnotify">onnotify</a>;
};
-<a href="#networkservice">NetworkService</a> implements <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#interface-eventtarget" class="externalDFN">EventTarget</a>;
+<a href="#networkservice">NetworkService</a> implements <a href=
+"http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#interface-eventtarget"
+ class="externalDFN">EventTarget</a>;
</pre>
-
-<section>
- <h2>Attributes</h2>
-
- <dl class="domintro">
- <dt>
- <var title="">service</var>
- .
- <code title="dom-networkservice-id">
- <a href="#dom-networkservice-id">id</a>
- </code>
- </dt>
- <dd>
- <p>
- A unique identifier for the given user-selected service instance.
- </p>
- </dd>
- <dt>
- <var title="">service</var>
- .
- <code title="dom-networkservice-name">
- <a href="#dom-networkservice-name">name</a>
- </code>
- </dt>
- <dd>
- <p>
- The name of the user-selected service.
- </p>
- </dd>
- <dt>
- <var title="">service</var>
- .
- <code title="dom-networkservice-type">
- <a href="#dom-networkservice-type">type</a>
- </code>
- </dt>
- <dd>
- <p>
- The <a>valid service type</a> token value of the user-selected service.
- </p>
- </dd>
- <dt>
- <var title="">service</var>
- .
- <code title="dom-networkservice-url">
- <a href="#dom-networkservice-url">url</a>
- </code>
- </dt>
- <dd>
- <p>
- The control URL endpoint (including any required port information) of the user-selected control service that has been added to the <a>entry script origin's URL whitelist</a>.
- </p>
- </dd>
- <dt>
- <var title="">service</var>
- .
- <code title="dom-networkservice-config">
- <a href="#dom-networkservice-config">config</a>
- </code>
- </dt>
- <dd>
- <p>
- The configuration information associated with the service depending on the requested service type.
- </p>
- </dd>
- </dl>
-
+ <section>
+ <h2>
+ Attributes
+ </h2>
+ <dl class="domintro">
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-id"><a href=
+ "#dom-networkservice-id">id</a></code>
+ </dt>
+ <dd>
+ <p>
+ A unique identifier for the given user-selected service instance.
+ </p>
+ </dd>
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-name"><a href=
+ "#dom-networkservice-name">name</a></code>
+ </dt>
+ <dd>
+ <p>
+ The name of the user-selected service.
+ </p>
+ </dd>
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-type"><a href=
+ "#dom-networkservice-type">type</a></code>
+ </dt>
+ <dd>
+ <p>
+ The <a>valid service type</a> token value of the user-selected service.
+ </p>
+ </dd>
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-url"><a href=
+ "#dom-networkservice-url">url</a></code>
+ </dt>
+ <dd>
+ <p>
+ The control URL endpoint (including any required port information) of the user-selected control service
+ that has been added to the <a>entry script origin's URL whitelist</a>.
+ </p>
+ </dd>
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-config"><a href=
+ "#dom-networkservice-config">config</a></code>
+ </dt>
+ <dd>
+ <p>
+ The configuration information associated with the service depending on the requested service type.
+ </p>
+ </dd>
+ </dl>
+ <p>
+ The <dfn id="dom-networkservice-id"><code>id</code></dfn> attribute is a unique identifier for the service.
+ The same service provided at different times or on different objects MUST have the same <a href=
+ "#dom-networkservice-id"><code>id</code></a> value.
+ </p>
+ <p>
+ The <dfn id="dom-networkservice-name"><code>name</code></dfn> attribute represents a human-readable title for
+ the service.
+ </p>
+ <p>
+ The <dfn id="dom-networkservice-type"><code>type</code></dfn> attribute reflects the value of the <a>valid
+ service type</a> of the service.
+ </p>
+ <p>
+ The <dfn id="dom-networkservice-url"><code>url</code></dfn> attribute is an <a href=
+ "http://www.w3.org/TR/html5/urls.html#absolute-url"
+ class="externalDFN">absolute URL</a> pointing to the root HTTP endpoint for the service that has been
+ added to the <a>entry script origin's URL whitelist</a>. Web pages can subsequently use this value for
+ implicit cross-document messaging via various existing mechanisms (e.g. Web Sockets, Server-Sent Events,
+ Web Messaging, XMLHttpRequest).
+ </p>
+ <p>
+ The <dfn id="dom-networkservice-config"><code>config</code></dfn> attribute provides the raw configuration
+ information extracted from the given network service.
+ </p>
+ </section>
+ <section>
+ <h3>
+ States
+ </h3>
+ <dl class="domintro">
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-online"><a href=
+ "#dom-networkservice-online">online</a></code>
+ </dt>
+ <dd>
+ <p>
+ Returns <code>true</code> if the service is reporting that it is accessible on the local network or
+ <code>false</code> if the service is reporting that it is no longer accessible (temporarily or
+ permanently) on the local network.
+ </p>
+ </dd>
+ </dl>
+ <p>
+ The <dfn id="dom-networkservice-online"><code>online</code></dfn> attribute indicates whether the service is
+ reporting itself as being either <var>online</var>, and therefore accessible on the local network, in which
+ case this attribute will return <code>true</code> or, <var>offline</var>, and therefore not accessible on the
+ local network, either temporarily or permanently, in which case this attribute will return
+ <code>false</code>. This attribute MUST default to <code>true</code>.
+ </p>
+ </section>
+ <section>
+ <h3>
+ Events
+ </h3>
+ <p>
+ The following are the event handlers (and their corresponding event handler event types) that <em class=
+ "ct">MUST</em> be supported, as IDL attributes, by all objects implementing the <a href=
+ "#networkservice"><code>NetworkService</code></a> interface:
+ </p>
+ <table border="1">
+ <thead>
+ <tr>
+ <th>
+ <span title="event handlers">Event handler</span>
+ </th>
+ <th>
+ <span>Event handler event type</span>
+ </th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <dfn id="dom-networkservice-onnotify"
+ title="dom-NetworkService-onnotify"><code>onnotify</code></dfn>
+ </td>
+ <td>
+ <a href="#event-notify"><code>notify</code></a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="dom-networkservice-onserviceonline"
+ title="dom-NetworkService-onserviceonline"><code>onserviceonline</code></dfn>
+ </td>
+ <td>
+ <a href="#event-serviceonline"><code>serviceonline</code></a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="dom-networkservice-onserviceoffline"
+ title="dom-NetworkService-onserviceoffline"><code>onserviceoffline</code></dfn>
+ </td>
+ <td>
+ <a href="#event-serviceoffline"><code>serviceoffline</code></a>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+ </section>
+ <section>
+ <h2>
+ Service Discovery
+ </h2>
+ <p>
+ A <a>user agent</a> conforming to this specification MAY implement <abbr title=
+ "Simple Service Discovery Protocol">SSDP</abbr> [[!UPNP-DEVICEARCH11]] and Zeroconf [[!DNS-SD]] + [[!MDNS]]
+ <dfn>service discovery mechanisms</dfn> - the requirements detailed in this section of the specification - to
+ enable Web pages to request and connect with HTTP services running on networked devices, discovered via either
+ mechanism, through this API. When a <a>user agent</a> implements either of these <a>service discovery
+ mechanisms</a>, then it MUST conform to the corresponding algorithms provided in this section of the
+ specification.
+ </p>
+ <p>
+ This section presents how the results of these two <a>service discovery mechanisms</a> will be matched to
+ requested service types, how the user agent stores available and active services, how their properties are
+ applied to any resulting <a href="#networkservice"><code>NetworkService</code></a> objects.
+ </p>
+ <p>
+ It is expected that user agents will perform these <a>service discovery mechanisms</a> asynchronously and
+ periodically update the <a>list of available service records</a> as required. The timing of any <a>service
+ discovery mechanisms</a> is an implementation detail left to the discretion of the implementer (e.g. by
+ continuously monitoring the network as a background process or on invocation of this API from a Web page).
+ </p>
+ <p>
+ The <dfn>list of available service records</dfn> is a single dynamic internal lookup table within user agents
+ that is used to track all the services that have been discovered and are available in the current network at
+ any given time. At any point during the running of either of the two <a>service discovery mechanisms</a> then
+ existing entries within this table can be updated, entries can be added and entries can be removed as the
+ status of networked services changes according to the rules defined in this specification.
+ </p>
+ <p>
+ The <dfn>list of active service managers</dfn> is an internal list within user agents that is used to track all
+ <a href="#networkservices"><code>NetworkServices</code></a> objects currently being shared with any web pages
+ at the current time. Each <a href="#networkservices"><code>NetworkServices</code></a> object in the <a>list of
+ active service managers</a> represents a collection of one or more <a href=
+ "#networkservice"><code>NetworkService</code></a> objects - known as its <dfn>indexed properties</dfn>.
+ <a href="#networkservice"><code>NetworkService</code></a> objects are attached as the <a>indexed properties</a>
+ of a <a href="#networkservices"><code>NetworkServices</code></a> object as part of the <a href=
+ "#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> algorithm.
+ </p>
+ <p>
+ The rule for <dfn>adding an available service</dfn> is the process of adding a new service or updating an
+ existing service in the <a>list of available service records</a> that is generally available on the user's
+ current network. This rule takes one argument, <var>network service record</var>, and consists of running the
+ following steps:
+ </p>
+ <ol class="rule">
+ <li>Let <var>new service registration flag</var> be <code>true</code>.
+ </li>
+ <li>For each <var>existing service record</var> in the current <a>list of available service records</a>, run
+ the following sub-steps:
+ <ol class="rule">
+ <li>If the <var>existing service record</var>'s <code>id</code> property does not equal <var>network
+ service record</var>'s <code>id</code> property then abort any remaining sub-steps and continue at the next
+ available <var>existing service record</var>.
+ </li>
+ <li>Set <var>new service registration flag</var> to <code>false</code>.
+ </li>
+ <li>Replace the value of <var>existing service record</var> in the current <a>list of available service
+ records</a> with the value of <var>network service record</var>.
+ </li>
+ </ol>
+ </li>
+ <li>If <var>new service registration flag</var> is set to <code>true</code> then add <var>network service
+ record</var> to the <a>list of available service records</a> as a new item.
+ </li>
+ <li>For each <var>service manager</var> in the <a>list of active service managers</a> run the following steps:
+ <ol class="rule">
+ <li>Let <var>service type in current service manager flag</var> be <code>false</code>.
+ </li>
+ <li>For each <var>active service</var> in <var>service manager</var> run the following steps:
+ <ol class="rule">
+ <li>If <var>network service record</var>'s <code>type</code> property does not equal <var>active
+ service</var>'s <code>type</code> attribute then abort any remaining sub-steps for this <var>active
+ service</var> and continue at the next available <var>active service</var>.
+ </li>
+ <li>Set the <var>service type in current service manager flag</var> to <code>true</code>.
+ </li>
+ <li>If the <var>new service registration flag</var> is set to <code>false</code>, the <var>network
+ service record</var>'s <code>id</code> property equals the <var>active service</var>'s <code>id</code>
+ attribute and <var>active service</var>'s <a href="#dom-networkservice-online"><code>online</code></a>
+ attribute is currently set to <code>false</code> then set <var>active service</var>'s <a href=
+ "#dom-networkservice-online"><code>online</code></a> attribute to <code>true</code> and then <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
+ class="externalDFN">queue a task</a> to dispatch a newly created event with the name <a href=
+ "#event-serviceonline"><code>serviceonline</code></a> that uses the <a href=
+ "http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
+ class="externalDFN"><code>Event</code></a> interface, which does not bubble, is not cancellable,
+ and has no default action, at the current <var>active service</var> object.
+ </li>
+ </ol>
+ </li>
+ <li>If the <var>new service registration flag</var> is set to <code>true</code> and the <var>service type
+ in current service manager flag</var> is also set to <code>true</code> then increment <var>service
+ manager</var>'s <a href="#dom-networkservices-servicesavailable"><code>servicesAvailable</code></a>
+ attribute by <code>1</code> and then <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
+ class="externalDFN">queue a task</a> to dispatch a newly created event with the name <a href=
+ "#event-serviceavailable"><code>serviceavailable</code></a> that uses the <a href=
+ "http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
+ class="externalDFN"><code>Event</code></a> interface, which does not bubble, is not cancellable, and
+ has no default action, at the current <var>service manager</var> object.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ <p>
+ The rule for <dfn>removing an available service</dfn> is the general process of removing a service from the
+ <a>list of available service records</a> that has left the user's current network or has otherwise expired.
+ This rule takes one argument, <var>service identifier</var>, and consists of running the following steps:
+ </p>
+ <ol class="rule">
+ <li>For each <var>existing service record</var> in the current <a>list of available service records</a>, run
+ the following sub-steps:
+ <ol class="rule">
+ <li>If the <var>existing service record</var>'s <code>id</code> property does not match <var>service
+ identifier</var> then skip any remaining sub-steps for the current <var>existing service record</var> and
+ continue at the next available <var>existing service record</var>.
+ </li>
+ <li>If the <var>existing service record</var>'s <code>type</code> property begins with the DOMString
+ "<code>upnp:</code>" and <var>existing service record</var>'s <code>eventsURL</code> property is set then
+ run the rule to <a>terminate an existing UPnP Events Subscription</a>, if one is currently active (as a
+ result of having previously called <a>setup a UPnP Events Subscription</a> against the current
+ <var>existing service record</var>).
+ </li>
+ <li>For each <var>service manager</var> in the <a>list of active service managers</a> run the following
+ steps:
+ <ol class="rule">
+ <li>Let <var>service type in current service manager flag</var> be <code>false</code>.
+ </li>
+ <li>For each <var>active service</var> in <var>service manager</var> run the following steps:
+ <ol class="rule">
+ <li>If <var>existing service record</var>'s <code>type</code> property does not equal the
+ <var>active service</var>'s <code>type</code> attribute then abort any remaining sub-steps for this
+ <var>active service</var> and continue at the next available <var>active service</var>.
+ </li>
+ <li>Set the <var>service type in current service manager flag</var> to <code>true</code>.
+ </li>
+ <li>If <var>existing service record</var>'s <code>id</code> property equals the <var>active
+ service</var>'s <code>id</code> attribute and <var>active service</var>'s <a href=
+ "#dom-networkservice-online"><code>online</code></a> attribute is currently set to
+ <code>true</code> then set <var>active service</var>'s <a href="#dom-networkservice-online"><code>
+ online</code></a> attribute to <code>false</code> and then <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
+ class="externalDFN">queue a task</a> to dispatch a newly created event with the name <a href=
+ "#event-serviceoffline"><code>serviceoffline</code></a> that uses the <a href=
+ "http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
+ class="externalDFN"><code>Event</code></a> interface, which does not bubble, is not
+ cancellable, and has no default action, at the current <var>active service</var>.
+ </li>
+ </ol>
+ </li>
+ <li>If the <var>service type in current service manager flag</var> is set to <code>true</code> then
+ decrement <var>service manager</var>'s <a href=
+ "#dom-networkservices-servicesavailable"><code>servicesAvailable</code></a> attribute by <code>1</code>
+ and then <a href=
+ "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
+ class="externalDFN">queue a task</a> to dispatch a newly created event with the name <a href=
+ "#event-serviceunavailable"><code>serviceunavailable</code></a> that uses the <a href=
+ "http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
+ class="externalDFN"><code>Event</code></a> interface, which does not bubble, is not cancellable,
+ and has no default action, at the current <var>service manager</var> object.
+ </li>
+ </ol>
+ </li>
+ <li>Remove <var>existing service record</var> from the current <a>list of available service records</a>.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ <p>
+ User agents SHOULD expire a service record from the <a>list of available service records</a> when its
+ <code>expiryTimestamp</code> attribute exceeds the current UTC timestamp. When this condition is met the
+ <a>user agent</a> SHOULD run the rule for <a>removing an available service</a>, passing in the expired service
+ record's <code>id</code> attribute as the only argument.
+ </p>
+ <section>
+ <h4>
+ Zeroconf (<abbr title="Multicast DNS">mDNS</abbr> + <abbr title="Domain Name System">DNS</abbr>-<abbr title=
+ "Service Discovery">SD</abbr>)
+ </h4>
+ <p>
+ For each DNS response received from a user-agent-initiated Multicast DNS Browse for <abbr title=
+ "DNS Pointer Record">PTR</abbr> records with the name <code>_services._dns-sd._udp</code> on the resolved
+ recommended automatic browsing domain [[!MDNS]], the <a>user agent</a> MUST run the following steps:
+ </p>
+ <ol class="rule">
+ <li>Let <var>service mDNS responses</var> be an array of PTR records received by issuing a Multicast DNS
+ Browse for PTR records with the name of the current discovered service type.
+ </li>
+ <li>For each Object <var>service mDNS response</var> in <var>service mDNS responses</var>, run the following
+ steps:
+ <ol>
+ <li>Let <var>network service record</var> be an Object consisting of the following empty properties:
+ <code>id</code>, <code>name</code>, <code>type</code>, <code>url</code>, <code>config</code>,
+ <code>expiryTimestamp</code>.
+ </li>
+ <li>Set <var>network service record</var>'s <code>id</code> property to the value of the full PTR Service
+ Instance Name [[!MDNS]].
+ </li>
+ <li>Set <var>network service record</var>'s <code>name</code> property to the value of the PTR Service
+ Instance Name's <var>Instance</var> component [[!MDNS]].
+ </li>
+ <li>Set <var>network service record</var>'s <code>type</code> property to the concatenation of the string
+ <code>zeroconf:</code> followed be the value of the PTR Service Instance Name's <var>Service</var>
+ component [[!MDNS]].
+ </li>
+ <li>Set <var>network service record</var>'s <code>url</code> property to the resolvable Service URL
+ obtained from performing an DNS-SD Lookup [[!DNS-SD]] of the current service from the PTR record provided
+ [[!MDNS]].
+ </li>
+ <li>Set <var>network service record</var>'s <code>config</code> property to the string value of the
+ contents of the first DNS-SD TXT record associated with the <var>service mDNS response</var> as defined
+ in [[!DNS-SD]].
+ </li>
+ <li>Set <var>network service record</var>'s <code>expiryTimestamp</code> property to the value of the
+ current date, in UTC timestamp format, plus a value of <code>120</code> seconds.
+ </li>
+ <li>Run the general rule for <a>adding an available service</a>, passing in the current <var>network
+ service record</var> as the only argument.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ </section>
+ <section>
+ <h5>
+ Simple Service Discovery Protocol (<abbr title="Simple Service Discovery Protocol">SSDP</abbr>)
+ </h5>
+ <p>
+ A user agent that implements UPnP service discovery MUST issue a <dfn>search request for UPnP root
+ devices</dfn> against the user's current local network according to the full normative text and timing
+ provided in 'Section 1.3.2: Search request with M-SEARCH' detailed in [[!UPNP-DEVICEARCH11]].
+ </p>
+ <p>
+ The user agent MUST issue all <a title="search request for UPnP root devices">search requests for UPnP root
+ devices</a> with a HTTP request line equal to <code>M-SEARCH * HTTP/1.1</code>, with a HOST header equal to
+ the reserved multicast address and port of <code>239.255.255.250:1900</code>, a MAN header equal to
+ <code>ssdp:discover</code>, an ST header equal to <code>upnp:rootdevice</code> and a user-agent defined MX
+ header equal to a <dfn>maximum UPnP advertisement response wait time</dfn> value between <code>1</code> and
+ <code>5</code> seconds.
+ </p>
+ <p>
+ The user agent MUST listen for any incoming responses to any <a>search request for UPnP root devices</a>.
+ </p>
+ <p>
+ For each <dfn>HTTP Response</dfn> following an initial <a>search request for UPnP root devices</a> sent on a
+ <a>standard UPnP address and port</a> the user agent MUST run the following steps:
+ </p>
+ <ol class="rule">
+ <li>If the <a>HTTP Response</a> is not a HTTP 200 OK response then this response is invalid and the user
+ agent MUST discard this response, abort any remaining steps and return. The user agent MAY issue a new
+ <a>search request for UPnP root devices</a> as a result of this error occurring.
+ </li>
+ <li>If the <a>maximum UPnP advertisement response wait time</a> has been exceeded since the initial <a>search
+ request for UPnP root devices</a> was sent then the <a>HTTP Response</a> is invalid and the user agent MUST
+ discard this response, abort any remaining steps and return. The user agent MAY stop listening for responses
+ from the current <a>search request for UPnP root devices</a> as a result of this error occurring. Equally,
+ the user agent MAY issue a new <a>search request for UPnP root devices</a> as a result of this error
+ occurring.
+ </li>
+ <li>Let <var>ssdp device</var> be an Object with a property for each HTTP header received in the <a>HTTP
+ Response</a>, with each key being the name of a HTTP response header and each value being that HTTP response
+ header's value.
+ </li>
+ <li>If <var>ssdp device</var> does not contain at least one <var>CACHE-CONTROL</var> entry, at least one
+ <var>USN</var> entry, at least one <var>ST</var> entry and at least one <var>LOCATION</var> entry or the
+ value of its <var>ST</var> entry is not <code>upnp:rootdevice</code>, then the <a>HTTP Response</a> is
+ invalid and the <a>user agent</a> MUST discard this response, abort any remaining steps and return.
+ </li>
+ <li>The user agent MUST run the rule for <a>obtaining a UPnP Device Description File</a> passing in the first
+ occurrence of <var>LOCATION</var> from <var>ssdp device</var> as the <var>device descriptor URL</var>
+ argument and the first occurrence of <var>USN</var> from <var>ssdp device</var> as the <var>device
+ identifier</var> argument and the first occurrence of <var>CACHE-CONTROL</var> from <var>ssdp device</var>
+ (minus the leading string of <code>max-age=</code>) as the <var>device expiry</var> argument.
+ </li>
+ </ol>
+ <p>
+ The user agent MUST listen for incoming requests on the <dfn>standard UPnP address and port</dfn> on all
+ current local network interface addresses with the port <code>1900</code>.
+ </p>
+ <p>
+ For each <dfn>HTTP Request</dfn> received on a <a>standard UPnP address and port</a> the user agent MUST run
+ the following steps:
+ </p>
+ <ol class="rule">
+ <li>If the <a>HTTP Request</a> is not a HTTP NOTIFY request then it is not a valid UPnP Request and the user
+ agent MUST discard this request, abort any remaining steps and return.
+ </li>
+ <li>Let <var>ssdp device</var> be an Object with a property for each HTTP header received in the <a>HTTP
+ Request</a>, with each key being the name of a HTTP header and each value being that HTTP header's value.
+ </li>
+ <li>If <var>ssdp device</var> does not contain at least one <var>CACHE-CONTROL</var> entry, at least one
+ <var>USN</var> entry, at least one <var>NT</var> entry, at least one <var>NTS</var> entry and at least one
+ <var>LOCATION</var> entry or the value of its <var>NT</var> entry is not <code>upnp:rootdevice</code>, then
+ the <a>HTTP Request</a> is a malformed UPnP Request and the <a>user agent</a> MUST discard this request,
+ abort any remaining steps and return.
+ </li>
+ <li>If <var>ssdp device</var>'s <var>NTS</var> entry is equal to <code>ssdp:alive</code> then the user agent
+ MUST run the rule for <a>obtaining a UPnP Device Description File</a> passing in the first occurrence of
+ <var>LOCATION</var> from <var>ssdp device</var> as the <var>device descriptor URL</var> argument and the
+ first occurrence of <var>USN</var> from <var>ssdp device</var> as the <var>device identifier</var> argument
+ and the first occurrence of <var>CACHE-CONTROL</var> from <var>ssdp device</var> (minus the leading string of
+ <code>max-age=</code>) as the <var>device expiry</var>.<br>
+ <br>
+ Otherwise, if <var>ssdp device</var>'s <var>NTS</var> entry is equal to <code>ssdp:byebye</code> then the
+ user agent MUST run the rule for <a>removing all services from a registered UPnP Device</a> passing in the
+ first occurrence of <var>USN</var> from <var>ssdp device</var> as the <var>device identifier</var>
+ argument.
+ </li>
+ </ol>
+ <p>
+ The rule for <dfn>obtaining a UPnP Device Description File</dfn> is the process of obtaining the contents of
+ a standard UPnP Device Description [[!UPNP-DEVICEARCH11]] from a URL-based resource. This rule takes three
+ arguments - <var>device descriptor URL</var>, <var>device identifier</var> and <var>device expiry</var> - and
+ when called the user agent MUST run the following steps:
+ </p>
+ <ol class="rule">
+ <li>Let <var>device descriptor file</var> contain the contents of the file located at the URL provided in
+ <var>device descriptor URL</var> obtained according to the rules defined in 'Section 2.11: Retrieving a
+ description using HTTP' in [[!UPNP-DEVICEARCH11]].
+ </li>
+ <li>If the value provided in <var>device descriptor URL</var> cannot be resolved as a reachable URL on the
+ current network or the <var>device descriptor file</var> remains empty then it is invalid and the <a>user
+ agent</a> MUST abort any remaining steps and return.
+ </li>
+ <li>Run the rule for <a>processing a UPnP Device Description File</a>, passing in the current <var>device
+ descriptor file</var>, <var>device identifier</var> and <var>device expiry</var> arguments.
+ </li>
+ </ol>
+ <p>
+ The rule for <dfn>processing a UPnP Device Description File</dfn> is the process of parsing the contents of a
+ standard UPnP Device Description [[!UPNP-DEVICEARCH11]] and registering the UPnP services contained therein
+ within the <a>list of available service records</a>.
+ </p>
+ <p>
+ The rule for <a>processing a UPnP Device Description File</a> takes three arguments - <var>device descriptor
+ file</var>, <var>device identifier</var> and <var>device expiry</var> - and when called the user agent MUST
+ run the following steps:
+ </p>
+ <ol class="rule">
+ <li>Let <var>advertised services</var> be a list of all advertised services obtained from the <var>device
+ descriptor file</var> containing the value of the first occurrence of the <code><serviceList></code>
+ element as it is defined in 'Section 2.3: Device Description' in [[!UPNP-DEVICEARCH11]].
+ </li>
+ <li>For each <code><service></code> element - known as an <var>advertised service</var> - in
+ <var>advertised services</var> run the following steps:
+ <ol class="rule">
+ <li>Let <var>network service record</var> be a new Object consisting of the following empty properties:
+ <code>id</code>, <code>deviceId</code>, <code>name</code>, <code>type</code>, <code>url</code>,
+ <code>eventsUrl</code>, <code>config</code>, <code>expiryTimestamp</code>.
+ </li>
+ <li>Set <var>network service record</var>'s <code>id</code> property to the concatenated string value of
+ the first occurrence of the <code><UDN></code> element in the <var>device descriptor file</var>
+ with the <var>advertised service</var>'s <code><serviceId></code> sub-element.
+ </li>
+ <li>Set <var>network service record</var>'s <code>deviceId</code> property to the value of <var>device
+ identifier</var>.
+ </li>
+ <li>Set <var>network service record</var>'s <code>name</code> property to the string value of the first
+ occurrence of the <var>advertised service</var>'s <code><serviceId></code> sub-element.
+ </li>
+ <li>Set <var>network service record</var>'s <code>type</code> property to the concatenation of the string
+ <code>upnp:</code> followed by the string value of the first occurrence of the <var>advertised
+ service</var>'s <code><serviceType></code> sub-element.
+ </li>
+ <li>Set <var>network service record</var>'s <code>url</code> property to the string value of the first
+ occurrence of the <var>advertised service</var>'s <code><controlURL></code> sub-element.
+ </li>
+ <li>Set <var>network service record</var>'s <code>config</code> property to the string value of the
+ contents of the first occurrence of the <code><device></code> element in the <var>device descriptor
+ file</var>.
+ </li>
+ <li>If <var>advertised service</var>'s <code><eventSubURL></code> sub-element is not empty, then
+ set <var>network service record</var>'s <code>eventsUrl</code> property to the string value of the first
+ occurrence of the <var>advertised service</var>'s <code><eventSubURL></code> sub-element.
+ Otherwise, do not set <var>network service record</var>'s <code>eventsUrl</code> property.
+ </li>
+ <li>Set <var>network service record</var>'s <code>expiryTimestamp</code> property to the value of the
+ current date, in UTC timestamp format, plus the value of <var>device expiry</var>.
+ </li>
+ <li>Run the general rule for <a>adding an available service</a>, passing in the current <var>network
+ service record</var> as the only argument.
+ </li>
+ </ol>
+ </li>
+ <li>If <var>device descriptor file</var> contains a <code><deviceList></code> element then for each
+ <code><device></code> element within <code><deviceList></code> - herein known as an <var>embedded
+ device descriptor file</var> - the user agent MUST run the rule for <a>processing a UPnP Device Description
+ File</a>, passing in the current <var>embedded device descriptor file</var> as the <var>device descriptor
+ file</var> argument, along with the current <var>device identifier</var> and <var>device expiry</var>
+ arguments.
+ </li>
+ </ol>
+ <p>
+ The rule for <dfn>removing all services from a registered UPnP Device</dfn> is the process of removing all
+ services associated with a device from the <a>list of available service records</a> that has left the user's
+ current network or has otherwise timed out or expired. This rule takes one argument, <var>device
+ identifier</var>, and consists of running the following steps:
+ </p>
+ <ol class="rule">
+ <li>For each <var>existing service record</var> in the current <a>list of available service records</a>, run
+ the following sub-steps:
+ <ol class="rule">
+ <li>If the <var>existing service record</var>'s <code>deviceId</code> property does not match <var>device
+ identifier</var> then skip any remaining sub-steps for the current <var>existing service record</var> and
+ continue at the next available <var>existing service record</var>.
+ </li>
+ <li>Run the general rule for <a>removing an available service</a> passing in <var>existing service
+ record</var>'s <code>id</code> property as the only argument.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ <p>
+ When the <a>user agent</a> is to <dfn>setup a UPnP Events Subscription</dfn>, it is to run the following
+ steps with the current <var>network service record</var> object as defined in 'Section 4.1.2: SUBSCRIBE with
+ NT and CALLBACK' in [[!UPNP-DEVICEARCH11]]:
+ </p>
+ <ol class="rule">
+ <li>If <var>network service record</var>'s <code>eventsUrl</code> property is empty then the <a>user
+ agent</a> MUST abort these steps.
+ </li>
+ <li>Let <var>callback URL</var> be the value of creating a new <a>user-agent generated callback url</a>.
+ </li>
+ <li>Send a HTTP SUBSCRIBE request with a <em>NT</em> header with a string value of <code>upnp:event</code>, a
+ <em>TIMEOUT</em> header with a user-agent defined timeout value (in the form <code>Second-XX</code> where
+ <code>XX</code> is the user-agent defined timeout value in seconds) and a <em>CALLBACK</em> header with a
+ string value of <var>callback URL</var> towards the <var>network service record</var>'s
+ <code>eventsUrl</code> property.
+ </li>
+ <li>If a non-200 OK response is received from the HTTP SUBSCRIBE request then the <a>user agent</a> MUST
+ abort these steps.
+ </li>
+ <li>On receiving a valid 200 OK response, run the following steps:
+ <ol class="rule">
+ <li>Let <var>callback ID</var> equal the string value of the first included <em>SID</em> header, if it
+ exists.
+ </li>
+ <li>Let <var>timeout date</var> equal the sum of the current UTC date value plus the integer value of the
+ first included <em>TIMEOUT</em> header (minus the leading string of <code>Second-</code>), if it exists.
+ </li>
+ <li>Run the following steps asynchronously and continue to the step labeled <em>listen</em> below.
+ </li>
+ <li>
+ <em>Refresh Subscription</em>: Run the following steps at a set interval (X) within the <a>user
+ agent</a>:
+ <ol class="rule">
+ <li>Let <var>current date</var> equal the current UTC date.
+ </li>
+ <li>If <var>current date</var> is less than the <var>timeout date</var> then continue to the step
+ labeled <em>refresh subscription</em> above.
+ </li>
+ <li>Send a HTTP SUBSCRIBE request with a <em>SID</em> header with the string value of <var>callback
+ ID</var> and a user-agent defined <em>TIMEOUT</em> header (in the form <code>Second-XX</code> where
+ <code>XX</code> is the user-agent defined timeout value in seconds) towards the <var>network service
+ record</var>'s <code>eventsUrl</code> property.
+ </li>
+ <li>On receiving a valid 200 OK, update <var>callback ID</var> with the string value of the first
+ included <em>SID</em> header and set <var>timeout date</var> to the sum of the current UTC date value
+ plus the integer value of the first included <em>TIMEOUT</em> header (minus the leading string of
+ <code>Second-</code>), if it exists. If the current date is greater than or equal to <var>timeout
+ date</var> then the <a>user agent</a> SHOULD continue from the step labeled <em>refresh
+ subscription</em> above. For all non 200 OK responses the <a>user agent</a> SHOULD continue from the
+ step labeled <em>refresh subscription</em> above.
+ </li>
+ </ol>
+ </li>
+ <li>
+ <em>Listen</em>: For each HTTP NOTIFY request received at the <var>callback URL</var> the <a>user
+ agent</a> is to run the following steps:
+ <ol class="rule">
+ <li>Let <var>content clone</var> be the result of obtaining the message body of the HTTP NOTIFY
+ request. If <var>content clone</var> is empty, then the <a>user agent</a> MUST abort these steps.
+ </li>
+ <li>Let <var>notification event</var> be a new simple event that uses the <a href=
+ "http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
+ class="externalDFN"><code>Event</code></a> interface with the name <a href=
+ "#event-notify"><code>notify</code></a>, which does not bubble, is not cancellable, and has no
+ default action.
+ </li>
+ <li>Let the <code>data</code> attribute of <var>notification event</var> have the DOMString value of
+ <var>content clone</var>.
+ </li>
+ <li>
+ <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
+ class="externalDFN">Queue a task</a> to dispatch <var>notification event</var> at the current
+ <a><code>NetworkService</code></a> object.
+ </li>
+ <li>Return a HTTP 200 OK response to the sender of the HTTP NOTIFY request.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ </li>
+ </ol>
+ <p>
+ A <a>user agent</a> can <dfn>terminate an existing UPnP Events Subscription</dfn> at any time for a
+ <var>network service record</var> by sending an HTTP UNSUBSCRIBE request - as defined in 'Section 4.1.4:
+ Cancelling a subscription with UNSUBSCRIBE' in [[!UPNP-DEVICEARCH11]] - with a HOST header set to that
+ <var>active service</var>'s <code>eventsUrl</code> property and a SID header set to the <var>callback
+ ID</var> obtained when the initial <a>setup a UPnP Events Subscription</a> action occurred.
+ </p>
+ </section>
+ <section>
+ <h3>
+ Network Topology Monitoring
+ </h3>
+ <div>
<p>
- The <dfn id="dom-networkservice-id"><code>id</code></dfn> attribute is a unique identifier for the service. Two services provided at different times or on different objects MUST have the same <a href="#dom-networkservice-id"><code>id</code></a> value.
- </p>
-
- <p>
- The <dfn id="dom-networkservice-name"><code>name</code></dfn> attribute represents a human-readable title for the service.
- </p>
-
- <p>
- The <dfn id="dom-networkservice-type"><code>type</code></dfn> attribute reflects the value of the <a>valid service type</a> of the service.
- </p>
-
- <p>
- The <dfn id="dom-networkservice-url"><code>url</code></dfn> attribute is an <a href="http://www.w3.org/TR/html5/urls.html#absolute-url" class="externalDFN">absolute URL</a> pointing to the root HTTP
- endpoint for the service that has been added to the <a>entry script origin's URL whitelist</a>. Web pages can subsequently use this value for implicit cross-document messaging via various existing mechanisms (e.g. Web Sockets, Server-Sent Events, Web Messaging, XMLHttpRequest).
- </p>
-
- <p>
- The <dfn id="dom-networkservice-config"><code>config</code></dfn> attribute provides the raw configuration information extracted from the given network service.
- </p>
-
- </section>
-
- <section>
- <h3>States</h3>
-
- <dl class="domintro">
- <dt>
- <var title="">service</var>
- .
- <code title="dom-networkservice-readystate">
- <a href="#dom-networkservice-readystate">readyState</a>
- </code>
- </dt>
- <dd>
- <p>
- Returns the current state.
+ When the <a>user agent</a> detects that the user has dropped from their connected network then, for each
+ <var>existing service record</var> in the <a>list of available service records</a>, the user agent MUST run
+ the general rule for <a>removing an available service</a> passing in each <var>existing service
+ record</var>'s <code>id</code> property as the only argument for each call.
</p>
- </dd>
- </dl>
-
- A <a href="#networkservice"><code>NetworkService</code></a> object can be in several states. The <dfn id="dom-networkservice-readystate"><code>readyState</code></dfn> attribute MUST return the current state of the networked service,
- which MUST be one of the following values:
-
- <dl>
- <dt>
- <dfn id="dom-networkservice-AVAILABLE" title="dom-networkservice-AVAILABLE">
- <code>AVAILABLE</code>
- </dfn>
- (numeric value
- 1)
-
-
- </dt>
- <dd>
- <p>The object is connected to its service endpoint.
-
- </p>
- </dd>
- <dt>
- <dfn id="dom-networkservice-UNAVAILABLE" title="dom-networkservice-UNAVAILABLE">
- <code>UNAVAILABLE</code>
- </dfn>
- (numeric value
- 2)
- </dt>
- <dd>
- <p>The object is not connected to its service endpoint.
- </p>
- </dd>
- </dl>
-
+ <p>
+ When the <a>user agent</a> detects that the user has connected to a new network or reconnected to an
+ existing network, then it SHOULD restart its discovery mechanisms as defined in the <a href=
+ "#service-discovery">Service Discovery</a> section of this specification, maintaining the existing <a>list
+ of active service managers</a> currently in use.
+ </p>
+ </div>
</section>
-
- <section>
- <h3>Events</h3>
-
+ </section>
+ <section>
+ <h3>
+ Events Summary
+ </h3>
<p>
- The following are the event handlers (and their corresponding event handler event types) that must be supported, as IDL attributes, by all objects implementing the
- <a href="#networkservice"><code>NetworkService</code></a> interface:
- </p>
-
- <table border="1">
+ The following events are dispatched on the <a href="#networkservices"><code>NetworkServices</code></a> and/or
+ <a href="#networkservice"><code>NetworkService</code></a> objects:
+ </p>
+ <table border="1">
<thead>
<tr>
<th>
- <span title="event handlers">Event handler</span>
+ <span>Event name</span>
</th>
<th>
- <span>Event handler event type</span>
+ <span>Interface</span>
+ </th>
+ <th>
+ <span>Dispatched when...</span>
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
- <dfn id="dom-networkservice-onmessage" title="dom-NetworkService-onmessage">
- <code>onmessage</code>
- </dfn>
+ <dfn id="event-serviceavailable"><code>serviceavailable</code></dfn>
</td>
<td>
- <code title="event-message">message</code>
+ <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
+ class="externalDFN"><code>Event</code></a>
+ </td>
+ <td>
+ When a new service that matches one of the <a>requested type tokens</a> is found in the current network.
</td>
</tr>
<tr>
<td>
- <dfn id="dom-networkservice-onreadystatechange" title="dom-NetworkService-onreadystatechange">
- <code>onreadystatechange</code>
- </dfn>
+ <dfn id="event-serviceunavailable"><code>serviceunavailable</code></dfn>
</td>
<td>
- <code title="event-onreadystatechange">readystatechange</code>
+ <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
+ class="externalDFN"><code>Event</code></a>
+ </td>
+ <td>
+ When an existing service that matches one of the <a>requested type tokens</a> gracefully leaves or
+ expires from the current network.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="event-serviceonline"><code>serviceonline</code></dfn>
+ </td>
+ <td>
+ <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
+ class="externalDFN"><code>Event</code></a>
+ </td>
+ <td>
+ When a current service renews its service registration within the current network.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="event-serviceoffline"><code>serviceoffline</code></dfn>
+ </td>
+ <td>
+ <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
+ class="externalDFN"><code>Event</code></a>
+ </td>
+ <td>
+ When a current service gracefully leaves or otherwise expires from the current network.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="event-notify"><code>notify</code></dfn>
+ </td>
+ <td>
+ <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
+ class="externalDFN"><code>Event</code></a>
+ </td>
+ <td>
+ When a valid UPnP Events Subscription Message is received on a <a>user-agent generated callback url</a>
+ for a current service. This event never fires for Zeroconf-based services.
</td>
</tr>
</tbody>
</table>
-
- <p>
- Events with an event type of <code>message</code> defined in this specification are <a href="http://dev.w3.org/html5/postmsg/#messageevent" class="externalDFN"><code>MessageEvent</code></a> objects as defined in [[!POSTMSG]].
- </p>
-
+ </section>
+ <section>
+ <h3>
+ Garbage collection
+ </h3>
<p>
- Events with an event type of <code>readystatechange</code> defined in this specification are simple <code>Event</code> objects.
- </p>
-
- </section>
- </section>
-
- <section>
- <h2>Service Discovery</h2>
-
- <p>
- A <a>user agent</a> conforming to this specification MAY implement <abbr title="Simple Service Discovery Protocol">SSDP</abbr> [[!UPNP-DEVICEARCH11]] and Zeroconf [[!ZEROCONF]] service discovery mechanisms
- to enable Web pages to request and connect with HTTP services running on networked devices, discovered via either mechanism, through this API. When a <a>user agent</a> implements either of these service discovery mechanisms, then it MUST conform to the corresponding algorithms provided in this section of the specification.
+ A user agent MUST only garbage collect a <a><code>NetworkServices</code></a> object and remove its entry from
+ the <a>list of active service managers</a> when the user has navigated away from the browsing context in which
+ that <a><code>NetworkServices</code></a> object was provided.
</p>
<p>
- This section presents how the results of these two service discovery
- mechanisms will be matched to requested service types and how their properties will be applied to any resulting <a href="#networkservice"><code>NetworkService</code></a> objects.
- </p>
-
- <p>
- It is expected that user agents will perform these service discovery mechansisms asynchronously and periodically update the <a>list of networked devices</a> as required. The timing of any
- service discovery mechanisms is an implementation detail left to the discretion of the implementer (e.g. once on user agent start-up, every X seconds during user agent execution or on
- invocation of this API from a Web page).
- </p>
-
- <p>
- The <dfn>list of available service records</dfn> is a single dynamic internal lookup table within user agents that is used to track the current services available in the network at any given time.
- At any point during the running of either of the two service discovery mechanisms then existing entries within this table can be updated, entries can be added and entries can be removed as the status of networked
- services changes. Each record contained within this table contains the attributes: <code>id</code>, <code>name</code>, <code>type</code>, <code>url</code> and <code>config</code>.
+ A user agent MUST NOT garbage collect individual <a><code>NetworkService</code></a> objects until their parent
+ <a><code>NetworkServices</code></a> object has been garbage collected.
</p>
-
- <section>
- <h4>Zeroconf (<abbr title="Multicast DNS">mDNS</abbr> + <abbr title="Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr>)</h4>
-
- <p>
- For each DNS response received from a user-agent-initiated Multicast DNS Browse for <abbr title="DNS Pointer Record">PTR</abbr> records with the name <code>_services._dns-sd._udp</code> on the resolved recommended automatic browsing
- domain [[!MDNS]], the <a>user agent</a> MUST run the following steps:
- </p>
-
- <ol class="rule">
-
- <li>Let <var>service mDNS responses</var> be an array of PTR records received by issuing a Multicast DNS Browse for PTR records with the name of the current discovered service type.</li>
-
- <li>For each Object <var>service mDNS response</var> in <var>service mDNS responses</var>, run the following steps:
- <ol>
-
- <li>
- Let <var>network service record</var> be an Object consisting of the following empty properties: <code>id</code>, <code>name</code>, <code>type</code>, <code>url</code>, <code>config</code>.
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>id</code> property to the value of the full PTR Service Instance Name [[!MDNS]].
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>name</code> property to the value of the PTR Service Instance Name's <var>Instance</var> component [[!MDNS]].
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>type</code> property to the concatenation of the string <code>zeroconf:</code> followed by the value of the PTR Service Instance Name's <var>Service</var> component [[!MDNS]].
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>url</code> property to the resolvable Service URL obtained from performing an DNS-SD Lookup [[!DNS-SD]] of the current service from the PTR record provided [[!MDNS]].
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>config</code> property to the string value of the contents of the first DNS-SD TXT record associated with the <var>service mDNS response</var> as defined in [[!DNS-SD]].
- </li>
-
- <li>
- For each Object <var>existing service record</var> in the current <a>list of available service records</a>, run the following sub-steps:
- <ol class="rule">
-
- <li>
- If the <var>existing service record</var>'s <code>id</code> property matches the value of the <var>network service record</var>'s <code>id</code>, then set the
- value of <var>existing service record</var> in the current <a>list of available service records</a> to the value of the
- <var>network service record</var> and skip the next step.
- </li>
- </ol>
- </li>
-
- <li>
- Add <var>network service record</var> to the <a>list of available service records</a>.
- </li>
-
- <li>
- For each non-garbage collected <a href="#networkservice"><code>NetworkService</code></a> object run the following steps:
-
- <ol class="rule">
- <li>
- If the <a href="#networkservice"><code>NetworkService</code></a> object's <code>type</code> attribute does not equal the
- current <a>network service record</a>'s <code>type</code> property then continue at the next available active
- <a href="#networkservice"><code>NetworkService</code></a> object.
- </li>
- <li>
- Increment the <code>servicesAvailable</code> attribute of the <a href="#networkservices"><code>NetworkServices</code></a> object by <code>1</code>.
- </li>
- </ol>
- </li>
- </ol>
- </li>
- </ol>
-
- </section>
-
- <section>
- <h5>Universal Plug-and-Play (<abbr title="Universal Plug-and-Play">UPnP</abbr>)</h5>
-
- <p>
- For each SSDP Presence Announcement [[!UPNP-DEVICEARCH11]] - a HTTP NOTIFY request - received from a user-agent-initiated SSDP Discovery Request [[!UPNP-DEVICEARCH11]], the <a>user agent</a> MUST run the following steps:
- </p>
-
- <ol class="rule">
- <li>
- Let <var>ssdp device</var> be an Object with a property for each HTTP header received in the received SSDP Presence Announcement, with each key being the name of a HTTP header and its
- value being that HTTP header's accompanying value.
- </li>
-
- <li>
- If <var>ssdp device</var> does not contain at least one <var>NTS</var>, <var>USN</var> and <var>Location</var> parameter, then the <a>user agent</a> MUST abort these steps.
- </li>
-
- <li>
- If the first occurrence of <var>NTS</var> has a value other than <code>ssdp:alive</code>, then continue to the step labeled <var>update service monitor</var> below.
- </li>
-
- <li>
- Let <var>root device descriptor file</var> contain the contents of the file located at the URL provided in the first occurrence of <var>Location</var> obtained according to the rules
- defined in the section 'Retrieving a description using HTTP' [[!UPNP-DEVICEARCH11]].
- </li>
-
- <li>
- If <var>root device descriptor file</var> is empty, then the <a>user agent</a> MUST abort these steps.
- </li>
-
- <li>
- Let <var>advertised services</var> be a <a>list of all advertised services</a> obtained from the <var>root device descriptor file</var> containing all sub-nodes of the <code>serviceList</code> node as described in
- the section 'Device Description' [[!UPNP-DEVICEARCH11]].
- </li>
-
- <li>
- For each Object <var>advertised service</var> in <var>advertised services</var> run the following steps:
- <ol class="rule">
-
- <li>
- Let <var>network service record</var> be an Object consisting of the following empty properties: <code>id</code>, <code>name</code>, <code>type</code>, <code>url</code>, <code>eventsUrl</code>, <code>config</code>.
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>id</code> property to the string value of the first occurrence of <var>ssdp device</var>'s <var>USN</var> parameter.
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>name</code> property to the string value of the first occurrence of the <var>service</var>'s <code>serviceId</code> property.
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>type</code> property to the concatenation of the string <code>upnp:</code> followed by the string value of the first occurrence of the <var>service</var>'s <code>serviceType</code> property.
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>url</code> property to the string value of the first occurrence of the <var>service</var>'s <code>controlURL</code> property.
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>config</code> property to the string value of the first occurrence of the <var>device</var> property.
- </li>
-
- <li>
- If <var>service</var>'s <code>eventSubURL</code> property is empty, then continue to the step labeled <em>register</em> below.
- </li>
-
- <li>
- Set <var>network service record</var>'s <code>eventsUrl</code> property to the string value of the first occurrence of the <var>service</var>'s <code>eventSubURL</code> property.
- </li>
-
- <li>
- <em>Register</em>: For each Object <var>existing service record</var> in the current <a>list of available service records</a>, run the following sub-steps:
- <ol class="rule">
-
- <li>
- If the <var>existing service record</var>'s <var>id</var> property matches the value of the first occurrence of <var>USN</var> and the
- <var>existing service record</var>'s <code>type</code> property matches the value of <var>network service record</var>'s <code>type</code>, then set the
- value of <var>existing service record</var> in the current <a>list of available service records</a> to the value of the
- <var>network service record</var> and skip the next step.
- </li>
- </ol>
- </li>
-
- <li>
- Add <var>network service record</var> to the <a>list of available service records</a>.
- </li>
-
- </ol>
- </li>
- <li>
- <em>Update Service Monitor</em>: For each non-garbage collected <a href="#networkservice"><code>NetworkService</code></a> object run the following steps:
-
- <ol class="rule">
- <li>
- If this <a href="#networkservice"><code>NetworkService</code></a> object's <code>type</code> attribute does not equal the
- current <a>network service record</a>'s <code>type</code> property then continue at the next available active
- <a href="#networkservice"><code>NetworkService</code></a> object.
- </li>
- <li>
- If the <var>announcement type</var> equals <code>ssdp:alive</code> then Increment the <code>servicesAvailable</code> attribute of the <a href="#networkservices"><code>NetworkServices</code></a>
- object by <code>1</code>. Otherwise, decrement the <code>servicesAvailable</code> attribute of the <a href="#networkservices"><code>NetworkServices</code></a>
- object by <code>1</code>.
- </li>
- </ol>
+ <p>
+ A user agent MUST garbage collect the <a><code>NetworkService</code></a> <a>indexed properties</a> of a
+ <a><code>NetworkServices</code></a> object when that <a><code>NetworkServices</code></a> object itself has been
+ garbage-collected.
+ </p>
+ </section>
+ <section>
+ <h3>
+ Use Cases and Requirements
+ </h3>
+ <p>
+ This section covers what the requirements are for this API, as well as illustrates some use cases.
+ </p>
+ <ul class="rule">
+ <li>Once a user has given permission, user agents should provide the ability for Web pages to communicate
+ directly with a Local-networked Service.
+ <ul class="rule">
+ <li>Example: A web-based TV remote control. A Web page wants to control the current user's TV, changing the
+ programming shown or increasing/decreasing/muting the volume of the Local-networked Device. The Web page
+ requests a service type that is known to be implemented by television sets to which it has the application
+ logic to communicate. Local devices providing the request service types are discovered and presented to the
+ user for authorization. The user selects one or more of the discovered television sets to be accessible to
+ the current Web page and then clicks 'Share'. The Web page can now communicate directly with the
+ user-authorized Local-networked services.
</li>
- </ol>
-
- <p>
- A <dfn>user-agent generated callback url</dfn> is a Local-network accessible URL endpoint that a <a>user agent</a> must generate and maintain for receiving HTTP NOTIFY requests from UPnP Event sources.
- </p>
-
- <p>When the <a>user agent</a> is to <dfn>setup a UPnP Events Subscription</dfn>, it is to run the following steps with the current <var>network service record</var> object:</p>
-
- <ol class="rule">
- <li>
- If <var>network service record</var>'s <code>eventsUrl</code> property is empty then the <a>user agent</a> MUST abort these steps.
- </li>
-
- <li>
- Let <var>callback URL</var> be the value of creating a new <a>user-agent generated callback url</a>.
- </li>
-
- <li>
- Send a HTTP SUBSCRIBE request with a <em>NT</em> header with a string value of <code>upnp:event</code>, a <em>TIMEOUT</em> header with an integer value of
- <code>86400</code> and a <em>CALLBACK</em> header
- with a string value of <var>callback URL</var> towards the <var>network service record</var>'s <code>eventsUrl</code> property.
- </li>
-
- <li>
- If a non-200 OK response is received from the HTTP SUBSCRIBE request then the <a>user agent</a> MUST abort these steps.
- </li>
-
- <li>
- On receiving a valid 200 OK response, run the following steps:
-
- <ol class="rule">
- <li>
- Let <var>callback ID</var> equal the string value of the first included <em>SID</em> header, if it exists.
- </li>
- <li>
- Let <var>timeout date</var> equal the sum of the current UTC date value plus the integer value of the first included <em>TIMEOUT</em> header, if it exists.
- </li>
- <li>
- Run the following steps aynchronously and continue to the step labeled <em>listen</em> below.
- </li>
- <li>
- <em>Refresh Subscription</em>: Run the following steps at a set interval (X) within the <a>user agent</a>:
-
- <ol class="rule">
- <li>
- Let <var>current date</var> equal the current UTC date.
- </li>
- <li>
- If <var>current date</var> is less than the <var>timeout date</var> then continue to the step labeled <em>refresh subscription</em> above.
- </li>
- <li>
- Send a HTTP SUBSCRIBE request with a <em>SID</em> header with the string value of <var>callback ID</var> and a <em>TIMEOUT</em> header
- with an integer value of <code>86400</code> towards the <var>network service record</var>'s <code>eventsUrl</code> property.
- </li>
- <li>
- On receiving a valid 200 OK, update <var>callback ID</var> with the string value of the first included <em>SID</em> header, if it exists. All other HTTP
- responses should cause the <a>user agent</a> to continue from the step labeled <em>refresh subscription</em> above.
- </li>
- </ol>
-
- </li>
-
- <li>
- <em>Listen</em>: For each HTTP NOTIFY request received at the <var>callback URL</var> the <a>user agent</a> is to run the following steps:
-
- <ol class="rule">
- <li>
- Let <var>content clone</var> be the result of obtaining the message body of the HTTP NOTIFY request. If <var>content clone</var> is empty, then the <a>user agent</a> MUST abort these steps.
- </li>
- <li>
- Create a new <code>message</code> event that uses the <a href="http://dev.w3.org/html5/postmsg/#messageevent" class="externalDFN"><code>MessageEvent</code></a> interface [[!POSTMSG]], with the name <code>message</code>,
- which does not bubble, is not cancelable, and has no default action.
- </li>
- <li>
- Let the <code>data</code> attribute of the event have the DOMString value of <var>content clone</var>.
- </li>
- <li>
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">Queue a task</a> to
- dispatch the newly created event at the current <a><code>NetworkService</code></a> object.
- </li>
- </ol>
- </li>
-
- </ol>
-
+ </ul>
+ </li>
+ <li>Web pages should be able to communicate with Local-networked Services using the messaging channel supported
+ by those Devices.
+ <ul class="rule">
+ <li>Example: A Web page advertises that it is capable of controlling multiple Home Media Servers. The user
+ can select their Home Media Server type from a drop-down list, at which point the Web page sends a request
+ to the user agent to connect with the associated service type of the Home Media Server. The Media Server
+ selected implements a Web Socket channel for bi-directional service communication and so the Web page opens
+ a web socket to the requested Media Server and can communicate as required via that appropriate channel.
</li>
- </ol>
-
- </section>
-
- <section>
- <h3>Network Topology Monitoring</h3>
-
- <div>
- <p>
- When the <a>user agent</a> detects that the user has dropped from their connected network, then it MUST run the following steps:
- </p>
-
- <ol class="rule">
- <li>
- Flush all entries from the <a>list of available service records</a>.
- </li>
- <li>
- For each <a href="#networkservice"><code>NetworkService</code></a> object currently active in the <a>user agent</a> perform the following steps:
-
- <ol class="rule">
- <li>
- Set the <a href="#dom-networkservice-readystate"><code>readyState</code></a> attribute to <code>2</code> (<a href="#dom-networkservice-UNAVAILABLE"><code>UNAVAILABLE</code></a>).
- </li>
- <li>
- Create a new <code>readystatechange</code> event that uses the <code>Event</code> interface which does not bubble, is not cancelable, and has no default action.
- </li>
- <li>
- <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">Queue a task</a> to
- dispatch the newly created event at the <a href="#networkservice"><code>NetworkService</code></a> object.
- </li>
- </ol>
- </li>
- </ol>
-
- <p>
- When the <a>user agent</a> detects that the user has connected to a new network, then it SHOULD run the following steps:
- </p>
-
- <ol class="rule">
- <li>
- Re-issue an mDNS search and SSDP discovery search and handle the responses according to the processing defined in <a href="#service-discovery">Section 6: Service Discovery</a>.
- </li>
- </ol>
- </div>
- </section>
- </section>
-
- <section>
- <h3>Garbage collection</h3>
-
- <p>
- A <a><code>NetworkService</code></a> object containing a <code>url</code> parameter currently in the <a>entry script origin's URL whitelist</a> MUST NOT be garbage collected.
- </p>
-
- <p>
- Only when the user navigates away from the current browsing context can <a><code>NetworkService</code></a> objects be garbage-collected and records in the <a>entry script origin's URL whitelist</a> be removed.
- </p>
-
- </section>
-
-
- <section>
- <h3>Use Cases and Requirements</h3>
-
- <p>This section covers what the requirements are for this API, as well as illustrates some use cases.</p>
-
- <ul class="rule">
- <li>
- Once a user has given permission, user agents should provide the ability for Web pages to communicate directly with a Local-networked Service.
- <ul class="rule">
- <li>
- Example: A web-based TV remote control. A Web page wants to control the current user's TV, changing the programming shown or increasing/decreasing/muting the
- volume of the Local-networked Device. The Web page requests a service type that is known to be implemented by television sets to which it has the
- application logic to communicate. Local devices providing the request service types are discovered and presented to the user for authorization. The user selects one
- or more of the discovered television sets to be accessible to the current Web page and then clicks 'Share'. The Web page can now communicate directly with
- the user-authorized Local-networked services.
- </li>
- </ul>
- </li>
-
- <li>
- Web pages should be able to communicate with Local-networked Services using the messaging channel supported by those Devices.
- <ul class="rule">
- <li>
- Example: A Web page advertises that it is capable of controlling multiple Home Media Servers. The user can select their Home Media Server type from a drop-down list, at which point the
- Web page sends a request to the user agent to connect with the associated service type of the Home Media Server. The Media Server selected implements a Web Socket channel for
- bi-directional service communication and so the Web page opens a web socket to the requested Media Server and can communicate as required via that appropriate channel.
+ </ul>
+ </li>
+ <li>Web pages should be able to communicate with Local-networked Services using the messaging format supported
+ by those Devices.
+ <ul class="rule">
+ <li>Example: A Web page advertises that it is capable of interacting with and controlling multiple types of
+ Home Media Server. The user can select their Home Media Server type from a drop-down list or known Media
+ Servers, at which point the Web page sends a request to the user agent to connect with the associated
+ service type (and, optionally, the associated event type) of the Home Media Server. The communication
+ protocols supported by Home Media Servers typically vary between UPnP, JSON-RPC, Protocol Buffers or other
+ messaging formats depending on the Home Media Server requested. The Web page is able to communicate with
+ the user-selected Home Media Server in the messaging format supported by that Device, which, in this
+ example is a simple key/value pair text format.
</li>
- </ul>
- </li>
-
- <li>
- Web pages should be able to communicate with Local-networked Services using the messaging format supported by those Devices.
- <ul class="rule">
- <li>
- Example: A Web page advertises that it is capable of interacting with and controlling multiple types of Home Media Server. The user can select their Home Media Server type from a drop-down list or known Media Servers, at which point the
- Web page sends a request to the user agent to connect with the associated service type (and, optionally, the associated event type) of the Home Media Server. The communiciation protocols supported by Home Media Servers typically vary
- between UPnP, JSON-RPC, Protocol Buffers or other messaging formats depending on the Home Media Server requested. The Web page is able to communicate with the user-selected Home Media
- Server in the messaging format supported by that Device, which, in this example is a simple key/value pair text format.
+ </ul>
+ </li>
+ <li>Web pages should not be able to communicate with Local-networked Services that have not been authorized by
+ the user thereby maintaining the user's privacy.
+ <ul class="rule">
+ <li>Example: A Web page requests access to one type of Local-networked service. The user authorizes access
+ to that particular service. Other services running on that same device, and on other devices within the
+ network, should not be accessible to the current Web page.
</li>
- </ul>
- </li>
-
- <li>
- Web pages should not be able to communicate with Local-networked Services that have not been authorized by the user thereby maintaining the user's privacy.
- <ul class="rule">
- <li>
- Example: A Web page requests access to one type of Local-networked service. The user authorizes access to that particular service. Other services running on that same device, and on other devices
- within the network, should not be accessible to the current Web page.
+ </ul>
+ </li>
+ <li>A user should be able to share one or more Local-networked Services based on a particular service type
+ request from a Web page.
+ <ul class="rule">
+ <li>Example: A Web page is capable of interacting with a specific profile of Local-networked Service. As
+ such, it makes a request to the user agent to access those services, of which multiple matches are found.
+ The user is capable of selecting one or more of the discovered services to share with the Web page. The Web
+ page can then implement a drag-and-drop interface for the user to drag specific actions on to one or more
+ of the authorized Local-networked Services.
</li>
- </ul>
- </li>
-
- <li>
- A user should be able to share one or more Local-networked Services based on a particular service type request from a Web page.
- <ul class="rule">
- <li>
- Example: A Web page is capable of interacting with a specific profile of Local-networked Service. As such, it makes a request to the user agent to access those services, of which multiple matches
- are found. The user is capable of selecting one or more of the discovered services to share with the Web page. The Web page can then implement a drag-and-drop interface for the user to drag specific
- actions on to one or more of the authorized Local-networked Services.
- </li>
- </ul>
- </li>
-
- <li>
- User agents should provide an API exposed to script that exposes the features above. The user is notified by UI anytime interaction with Local-networked Services is requested, giving the user
- full ability to cancel or abort the transaction. The user selects the Local-networked Services to be connected to the current Web page, and can cancel these at any time. No invocations to
- these APIs occur silently without user intervention.
- </li>
+ </ul>
+ </li>
+ <li>User agents should provide an API exposed to script that exposes the features above. The user is notified
+ by UI anytime interaction with Local-networked Services is requested, giving the user full ability to cancel or
+ abort the transaction. The user selects the Local-networked Services to be connected to the current Web page,
+ and can cancel these at any time. No invocations to these APIs occur silently without user intervention.
+ </li>
</ul>
</section>
-
- <section class="informative appendix">
- <h3>Examples</h3>
+ <section class="informative appendix">
+ <h3>
+ Examples
+ </h3>
+ <div class="example">
+ <p>
+ This sample code exposes a button. When clicked, this button is disabled and the user is prompted to offer a
+ network service. The user may also select multiple network services. When the user has authorized a network
+ service to be connected to the web page then the web page issues a simple command to get a list of all the
+ albums stored on the connected media player service.
+ </p>
+ <p>
+ The button is re-enabled only when the connected network service disconnects for whatever reason (the service
+ becomes unavailable on the network, the user disconnects from their current network or the user revokes
+ access to the service from the current web page). At this point the user can re-click the button to select a
+ new network service to connect to the web page and the above steps are repeated.
+ </p>
+ <p>
+ The provided service type identifier and service interaction used in this example is based on the
+ well-defined service type and messaging format supported by the <a href="http://xbmc.org/about/">XBMC Media
+ Server</a>.
+ </p>
+ <hr>
+ <pre class="highlight">
+<input type="button" value="Start" onclick="start()" id="startBtn"/>
+<div id="debugconsole"></div>
- <div class="example">
- <p>This sample code exposes a button. When clicked, this button is disabled and the user is prompted to offer a network service. The user may also select multiple network services. When the user has authorized a network service to be connected to the web page then the web page issues a simple command to get a list of all the albums stored on the connected media player service.
- <p>The button is re-enabled only when the connected network service disconnects for whatever reason (the service becomes unavailable on the network, the user disconnects from their current network or the user revokes access to the service from the current web page). At this point the user can re-click the button to select a new network service to connect to the web page and the above steps are repeated.</p>
- <p>The provided service type identifier and service interaction used in this example is based on the well-defined service type and messaging format supported by the <a href="http://xbmc.org/about/">XBMC Media Server</a>. </p>
- <hr />
- <pre class="highlight"><input type="button" value="Start" onclick="start()" id="startBtn"/>
-<div id="debugconsole"></div>
-
-<script>
+<script>
var startBtn = document.getElementById('startBtn'),
debug = document.getElementById('debugconsole');
@@ -1358,7 +1687,7 @@
navigator.getNetworkServices('zeroconf:_xbmc-jsonrpc._tcp', gotXBMCService, error);
startBtn.disabled = true;
} else {
- debug.innerHTML += "<br>Service Discovery API not supported!";
+ debug.innerHTML += "<br>Service Discovery not supported!";
}
}
@@ -1366,17 +1695,15 @@
// Listen for service disconnect messages
- services[0].addEventListener('readystatechange', function ( e ) {
- if(services[0].readyState === services[0].UNAVAILABLE) {
- debug.innerHTML += "<br>" + services[0].name + " disconnected.";
+ services[0].addEventListener('serviceoffline', function ( e ) {
+ debug.innerHTML += "<br>" + services[0].name + " disconnected.";
startBtn.disabled = false;
- }
}, false);
// Send a service message to get albums list (and process the service response)
var svcXhr = new XMLHttpRequest();
- svcXhr.open("POST", services[0].url + "/getAlbums"); // services[0].url and its subresources have been
+ svcXhr.open("POST", services[0].url + "/getAlbums"); // services[0].url and its sub-resources have been
// whitelisted for cross-site XHR use in this
// current browsing context.
@@ -1385,7 +1712,7 @@
svcXhr.addEventListener('readystatechange', function ( response ) {
if( response.readyState != 4 || response.status != 200 )
return;
- debug.innerHTML += "<br>" + services[0].name + " response received: ";
+ debug.innerHTML += "<br>" + services[0].name + " response received: ";
debug.textContent += JSON.parse(response.responseText);
}, false);
@@ -1395,28 +1722,33 @@
];
svcXhr.send(JSON.stringify(svcMsg));
- debug.innerHTML += "<br>" + services[0].name + " request sent: ";
+ debug.innerHTML += "<br>" + services[0].name + " request sent: ";
debug.textContent += JSON.stringify(svcMsg);
}
function error( err ) {
- debug.innerHTML += "<br>An error occurred obtaining a local network service.";
+ debug.innerHTML += "<br>An error occurred obtaining a local network service.";
startBtn.disabled = false;
}
-</script></pre>
- </div>
-
- <div class="example">
- <p>
- This sample exposes a drop-down list containing a number of common Home-based audio devices. When the user selects an audio device from the list provided, they are prompted to authorize a network service
- based on the service type requested. The user may also select multiple network services matching the selected service type.
- In this example, the user selects their make as being <var>Sony</var> and their model as being <var>Bravia S1000</var> from which the Web page can derive a service type
- (<var>urn:schemas-upnp-org:service:RenderingControl:1</var>).
- <br /><br />Once the user has authorized the device, the web page sends a simple mute command according to the messaging format supported by the device.
- </p>
- <hr />
- <pre class="highlight"><select name="make" id="make">
+</script>
+</pre>
+ </div>
+ <div class="example">
+ <p>
+ This sample exposes a drop-down list containing a number of common Home-based audio devices. When the user
+ selects an audio device from the list provided, they are prompted to authorize a network service based on the
+ service type requested. The user may also select multiple network services matching the selected service
+ type. In this example, the user selects their make as being <var>Sony</var> and their model as being
+ <var>Bravia S1000</var> from which the Web page can derive a service type
+ (<var>urn:schemas-upnp-org:service:RenderingControl:1</var>).<br>
+ <br>
+ Once the user has authorized the device, the web page sends a simple mute command according to the messaging
+ format supported by the device.
+ </p>
+ <hr>
+ <pre class="highlight">
+<select name="make" id="make">
<option selected="selected" disabled="disabled">Select make</option>
<option>Sony</option>
<option>Philips</option>
@@ -1448,7 +1780,7 @@
defaultOption.setAttribute("disabled", "disabled");
defaultOption.setAttribute("selected", "selected");
modelEl.appendChild(defaultOption);
- for(var i = 0, l = models[makeEl.value].length; i < l; i++) {
+ for(var i = 0, l = models[makeEl.value].length; i < l; i++) {
var option = document.createElement("option");
option.textContent = models[makeEl.value][i]["name"];
option.setAttribute("value", models[makeEl.value][i]["type"] + ":" + models[makeEl.value][i]["service"]);
@@ -1457,7 +1789,7 @@
}, false);
modelEl.addEventListener('change', function() {
- if(navigator.getNetworkServices &&
+ if(navigator.getNetworkServices &&
modelEl.value == "upnp:urn:schemas-upnp-org:service:RenderingControl:1") {
navigator.getNetworkServices(modelEl.value, successCallback, errorCallback);
} else if (modelEl.value == "zeroconf:_mediarenderer._http._tcp") {
@@ -1471,10 +1803,10 @@
<script>
function successCallback( services ) {
- // Listen for service push messages
+ // Listen for service push notification messages
- services[0].addEventListener('message', function ( msg ) {
- debug.innerHTML += "<br>" + services[0].name + " event received: ";
+ services[0].addEventListener('notify', function ( msg ) {
+ debug.innerHTML += "<br>" + services[0].name + " event received: ";
debug.textContent += msg.data;
}, false);
@@ -1482,7 +1814,7 @@
var svcXhr = new XMLHttpRequest();
svcXhr.open("POST", services[0].url); // services[0].url and its
- // subresources have been whitelisted for
+ // sub-resources have been whitelisted for
// cross-site XHR use in this current
// browsing context.
@@ -1517,21 +1849,27 @@
function errorCallback( error ) {
debug.innerHTML += "<br>An error occurred: " + error.code;
}
-</script></pre>
- </div>
-
- </section>
-
+</script>
+</pre>
+ </div>
+ </section>
<section>
- <h3>Acknowledgements</h3>
-
- <p>Thanks are expressed by the editor to the following individuals for their feedback on this specification to date (in alphabetical order):
- <br /><br />
- Gar Bergstedt, Lars-Erik Bolstad, Hari G Kumar, Bob Lund, Giuseppe Pascale, Marcin Simonides, Clarke Stevens, Christian Söderström, Mark Vickers, ...</p>
-
- <p>Thanks are also expressed by the editor to the following organizations and groups for their support in producing this specification to date (in alphabetical order):
- <br /></br />
- CableLabs, Opera Software ASA, W3C Device APIs Working Group, W3C Web and TV Interest Group, ...</p>
+ <h3>
+ Acknowledgements
+ </h3>
+ <p>
+ Thanks are expressed by the editor to the following individuals for their feedback on this specification to
+ date (in alphabetical order):<br>
+ <br>
+ Gar Bergstedt, Lars-Erik Bolstad, Cathy Chan, Hari G Kumar, Bob Lund, Giuseppe Pascale, Marcin Simonides,
+ Clarke Stevens, Christian Söderström, Mark Vickers.
+ </p>
+ <p>
+ Thanks are also expressed by the editor to the following organizations and groups for their support in
+ producing this specification to date (in alphabetical order):<br>
+ <br>
+ CableLabs, Opera Software ASA, W3C Device APIs Working Group, W3C Web and TV Interest Group.
+ </p>
</section>
-</body>
+ </body>
</html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/discovery-api/WD.html Tue Oct 02 18:07:01 2012 -0700
@@ -0,0 +1,1966 @@
+<!DOCTYPE html>
+<html lang="en" dir="ltr">
+<head>
+ <title>
+ Network Service Discovery
+ </title>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+
+
+ <style type="text/css">
+/* Custom ReSpec CSS (by Rich Tibbett) */
+
+ /* Add better spacing to sections */
+ section, .section { margin-bottom: 2em; }
+
+ /* Reduce note & issue render size */
+ .note, .issue { font-size:0.8em; }
+
+ /* Add addition spacing to <ol> and <ul> for rule definition */
+ ol.rule li, ul.rule li { padding:0.6em; }
+
+ pre.widl { border: solid thin; background: #EEEEEE; color: black; padding: 0.5em 1em; position: relative; }
+ pre.widl :link, pre.widl :visited { color: #000; background: transparent; }
+ pre.widl:before { content: "IDL"; font: bold small sans-serif; padding: 0.5em; background: white; position: absolute; top: 0; margin: -1px 0 0 -4em; width: 1.5em; border: thin solid; border-radius: 0 0 0 0.5em }
+
+ div.example { border: solid thin red; background: #F7DFE5; color: black; padding: 0.5em 1em; position: relative; margin: 1em 0 1em 4.6em; width: auto; }
+ div.example:before { content: "EXAMPLE"; font: bold small sans-serif; padding: 0.5em; background: red; color: white; position: absolute; top: 0; margin: -1px 0 0 -7.6em; width: 5em; border: thin solid red; border-radius: 0 0 0 0.5em }
+
+ dl.domintro { color: green; margin: 2em 0 2em 2em; padding: 0.5em 1em; border: none; background: #DDFFDD; }
+ hr + dl.domintro, div.impl + dl.domintro { margin-top: 2.5em; margin-bottom: 1.5em; }
+ dl.domintro dt, dl.domintro dt * { color: black; text-decoration: none; }
+ dl.domintro dd { margin: 0.5em 0 1em 2em; padding: 0; }
+ dl.domintro dd p { margin: 0.5em 0; }
+ dl.domintro code {font-size: inherit; font-style: italic; }
+ dl.domintro:before { display: table; margin: -1em -0.5em 0.5em auto; width: auto; content: 'This box is non-normative. Implementation requirements are given below this box.'; color: red; border: solid 2px; background: white; padding: 0 0.25em; }
+
+ table { border-collapse:collapse; border-style:hidden hidden none hidden }
+ table thead { border-bottom:solid }
+ table tbody th:first-child { border-left:solid }
+ table td, table th { border-left:solid; border-right:solid; border-bottom:solid thin; vertical-align:top; padding:0.2em }
+ </style>
+ <style>/*****************************************************************
+ * ReSpec 3 CSS
+ * Robin Berjon - http://berjon.com/
+ *****************************************************************/
+
+/* --- INLINES --- */
+em.rfc2119 {
+ text-transform: lowercase;
+ font-variant: small-caps;
+ font-style: normal;
+ color: #900;
+}
+
+h1 acronym, h2 acronym, h3 acronym, h4 acronym, h5 acronym, h6 acronym, a acronym,
+h1 abbr, h2 abbr, h3 abbr, h4 abbr, h5 abbr, h6 abbr, a abbr {
+ border: none;
+}
+
+dfn {
+ font-weight: bold;
+}
+
+a.internalDFN {
+ color: inherit;
+ border-bottom: 1px solid #99c;
+ text-decoration: none;
+}
+
+a.externalDFN {
+ color: inherit;
+ border-bottom: 1px dotted #ccc;
+ text-decoration: none;
+}
+
+a.bibref {
+ text-decoration: none;
+}
+
+cite .bibref {
+ font-style: normal;
+}
+
+code {
+ color: #ff4500;
+}
+
+
+/* --- --- */
+ol.algorithm { counter-reset:numsection; list-style-type: none; }
+ol.algorithm li { margin: 0.5em 0; }
+ol.algorithm li:before { font-weight: bold; counter-increment: numsection; content: counters(numsection, ".") ") "; }
+
+/* --- TOC --- */
+.toc a, .tof a {
+ text-decoration: none;
+}
+
+a .secno, a .figno {
+ color: #000;
+}
+
+ul.tof, ol.tof {
+ list-style: none outside none;
+}
+
+.caption {
+ margin-top: 0.5em;
+ font-style: italic;
+}
+
+/* --- TABLE --- */
+table.simple {
+ border-spacing: 0;
+ border-collapse: collapse;
+ border-bottom: 3px solid #005a9c;
+}
+
+.simple th {
+ background: #005a9c;
+ color: #fff;
+ padding: 3px 5px;
+ text-align: left;
+}
+
+.simple th[scope="row"] {
+ background: inherit;
+ color: inherit;
+ border-top: 1px solid #ddd;
+}
+
+.simple td {
+ padding: 3px 10px;
+ border-top: 1px solid #ddd;
+}
+
+.simple tr:nth-child(even) {
+ background: #f0f6ff;
+}
+
+/* --- DL --- */
+.section dd > p:first-child {
+ margin-top: 0;
+}
+
+.section dd > p:last-child {
+ margin-bottom: 0;
+}
+
+.section dd {
+ margin-bottom: 1em;
+}
+
+.section dl.attrs dd, .section dl.eldef dd {
+ margin-bottom: 0;
+}
+</style><style>/* --- ISSUES/NOTES --- */
+div.issue-title, div.note-title {
+ padding-right: 1em;
+ min-width: 7.5em;
+ color: #b9ab2d;
+}
+div.issue-title { color: #e05252; }
+div.note-title { color: #52e052; }
+div.issue-title span, div.note-title span {
+ text-transform: uppercase;
+}
+div.note, div.issue {
+ margin-top: 1em;
+ margin-bottom: 1em;
+}
+.note > p:first-child, .issue > p:first-child { margin-top: 0 }
+.issue, .note {
+ padding: .5em;
+ border-left-width: .5em;
+ border-left-style: solid;
+}
+div.issue, div.note {
+ padding: 0.5em;
+ margin: 1em 0;
+ position: relative;
+ clear: both;
+}
+span.note, span.issue { padding: .1em .5em .15em; }
+
+.issue {
+ border-color: #e05252;
+ background: #fbe9e9;
+}
+.note {
+ border-color: #52e052;
+ background: #e9fbe9;
+}
+
+
+</style><style>/* HIGHLIGHTS */
+code.prettyprint {
+ color: inherit;
+}
+
+/* this from google-code-prettify */
+.pln{color:#000}@media screen{.str{color:#080}.kwd{color:#008}.com{color:#800}.typ{color:#606}.lit{color:#066}.pun,.opn,.clo{color:#660}.tag{color:#008}.atn{color:#606}.atv{color:#080}.dec,.var{color:#606}.fun{color:red}}@media print,projection{.str{color:#060}.kwd{color:#006;font-weight:bold}.com{color:#600;font-style:italic}.typ{color:#404;font-weight:bold}.lit{color:#044}.pun,.opn,.clo{color:#440}.tag{color:#006;font-weight:bold}.atn{color:#404}.atv{color:#060}}ol.linenums{margin-top:0;margin-bottom:0}li.L0,li.L1,li.L2,li.L3,li.L5,li.L6,li.L7,li.L8{list-style-type:none}li.L1,li.L3,li.L5,li.L7,li.L9{background:#eee}
+</style><link rel="stylesheet" href="http://www.w3.org/StyleSheets/TR/W3C-WD"><!--[if lt IE 9]><script src='undefined://www.w3.org/2008/site/js/html5shiv.js'></script><![endif]--></head><body><div class="head">
+ <p>
+
+ <a href="http://www.w3.org/"><img width="72" height="48" src="http://www.w3.org/Icons/w3c_home" alt="W3C"></a>
+
+ </p>
+ <h1 class="title" id="title">Network Service Discovery</h1>
+
+ <h2 id="w3c-working-draft-04-october-2012"><abbr title="World Wide Web Consortium">W3C</abbr> Working Draft 04 October 2012</h2>
+ <dl>
+
+ <dt>This version:</dt>
+ <dd><a href="http://www.w3.org/TR/2012/WD-discovery-api-20121004/">http://www.w3.org/TR/2012/WD-discovery-api-20121004/</a></dd>
+ <dt>Latest published version:</dt>
+ <dd><a href="http://www.w3.org/TR/discovery-api/">http://www.w3.org/TR/discovery-api/</a></dd>
+
+
+ <dt>Latest editor's draft:</dt>
+ <dd><a href="http://dvcs.w3.org/hg/dap/raw-file/tip/discovery-api/Overview.html">http://dvcs.w3.org/hg/dap/raw-file/tip/discovery-api/Overview.html</a></dd>
+
+
+
+
+
+ <dt>Previous version:</dt>
+ <dd><a href="http://www.w3.org/TR/2012/WD-discovery-api-20120807/">http://www.w3.org/TR/2012/WD-discovery-api-20120807/</a></dd>
+
+
+ <dt>Editors:</dt>
+ <dd><span>Rich Tibbett</span>, <a href="http://opera.com/">Opera Software ASA</a></dd>
+<dd><span>Clarke Stevens</span>, <a href="http://cablelabs.com/">CableLabs</a></dd>
+
+
+ </dl>
+
+
+
+
+
+ <p class="copyright">
+ <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright">Copyright</a> ©
+ 2012
+
+ <a href="http://www.w3.org/"><abbr title="World Wide Web Consortium">W3C</abbr></a><sup>®</sup>
+ (<a href="http://www.csail.mit.edu/"><abbr title="Massachusetts Institute of Technology">MIT</abbr></a>,
+ <a href="http://www.ercim.eu/"><abbr title="European Research Consortium for Informatics and Mathematics">ERCIM</abbr></a>,
+ <a href="http://www.keio.ac.jp/">Keio</a>), All Rights Reserved.
+ <abbr title="World Wide Web Consortium">W3C</abbr> <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>,
+ <a href="http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a> and
+ <a href="http://www.w3.org/Consortium/Legal/copyright-documents">document use</a> rules apply.
+ </p>
+
+
+ <hr>
+</div>
+ <section id="abstract" class="introductory"><h2>Abstract</h2>
+ <p>
+ This specification defines a mechanism for an HTML document to discover and subsequently communicate with
+ <abbr title="Hypertext Transfer Protocol">HTTP</abbr>-based services advertised via common discovery protocols
+ within the current network.
+ </p>
+ </section><section id="sotd" class="introductory"><h2>Status of This Document</h2>
+
+
+
+ <p>
+ <em>This section describes the status of this document at the time of its publication. Other
+ documents may supersede this document. A list of current <abbr title="World Wide Web Consortium">W3C</abbr> publications and the latest revision
+ of this technical report can be found in the <a href="http://www.w3.org/TR/"><abbr title="World Wide Web Consortium">W3C</abbr> technical reports
+ index</a> at http://www.w3.org/TR/.</em>
+ </p>
+
+ <p>
+ This document represents the early consensus of the group on the scope and features of the proposed <abbr title="Application Programming Interface">API</abbr>.
+ </p>
+
+ <p>
+ This document was published by the <a href="http://www.w3.org/2009/dap/">Device APIs Working Group</a> as a Working Draft.
+
+ This document is intended to become a <abbr title="World Wide Web Consortium">W3C</abbr> Recommendation.
+
+ If you wish to make comments regarding this document, please send them to
+ <a href="mailto:public-device-apis@w3.org">public-device-apis@w3.org</a>
+ (<a href="mailto:public-device-apis-request@w3.org?subject=subscribe">subscribe</a>,
+ <a href="http://lists.w3.org/Archives/Public/public-device-apis/">archives</a>).
+
+
+ All feedback is welcome.
+ </p>
+
+ <p>
+ Publication as a Working Draft does not imply endorsement by the <abbr title="World Wide Web Consortium">W3C</abbr> Membership.
+ This is a draft document and may be updated, replaced or obsoleted by other documents at
+ any time. It is inappropriate to cite this document as other than work in progress.
+ </p>
+
+
+ <p>
+
+ This document was produced by a group operating under the
+ <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/">5 February 2004 <abbr title="World Wide Web Consortium">W3C</abbr> Patent Policy</a>.
+
+
+
+
+ <abbr title="World Wide Web Consortium">W3C</abbr> maintains a <a href="http://www.w3.org/2004/01/pp-impl/43696/status" rel="disclosure">public list of any patent disclosures</a>
+
+ made in connection with the deliverables of the group; that page also includes instructions for
+ disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains
+ <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#def-essential">Essential Claim(s)</a> must disclose the
+ information in accordance with <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#sec-Disclosure">section
+ 6 of the <abbr title="World Wide Web Consortium">W3C</abbr> Patent Policy</a>.
+
+
+ </p>
+
+
+
+
+</section><section id="toc"><h2 class="introductory">Table of Contents</h2><ul class="toc"><li class="tocline"><a href="#introduction" class="tocxref"><span class="secno">1. </span>
+ Introduction
+ </a></li><li class="tocline"><a href="#conformance" class="tocxref"><span class="secno">2. </span>Conformance</a><ul class="toc"><li class="tocline"><a href="#dependencies" class="tocxref"><span class="secno">2.1 </span>
+ Dependencies
+ </a></li></ul></li><li class="tocline"><a href="#terminology" class="tocxref"><span class="secno">3. </span>
+ Terminology
+ </a></li><li class="tocline"><a href="#requesting-networked-services" class="tocxref"><span class="secno">4. </span>
+ Requesting networked services
+ </a><ul class="toc"><li class="tocline"><a href="#methods" class="tocxref"><span class="secno">4.1 </span>
+ Methods
+ </a></li><li class="tocline"><a href="#error-handling" class="tocxref"><span class="secno">4.2 </span>
+ Error Handling
+ </a></li></ul></li><li class="tocline"><a href="#obtaining-networked-services" class="tocxref"><span class="secno">5. </span>
+ Obtaining networked services
+ </a><ul class="toc"><li class="tocline"><a href="#attributes" class="tocxref"><span class="secno">5.1 </span>
+ Attributes
+ </a></li><li class="tocline"><a href="#methods-1" class="tocxref"><span class="secno">5.2 </span>
+ Methods
+ </a></li><li class="tocline"><a href="#events" class="tocxref"><span class="secno">5.3 </span>
+ Events
+ </a></li></ul></li><li class="tocline"><a href="#communicating-with-a-networked-service" class="tocxref"><span class="secno">6. </span>
+ Communicating with a networked service
+ </a><ul class="toc"><li class="tocline"><a href="#attributes-1" class="tocxref"><span class="secno">6.1 </span>
+ Attributes
+ </a></li><li class="tocline"><a href="#states" class="tocxref"><span class="secno">6.2 </span>
+ States
+ </a></li><li class="tocline"><a href="#events-1" class="tocxref"><span class="secno">6.3 </span>
+ Events
+ </a></li></ul></li><li class="tocline"><a href="#service-discovery" class="tocxref"><span class="secno">7. </span>
+ Service Discovery
+ </a><ul class="toc"><li class="tocline"><a href="#zeroconf-mdns-dns-sd" class="tocxref"><span class="secno">7.1 </span>
+ Zeroconf (<abbr title="Multicast DNS">mDNS</abbr> + <abbr title="Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr>)
+ </a></li><li class="tocline"><a href="#simple-service-discovery-protocol-ssdp" class="tocxref"><span class="secno">7.2 </span>
+ Simple Service Discovery Protocol (<abbr title="Simple Service Discovery Protocol">SSDP</abbr>)
+ </a></li><li class="tocline"><a href="#network-topology-monitoring" class="tocxref"><span class="secno">7.3 </span>
+ Network Topology Monitoring
+ </a></li></ul></li><li class="tocline"><a href="#events-summary" class="tocxref"><span class="secno">8. </span>
+ Events Summary
+ </a></li><li class="tocline"><a href="#garbage-collection" class="tocxref"><span class="secno">9. </span>
+ Garbage collection
+ </a></li><li class="tocline"><a href="#use-cases-and-requirements" class="tocxref"><span class="secno">10. </span>
+ Use Cases and Requirements
+ </a></li><li class="tocline"><a href="#examples" class="tocxref"><span class="secno">A. </span>
+ Examples
+ </a></li><li class="tocline"><a href="#acknowledgements" class="tocxref"><span class="secno">B. </span>
+ Acknowledgements
+ </a></li><li class="tocline"><a href="#references" class="tocxref"><span class="secno">C. </span>References</a><ul class="toc"><li class="tocline"><a href="#normative-references" class="tocxref"><span class="secno">C.1 </span>Normative references</a></li></ul></li></ul></section>
+
+ <section class="informative" id="introduction">
+ <!--OddPage--><h2><span class="secno">1. </span>
+ Introduction
+ </h2><p><em>This section is non-normative.</em></p>
+ <p>
+ To enable Web pages to connect and communicate with Local-networked Services provided over <abbr title="Hypertext Transfer Protocol">HTTP</abbr>, this
+ specification introduces the <a href="#navigatornetworkservice"><code>NavigatorNetworkService</code></a>
+ interface.
+ </p>
+ <p>
+ Using this <abbr title="Application Programming Interface">API</abbr> consists of requesting a well-known
+ service type, known by developers and advertised by Local-networked Devices. User authorization, where the user
+ connects the web page to one or more discovered services, is expected before the web page is able to interact
+ with any Local-networked Services.
+ </p>
+ <p>
+ A web page creates a request to obtain connectivity to services running in the network by specifying a
+ well-known discovery service type that it wishes to interact with.
+ </p>
+ <p>
+ The user agent, having captured all advertised services on the network from the Service Discovery mechanisms
+ included in this recommendation, attempts to match the requested service type to a discovered service according
+ to the processing described herein.
+ </p>
+ <p>
+ If a service connectivity request is successful then the Web page is provided with the necessary information to
+ communicate with the authorized Local-networked Service. If the request fails then the Web page will receive an
+ error callback containing an error code describing the cause of Local-networked Service connectivity failure.
+ </p>
+ <p>
+ Once connected to a Local-networked Service the Web page can send requests and receive responses to the
+ Local-networked Service via the messaging format and appropriate channel inferred from the service type
+ authorized via the provided <abbr title="Application Programming Interface">API</abbr>. The Web page, once connected, can also receive service-pushed events, in the
+ messaging format supported by the Local-networked Device, if such event subscription functionality is provided
+ by the connected Local-networked Service.
+ </p>
+ <div class="example">
+ <p>
+ Example of requesting a <abbr title="Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr> advertised service:
+ </p>
+ <hr>
+ <pre class="highlight prettyprint"><span class="kwd">function</span><span class="pln"> showServices</span><span class="pun">(</span><span class="pln"> services </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ </span><span class="com">// Show a list of all the services provided to the web page</span><span class="pln">
+ </span><span class="kwd">for</span><span class="pun">(</span><span class="kwd">var</span><span class="pln"> i </span><span class="pun">=</span><span class="pln"> </span><span class="lit">0</span><span class="pun">,</span><span class="pln"> l </span><span class="pun">=</span><span class="pln"> services</span><span class="pun">.</span><span class="pln">length</span><span class="pun">;</span><span class="pln"> i </span><span class="pun"><</span><span class="pln"> l</span><span class="pun">;</span><span class="pln"> i</span><span class="pun">++)</span><span class="pln"> console</span><span class="pun">.</span><span class="pln">log</span><span class="pun">(</span><span class="pln"> services</span><span class="pun">[</span><span class="pln">i</span><span class="pun">].</span><span class="pln">name </span><span class="pun">);</span><span class="pln">
+</span><span class="pun">}</span><span class="pln">
+
+navigator</span><span class="pun">.</span><span class="pln">getNetworkServices</span><span class="pun">(</span><span class="str">'zeroconf:_boxee-jsonrpc._tcp'</span><span class="pun">,</span><span class="pln"> showServices</span><span class="pun">);</span></pre>
+ </div>
+ <div class="example">
+ <p>
+ Example of requesting a UPnP advertised service, also handling error conditions:
+ </p>
+ <hr>
+ <pre class="highlight prettyprint"><span class="kwd">function</span><span class="pln"> showServices</span><span class="pun">(</span><span class="pln"> services </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ </span><span class="com">// Show a list of all the services provided to the web page</span><span class="pln">
+ </span><span class="kwd">for</span><span class="pun">(</span><span class="kwd">var</span><span class="pln"> i </span><span class="pun">=</span><span class="pln"> </span><span class="lit">0</span><span class="pun">,</span><span class="pln"> l </span><span class="pun">=</span><span class="pln"> services</span><span class="pun">.</span><span class="pln">length</span><span class="pun">;</span><span class="pln"> i </span><span class="pun"><</span><span class="pln"> l</span><span class="pun">;</span><span class="pln"> i</span><span class="pun">++)</span><span class="pln"> console</span><span class="pun">.</span><span class="pln">log</span><span class="pun">(</span><span class="pln"> services</span><span class="pun">[</span><span class="pln">i</span><span class="pun">].</span><span class="pln">name </span><span class="pun">);</span><span class="pln">
+</span><span class="pun">}</span><span class="pln">
+
+</span><span class="kwd">function</span><span class="pln"> error</span><span class="pun">(</span><span class="pln"> e </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ console</span><span class="pun">.</span><span class="pln">log</span><span class="pun">(</span><span class="pln"> </span><span class="str">"Error occurred: "</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> e</span><span class="pun">.</span><span class="pln">code </span><span class="pun">);</span><span class="pln">
+</span><span class="pun">}</span><span class="pln">
+
+navigator</span><span class="pun">.</span><span class="pln">getNetworkServices</span><span class="pun">(</span><span class="str">'upnp:urn:schemas-upnp-org:service:ContentDirectory:1'</span><span class="pun">,</span><span class="pln"> showServices</span><span class="pun">,</span><span class="pln"> error</span><span class="pun">);</span></pre>
+ </div>
+ <div class="example">
+ <p>
+ Example of requesting either a <abbr title="Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr> or UPnP advertised service:
+ </p>
+ <hr>
+ <pre class="highlight prettyprint"><span class="kwd">function</span><span class="pln"> showServices</span><span class="pun">(</span><span class="pln"> services </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ </span><span class="com">// Show a list of all the services provided to the web page (+ service type)</span><span class="pln">
+ </span><span class="kwd">for</span><span class="pun">(</span><span class="kwd">var</span><span class="pln"> i </span><span class="pun">=</span><span class="pln"> </span><span class="lit">0</span><span class="pun">,</span><span class="pln"> l </span><span class="pun">=</span><span class="pln"> services</span><span class="pun">.</span><span class="pln">length</span><span class="pun">;</span><span class="pln"> i </span><span class="pun"><</span><span class="pln"> l</span><span class="pun">;</span><span class="pln"> i</span><span class="pun">++)</span><span class="pln">
+ console</span><span class="pun">.</span><span class="pln">log</span><span class="pun">(</span><span class="pln"> services</span><span class="pun">[</span><span class="pln">i</span><span class="pun">].</span><span class="pln">name </span><span class="pun">+</span><span class="pln"> </span><span class="str">'('</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> services</span><span class="pun">[</span><span class="pln">i</span><span class="pun">].</span><span class="pln">type </span><span class="pun">+</span><span class="pln"> </span><span class="str">')'</span><span class="pln"> </span><span class="pun">);</span><span class="pln">
+</span><span class="pun">}</span><span class="pln">
+
+navigator</span><span class="pun">.</span><span class="pln">getNetworkServices</span><span class="pun">([</span><span class="pln">
+ </span><span class="str">'zeroconf:_boxee-jsonrpc._tcp'</span><span class="pun">,</span><span class="pln">
+ </span><span class="str">'upnp:urn:schemas-upnp-org:service:ContentDirectory:1'</span><span class="pln">
+</span><span class="pun">],</span><span class="pln"> showServices</span><span class="pun">);</span></pre>
+ </div>
+ <p>
+ For more detailed examples see the <a href="#examples">Examples</a> section.
+ </p>
+ </section>
+ <section id="conformance"><!--OddPage--><h2><span class="secno">2. </span>Conformance</h2>
+<p>
+ As well as sections marked as non-normative, all authoring guidelines, diagrams, examples,
+ and notes in this specification are non-normative. Everything else in this specification is
+ normative.
+</p>
+<p>
+ The key words <em class="rfc2119" title="must">must</em>, <em class="rfc2119" title="must not">must not</em>, <em class="rfc2119" title="required">required</em>, <em class="rfc2119" title="should">should</em>, <em class="rfc2119" title="should not">should not</em>, <em class="rfc2119" title="recommended">recommended</em>, <em class="rfc2119" title="may">may</em>,
+ and <em class="rfc2119" title="optional">optional</em> in this specification are to be interpreted as described in [<cite><a class="bibref" href="#bib-RFC2119">RFC2119</a></cite>].
+</p>
+
+ <p>
+ Requirements phrased in the imperative as part of algorithms (such as "strip any leading space characters" or
+ "return false and abort these steps") are to be interpreted with the meaning of the key word ("must", "should",
+ "may", etc) used in introducing the algorithm.
+ </p>
+ <p>
+ Some conformance requirements are phrased as requirements on attributes, methods or objects. Such requirements
+ are to be interpreted as requirements on user agents.
+ </p>
+ <p>
+ Conformance requirements phrased as algorithms or specific steps <em class="rfc2119" title="may">may</em> be implemented in any
+ manner, so long as the end result is equivalent. (In particular, the algorithms defined in this specification
+ are intended to be easy to follow, and not intended to be performant.)
+ </p>
+ <p>
+ The only conformance class defined by this specification is a <dfn id="dfn-user-agent">user agent</dfn>.
+ </p>
+ <p>
+ User agents <em class="rfc2119" title="may">may</em> impose implementation-specific limits on otherwise unconstrained inputs,
+ e.g. to prevent denial of service attacks, to guard against running out of memory, or to work around
+ platform-specific limitations.
+ </p>
+ <p>
+ When support for a feature is disabled (e.g. as an emergency measure to mitigate a security problem, or to aid
+ in development, or for performance reasons), user agents <em class="rfc2119" title="must">must</em> act as if they had no support
+ for the feature whatsoever, and as if the feature was not mentioned in this specification. For example, if a
+ particular feature is accessed via an attribute in a Web IDL interface, the attribute itself would be omitted
+ from the objects that implement that interface - leaving the attribute on the object but making it return null
+ or throw an exception is insufficient.
+ </p>
+ <section id="dependencies">
+ <h3><span class="secno">2.1 </span>
+ Dependencies
+ </h3>This specification relies on several other underlying specifications.
+ <dl>
+ <dt>
+ HTML
+ </dt>
+ <dd>
+ Many fundamental concepts from HTML are used by this specification. [<cite><a class="bibref" href="#bib-HTML5">HTML5</a></cite>]
+ </dd>
+ <dt>
+ WebIDL
+ </dt>
+ <dd>
+ The IDL blocks in this specification use the semantics of the WebIDL specification. [<cite><a class="bibref" href="#bib-WEBIDL">WEBIDL</a></cite>]
+ </dd>
+ </dl>
+ </section>
+ </section>
+ <section id="terminology">
+ <!--OddPage--><h2><span class="secno">3. </span>
+ Terminology
+ </h2>
+ <p>
+ The construction "a <code>Foo</code> object", where <code>Foo</code> is actually an interface, is sometimes
+ used instead of the more accurate "an object implementing the interface <code>Foo</code>".
+ </p>
+ <p>
+ The term DOM is used to refer to the <abbr title="Application Programming Interface">API</abbr> set made available to scripts in Web applications, and does not
+ necessarily imply the existence of an actual <code>Document</code> object or of any other <code>Node</code>
+ objects as defined in the DOM Core specifications. [<cite><a class="bibref" href="#bib-DOM4">DOM4</a></cite>]
+ </p>
+ <p>
+ An IDL attribute is said to be <em>getting</em> when its value is being retrieved (e.g. by author script), and
+ is said to be <em>setting</em> when a new value is assigned to it.
+ </p>
+ <p>
+ A <dfn id="dfn-valid-service-type">valid service type</dfn> is a string that begins with <code>upnp:</code> or <code>zeroconf:</code>
+ followed by one or more characters in the ranges U+0021, U+0023 to U+0027, U+002A to U+002B, U+002D to U+002E,
+ U+0030 to U+0039, U+0041 to U+005A, U+005E to U+007E.
+ </p>
+ <p>
+ A <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> provided in the <code>type</code> attribute of the <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> method will be matched against the
+ services currently contained in the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a> according to the algorithms
+ defined in this specification.
+ </p>
+ <p>
+ A <dfn id="dfn-user-agent-generated-callback-url">user-agent generated callback url</dfn> is a Local-network accessible <abbr title="Uniform Resource Locator">URL</abbr> endpoint that a <a href="#dfn-user-agent" class="internalDFN">user
+ agent</a> generates and maintains for receiving <abbr title="Hypertext Transfer Protocol">HTTP</abbr> NOTIFY requests from UPnP Event sources. It is only
+ required when the user agent implements UPnP Service Discovery as defined in this specification.
+ </p>
+ </section>
+ <section id="requesting-networked-services">
+ <!--OddPage--><h2><span class="secno">4. </span>
+ Requesting networked services
+ </h2>
+ <pre class="widl">[Supplemental, NoInterfaceObject]
+interface <dfn id="navigatornetworkservice">NavigatorNetworkService</dfn> {
+ // Obtain a Local-networked Service
+ void <a href="#dom-navigator-getnetworkservices">getNetworkServices</a>( in any type,
+ in <a href="#navigatornetworkservicesuccesscallback">NavigatorNetworkServiceSuccessCallback</a> successCallback,
+ in optional <a href="#navigatornetworkserviceerrorcallback">NavigatorNetworkServiceErrorCallback</a> errorCallback );
+};
+<a class="externalDFN" href="http://www.whatwg.org/specs/web-apps/current-work/complete/timers.html#navigator">Navigator</a> implements <a href="#navigatornetworkservice">NavigatorNetworkService</a>;
+
+[Callback=FunctionOnly, NoInterfaceObject]
+interface <dfn id="navigatornetworkservicesuccesscallback">NavigatorNetworkServiceSuccessCallback</dfn> {
+ void handleEvent( in <a href="#networkservices">NetworkServices</a> services );
+};
+
+[NoInterfaceObject]
+interface <dfn id="navigatornetworkserviceerror">NavigatorNetworkServiceError</dfn> {
+ const unsigned short <a href="#dom-navigatornetworkserviceerror-permission_denied">PERMISSION_DENIED_ERR</a> = 1;
+ const unsigned short <a href="#dom-navigatornetworkserviceerror-unknown_type_prefix">UNKNOWN_TYPE_PREFIX_ERR</a> = 2;
+ readonly attribute unsigned short <a href="#dom-navigatornetworkserviceerror-code">code</a>;
+};
+
+[Callback=FunctionOnly, NoInterfaceObject]
+interface <dfn id="navigatornetworkserviceerrorcallback">NavigatorNetworkServiceErrorCallback</dfn> {
+ void handleEvent( in <a href="#navigatornetworkserviceerror">NavigatorNetworkServiceError</a> error );
+};
+</pre>
+ <section id="methods">
+ <h3><span class="secno">4.1 </span>
+ Methods
+ </h3>
+ <dl class="domintro">
+ <dt>
+ <var title="">window</var> . <code title="dom-navigator"><a href="http://www.whatwg.org/specs/web-apps/current-work/complete/timers.html#navigator">navigator</a></code> .
+ <code title="dom-navigator-getNetworkServices"><a href="#dom-navigator-getnetworkservices">getNetworkServices</a></code> ( <var title="">type</var> , <var title="">successCallback</var> [, <var title="">errorCallback</var> ] )
+ </dt>
+ <dd>
+ <p>
+ Prompts the user to select one or more discovered network services that have advertised support for the
+ requested service type.
+ </p>
+ <p>
+ The <var title="">type</var> argument contains one or more <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> tokens that the web
+ page would like to interact with.
+ </p>
+ <p>
+ If the user accepts, the <var title="">successCallback</var> is invoked, with one or more <a href="#networkservice"><code>NetworkService</code></a> objects as its argument.
+ </p>
+ <p>
+ If the user declines, the <var title="">errorCallback</var> (if any) is invoked.
+ </p>
+ </dd>
+ </dl>
+ <div>
+ <p>
+ When the <dfn id="dom-navigator-getnetworkservices" title="dom-navigator-getnetworkservices"><code>getNetworkServices(type, successCallback[,
+ errorCallback])</code></dfn> method is called, the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> run the
+ following steps:
+ </p>
+ <ol class="rule">
+ <li>Let <var>requested control types</var> be initially set to an empty array.
+ </li>
+ <li>If <var>type</var> is an array consisting of one or more <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> tokens, then let
+ <var>requested control types</var> by the value of <var>type</var>, removing any non-<a href="#dfn-valid-service-type" class="internalDFN">valid service
+ type</a> tokens from the resulting array.
+ </li>
+ <li>If <var>type</var> is a string consisting of one <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> token, then let
+ <var>requested control types</var> be an array containing one item with a value of <var>type</var>.
+ </li>
+ <li>If <var>requested control types</var> is an array that contains at least one or more <a title="valid service type" href="#dfn-valid-service-type" class="internalDFN">valid service type</a> tokens then continue to the step labeled <em>process</em>
+ below. Otherwise, the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an
+ object of type <code>Function</code>, with a new <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose <a href="#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 2
+ (<a href="#dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></a>) as
+ its argument, abort any remaining steps and return.
+ </li>
+ <li>
+ <em>Process</em>: Let <var>services found</var> be an empty array.
+ </li>
+ <li>For each <var>available service</var> in the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a> run the following
+ steps:
+ <ol class="rule">
+ <li>For each <var>requested control type</var> in <var>requested control types</var>: If <var>available
+ service</var>'s <code>type</code> attribute equals the <var>requested control type</var> then let <var>
+ matched service</var> equal the value of <var>available service</var> and continue at the step
+ labeled <var>attach</var> below.
+ </li>
+ <li>Continue at the next <var>available service</var>.
+ </li>
+ <li>
+ <em>Attach</em>: If <var>matched service</var> is not empty then run the following steps:
+ <ol class="rule">
+ <li>Let <var>new service object</var> be a new <a href="#networkservice"><code>NetworkService</code></a> object, mapping the parameters of <var>matched
+ service</var> to this new object where possible.
+ </li>
+ <li>Append <var>new service object</var> to the <var>services found</var> array.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ </li>
+ <li>If <var>services found</var> is an empty array, then the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em>
+ <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an
+ object of type <code>Function</code>, with a new <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose <a href="#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
+ (<a href="#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its
+ argument, abort any remaining steps and return.
+ </li>
+ <li>Return, and run the remaining steps asynchronously.
+ </li>
+ <li>Optionally, e.g. based on a previously-established user preference, for security reasons, or due to
+ platform limitations, the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="may">may</em> <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an
+ object of type <code>Function</code>, with a new <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose <a href="#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
+ (<a href="#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its
+ argument, abort any remaining steps and return.
+ </li>
+ <li>The <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> prompt the user in a user-agent-specific manner for
+ permission to provide the <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/browsers.html#entry-script" class="externalDFN">entry script</a>'s <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/origin-0.html#origin" class="externalDFN">origin</a> with an array of <a href="#networkservice"><code>NetworkService</code></a> objects representing the user-authorized subset of
+ <var>services found</var>.
+ <p>
+ If the user grants permission to access one or more networked services then the <a href="#dfn-user-agent" class="internalDFN">user agent</a>
+ <em class="rfc2119" title="should">should</em> include an "ongoing local-network communication" indicator.
+ </p>
+ <p>
+ If the user denies permission, then the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an
+ object of type <code>Function</code>, with a new <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose <a href="#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
+ (<a href="#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its
+ argument, abort any remaining steps and return.
+ </p>
+ <p>
+ If the user never responds, this algorithm stalls on this step.
+ </p>
+ </li>
+ <li>Let <var>services</var> be the array of one or more <a href="#networkservice"><code>NetworkService</code></a> objects for which the user granted permission.
+ </li>
+ <li>For each Object <var>service</var> in <var>services</var>, run the following sub-steps:
+ <ol class="rule">
+ <li>Add the <var>service</var>'s <code>url</code> parameter to the <a href="#dfn-entry-script-origin-s-url-whitelist" class="internalDFN">entry script origin's
+ <abbr title="Uniform Resource Locator">URL</abbr> whitelist</a>.
+ </li>
+ <li>If <var>service</var>'s <code>type</code> parameter begins with the DOMString "<code>upnp:</code>"
+ and the <var>service</var>'s <code>eventsUrl</code> parameter is not empty then <a href="#dfn-setup-a-upnp-events-subscription" class="internalDFN">setup a UPnP Events
+ Subscription</a> for <var>service</var>.
+ </li>
+ </ol>
+ </li>
+ <li>Let <var>services manager</var> be a new <a href="#networkservices"><code>NetworkServices</code></a>
+ object.
+ </li>
+ <li>Set <var>services manager</var>'s <a href="#dom-networkservices-servicesavailable"><code>servicesAvailable</code></a> attribute to the number of
+ services currently found in the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a> whose <code>type</code> property
+ matches any of the tokens requested in <var>requested control types</var>.
+ </li>
+ <li>Add the set of <var>services</var> to the <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a> internally against
+ the newly created <var>services manager</var> object.
+ </li>
+ <li>The <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to invoke <var>successCallback</var> with <var>services
+ manager</var> as its argument.
+ </li>
+ </ol>
+ <p>
+ The <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#task-source" class="externalDFN">task source</a> for these <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#concept-task" class="externalDFN">tasks</a> is the <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#user-interaction-task-source" class="externalDFN">user interaction task source</a>.
+ </p>
+ <p>
+ When a <a href="#networkservice"><code>NetworkService</code></a> object is provided to a Web page, the
+ <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> add the <code>url</code> property to the <dfn id="dfn-entry-script-origin-s-url-whitelist">entry script
+ origin's <abbr title="Uniform Resource Locator">URL</abbr> whitelist</dfn>. This list enables the Web page to override and initiate cross-site resource
+ requests towards these URLs, and any sub-resources of these URLs, within the current <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/browsers.html#entry-script" class="externalDFN">entry script</a>'s <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/origin-0.html#origin" class="externalDFN">origin</a> via various existing mechanisms (e.g. Web Sockets, Server-Sent Events,
+ Web Messaging, XMLHttpRequest).
+ </p>
+ <p>
+ If the user navigates away from the current browsing context, the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="ct"><em class="rfc2119" title="must">must</em></em> remove all previously whitelisted urls from the <a href="#dfn-entry-script-origin-s-url-whitelist" class="internalDFN">entry script origin's <abbr title="Uniform Resource Locator">URL</abbr> whitelist</a>.
+ There is no persistence to network service selections provided to a web page. It is not possible to access
+ a previously white-listed networked service without the necessary user authorization in all of the
+ following cases:
+ </p>
+ <ul>
+ <li>If the current script is reloaded at any point in the same or different window.
+ </li>
+ <li>if the current script reinvokes the <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> method at any point in its
+ execution.
+ </li>
+ <li>If the user navigates forward or back in their history to reload the current page.
+ </li>
+ <li>If a script is running in a different origin.
+ </li>
+ </ul>
+ </div>
+ </section>
+ <section id="error-handling">
+ <h3><span class="secno">4.2 </span>
+ Error Handling
+ </h3>
+ <dl class="domintro">
+ <dt>
+ <var title="">error</var> . <code title="dom-NavigatorNetworkServiceError-code"><a href="#dom-navigatornetworkserviceerror-code">code</a></code>
+ </dt>
+ <dd>
+ <p>
+ Returns the current error's error code. At the current time, this will be <code>1</code> or
+ <code>2</code>, for which the corresponding error constants <a href="#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a> and <a href="#dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></a> are
+ defined.
+ </p>
+ </dd>
+ </dl>
+ <p>
+ The <dfn id="dom-navigatornetworkserviceerror-code" title="dom-navigatornetworkserviceerror-code"><code>code</code></dfn> attribute of a <a href="#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object <em class="ct"><em class="rfc2119" title="must">must</em></em> return the code for the error, which will be one of the following:
+ </p>
+ <dl>
+ <dt>
+ <dfn id="dom-navigatornetworkserviceerror-permission_denied" title="dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></dfn>
+ (numeric value 1)
+ </dt>
+ <dd>
+ The user or user agent denied the page permission to access any services.
+ </dd>
+ <dt>
+ <dfn id="dom-navigatornetworkserviceerror-unknown_type_prefix" title="dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></dfn>
+ (numeric value 2)
+ </dt>
+ <dd>
+ No <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> tokens were provided in the method invocation.
+ </dd>
+ </dl>
+ </section>
+ </section>
+ <section id="obtaining-networked-services">
+ <!--OddPage--><h2><span class="secno">5. </span>
+ Obtaining networked services
+ </h2>
+ <p>
+ The <a href="#networkservices"><code>NetworkServices</code></a> interface is the top-level response object from
+ a call to <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> and provides access
+ to a set of user-authorized <a href="#networkservice"><code>NetworkService</code></a> objects for the given
+ request.
+ </p>
+ <pre class="widl">[NoInterfaceObject]
+interface <dfn id="networkservices">NetworkServices</dfn> {
+ readonly attribute unsigned long <a href="#dom-networkservices-length">length</a>;
+ getter <a href="#networkservice">NetworkService</a> (unsigned long index);
+ <a href="#networkservice">NetworkService</a>? <a href="#dom-networkservices-getservicebyid">getServiceById</a>(DOMString id);
+
+ readonly attribute unsigned long <a href="#dom-networkservices-servicesavailable">servicesAvailable</a>;
+
+ // event handler attributes
+ attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler" class="externalDFN">EventHandler</a> <a href="#dom-networkservices-onserviceavailable">onserviceavailable</a>;
+ attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler" class="externalDFN">EventHandler</a> <a href="#dom-networkservices-onserviceunavailable">onserviceunavailable</a>;
+
+};
+
+<a href="#networkservices">NetworkServices</a> implements <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#interface-eventtarget" class="externalDFN">EventTarget</a>;
+</pre>
+ <section id="attributes">
+ <h3><span class="secno">5.1 </span>
+ Attributes
+ </h3>
+ <dl class="domintro">
+ <dt>
+ <code title="dom-networkservices-length"><a href="#dom-networkservices-length">length</a></code>
+ </dt>
+ <dd>
+ <p>
+ Returns the current number of services belonging in the respective object's <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service
+ records</a>.
+ </p>
+ </dd>
+ <dt>
+ <code title="dom-networkservices-servicesavailable"><a href="#dom-networkservices-servicesavailable">servicesAvailable</a></code>
+ </dt>
+ <dd>
+ <p>
+ Returns the current number of services matching one of the app-requested <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> tokens
+ in the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>.
+ </p>
+ </dd>
+ </dl>
+ <div>
+ <p>
+ The <dfn id="dom-networkservices-length"><code>length</code></dfn> attribute <em class="rfc2119" title="must">must</em>
+ return the number of services represented in the object's corresponding <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service
+ records</a> at the time of getting.
+ </p>
+ <p>
+ The <dfn id="dom-networkservices-servicesavailable"><code>servicesAvailable</code></dfn> attribute
+ <em class="rfc2119" title="must">must</em> return the number of services in the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>
+ whose <code>type</code> attribute matches any of the <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> tokens that was initially
+ used to create the current <a href="#networkservices"><code>NetworkServices</code></a> object.
+ </p>
+ </div>
+ </section>
+ <section id="methods-1">
+ <h3><span class="secno">5.2 </span>
+ Methods
+ </h3>
+ <dl class="domintro">
+ <dt>
+ <code title="networkservices-getter"><a href="#networkservices">services</a></code> [ <var title="">index</var> ]
+ </dt>
+ <dd>
+ <p>
+ Returns the specified <a href="#networkservice"><code>NetworkService</code></a> object.
+ </p>
+ </dd>
+ <dt>
+ <code title="networkservices-getter"><a href="#networkservices">services</a></code> . <code title="dom-networkservices-getservicebyid"><a href="#dom-networkservices-getservicebyid">getServiceById</a></code> ( <var title="">id</var> )
+ </dt>
+ <dd>
+ <p>
+ Returns the <a href="#networkservice"><code>NetworkService</code></a> object with the given identifier,
+ or null if no service has that identifier.
+ </p>
+ </dd>
+ </dl>
+ <p>
+ A <a href="#networkservices"><code>NetworkServices</code></a> object represents the current list of one or
+ more current authorized services - the <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a>. Each item in the <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of
+ authorized service records</a> is represented by a <a href="#networkservice"><code>NetworkService</code></a>
+ object. The <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a> is <span>immutable</span> meaning that it cannot be
+ modified for the lifetime of a <a href="#networkservices"><code>NetworkServices</code></a> object.
+ </p>
+ <div class="note"><div class="note-title"><span>Note</span></div><p class="">
+ Each service in a <a href="#networkservices"><code>NetworkServices</code></a> object thus has an index; the
+ first has the index 0, and each subsequent service is numbered one higher than the previous one.
+ </p></div>
+ <p>
+ The <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/infrastructure.html#supported-property-indices" class="externalDFN">supported property indices</a> of <a href="#networkservices"><code>NetworkServices</code></a> objects at any instant are the numbers from zero to
+ the number of items in the <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a> represented by the respective object
+ minus one, if any services are represented in the <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a>.
+ </p>
+ <p>
+ To <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/infrastructure.html#determine-the-value-of-an-indexed-property" class="externalDFN">determine the value of an indexed property</a> for a given index <var>index</var> in a
+ <a href="#networkservices"><code>NetworkServices</code></a> object's <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service
+ records</a>, the user agent <em class="rfc2119" title="must">must</em> return the <a href="#networkservice"><code>NetworkService</code></a> object that represents the <var>index</var>th service in
+ the <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a>.
+ </p>
+ <p>
+ The <dfn id="dom-networkservices-getservicebyid"><code>getServiceById(id)</code></dfn> method <em class="ct"><em class="rfc2119" title="must">must</em></em> return the first <a href="#networkservice"><code>NetworkService</code></a> object in the
+ <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a> represented by the respective object whose <a href="#dom-networkservice-id"><code>id</code></a> attribute is equal to the value of the <var>id</var> argument.
+ When no services in the <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a> match the given argument, the method
+ <em class="rfc2119" title="must">must</em> return null.
+ </p>
+ <p>
+ Services available within the local network can connect and disconnect at different times during the
+ execution of a web page. A <a href="#dfn-user-agent" class="internalDFN">user agent</a> can inform a web page when the state of networked services
+ matching the requested <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> change. Web pages can use this information to enable in-page
+ experiences for communicating the state of networked services with the ability to change the particular
+ service or set of services the page is connected to by re-invoking the <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> method.
+ </p>
+ </section>
+ <section id="events">
+ <h3><span class="secno">5.3 </span>
+ Events
+ </h3>
+ <p>
+ The following are the event handlers (and their corresponding event handler event types) that <em class="ct"><em class="rfc2119" title="must">must</em></em> be supported, as IDL attributes, by all objects implementing the <a href="#networkservices"><code>NetworkServices</code></a> interface:
+ </p>
+ <table border="1">
+ <thead>
+ <tr>
+ <th>
+ <span title="event handlers">Event handler</span>
+ </th>
+ <th>
+ <span>Event handler event type</span>
+ </th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <dfn id="dom-networkservices-onserviceavailable" title="dom-NetworkServices-onserviceavailable"><code>onserviceavailable</code></dfn>
+ </td>
+ <td>
+ <a href="#event-serviceavailable"><code>serviceavailable</code></a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="dom-networkservices-onserviceunavailable" title="dom-NetworkServices-onserviceunavailable"><code>onserviceunavailable</code></dfn>
+ </td>
+ <td>
+ <a href="#event-serviceunavailable"><code>serviceunavailable</code></a>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+ </section>
+ <section id="communicating-with-a-networked-service">
+ <!--OddPage--><h2><span class="secno">6. </span>
+ Communicating with a networked service
+ </h2>
+ <p>
+ The <a href="#networkservice"><code>NetworkService</code></a> interface is used to provide a set of connection
+ information for an <abbr title="Hypertext Transfer Protocol">HTTP</abbr> service endpoint and if available, service events, running on a networked device.
+ </p>
+ <pre class="widl">[NoInterfaceObject]
+interface <dfn id="networkservice">NetworkService</dfn> {
+ readonly attribute DOMString <a href="#dom-networkservice-id">id</a>;
+ readonly attribute DOMString <a href="#dom-networkservice-name">name</a>;
+ readonly attribute DOMString <a href="#dom-networkservice-type">type</a>;
+ readonly attribute DOMString <a href="#dom-networkservice-url">url</a>;
+ readonly attribute DOMString <a href="#dom-networkservice-config">config</a>;
+
+ readonly attribute boolean <a href="#dom-networkservice-online">online</a>;
+
+ // event handler attributes
+ attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler" class="externalDFN">EventHandler</a> <a href="#dom-networkservice-onserviceonline">onserviceonline</a>;
+ attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler" class="externalDFN">EventHandler</a> <a href="#dom-networkservice-onserviceoffline">onserviceoffline</a>;
+
+ attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler" class="externalDFN">EventHandler</a> <a href="#dom-networkservice-onnotify">onnotify</a>;
+};
+
+<a href="#networkservice">NetworkService</a> implements <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#interface-eventtarget" class="externalDFN">EventTarget</a>;
+</pre>
+ <section id="attributes-1">
+ <h3><span class="secno">6.1 </span>
+ Attributes
+ </h3>
+ <dl class="domintro">
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-id"><a href="#dom-networkservice-id">id</a></code>
+ </dt>
+ <dd>
+ <p>
+ A unique identifier for the given user-selected service instance.
+ </p>
+ </dd>
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-name"><a href="#dom-networkservice-name">name</a></code>
+ </dt>
+ <dd>
+ <p>
+ The name of the user-selected service.
+ </p>
+ </dd>
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-type"><a href="#dom-networkservice-type">type</a></code>
+ </dt>
+ <dd>
+ <p>
+ The <a href="#dfn-valid-service-type" class="internalDFN">valid service type</a> token value of the user-selected service.
+ </p>
+ </dd>
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-url"><a href="#dom-networkservice-url">url</a></code>
+ </dt>
+ <dd>
+ <p>
+ The control <abbr title="Uniform Resource Locator">URL</abbr> endpoint (including any required port information) of the user-selected control service
+ that has been added to the <a href="#dfn-entry-script-origin-s-url-whitelist" class="internalDFN">entry script origin's <abbr title="Uniform Resource Locator">URL</abbr> whitelist</a>.
+ </p>
+ </dd>
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-config"><a href="#dom-networkservice-config">config</a></code>
+ </dt>
+ <dd>
+ <p>
+ The configuration information associated with the service depending on the requested service type.
+ </p>
+ </dd>
+ </dl>
+ <p>
+ The <dfn id="dom-networkservice-id"><code>id</code></dfn> attribute is a unique identifier for the service.
+ The same service provided at different times or on different objects <em class="rfc2119" title="must">must</em> have the same
+ <a href="#dom-networkservice-id"><code>id</code></a> value.
+ </p>
+ <p>
+ The <dfn id="dom-networkservice-name"><code>name</code></dfn> attribute represents a human-readable title for
+ the service.
+ </p>
+ <p>
+ The <dfn id="dom-networkservice-type"><code>type</code></dfn> attribute reflects the value of the <a href="#dfn-valid-service-type" class="internalDFN">valid
+ service type</a> of the service.
+ </p>
+ <p>
+ The <dfn id="dom-networkservice-url"><code>url</code></dfn> attribute is an <a href="http://www.w3.org/TR/html5/urls.html#absolute-url" class="externalDFN">absolute <abbr title="Uniform Resource Locator">URL</abbr></a> pointing to the root <abbr title="Hypertext Transfer Protocol">HTTP</abbr> endpoint for the service that has been
+ added to the <a href="#dfn-entry-script-origin-s-url-whitelist" class="internalDFN">entry script origin's <abbr title="Uniform Resource Locator">URL</abbr> whitelist</a>. Web pages can subsequently use this value for
+ implicit cross-document messaging via various existing mechanisms (e.g. Web Sockets, Server-Sent Events,
+ Web Messaging, XMLHttpRequest).
+ </p>
+ <p>
+ The <dfn id="dom-networkservice-config"><code>config</code></dfn> attribute provides the raw configuration
+ information extracted from the given network service.
+ </p>
+ </section>
+ <section id="states">
+ <h3><span class="secno">6.2 </span>
+ States
+ </h3>
+ <dl class="domintro">
+ <dt>
+ <var title="">service</var> . <code title="dom-networkservice-online"><a href="#dom-networkservice-online">online</a></code>
+ </dt>
+ <dd>
+ <p>
+ Returns <code>true</code> if the service is reporting that it is accessible on the local network or
+ <code>false</code> if the service is reporting that it is no longer accessible (temporarily or
+ permanently) on the local network.
+ </p>
+ </dd>
+ </dl>
+ <p>
+ The <dfn id="dom-networkservice-online"><code>online</code></dfn> attribute indicates whether the service is
+ reporting itself as being either <var>online</var>, and therefore accessible on the local network, in which
+ case this attribute will return <code>true</code> or, <var>offline</var>, and therefore not accessible on the
+ local network, either temporarily or permanently, in which case this attribute will return
+ <code>false</code>. This attribute <em class="rfc2119" title="must">must</em> default to <code>true</code>.
+ </p>
+ </section>
+ <section id="events-1">
+ <h3><span class="secno">6.3 </span>
+ Events
+ </h3>
+ <p>
+ The following are the event handlers (and their corresponding event handler event types) that <em class="ct"><em class="rfc2119" title="must">must</em></em> be supported, as IDL attributes, by all objects implementing the <a href="#networkservice"><code>NetworkService</code></a> interface:
+ </p>
+ <table border="1">
+ <thead>
+ <tr>
+ <th>
+ <span title="event handlers">Event handler</span>
+ </th>
+ <th>
+ <span>Event handler event type</span>
+ </th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <dfn id="dom-networkservice-onnotify" title="dom-NetworkService-onnotify"><code>onnotify</code></dfn>
+ </td>
+ <td>
+ <a href="#event-notify"><code>notify</code></a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="dom-networkservice-onserviceonline" title="dom-NetworkService-onserviceonline"><code>onserviceonline</code></dfn>
+ </td>
+ <td>
+ <a href="#event-serviceonline"><code>serviceonline</code></a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="dom-networkservice-onserviceoffline" title="dom-NetworkService-onserviceoffline"><code>onserviceoffline</code></dfn>
+ </td>
+ <td>
+ <a href="#event-serviceoffline"><code>serviceoffline</code></a>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+ </section>
+ <section id="service-discovery">
+ <!--OddPage--><h2><span class="secno">7. </span>
+ Service Discovery
+ </h2>
+ <p>
+ A <a href="#dfn-user-agent" class="internalDFN">user agent</a> conforming to this specification <em class="rfc2119" title="may">may</em> implement <abbr title="Simple Service Discovery Protocol">SSDP</abbr> [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>] and Zeroconf [<cite><a class="bibref" href="#bib-DNS-SD">DNS-SD</a></cite>] + [<cite><a class="bibref" href="#bib-MDNS">MDNS</a></cite>]
+ service discovery mechanisms to enable Web pages to request and connect with <abbr title="Hypertext Transfer Protocol">HTTP</abbr> services running on networked
+ devices, discovered via either mechanism, through this <abbr title="Application Programming Interface">API</abbr>. When a <a href="#dfn-user-agent" class="internalDFN">user agent</a> implements either of these
+ service discovery mechanisms, then it <em class="rfc2119" title="must">must</em> conform to the corresponding algorithms provided
+ in this section of the specification.
+ </p>
+ <p>
+ This section presents how the results of these two service discovery mechanisms will be matched to requested
+ service types, how the user agent stores available and active services, how their properties are applied to any
+ resulting <a href="#networkservice"><code>NetworkService</code></a> objects.
+ </p>
+ <p>
+ It is expected that user agents will perform these service discovery mechanisms asynchronously and
+ periodically update the <a>list of networked devices</a> as required. The timing of any service discovery
+ mechanisms is an implementation detail left to the discretion of the implementer (e.g. once on user agent
+ start-up, every X seconds during user agent execution or on invocation of this <abbr title="Application Programming Interface">API</abbr> from a Web page).
+ </p>
+ <p>
+ The <dfn id="dfn-list-of-available-service-records">list of available service records</dfn> is a single dynamic internal lookup table within user agents
+ that is used to track all the services that have been discovered and are available in the current network at
+ any given time. At any point during the running of either of the two service discovery mechanisms then existing
+ entries within this table can be updated, entries can be added and entries can be removed as the status of
+ networked services changes according to the rules defined in this specification.
+ </p>
+ <p>
+ The <dfn id="dfn-list-of-authorized-service-records">list of authorized service records</dfn> is a single dynamic internal lookup table within user agents
+ that is used to track the current services that are being shared with web pages at any given time from the
+ <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>. Each record in the <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a> is
+ associated with a <var>services manager</var> object that is assigned as part of the <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> algorithm.
+ </p>
+ <p>
+ The rule for <dfn id="dfn-adding-an-available-service">adding an available service</dfn> is the process of adding a new service or updating an
+ existing service in the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a> that is generally available on the user's
+ current network. This rule takes one argument, <var>network service record</var>, and consists of running the
+ following steps:
+ </p>
+ <ol class="rule">
+ <li>Let <var>new service registration flag</var> be <code>true</code>.
+ </li>
+ <li>For each <var>existing service record</var> in the current <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>, run
+ the following sub-steps:
+ <ol class="rule">
+ <li>If the <var>existing service record</var>'s <code>id</code> property does not equal <var>network
+ service record</var>'s <code>id</code> property then abort any remaining sub-steps and continue at the next
+ available <var>existing service record</var>.
+ </li>
+ <li>Set <var>new service registration flag</var> to <code>false</code>.
+ </li>
+ <li>Replace the value of <var>existing service record</var> in the current <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service
+ records</a> with the value of <var>network service record</var>.
+ </li>
+ </ol>
+ </li>
+ <li>If <var>new service registration flag</var> is set to <code>true</code> then add <var>network service
+ record</var> to the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a> as a new entry.
+ </li>
+ <li>For each <var>active service</var> in the <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a> run the following
+ steps:
+ <ol class="rule">
+ <li>If <var>network service record</var>'s <code>type</code> property does not equal the current
+ <var>active service</var>'s <code>type</code> attribute then abort any remaining sub-steps for this
+ <var>active service</var> and continue at the next available <var>active service</var>.
+ </li>
+ <li>If the <var>new service registration flag</var> is set to <code>true</code> then increment the
+ <a href="#dom-networkservices-servicesavailable"><code>servicesAvailable</code></a> attribute of the
+ <var>services manager</var> associated with the current <var>active service</var> object by
+ <code>1</code> and then <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to dispatch a newly created event with the name <a href="#event-serviceavailable"><code>serviceavailable</code></a> that uses the <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event" class="externalDFN"><code>Event</code></a> interface, which does not bubble, is not cancellable, and
+ has no default action, at the <var>services manager</var> associated with the current <var>active
+ service</var> object.
+ </li>
+ <li>Set <var>active service</var>'s <a href="#dom-networkservice-online"><code>online</code></a> attribute
+ to <code>true</code> and then <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to dispatch a newly created event with the name <a href="#event-serviceonline"><code>serviceonline</code></a> that uses the <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event" class="externalDFN"><code>Event</code></a> interface, which does not bubble, is not cancellable, and
+ has no default action, at the current <var>active service</var> object.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ <p>
+ The rule for <dfn id="dfn-removing-an-available-service">removing an available service</dfn> is the general process of removing a service from the
+ <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a> that has left the user's current network or has otherwise expired.
+ This rule takes one argument, <var>service identifier</var>, and consists of running the following steps:
+ </p>
+ <ol class="rule">
+ <li>For each <var>existing service record</var> in the current <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>, run
+ the following sub-steps:
+ <ol class="rule">
+ <li>If the <var>existing service record</var>'s <code>id</code> property does not match <var>service
+ identifier</var> then skip any remaining sub-steps for the current <var>existing service record</var> and
+ continue at the next available <var>existing service record</var>.
+ </li>
+ <li>If the <var>existing service record</var>'s <code>type</code> property begins with the DOMString
+ "<code>upnp:</code>" and <var>existing service record</var>'s <code>eventsURL</code> property is set then
+ run the rule to <a href="#dfn-terminate-an-existing-upnp-events-subscription" class="internalDFN">terminate an existing UPnP Events Subscription</a>, if one is currently active (as a
+ result of having previously called <a href="#dfn-setup-a-upnp-events-subscription" class="internalDFN">setup a UPnP Events Subscription</a> against the current
+ <var>existing service record</var>).
+ </li>
+ <li>For each <var>active service</var> in <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a> run the following
+ steps:
+ <ol class="rule">
+ <li>If <var>existing service record</var>'s <code>type</code> property does not equal the current <var>
+ active service</var>'s <code>type</code> attribute then abort any remaining sub-steps for this
+ <var>active service</var> and continue at the next available <var>active service</var>.
+ </li>
+ <li>Decrement the <a href="#dom-networkservices-servicesavailable"><code>servicesAvailable</code></a>
+ attribute of the <var>services manager</var> associated with the current <var>active service</var>
+ object by <code>1</code> and then <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to dispatch a newly created event with the name <a href="#event-serviceunavailable"><code>serviceunavailable</code></a> that uses the <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event" class="externalDFN"><code>Event</code></a> interface, which does not bubble, is not cancellable,
+ and has no default action, at the <var>services manager</var> associated with the current
+ <var>active service</var> object.
+ </li>
+ <li>Set <var>active service</var>'s <a href="#dom-networkservice-online"><code>online</code></a>
+ attribute to <code>false</code> and then <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">queue a task</a> to dispatch a newly created event with the name <a href="#event-serviceoffline"><code>serviceoffline</code></a> that uses the <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event" class="externalDFN"><code>Event</code></a> interface, which does not bubble, is not cancellable,
+ and has no default action, at the current <var>active service</var> object.
+ </li>
+ </ol>
+ </li>
+ <li>Remove <var>existing service record</var> from the current <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ <p>
+ User agents <em class="rfc2119" title="should">should</em> expire a service record from the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service
+ records</a> when its <code>expiryTimestamp</code> attribute exceeds the current UTC timestamp. When this
+ condition is met the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="should">should</em> run the rule for <a href="#dfn-removing-an-available-service" class="internalDFN">removing an available service</a>, passing in
+ the expired service record's <code>id</code> attribute as the only argument.
+ </p>
+ <section id="zeroconf-mdns-dns-sd">
+ <h3><span class="secno">7.1 </span>
+ Zeroconf (<abbr title="Multicast DNS">mDNS</abbr> + <abbr title="Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr>)
+ </h3>
+ <p>
+ For each <abbr title="Domain Name System">DNS</abbr> response received from a user-agent-initiated Multicast <abbr title="Domain Name System">DNS</abbr> Browse for <abbr title="DNS Pointer Record">PTR</abbr> records with the name <code>_services._dns-sd._udp</code> on the resolved
+ recommended automatic browsing domain [<cite><a class="bibref" href="#bib-MDNS">MDNS</a></cite>], the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> run the
+ following steps:
+ </p>
+ <ol class="rule">
+ <li>Let <var>service <abbr title="Multicast DNS">mDNS</abbr> responses</var> be an array of <abbr title="DNS Pointer Record">PTR</abbr> records received by issuing a Multicast <abbr title="Domain Name System">DNS</abbr>
+ Browse for <abbr title="DNS Pointer Record">PTR</abbr> records with the name of the current discovered service type.
+ </li>
+ <li>For each Object <var>service <abbr title="Multicast DNS">mDNS</abbr> response</var> in <var>service <abbr title="Multicast DNS">mDNS</abbr> responses</var>, run the following
+ steps:
+ <ol>
+ <li>Let <var>network service record</var> be an Object consisting of the following empty properties:
+ <code>id</code>, <code>name</code>, <code>type</code>, <code>url</code>, <code>config</code>,
+ <code>expiryTimestamp</code>.
+ </li>
+ <li>Set <var>network service record</var>'s <code>id</code> property to the value of the full <abbr title="DNS Pointer Record">PTR</abbr> Service
+ Instance Name [<cite><a class="bibref" href="#bib-MDNS">MDNS</a></cite>].
+ </li>
+ <li>Set <var>network service record</var>'s <code>name</code> property to the value of the <abbr title="DNS Pointer Record">PTR</abbr> Service
+ Instance Name's <var>Instance</var> component [<cite><a class="bibref" href="#bib-MDNS">MDNS</a></cite>].
+ </li>
+ <li>Set <var>network service record</var>'s <code>type</code> property to the concatenation of the string
+ <code>zeroconf:</code> followed be the value of the <abbr title="DNS Pointer Record">PTR</abbr> Service Instance Name's <var>Service</var>
+ component [<cite><a class="bibref" href="#bib-MDNS">MDNS</a></cite>].
+ </li>
+ <li>Set <var>network service record</var>'s <code>url</code> property to the resolvable Service <abbr title="Uniform Resource Locator">URL</abbr>
+ obtained from performing an <abbr title="Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr> Lookup [<cite><a class="bibref" href="#bib-DNS-SD">DNS-SD</a></cite>] of the current service from the <abbr title="DNS Pointer Record">PTR</abbr> record provided
+ [<cite><a class="bibref" href="#bib-MDNS">MDNS</a></cite>].
+ </li>
+ <li>Set <var>network service record</var>'s <code>config</code> property to the string value of the
+ contents of the first <abbr title="Domain Name System">DNS</abbr>-<abbr title="Service Discovery">SD</abbr> TXT record associated with the <var>service <abbr title="Multicast DNS">mDNS</abbr> response</var> as defined
+ in [<cite><a class="bibref" href="#bib-DNS-SD">DNS-SD</a></cite>].
+ </li>
+ <li>Set <var>network service record</var>'s <code>expiryTimestamp</code> property to the value of the
+ current date, in UTC timestamp format, plus a value of <code>120</code> seconds.
+ </li>
+ <li>Run the general rule for <a href="#dfn-adding-an-available-service" class="internalDFN">adding an available service</a>, passing in the current <var>network
+ service record</var> as the only argument.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ </section>
+ <section id="simple-service-discovery-protocol-ssdp">
+ <h3><span class="secno">7.2 </span>
+ Simple Service Discovery Protocol (<abbr title="Simple Service Discovery Protocol">SSDP</abbr>)
+ </h3>
+ <p>
+ A user agent that implements UPnP service discovery <em class="rfc2119" title="must">must</em> issue an <dfn id="dfn-advertisement-for-upnp-root-devices">advertisement for
+ UPnP root devices</dfn> against the user's current local network according to the full normative text and
+ timing provided in 'Section 1.3.2: Search request with M-SEARCH' detailed in [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>].
+ </p>
+ <p>
+ The user agent <em class="rfc2119" title="must">must</em> issue all <a title="advertisement for UPnP root devices" href="#dfn-advertisement-for-upnp-root-devices" class="internalDFN">advertisements for UPnP root devices</a> with a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> request line equal
+ to <code>M-SEARCH * <abbr title="Hypertext Transfer Protocol">HTTP</abbr>/1.1</code>, with a HOST header equal to the reserved multicast address and port of
+ <code>239.255.255.250:1900</code>, a MAN header equal to <code>ssdp:discover</code>, an ST header equal to
+ <code>upnp:rootdevice</code> and a user-agent defined MX header equal to a <dfn id="dfn-maximum-upnp-advertisement-response-wait-time">maximum UPnP advertisement
+ response wait time</dfn> value between <code>1</code> and <code>5</code> seconds.
+ </p>
+ <p>
+ The user agent <em class="rfc2119" title="must">must</em> listen for incoming requests and process any incoming responses to
+ any <a href="#dfn-advertisement-for-upnp-root-devices" class="internalDFN">advertisement for UPnP root devices</a> on the <dfn id="dfn-standard-upnp-address-and-port">standard UPnP address and port</dfn>, on all
+ current local network interface addresses with the port <code>1900</code>, according to the rules defined in
+ this section.
+ </p>
+ <p>
+ For each <dfn id="dfn-http-response"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Response</dfn> following an initial <a href="#dfn-advertisement-for-upnp-root-devices" class="internalDFN">advertisement for UPnP root devices</a> sent on a
+ <a href="#dfn-standard-upnp-address-and-port" class="internalDFN">standard UPnP address and port</a> the user agent <em class="rfc2119" title="must">must</em> run the following steps:
+ </p>
+ <ol class="rule">
+ <li>If the <a href="#dfn-http-response" class="internalDFN"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Response</a> is not a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> 200 OK response then this response is invalid and the user
+ agent <em class="rfc2119" title="must">must</em> discard this response, abort any remaining steps and return. The user agent
+ <em class="rfc2119" title="may">may</em> issue a new <a href="#dfn-advertisement-for-upnp-root-devices" class="internalDFN">advertisement for UPnP root devices</a> as a result of this error
+ occurring.
+ </li>
+ <li>If the <a href="#dfn-maximum-upnp-advertisement-response-wait-time" class="internalDFN">maximum UPnP advertisement response wait time</a> has been exceeded since the initial
+ <a href="#dfn-advertisement-for-upnp-root-devices" class="internalDFN">advertisement for UPnP root devices</a> was sent then the <a href="#dfn-http-response" class="internalDFN"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Response</a> is invalid and the user
+ agent <em class="rfc2119" title="must">must</em> discard this response, abort any remaining steps and return.
+ </li>
+ <li>Let <var>ssdp device</var> be an Object with a property for each <abbr title="Hypertext Transfer Protocol">HTTP</abbr> header received in the <a href="#dfn-http-response" class="internalDFN"><abbr title="Hypertext Transfer Protocol">HTTP</abbr>
+ Response</a>, with each key being the name of a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> response header and each value being that <abbr title="Hypertext Transfer Protocol">HTTP</abbr> response
+ header's value.
+ </li>
+ <li>If <var>ssdp device</var> does not contain at least one <var>CACHE-CONTROL</var> entry, at least one
+ <var>USN</var> entry, at least one <var>ST</var> entry and at least one <var>LOCATION</var> entry or the
+ value of its <var>ST</var> entry is not <code>upnp:rootdevice</code>, then the <a href="#dfn-http-response" class="internalDFN"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Response</a> is
+ invalid and the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> discard this response, abort any remaining steps
+ and return.
+ </li>
+ <li>The user agent <em class="rfc2119" title="must">must</em> run the rule for <a href="#dfn-obtaining-a-upnp-device-description-file" class="internalDFN">obtaining a UPnP Device Description File</a>
+ passing in the first occurrence of <var>LOCATION</var> from <var>ssdp device</var> as the <var>device
+ descriptor <abbr title="Uniform Resource Locator">URL</abbr></var> argument and the first occurrence of <var>USN</var> from <var>ssdp device</var> as the
+ <var>device identifier</var> argument and the first occurrence of <var>CACHE-CONTROL</var> from <var>ssdp
+ device</var> as the <var>device expiry</var> argument.
+ </li>
+ </ol>
+ <p>
+ For each <dfn id="dfn-http-request"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Request</dfn> received on a <a href="#dfn-standard-upnp-address-and-port" class="internalDFN">standard UPnP address and port</a> the user agent
+ <em class="rfc2119" title="must">must</em> run the following steps:
+ </p>
+ <ol class="rule">
+ <li>If the <a href="#dfn-http-request" class="internalDFN"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Request</a> is not a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> NOTIFY request then it is not a valid UPnP Request and the user
+ agent <em class="rfc2119" title="must">must</em> return a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> 200 OK response, discard this request, abort any remaining steps
+ and return.
+ </li>
+ <li>Let <var>ssdp device</var> be an Object with a property for each <abbr title="Hypertext Transfer Protocol">HTTP</abbr> header received in the <a href="#dfn-http-request" class="internalDFN"><abbr title="Hypertext Transfer Protocol">HTTP</abbr>
+ Request</a>, with each key being the name of a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> header and each value being that <abbr title="Hypertext Transfer Protocol">HTTP</abbr> header's value.
+ </li>
+ <li>If <var>ssdp device</var> does not contain at least one <var>CACHE-CONTROL</var> entry, at least one
+ <var>USN</var> entry, at least one <var>NT</var> entry, at least one <var>NTS</var> entry and at least one
+ <var>LOCATION</var> entry or the value of its <var>NT</var> entry is not <code>upnp:rootdevice</code>, then
+ the <a href="#dfn-http-request" class="internalDFN"><abbr title="Hypertext Transfer Protocol">HTTP</abbr> Request</a> is a malformed UPnP Request and the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> return
+ a 400 Bad Request response, discard this request, abort any remaining steps and return.
+ </li>
+ <li>If <var>ssdp device</var>'s <var>NTS</var> entry is equal to <code>ssdp:alive</code> or
+ <code>ssdp:update</code> then the user agent <em class="rfc2119" title="must">must</em> run the rule for <a href="#dfn-obtaining-a-upnp-device-description-file" class="internalDFN">obtaining a UPnP
+ Device Description File</a> passing in the first occurrence of <var>LOCATION</var> from <var>ssdp
+ device</var> as the <var>device descriptor <abbr title="Uniform Resource Locator">URL</abbr></var> argument and the first occurrence of <var>USN</var> from
+ <var>ssdp device</var> as the <var>device identifier</var> argument and the first occurrence of
+ <var>CACHE-CONTROL</var> from <var>ssdp device</var> as the <var>device expiry</var>.<br>
+ <br>
+ Otherwise, if <var>ssdp device</var>'s <var>NTS</var> entry is equal to <code>ssdp:byebye</code> then the
+ user agent <em class="rfc2119" title="must">must</em> run the rule for <a href="#dfn-removing-all-services-from-a-registered-upnp-device" class="internalDFN">removing all services from a registered UPnP
+ Device</a> passing in the first occurrence of <var>USN</var> from <var>ssdp device</var> as the <var>device
+ identifier</var> argument.
+ </li>
+ </ol>
+ <p>
+ The rule for <dfn id="dfn-obtaining-a-upnp-device-description-file">obtaining a UPnP Device Description File</dfn> is the process of obtaining the contents of
+ a standard UPnP Device Description [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>] from a <abbr title="Uniform Resource Locator">URL</abbr>-based resource. This rule takes three
+ arguments - <var>device descriptor <abbr title="Uniform Resource Locator">URL</abbr></var>, <var>device identifier</var> and <var>device expiry</var> - and
+ when called the user agent <em class="rfc2119" title="must">must</em> run the following steps:
+ </p>
+ <ol class="rule">
+ <li>Let <var>device descriptor file</var> contain the contents of the file located at the <abbr title="Uniform Resource Locator">URL</abbr> provided in
+ <var>device descriptor <abbr title="Uniform Resource Locator">URL</abbr></var> obtained according to the rules defined in 'Section 2.11: Retrieving a
+ description using <abbr title="Hypertext Transfer Protocol">HTTP</abbr>' in [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>].
+ </li>
+ <li>If the value provided in <var>device descriptor <abbr title="Uniform Resource Locator">URL</abbr></var> cannot be resolved as a reachable <abbr title="Uniform Resource Locator">URL</abbr> on the
+ current network or the <var>root device descriptor file</var> remains empty then it is invalid and the
+ <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em> abort any remaining steps and return.
+ </li>
+ <li>Run the rule for <a href="#dfn-processing-a-upnp-device-description-file" class="internalDFN">processing a UPnP Device Description File</a>, passing in the current <var>device
+ descriptor file</var>, <var>device identifier</var> and <var>device expiry</var> arguments.
+ </li>
+ <li>If the current <var>device descriptor file</var> contains a <code><deviceList></code> element then
+ for each <code><device></code> element within <code><deviceList></code> - herein known as an
+ <var>embedded device descriptor file</var> - the user agent <em class="rfc2119" title="must">must</em> run the rule for
+ <a href="#dfn-processing-a-upnp-device-description-file" class="internalDFN">processing a UPnP Device Description File</a>, passing in the current <var>embedded device descriptor
+ file</var> as the <var>device descriptor file</var> argument, along with the common <var>device
+ identifier</var> and <var>device expiry</var> arguments.
+ </li>
+ </ol>
+ <p>
+ The rule for <dfn id="dfn-processing-a-upnp-device-description-file">processing a UPnP Device Description File</dfn> is the process of parsing the contents of a
+ standard UPnP Device Description [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>] and registering the UPnP services contained therein
+ within the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>.
+ </p>
+ <p>
+ The rule for <a href="#dfn-processing-a-upnp-device-description-file" class="internalDFN">processing a UPnP Device Description File</a> takes three arguments - <var>device descriptor
+ file</var>, <var>device identifier</var> and <var>device expiry</var> - and when called the user agent
+ <em class="rfc2119" title="must">must</em> run the following steps:
+ </p>
+ <ol class="rule">
+ <li>Let <var>advertised services</var> be a list of all advertised services obtained from the <var>device
+ descriptor file</var> containing the value of the first occurrence of the <code><serviceList></code>
+ element as it is defined in 'Section 2.3: Device Description' in [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>].
+ </li>
+ <li>For each <code><service></code> element - known as an <var>advertised service</var> - in
+ <var>advertised services</var> run the following steps:
+ <ol class="rule">
+ <li>Let <var>network service record</var> be a new Object consisting of the following empty properties:
+ <code>id</code>, <code>deviceId</code>, <code>name</code>, <code>type</code>, <code>url</code>,
+ <code>eventsUrl</code>, <code>config</code>, <code>expiryTimestamp</code>.
+ </li>
+ <li>Set <var>network service record</var>'s <code>id</code> property to the concatenated string value of
+ <var>device identifier</var> with the <var>advertised service</var>'s <code><serviceId></code>
+ sub-element.
+ </li>
+ <li>Set <var>network service record</var>'s <code>deviceId</code> property to the value of <var>device
+ identifier</var>.
+ </li>
+ <li>Set <var>network service record</var>'s <code>name</code> property to the string value of the first
+ occurrence of the <var>advertised service</var>'s <code><serviceId></code> sub-element.
+ </li>
+ <li>Set <var>network service record</var>'s <code>type</code> property to the concatenation of the string
+ <code>upnp:</code> followed by the string value of the first occurrence of the <var>advertised
+ service</var>'s <code><serviceType></code> sub-element.
+ </li>
+ <li>Set <var>network service record</var>'s <code>url</code> property to the string value of the first
+ occurrence of the <var>advertised service</var>'s <code><controlURL></code> sub-element.
+ </li>
+ <li>Set <var>network service record</var>'s <code>config</code> property to the string value of the
+ contents of the first occurrence of the <code><device></code> element in the <var>device descriptor
+ file</var>.
+ </li>
+ <li>If <var>advertised service</var>'s <code><eventSubURL></code> sub-element is not empty, then
+ set <var>network service record</var>'s <code>eventsUrl</code> property to the string value of the first
+ occurrence of the <var>advertised service</var>'s <code><eventSubURL></code> sub-element.
+ Otherwise, do not set <var>network service record</var>'s <code>eventsUrl</code> property.
+ </li>
+ <li>Set <var>network service record</var>'s <code>expiryTimestamp</code> property to the value of the
+ current date, in UTC timestamp format, plus the value of <var>device expiry</var>.
+ </li>
+ <li>Run the general rule for <a href="#dfn-adding-an-available-service" class="internalDFN">adding an available service</a>, passing in the current <var>network
+ service record</var> as the only argument.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ <p>
+ The rule for <dfn id="dfn-removing-all-services-from-a-registered-upnp-device">removing all services from a registered UPnP Device</dfn> is the process of removing all
+ services associated with a device from the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a> that has left the user's
+ current network or has otherwise timed out or expired. This rule takes one argument, <var>device
+ identifier</var>, and consists of running the following steps:
+ </p>
+ <ol class="rule">
+ <li>For each <var>existing service record</var> in the current <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>, run
+ the following sub-steps:
+ <ol class="rule">
+ <li>If the <var>existing service record</var>'s <code>deviceId</code> property does not match <var>device
+ identifier</var> then skip any remaining sub-steps for the current <var>existing service record</var> and
+ continue at the next available <var>existing service record</var>.
+ </li>
+ <li>Run the general rule for <a href="#dfn-removing-an-available-service" class="internalDFN">removing an available service</a> passing in <var>existing service
+ record</var>'s <code>id</code> property as the only argument.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ <p>
+ When the <a href="#dfn-user-agent" class="internalDFN">user agent</a> is to <dfn id="dfn-setup-a-upnp-events-subscription">setup a UPnP Events Subscription</dfn>, it is to run the following
+ steps with the current <var>network service record</var> object as defined in 'Section 4.1.2: SUBSCRIBE with
+ NT and CALLBACK' in [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>]:
+ </p>
+ <ol class="rule">
+ <li>If <var>network service record</var>'s <code>eventsUrl</code> property is empty then the <a href="#dfn-user-agent" class="internalDFN">user
+ agent</a> <em class="rfc2119" title="must">must</em> abort these steps.
+ </li>
+ <li>Let <var>callback <abbr title="Uniform Resource Locator">URL</abbr></var> be the value of creating a new <a href="#dfn-user-agent-generated-callback-url" class="internalDFN">user-agent generated callback url</a>.
+ </li>
+ <li>Send a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> SUBSCRIBE request with a <em>NT</em> header with a string value of <code>upnp:event</code>, a
+ <em>TIMEOUT</em> header with a user-agent defined timeout value (in the form <code>Second-XX</code> where
+ <code>XX</code> is the user-agent defined timeout value in seconds) and a <em>CALLBACK</em> header with a
+ string value of <var>callback <abbr title="Uniform Resource Locator">URL</abbr></var> towards the <var>network service record</var>'s
+ <code>eventsUrl</code> property.
+ </li>
+ <li>If a non-200 OK response is received from the <abbr title="Hypertext Transfer Protocol">HTTP</abbr> SUBSCRIBE request then the <a href="#dfn-user-agent" class="internalDFN">user agent</a>
+ <em class="rfc2119" title="must">must</em> abort these steps.
+ </li>
+ <li>On receiving a valid 200 OK response, run the following steps:
+ <ol class="rule">
+ <li>Let <var>callback ID</var> equal the string value of the first included <em>SID</em> header, if it
+ exists.
+ </li>
+ <li>Let <var>timeout date</var> equal the sum of the current UTC date value plus the integer value of the
+ first included <em>TIMEOUT</em> header (minus the leading string of <code>Second-</code>), if it exists.
+ </li>
+ <li>Run the following steps asynchronously and continue to the step labeled <em>listen</em> below.
+ </li>
+ <li>
+ <em>Refresh Subscription</em>: Run the following steps at a set interval (X) within the <a href="#dfn-user-agent" class="internalDFN">user
+ agent</a>:
+ <ol class="rule">
+ <li>Let <var>current date</var> equal the current UTC date.
+ </li>
+ <li>If <var>current date</var> is less than the <var>timeout date</var> then continue to the step
+ labeled <em>refresh subscription</em> above.
+ </li>
+ <li>Send a <abbr title="Hypertext Transfer Protocol">HTTP</abbr> SUBSCRIBE request with a <em>SID</em> header with the string value of <var>callback
+ ID</var> and a user-agent defined <em>TIMEOUT</em> header (in the form <code>Second-XX</code> where
+ <code>XX</code> is the user-agent defined timeout value in seconds) towards the <var>network service
+ record</var>'s <code>eventsUrl</code> property.
+ </li>
+ <li>On receiving a valid 200 OK, update <var>callback ID</var> with the string value of the first
+ included <em>SID</em> header, if it exists. All other <abbr title="Hypertext Transfer Protocol">HTTP</abbr> responses should cause the <a href="#dfn-user-agent" class="internalDFN">user
+ agent</a> to continue from the step labeled <em>refresh subscription</em> above.
+ </li>
+ </ol>
+ </li>
+ <li>
+ <em>Listen</em>: For each <abbr title="Hypertext Transfer Protocol">HTTP</abbr> NOTIFY request received at the <var>callback <abbr title="Uniform Resource Locator">URL</abbr></var> the <a href="#dfn-user-agent" class="internalDFN">user
+ agent</a> is to run the following steps:
+ <ol class="rule">
+ <li>Let <var>content clone</var> be the result of obtaining the message body of the <abbr title="Hypertext Transfer Protocol">HTTP</abbr> NOTIFY
+ request. If <var>content clone</var> is empty, then the <a href="#dfn-user-agent" class="internalDFN">user agent</a> <em class="rfc2119" title="must">must</em>
+ abort these steps.
+ </li>
+ <li>Let <var>notification event</var> be a new simple event that uses the <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event" class="externalDFN"><code>Event</code></a> interface with the name <a href="#event-notify"><code>notify</code></a>, which does not bubble, is not cancellable, and has no
+ default action.
+ </li>
+ <li>Let the <code>data</code> attribute of <var>notification event</var> have the DOMString value of
+ <var>content clone</var>.
+ </li>
+ <li>
+ <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task" class="externalDFN">Queue a task</a> to dispatch <var>notification event</var> at the current
+ <a href="#networkservice" class="internalDFN"><code>NetworkService</code></a> object.
+ </li>
+ </ol>
+ </li>
+ </ol>
+ </li>
+ </ol>
+ <p>
+ A <a href="#dfn-user-agent" class="internalDFN">user agent</a> can <dfn id="dfn-terminate-an-existing-upnp-events-subscription">terminate an existing UPnP Events Subscription</dfn> at any time for any
+ <var>active service</var> in the <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a> by sending an <abbr title="Hypertext Transfer Protocol">HTTP</abbr> UNSUBSCRIBE
+ request - as defined in 'Section 4.1.4: Cancelling a subscription with UNSUBSCRIBE' in [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH11">UPNP-DEVICEARCH11</a></cite>]
+ - with a HOST header set to that <var>active service</var>'s <code>eventsUrl</code> property and a SID header
+ set to the <var>callback ID</var> obtained when the initial <a href="#dfn-setup-a-upnp-events-subscription" class="internalDFN">setup a UPnP Events Subscription</a> action
+ occurred.
+ </p>
+ </section>
+ <section id="network-topology-monitoring">
+ <h3><span class="secno">7.3 </span>
+ Network Topology Monitoring
+ </h3>
+ <div>
+ <p>
+ When the <a href="#dfn-user-agent" class="internalDFN">user agent</a> detects that the user has dropped from their connected network then, for each
+ <var>existing service record</var> in the <a href="#dfn-list-of-available-service-records" class="internalDFN">list of available service records</a>, the user agent
+ <em class="rfc2119" title="must">must</em> run the general rule for <a href="#dfn-removing-an-available-service" class="internalDFN">removing an available service</a> passing in each
+ <var>existing service record</var>'s <code>id</code> property as the only argument for each call.
+ </p>
+ <p>
+ When the <a href="#dfn-user-agent" class="internalDFN">user agent</a> detects that the user has connected to a new network or reconnected to an
+ existing network, then it <em class="rfc2119" title="should">should</em> restart its discovery mechanisms as defined in the
+ <a href="#service-discovery">Service Discovery</a> section of this specification, maintaining the existing
+ <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a> currently in use.
+ </p>
+ </div>
+ </section>
+ </section>
+ <section id="events-summary">
+ <!--OddPage--><h2><span class="secno">8. </span>
+ Events Summary
+ </h2>
+ <p>
+ The following events are dispatched on the <a href="#networkservices"><code>NetworkServices</code></a> and/or
+ <a href="#networkservice"><code>NetworkService</code></a> objects:
+ </p>
+ <table border="1">
+ <thead>
+ <tr>
+ <th>
+ <span>Event name</span>
+ </th>
+ <th>
+ <span>Interface</span>
+ </th>
+ <th>
+ <span>Dispatched when...</span>
+ </th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <dfn id="event-serviceavailable"><code>serviceavailable</code></dfn>
+ </td>
+ <td>
+ <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event" class="externalDFN"><code>Event</code></a>
+ </td>
+ <td>
+ When a new service that matches one of the <a>requested type tokens</a> is found in the current network.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="event-serviceunavailable"><code>serviceunavailable</code></dfn>
+ </td>
+ <td>
+ <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event" class="externalDFN"><code>Event</code></a>
+ </td>
+ <td>
+ When an existing service that matches one of the <a>requested type tokens</a> gracefully leaves or
+ expires from the current network.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="event-serviceonline"><code>serviceonline</code></dfn>
+ </td>
+ <td>
+ <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event" class="externalDFN"><code>Event</code></a>
+ </td>
+ <td>
+ When a current service renews its service registration within the current network.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="event-serviceoffline"><code>serviceoffline</code></dfn>
+ </td>
+ <td>
+ <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event" class="externalDFN"><code>Event</code></a>
+ </td>
+ <td>
+ When a current service gracefully leaves or otherwise expires from the current network.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <dfn id="event-notify"><code>notify</code></dfn>
+ </td>
+ <td>
+ <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event" class="externalDFN"><code>Event</code></a>
+ </td>
+ <td>
+ When a valid UPnP Events Subscription Message is received on a <a href="#dfn-user-agent-generated-callback-url" class="internalDFN">user-agent generated callback url</a>
+ for a current service. This event never fires for Zeroconf-based services.
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+ <section id="garbage-collection">
+ <!--OddPage--><h2><span class="secno">9. </span>
+ Garbage collection
+ </h2>
+ <p>
+ Only when the user navigates away from the current browsing context can <a href="#networkservice" class="internalDFN"><code>NetworkService</code></a>
+ objects be garbage-collected, its records in the <a href="#dfn-entry-script-origin-s-url-whitelist" class="internalDFN">entry script origin's <abbr title="Uniform Resource Locator">URL</abbr> whitelist</a> be removed and its
+ corresponding entry in the <a href="#dfn-list-of-authorized-service-records" class="internalDFN">list of authorized service records</a> be removed according to passing each
+ expired object identifier through the rule for <a href="#dfn-removing-an-available-service" class="internalDFN">removing an available service</a>.
+ </p>
+ </section>
+ <section id="use-cases-and-requirements">
+ <!--OddPage--><h2><span class="secno">10. </span>
+ Use Cases and Requirements
+ </h2>
+ <p>
+ This section covers what the requirements are for this <abbr title="Application Programming Interface">API</abbr>, as well as illustrates some use cases.
+ </p>
+ <ul class="rule">
+ <li>Once a user has given permission, user agents should provide the ability for Web pages to communicate
+ directly with a Local-networked Service.
+ <ul class="rule">
+ <li>Example: A web-based TV remote control. A Web page wants to control the current user's TV, changing the
+ programming shown or increasing/decreasing/muting the volume of the Local-networked Device. The Web page
+ requests a service type that is known to be implemented by television sets to which it has the application
+ logic to communicate. Local devices providing the request service types are discovered and presented to the
+ user for authorization. The user selects one or more of the discovered television sets to be accessible to
+ the current Web page and then clicks 'Share'. The Web page can now communicate directly with the
+ user-authorized Local-networked services.
+ </li>
+ </ul>
+ </li>
+ <li>Web pages should be able to communicate with Local-networked Services using the messaging channel supported
+ by those Devices.
+ <ul class="rule">
+ <li>Example: A Web page advertises that it is capable of controlling multiple Home Media Servers. The user
+ can select their Home Media Server type from a drop-down list, at which point the Web page sends a request
+ to the user agent to connect with the associated service type of the Home Media Server. The Media Server
+ selected implements a Web Socket channel for bi-directional service communication and so the Web page opens
+ a web socket to the requested Media Server and can communicate as required via that appropriate channel.
+ </li>
+ </ul>
+ </li>
+ <li>Web pages should be able to communicate with Local-networked Services using the messaging format supported
+ by those Devices.
+ <ul class="rule">
+ <li>Example: A Web page advertises that it is capable of interacting with and controlling multiple types of
+ Home Media Server. The user can select their Home Media Server type from a drop-down list or known Media
+ Servers, at which point the Web page sends a request to the user agent to connect with the associated
+ service type (and, optionally, the associated event type) of the Home Media Server. The communication
+ protocols supported by Home Media Servers typically vary between UPnP, JSON-RPC, Protocol Buffers or other
+ messaging formats depending on the Home Media Server requested. The Web page is able to communicate with
+ the user-selected Home Media Server in the messaging format supported by that Device, which, in this
+ example is a simple key/value pair text format.
+ </li>
+ </ul>
+ </li>
+ <li>Web pages should not be able to communicate with Local-networked Services that have not been authorized by
+ the user thereby maintaining the user's privacy.
+ <ul class="rule">
+ <li>Example: A Web page requests access to one type of Local-networked service. The user authorizes access
+ to that particular service. Other services running on that same device, and on other devices within the
+ network, should not be accessible to the current Web page.
+ </li>
+ </ul>
+ </li>
+ <li>A user should be able to share one or more Local-networked Services based on a particular service type
+ request from a Web page.
+ <ul class="rule">
+ <li>Example: A Web page is capable of interacting with a specific profile of Local-networked Service. As
+ such, it makes a request to the user agent to access those services, of which multiple matches are found.
+ The user is capable of selecting one or more of the discovered services to share with the Web page. The Web
+ page can then implement a drag-and-drop interface for the user to drag specific actions on to one or more
+ of the authorized Local-networked Services.
+ </li>
+ </ul>
+ </li>
+ <li>User agents should provide an <abbr title="Application Programming Interface">API</abbr> exposed to script that exposes the features above. The user is notified
+ by UI anytime interaction with Local-networked Services is requested, giving the user full ability to cancel or
+ abort the transaction. The user selects the Local-networked Services to be connected to the current Web page,
+ and can cancel these at any time. No invocations to these APIs occur silently without user intervention.
+ </li>
+ </ul>
+ </section>
+ <section class="informative appendix" id="examples">
+ <!--OddPage--><h2><span class="secno">A. </span>
+ Examples
+ </h2><p><em>This section is non-normative.</em></p>
+ <div class="example">
+ <p>
+ This sample code exposes a button. When clicked, this button is disabled and the user is prompted to offer a
+ network service. The user may also select multiple network services. When the user has authorized a network
+ service to be connected to the web page then the web page issues a simple command to get a list of all the
+ albums stored on the connected media player service.
+ </p>
+ <p>
+ The button is re-enabled only when the connected network service disconnects for whatever reason (the service
+ becomes unavailable on the network, the user disconnects from their current network or the user revokes
+ access to the service from the current web page). At this point the user can re-click the button to select a
+ new network service to connect to the web page and the above steps are repeated.
+ </p>
+ <p>
+ The provided service type identifier and service interaction used in this example is based on the
+ well-defined service type and messaging format supported by the <a href="http://xbmc.org/about/">XBMC Media
+ Server</a>.
+ </p>
+ <hr>
+ <pre class="highlight prettyprint"><span class="tag"><input</span><span class="pln"> </span><span class="atn">type</span><span class="pun">=</span><span class="atv">"button"</span><span class="pln"> </span><span class="atn">value</span><span class="pun">=</span><span class="atv">"Start"</span><span class="pln"> </span><span class="atn">onclick</span><span class="pun">=</span><span class="atv">"</span><span class="pln">start</span><span class="pun">()</span><span class="atv">"</span><span class="pln"> </span><span class="atn">id</span><span class="pun">=</span><span class="atv">"startBtn"</span><span class="tag">/></span><span class="pln">
+</span><span class="tag"><div</span><span class="pln"> </span><span class="atn">id</span><span class="pun">=</span><span class="atv">"debugconsole"</span><span class="tag">></div></span><span class="pln">
+
+</span><span class="tag"><script></span><span class="pln">
+ </span><span class="kwd">var</span><span class="pln"> startBtn </span><span class="pun">=</span><span class="pln"> document</span><span class="pun">.</span><span class="pln">getElementById</span><span class="pun">(</span><span class="str">'startBtn'</span><span class="pun">),</span><span class="pln">
+ debug </span><span class="pun">=</span><span class="pln"> document</span><span class="pun">.</span><span class="pln">getElementById</span><span class="pun">(</span><span class="str">'debugconsole'</span><span class="pun">);</span><span class="pln">
+
+ </span><span class="kwd">function</span><span class="pln"> start</span><span class="pun">()</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ </span><span class="kwd">if</span><span class="pun">(</span><span class="pln">navigator</span><span class="pun">.</span><span class="pln">getNetworkServices</span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ navigator</span><span class="pun">.</span><span class="pln">getNetworkServices</span><span class="pun">(</span><span class="str">'zeroconf:_xbmc-jsonrpc._tcp'</span><span class="pun">,</span><span class="pln"> gotXBMCService</span><span class="pun">,</span><span class="pln"> error</span><span class="pun">);</span><span class="pln">
+ startBtn</span><span class="pun">.</span><span class="pln">disabled </span><span class="pun">=</span><span class="pln"> </span><span class="kwd">true</span><span class="pun">;</span><span class="pln">
+ </span><span class="pun">}</span><span class="pln"> </span><span class="kwd">else</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class="pln"> </span><span class="str">"<br>Service Discovery not supported!"</span><span class="pun">;</span><span class="pln">
+ </span><span class="pun">}</span><span class="pln">
+ </span><span class="pun">}</span><span class="pln">
+
+ </span><span class="kwd">function</span><span class="pln"> gotXBMCService</span><span class="pun">(</span><span class="pln">services</span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+
+</span><span class="com">// Listen for service disconnect messages</span><span class="pln">
+
+ services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class="pln">addEventListener</span><span class="pun">(</span><span class="str">'serviceoffline'</span><span class="pun">,</span><span class="pln"> </span><span class="kwd">function</span><span class="pln"> </span><span class="pun">(</span><span class="pln"> e </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class="pln"> </span><span class="str">"<br>"</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class="pln">name </span><span class="pun">+</span><span class="pln"> </span><span class="str">" disconnected."</span><span class="pun">;</span><span class="pln">
+ startBtn</span><span class="pun">.</span><span class="pln">disabled </span><span class="pun">=</span><span class="pln"> </span><span class="kwd">false</span><span class="pun">;</span><span class="pln">
+ </span><span class="pun">},</span><span class="pln"> </span><span class="kwd">false</span><span class="pun">);</span><span class="pln">
+
+</span><span class="com">// Send a service message to get albums list (and process the service response)</span><span class="pln">
+
+ </span><span class="kwd">var</span><span class="pln"> svcXhr </span><span class="pun">=</span><span class="pln"> </span><span class="kwd">new</span><span class="pln"> </span><span class="typ">XMLHttpRequest</span><span class="pun">();</span><span class="pln">
+ svcXhr</span><span class="pun">.</span><span class="pln">open</span><span class="pun">(</span><span class="str">"POST"</span><span class="pun">,</span><span class="pln"> services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class="pln">url </span><span class="pun">+</span><span class="pln"> </span><span class="str">"/getAlbums"</span><span class="pun">);</span><span class="pln"> </span><span class="com">// services[0].url and its sub-resources have been</span><span class="pln">
+ </span><span class="com">// whitelisted for cross-site XHR use in this</span><span class="pln">
+ </span><span class="com">// current browsing context.</span><span class="pln">
+
+ svcXhr</span><span class="pun">.</span><span class="pln">setRequestHeader</span><span class="pun">(</span><span class="str">'Content-Type'</span><span class="pun">,</span><span class="pln"> </span><span class="str">'application/json-rpc'</span><span class="pun">);</span><span class="pln">
+
+ svcXhr</span><span class="pun">.</span><span class="pln">addEventListener</span><span class="pun">(</span><span class="str">'readystatechange'</span><span class="pun">,</span><span class="pln"> </span><span class="kwd">function</span><span class="pln"> </span><span class="pun">(</span><span class="pln"> response </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ </span><span class="kwd">if</span><span class="pun">(</span><span class="pln"> response</span><span class="pun">.</span><span class="pln">readyState </span><span class="pun">!=</span><span class="pln"> </span><span class="lit">4</span><span class="pln"> </span><span class="pun">||</span><span class="pln"> response</span><span class="pun">.</span><span class="pln">status </span><span class="pun">!=</span><span class="pln"> </span><span class="lit">200</span><span class="pln"> </span><span class="pun">)</span><span class="pln">
+ </span><span class="kwd">return</span><span class="pun">;</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class="pln"> </span><span class="str">"<br>"</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class="pln">name </span><span class="pun">+</span><span class="pln"> </span><span class="str">" response received: "</span><span class="pun">;</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">textContent </span><span class="pun">+=</span><span class="pln"> JSON</span><span class="pun">.</span><span class="pln">parse</span><span class="pun">(</span><span class="pln">response</span><span class="pun">.</span><span class="pln">responseText</span><span class="pun">);</span><span class="pln">
+ </span><span class="pun">},</span><span class="pln"> </span><span class="kwd">false</span><span class="pun">);</span><span class="pln">
+
+ </span><span class="kwd">var</span><span class="pln"> svcMsg </span><span class="pun">=</span><span class="pln"> </span><span class="pun">[</span><span class="pln">
+ </span><span class="pun">{</span><span class="pln"> </span><span class="str">"jsonrpc"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"2.0"</span><span class="pun">,</span><span class="pln"> </span><span class="str">"method"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"AudioLibrary.GetAlbums"</span><span class="pun">,</span><span class="pln"> </span><span class="str">"params"</span><span class="pun">:</span><span class="pln"> </span><span class="pun">{</span><span class="pln"> </span><span class="str">"genreid"</span><span class="pun">:</span><span class="pln"> </span><span class="pun">-</span><span class="lit">1</span><span class="pun">,</span><span class="pln">
+ </span><span class="str">"artistid"</span><span class="pun">:</span><span class="pln"> </span><span class="pun">-</span><span class="lit">1</span><span class="pun">,</span><span class="pln"> </span><span class="str">"start"</span><span class="pun">:</span><span class="pln"> </span><span class="pun">-</span><span class="lit">1</span><span class="pun">,</span><span class="pln"> </span><span class="str">"end"</span><span class="pun">:</span><span class="pln"> </span><span class="pun">-</span><span class="lit">1</span><span class="pln"> </span><span class="pun">},</span><span class="pln"> </span><span class="str">"id"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"1"</span><span class="pln"> </span><span class="pun">}</span><span class="pln">
+ </span><span class="pun">];</span><span class="pln">
+
+ svcXhr</span><span class="pun">.</span><span class="pln">send</span><span class="pun">(</span><span class="pln">JSON</span><span class="pun">.</span><span class="pln">stringify</span><span class="pun">(</span><span class="pln">svcMsg</span><span class="pun">));</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class="pln"> </span><span class="str">"<br>"</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class="pln">name </span><span class="pun">+</span><span class="pln"> </span><span class="str">" request sent: "</span><span class="pun">;</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">textContent </span><span class="pun">+=</span><span class="pln"> JSON</span><span class="pun">.</span><span class="pln">stringify</span><span class="pun">(</span><span class="pln">svcMsg</span><span class="pun">);</span><span class="pln">
+
+ </span><span class="pun">}</span><span class="pln">
+
+ </span><span class="kwd">function</span><span class="pln"> error</span><span class="pun">(</span><span class="pln"> err </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class="pln"> </span><span class="str">"<br>An error occurred obtaining a local network service."</span><span class="pun">;</span><span class="pln">
+ startBtn</span><span class="pun">.</span><span class="pln">disabled </span><span class="pun">=</span><span class="pln"> </span><span class="kwd">false</span><span class="pun">;</span><span class="pln">
+ </span><span class="pun">}</span><span class="pln">
+</span><span class="tag"></script></span></pre>
+ </div>
+ <div class="example">
+ <p>
+ This sample exposes a drop-down list containing a number of common Home-based audio devices. When the user
+ selects an audio device from the list provided, they are prompted to authorize a network service based on the
+ service type requested. The user may also select multiple network services matching the selected service
+ type. In this example, the user selects their make as being <var>Sony</var> and their model as being
+ <var>Bravia S1000</var> from which the Web page can derive a service type
+ (<var>urn:schemas-upnp-org:service:RenderingControl:1</var>).<br>
+ <br>
+ Once the user has authorized the device, the web page sends a simple mute command according to the messaging
+ format supported by the device.
+ </p>
+ <hr>
+ <pre class="highlight prettyprint"><span class="tag"><select</span><span class="pln"> </span><span class="atn">name</span><span class="pun">=</span><span class="atv">"make"</span><span class="pln"> </span><span class="atn">id</span><span class="pun">=</span><span class="atv">"make"</span><span class="tag">></span><span class="pln">
+ </span><span class="tag"><option</span><span class="pln"> </span><span class="atn">selected</span><span class="pun">=</span><span class="atv">"selected"</span><span class="pln"> </span><span class="atn">disabled</span><span class="pun">=</span><span class="atv">"disabled"</span><span class="tag">></span><span class="pln">Select make</span><span class="tag"></option></span><span class="pln">
+ </span><span class="tag"><option></span><span class="pln">Sony</span><span class="tag"></option></span><span class="pln">
+ </span><span class="tag"><option></span><span class="pln">Philips</span><span class="tag"></option></span><span class="pln">
+ </span><span class="tag"><option></span><span class="pln">Alba</span><span class="tag"></option></span><span class="pln">
+</span><span class="tag"></select></span><span class="pln">
+</span><span class="tag"><select</span><span class="pln"> </span><span class="atn">name</span><span class="pun">=</span><span class="atv">"model"</span><span class="pln"> </span><span class="atn">id</span><span class="pun">=</span><span class="atv">"model"</span><span class="tag">></select></span><span class="pln">
+</span><span class="tag"><div</span><span class="pln"> </span><span class="atn">id</span><span class="pun">=</span><span class="atv">"debugconsole"</span><span class="tag">></div></span><span class="pln">
+
+</span><span class="tag"><script></span><span class="pln">
+ </span><span class="kwd">var</span><span class="pln"> debug </span><span class="pun">=</span><span class="pln"> document</span><span class="pun">.</span><span class="pln">getElementById</span><span class="pun">(</span><span class="str">'debugconsole'</span><span class="pun">);</span><span class="pln">
+
+ </span><span class="kwd">var</span><span class="pln"> models </span><span class="pun">=</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ </span><span class="str">"Sony"</span><span class="pun">:</span><span class="pln"> </span><span class="pun">[</span><span class="pln">
+ </span><span class="pun">{</span><span class="str">"name"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"Bravia TV S1000"</span><span class="pun">,</span><span class="pln"> </span><span class="str">"type"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"upnp"</span><span class="pun">,</span><span class="pln"> </span><span class="str">"service"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"urn:schemas-upnp-org:service:RenderingControl:1"</span><span class="pln"> </span><span class="pun">},</span><span class="pln">
+ </span><span class="pun">{</span><span class="str">"name"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"Bravia TV S2000"</span><span class="pun">,</span><span class="pln"> </span><span class="str">"type"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"zeroconf"</span><span class="pun">,</span><span class="pln"> </span><span class="str">"service"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"_mediarenderer._http._tcp"</span><span class="pln"> </span><span class="pun">},</span><span class="pln">
+ </span><span class="pun">{</span><span class="str">"name"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"HiFi WD10"</span><span class="pun">,</span><span class="pln"> </span><span class="str">"type"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"upnp"</span><span class="pun">,</span><span class="pln"> </span><span class="str">"service"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"urn:schemas-upnp-org:service:RenderingControl:1"</span><span class="pln"> </span><span class="pun">}</span><span class="pln">
+ </span><span class="pun">],</span><span class="pln">
+ </span><span class="str">"Philips"</span><span class="pun">:</span><span class="pln"> </span><span class="pun">[</span><span class="pln"> </span><span class="com">/* ... */</span><span class="pln"> </span><span class="pun">],</span><span class="pln">
+ </span><span class="str">"Alba"</span><span class="pun">:</span><span class="pln"> </span><span class="pun">[</span><span class="pln"> </span><span class="com">/* ... */</span><span class="pln"> </span><span class="pun">]</span><span class="pln">
+ </span><span class="pun">};</span><span class="pln">
+
+ </span><span class="kwd">var</span><span class="pln"> makeEl </span><span class="pun">=</span><span class="pln"> document</span><span class="pun">.</span><span class="pln">getElementById</span><span class="pun">(</span><span class="str">"make"</span><span class="pun">),</span><span class="pln">
+ modelEl </span><span class="pun">=</span><span class="pln"> document</span><span class="pun">.</span><span class="pln">getElementById</span><span class="pun">(</span><span class="str">"model"</span><span class="pun">);</span><span class="pln">
+
+ makeEl</span><span class="pun">.</span><span class="pln">addEventListener</span><span class="pun">(</span><span class="str">'change'</span><span class="pun">,</span><span class="pln"> </span><span class="kwd">function</span><span class="pun">()</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ modelEl</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">=</span><span class="pln"> </span><span class="str">""</span><span class="pun">;</span><span class="pln"> </span><span class="com">// reset</span><span class="pln">
+ </span><span class="kwd">var</span><span class="pln"> defaultOption </span><span class="pun">=</span><span class="pln"> document</span><span class="pun">.</span><span class="pln">createElement</span><span class="pun">(</span><span class="str">"option"</span><span class="pun">);</span><span class="pln">
+ defaultOption</span><span class="pun">.</span><span class="pln">textContent </span><span class="pun">=</span><span class="pln"> </span><span class="str">"Select model"</span><span class="pun">;</span><span class="pln">
+ defaultOption</span><span class="pun">.</span><span class="pln">setAttribute</span><span class="pun">(</span><span class="str">"disabled"</span><span class="pun">,</span><span class="pln"> </span><span class="str">"disabled"</span><span class="pun">);</span><span class="pln">
+ defaultOption</span><span class="pun">.</span><span class="pln">setAttribute</span><span class="pun">(</span><span class="str">"selected"</span><span class="pun">,</span><span class="pln"> </span><span class="str">"selected"</span><span class="pun">);</span><span class="pln">
+ modelEl</span><span class="pun">.</span><span class="pln">appendChild</span><span class="pun">(</span><span class="pln">defaultOption</span><span class="pun">);</span><span class="pln">
+ </span><span class="kwd">for</span><span class="pun">(</span><span class="kwd">var</span><span class="pln"> i </span><span class="pun">=</span><span class="pln"> </span><span class="lit">0</span><span class="pun">,</span><span class="pln"> l </span><span class="pun">=</span><span class="pln"> models</span><span class="pun">[</span><span class="pln">makeEl</span><span class="pun">.</span><span class="pln">value</span><span class="pun">].</span><span class="pln">length</span><span class="pun">;</span><span class="pln"> i </span><span class="pun"><</span><span class="pln"> l</span><span class="pun">;</span><span class="pln"> i</span><span class="pun">++)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ </span><span class="kwd">var</span><span class="pln"> option </span><span class="pun">=</span><span class="pln"> document</span><span class="pun">.</span><span class="pln">createElement</span><span class="pun">(</span><span class="str">"option"</span><span class="pun">);</span><span class="pln">
+ option</span><span class="pun">.</span><span class="pln">textContent </span><span class="pun">=</span><span class="pln"> models</span><span class="pun">[</span><span class="pln">makeEl</span><span class="pun">.</span><span class="pln">value</span><span class="pun">][</span><span class="pln">i</span><span class="pun">][</span><span class="str">"name"</span><span class="pun">];</span><span class="pln">
+ option</span><span class="pun">.</span><span class="pln">setAttribute</span><span class="pun">(</span><span class="str">"value"</span><span class="pun">,</span><span class="pln"> models</span><span class="pun">[</span><span class="pln">makeEl</span><span class="pun">.</span><span class="pln">value</span><span class="pun">][</span><span class="pln">i</span><span class="pun">][</span><span class="str">"type"</span><span class="pun">]</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> </span><span class="str">":"</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> models</span><span class="pun">[</span><span class="pln">makeEl</span><span class="pun">.</span><span class="pln">value</span><span class="pun">][</span><span class="pln">i</span><span class="pun">][</span><span class="str">"service"</span><span class="pun">]);</span><span class="pln">
+ modelEl</span><span class="pun">.</span><span class="pln">appendChild</span><span class="pun">(</span><span class="pln">option</span><span class="pun">);</span><span class="pln">
+ </span><span class="pun">}</span><span class="pln">
+ </span><span class="pun">},</span><span class="pln"> </span><span class="kwd">false</span><span class="pun">);</span><span class="pln">
+
+ modelEl</span><span class="pun">.</span><span class="pln">addEventListener</span><span class="pun">(</span><span class="str">'change'</span><span class="pun">,</span><span class="pln"> </span><span class="kwd">function</span><span class="pun">()</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ </span><span class="kwd">if</span><span class="pun">(</span><span class="pln">navigator</span><span class="pun">.</span><span class="pln">getNetworkServices </span><span class="pun">&&</span><span class="pln">
+ modelEl</span><span class="pun">.</span><span class="pln">value </span><span class="pun">==</span><span class="pln"> </span><span class="str">"upnp:urn:schemas-upnp-org:service:RenderingControl:1"</span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ navigator</span><span class="pun">.</span><span class="pln">getNetworkServices</span><span class="pun">(</span><span class="pln">modelEl</span><span class="pun">.</span><span class="pln">value</span><span class="pun">,</span><span class="pln"> successCallback</span><span class="pun">,</span><span class="pln"> errorCallback</span><span class="pun">);</span><span class="pln">
+ </span><span class="pun">}</span><span class="pln"> </span><span class="kwd">else</span><span class="pln"> </span><span class="kwd">if</span><span class="pln"> </span><span class="pun">(</span><span class="pln">modelEl</span><span class="pun">.</span><span class="pln">value </span><span class="pun">==</span><span class="pln"> </span><span class="str">"zeroconf:_mediarenderer._http._tcp"</span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class="pln"> </span><span class="str">"<br>Service type is not implemented by this application."</span><span class="pun">;</span><span class="pln">
+ </span><span class="pun">}</span><span class="pln"> </span><span class="kwd">else</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class="pln"> </span><span class="str">"<br>Service Discovery is not supported!"</span><span class="pun">;</span><span class="pln">
+ </span><span class="pun">}</span><span class="pln">
+ </span><span class="pun">},</span><span class="pln"> </span><span class="kwd">false</span><span class="pun">);</span><span class="pln">
+</span><span class="tag"></script></span><span class="pln">
+
+</span><span class="tag"><script></span><span class="pln">
+ </span><span class="kwd">function</span><span class="pln"> successCallback</span><span class="pun">(</span><span class="pln"> services </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+
+ </span><span class="com">// Listen for service push notification messages</span><span class="pln">
+
+ services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class="pln">addEventListener</span><span class="pun">(</span><span class="str">'notify'</span><span class="pun">,</span><span class="pln"> </span><span class="kwd">function</span><span class="pln"> </span><span class="pun">(</span><span class="pln"> msg </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class="pln"> </span><span class="str">"<br>"</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class="pln">name </span><span class="pun">+</span><span class="pln"> </span><span class="str">" event received: "</span><span class="pun">;</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">textContent </span><span class="pun">+=</span><span class="pln"> msg</span><span class="pun">.</span><span class="pln">data</span><span class="pun">;</span><span class="pln">
+ </span><span class="pun">},</span><span class="pln"> </span><span class="kwd">false</span><span class="pun">);</span><span class="pln">
+
+ </span><span class="com">// Send a control signal to mute the service audio</span><span class="pln">
+
+ </span><span class="kwd">var</span><span class="pln"> svcXhr </span><span class="pun">=</span><span class="pln"> </span><span class="kwd">new</span><span class="pln"> </span><span class="typ">XMLHttpRequest</span><span class="pun">();</span><span class="pln">
+ svcXhr</span><span class="pun">.</span><span class="pln">open</span><span class="pun">(</span><span class="str">"POST"</span><span class="pun">,</span><span class="pln"> services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class="pln">url</span><span class="pun">);</span><span class="pln"> </span><span class="com">// services[0].url and its</span><span class="pln">
+ </span><span class="com">// sub-resources have been whitelisted for</span><span class="pln">
+ </span><span class="com">// cross-site XHR use in this current</span><span class="pln">
+ </span><span class="com">// browsing context.</span><span class="pln">
+
+ svcXhr</span><span class="pun">.</span><span class="pln">setRequestHeader</span><span class="pun">(</span><span class="str">'SOAPAction'</span><span class="pun">,</span><span class="pln"> </span><span class="str">'urn:schemas-upnp-org:service:RenderingControl:1#SetMute'</span><span class="pun">);</span><span class="pln">
+ svcXhr</span><span class="pun">.</span><span class="pln">setRequestHeader</span><span class="pun">(</span><span class="str">'Content-Type'</span><span class="pun">,</span><span class="pln"> </span><span class="str">'text/xml; charset="utf-8";'</span><span class="pun">);</span><span class="pln">
+
+ svcXhr</span><span class="pun">.</span><span class="pln">onreadystatechange </span><span class="pun">=</span><span class="pln"> </span><span class="kwd">function</span><span class="pln"> </span><span class="pun">(</span><span class="pln"> response </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ </span><span class="kwd">if</span><span class="pun">(</span><span class="pln"> response</span><span class="pun">.</span><span class="pln">readyState </span><span class="pun">!=</span><span class="pln"> </span><span class="lit">4</span><span class="pln"> </span><span class="pun">||</span><span class="pln"> response</span><span class="pun">.</span><span class="pln">status </span><span class="pun">!=</span><span class="pln"> </span><span class="lit">200</span><span class="pln"> </span><span class="pun">)</span><span class="pln">
+ </span><span class="kwd">return</span><span class="pun">;</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class="pln"> </span><span class="str">"<br>"</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class="pln">name </span><span class="pun">+</span><span class="pln"> </span><span class="str">" response received: "</span><span class="pun">;</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">textContent </span><span class="pun">+=</span><span class="pln"> response</span><span class="pun">.</span><span class="pln">responseXML</span><span class="pun">;</span><span class="pln">
+ </span><span class="pun">}</span><span class="pln">
+
+ </span><span class="com">// Service messaging to mute the provided service</span><span class="pln">
+ </span><span class="kwd">var</span><span class="pln"> svcMsg </span><span class="pun">=</span><span class="pln"> </span><span class="str">'<?xml version="1.0" encoding="utf-8"?>'</span><span class="pln"> </span><span class="pun">+</span><span class="pln">
+ </span><span class="str">'<s:Envelope s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" '</span><span class="pln"> </span><span class="pun">+</span><span class="pln">
+ </span><span class="str">'xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">'</span><span class="pln"> </span><span class="pun">+</span><span class="pln">
+ </span><span class="str">'<s:Body>'</span><span class="pln"> </span><span class="pun">+</span><span class="pln">
+ </span><span class="str">'<u:SetMute xmlns:u="urn:schemas-upnp-org:service:RenderingControl:1">'</span><span class="pln"> </span><span class="pun">+</span><span class="pln">
+ </span><span class="str">'<InstanceID>0</InstanceID>'</span><span class="pln"> </span><span class="pun">+</span><span class="pln">
+ </span><span class="str">'<Channel>Master</Channel>'</span><span class="pln"> </span><span class="pun">+</span><span class="pln">
+ </span><span class="str">'<DesiredMute>true</DesiredMute>'</span><span class="pln"> </span><span class="pun">+</span><span class="pln">
+ </span><span class="str">'</u:SetMute>'</span><span class="pln"> </span><span class="pun">+</span><span class="pln">
+ </span><span class="str">'</s:Body>'</span><span class="pln"> </span><span class="pun">+</span><span class="pln">
+ </span><span class="str">'</s:Envelope>'</span><span class="pun">;</span><span class="pln">
+
+ svcXhr</span><span class="pun">.</span><span class="pln">send</span><span class="pun">(</span><span class="pln">svcMsg</span><span class="pun">);</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class="pln"> </span><span class="str">"<br>"</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> services</span><span class="pun">[</span><span class="lit">0</span><span class="pun">].</span><span class="pln">name </span><span class="pun">+</span><span class="pln"> </span><span class="str">" request sent: "</span><span class="pun">;</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">textContent </span><span class="pun">+=</span><span class="pln"> svcMsg</span><span class="pun">;</span><span class="pln">
+ </span><span class="pun">}</span><span class="pln">
+
+ </span><span class="kwd">function</span><span class="pln"> errorCallback</span><span class="pun">(</span><span class="pln"> error </span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">
+ debug</span><span class="pun">.</span><span class="pln">innerHTML </span><span class="pun">+=</span><span class="pln"> </span><span class="str">"<br>An error occurred: "</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> error</span><span class="pun">.</span><span class="pln">code</span><span class="pun">;</span><span class="pln">
+ </span><span class="pun">}</span><span class="pln">
+</span><span class="tag"></script></span></pre>
+ </div>
+ </section>
+ <section id="acknowledgements">
+ <!--OddPage--><h2><span class="secno">B. </span>
+ Acknowledgements
+ </h2>
+ <p>
+ Thanks are expressed by the editor to the following individuals for their feedback on this specification to
+ date (in alphabetical order):<br>
+ <br>
+ Gar Bergstedt, Lars-Erik Bolstad, Cathy Chan, Hari G Kumar, Bob Lund, Giuseppe Pascale, Marcin Simonides,
+ Clarke Stevens, Christian Söderström, Mark Vickers.
+ </p>
+ <p>
+ Thanks are also expressed by the editor to the following organizations and groups for their support in
+ producing this specification to date (in alphabetical order):<br>
+ <br>
+ CableLabs, Opera Software ASA, <abbr title="World Wide Web Consortium">W3C</abbr> Device APIs Working Group, <abbr title="World Wide Web Consortium">W3C</abbr> Web and TV Interest Group.
+ </p>
+ </section>
+
+
+<section id="references" class="appendix"><!--OddPage--><h2><span class="secno">C. </span>References</h2><section id="normative-references"><h3><span class="secno">C.1 </span>Normative references</h3><dl class="bibliography"><dt id="bib-DNS-SD">[DNS-SD]</dt><dd>S. Cheshire; M. Krochmal. <a href="http://files.dns-sd.org/draft-cheshire-dnsext-dns-sd.txt"><cite>DNS-Based Service Discovery.</cite></a> 27 February 2011. IETF Draft. URL: <a href="http://files.dns-sd.org/draft-cheshire-dnsext-dns-sd.txt">http://files.dns-sd.org/draft-cheshire-dnsext-dns-sd.txt</a>
+</dd><dt id="bib-DOM4">[DOM4]</dt><dd>Anne van Kesteren; Aryeh Gregor; Ms2ger. <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html/"><cite>DOM4.</cite></a> URL: <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html/">http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html/</a>
+</dd><dt id="bib-HTML5">[HTML5]</dt><dd>Ian Hickson; David Hyatt. <a href="http://www.w3.org/TR/html5"><cite>HTML5.</cite></a> 29 March 2012. W3C Working Draft. (Work in progress.) URL: <a href="http://www.w3.org/TR/html5">http://www.w3.org/TR/html5</a>
+</dd><dt id="bib-MDNS">[MDNS]</dt><dd>S. Cheshire; M. Krochmal. <a href="http://files.multicastdns.org/draft-cheshire-dnsext-multicastdns.txt"><cite>Multicast DNS.</cite></a> 14 February 2011. IETF Draft. URL: <a href="http://files.multicastdns.org/draft-cheshire-dnsext-multicastdns.txt">http://files.multicastdns.org/draft-cheshire-dnsext-multicastdns.txt</a>
+</dd><dt id="bib-RFC2119">[RFC2119]</dt><dd>S. Bradner. <a href="http://www.ietf.org/rfc/rfc2119.txt"><cite>Key words for use in RFCs to Indicate Requirement Levels.</cite></a> March 1997. Internet RFC 2119. URL: <a href="http://www.ietf.org/rfc/rfc2119.txt">http://www.ietf.org/rfc/rfc2119.txt</a>
+</dd><dt id="bib-UPNP-DEVICEARCH11">[UPNP-DEVICEARCH11]</dt><dd><a href="http://upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.1.pdf"><cite>UPnP Device Architecture 1.1</cite></a>. 15 October 2008. UPnP Forum. PDF document. URL: <a href="http://upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.1.pdf">http://upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.1.pdf</a>
+</dd><dt id="bib-WEBIDL">[WEBIDL]</dt><dd>Cameron McCormack. <a href="http://www.w3.org/TR/2011/WD-WebIDL-20110927/"><cite>Web IDL.</cite></a> 27 September 2011. W3C Working Draft. (Work in progress.) URL: <a href="http://www.w3.org/TR/2011/WD-WebIDL-20110927/">http://www.w3.org/TR/2011/WD-WebIDL-20110927/</a>
+</dd></dl></section></section></body></html>
\ No newline at end of file
--- a/gallery/Overview.html Tue Oct 02 18:05:58 2012 -0700
+++ b/gallery/Overview.html Tue Oct 02 18:07:01 2012 -0700
@@ -99,8 +99,8 @@
The following code illustrates how to obtain media object from a user's media gallery:
</p>
<pre class="example highlight">
- var intent = new Intent({ action: "http://webintents.org/pick",
- type: "http://w3.org/type/media",
+ var intent = new Intent({ action: "http://intents.w3.org/pick",
+ type: "http://intents.w3.org/type/media",
extras: { search: "Olympic",
filters: ["title", "description", "author", "tags"],
limit: 100 }});
@@ -216,10 +216,10 @@
<section>
<h2>Intent Description</h2>
<p>
- The action for this Intent is <code>http://webintents.org/pick</code>.
+ The action for this Intent is <code>http://intents.w3.org/pick</code>.
</p>
<p>
- The type for this Intent is <code>http://w3.org/type/media</code>.
+ The type for this Intent is <code>http://intents.w3.org/type/media</code>.
</p>
<p>
When a <a>media service</a> is matched for delivery using these action and type, it
@@ -248,19 +248,19 @@
The <a>MediaIntentExtras</a> dictionary describes the options that the invoker can inform to the service as hints in searching the media objects. None of the fields are mandatory.
</p>
<dl title='dictionary MediaIntentExtras' class='idl'>
- <dt>DOMString? search</dt>
+ <dt>DOMString search</dt>
<dd>
A string which provides a hint to the <a>media service</a> to search media objects.
The exact manner in which this hint is exploited is entirely up to the <a>media service</a>.
</dd>
- <dt>DOMString[]? filters</dt>
+ <dt>sequence<DOMString> filters</dt>
<dd>
An array of string which contain hints to the <a>media service</a> to the DOMString and DOMString[] fields in the <a>Media</a> dictionary that
the Web application prefers to use as search criteria. The <a>media service</a> MAY
use the values of the <a>filters</a> to search media objects in the media gallery. If a filter name is provided that the <a>media service</a> does not recognise as a field
of the <a>Media</a> dictionary, then it MUST ignore it.
</dd>
- <dt>unsigned long? limit</dt>
+ <dt>unsigned long limit</dt>
<dd>
By default a <a>media service</a> MAY return as many media objects as the user selects. If <code>limit</code>
is specified, the <a>media service</a> MUST NOT return more than <code>limit</code> media objects. The
@@ -285,9 +285,9 @@
<a href="#extended-media-properties-and-parameters">Extended Media Properties and Parameters</a>.
</p>
<dl title='dictionary Media' class='idl'>
- <dt>MediaContent content</dt>
+ <dt>Object content</dt>
<dd>
- The dictionary contains the URI to the content of the media resource. It optionally contains a Blob of the content.
+ A <a>MediaContent</a> dictionary object containing the URI to the content of the media resource. It optionally contains a Blob of the content.
</dd>
<dt>DOMString title</dt>
<dd>
@@ -301,101 +301,101 @@
<dd>
The attribute specifies the MIME type of the media resource (e.g., image/png, video/*) [[RFC2046]].
</dd>
- <dt>DOMString? author</dt>
+ <dt>DOMString author</dt>
<dd>
The attribute specifies the creator of the media resource.
<p class="note">
The name of the attribute represents various contributors, e.g. creator, artist, actoress, etc., in the given media resouce. Hence, the name of the attribute can be changed based on the discussion.
</p>
</dd>
- <dt>DOMString? publisher</dt>
+ <dt>DOMString publisher</dt>
<dd>
The attribute specifies the publisher of the media resource. The attribute can represent various contributors including media uploader, album artist, producer, etc.
</dd>
- <dt>DOMString? composer</dt>
+ <dt>DOMString composer</dt>
<dd>
The attribute specifies the composer of the media resource.
<p class="note">
The usage of the attribute in deployed web services is low (see <a href="#metadata-properties">Metadata properties table</a>.) However, the use case exists in audio applications. The retention of the attribue will be discussed in the group.
</p>
</dd>
- <dt>DOMString? collection</dt>
+ <dt>DOMString collection</dt>
<dd>
The attribute specifies the name of the collection that the media resource belongs to.
<p class="note">
The name of the attribute represents various sets of media resources, e.g. music album, photo album, video collection, etc. Hence, the name of the attribute can be changed based on the discussion.
</p>
</dd>
- <dt>DOMString? genre</dt>
+ <dt>DOMString genre</dt>
<dd>
The attribute specifies the genre (category) of the content of the media resource.
</dd>
- <dt>DOMString? copyright</dt>
+ <dt>DOMString copyright</dt>
<dd>
The attribute specifies the copyright statement associated with the media resource.
</dd>
- <dt>DOMString? path</dt>
+ <dt>DOMString path</dt>
<dd>
The attribute specifies file path of the media resource in user's local storage. The value of the attribute can be an absolute file path or a name of the leaf file considering the use cases.
<p class="note">
Although, the original purpose of the attribute is to denote the file path of user's local storage, any additional URL information can be delivered in this attribute.
</p>
</dd>
- <dt>float? size</dt>
+ <dt>float size</dt>
<dd>
The attribute specifies the size of the content of the media resource.
</dd>
- <dt>Position? location</dt>
+ <dt>Position location</dt>
<dd>
The attribute contains the location information related to the content of the media resource. [[GEOLOCATION-API]]
</dd>
- <dt>DOMString[]? tags</dt>
+ <dt>sequence<DOMString> tags</dt>
<dd>
The attribute contains the array of strings representing series of tag string.
</dd>
- <dt>MediaContent? thumbnail</dt>
+ <dt>Object thumbnail</dt>
<dd>
- The dictionary contains the URI to the thumbnail of the content of the media resource. It optionally contains a Blob of the thumbnail of the content.
+ A <a>MediaContent</a> dictionary object containing the URI to the thumbnail of the content of the media resource. It optionally contains a Blob of the thumbnail of the content.
</dd>
- <dt>Date? date</dt>
+ <dt>Date date</dt>
<dd>
The date Date object represents either the creation date or the last updated date of the media resource.
</dd>
- <dt>Date? publishDate</dt>
+ <dt>Date publishDate</dt>
<dd>
The publishDate Date object represents the publishing date of the media resource.
</dd>
- <dt>unsigned long? duration</dt>
+ <dt>unsigned long duration</dt>
<dd>
The attribute specifies the actual duration of the resource in seconds. (e.g., a running time for a film, a length of a song, etc.)
</dd>
- <dt>Resolution? resolution</dt>
+ <dt>Object resolution</dt>
<dd>
- The dictionary specifies the width and height of the media resource in pixels. (e.g., the resolution of Full HD, 1080p, can be represented as: width = 1920 and height = 1080.)
+ A <a>Resolution</a> dictionary object specifying the width and height of the media resource in pixels. (e.g., the resolution of Full HD, 1080p, can be represented as: width = 1920 and height = 1080.)
</dd>
- <dt>unsigned long? trackNumber</dt>
+ <dt>unsigned long trackNumber</dt>
<dd>
The attribute specifies the track number of the media resource.
<p class="note">
The usage of the attribute is confined to audio type. (see <a href="#metadata-properties">Metadata properties table</a>.) However, the use case exists in audio applications. The retention of the attribue will be discussed in the group.
</p>
</dd>
- <dt>DOMString? subtitle</dt>
+ <dt>DOMString subtitle</dt>
<dd>
The attribute contains the subtitle used in the media resource.
<p class="note">
The usage of the attribute in deployed web services is low (see <a href="#metadata-properties">Metadata properties table</a>.) However, the use case exists in audio and video applications. The retention of the attribue will be discussed in the group.
</p>
</dd>
- <dt>unsigned long? likeCount</dt>
+ <dt>unsigned long likeCount</dt>
<dd>
The attribute specifies the count of the votes in favor of the media resource.
</dd>
- <dt>unsigned long? viewCount</dt>
+ <dt>unsigned long viewCount</dt>
<dd>
The attribute specifies the access count made on the media resource.
</dd>
- <dt>float? rating</dt>
+ <dt>float rating</dt>
<dd>
The attribute specifies the rating value (e.g., customer rating, review, audience appreciation) of the media resource.
</dd>
@@ -412,7 +412,7 @@
<dd>
The URI to the content of the media resource. This attribute is a mandatory property.
</dd>
- <dt>Blob? blob</dt>
+ <dt>Blob blob</dt>
<dd>
The optional property to contain the media content in Blob format.
</dd>
@@ -1161,4 +1161,4 @@
</section>
</section>
</body>
-</html>
\ No newline at end of file
+</html>
--- a/light/Overview.html Tue Oct 02 18:05:58 2012 -0700
+++ b/light/Overview.html Tue Oct 02 18:07:01 2012 -0700
@@ -47,9 +47,28 @@
<h2>Introduction</h2>
<p>
The <a>DeviceLightEvent</a> interface provides web developers
- information about the ambient light levels near the hosting.
+ information about the ambient light levels near the
+ hosting in terms of lux units.
</p>
<p>
+ The <a>LightLevelEvent</a> interface provides web
+ developers information about the ambient light
+ levels near the hosting in terms of general ranges.
+ </p>
+ <p>
+ The values of the <a>LightLevelEvent</a> event may
+ be "normal", "dim", or "bright". "bright" is
+ supposed to mean "direct sunlight, or similarly
+ bright conditions that make it hard to see things
+ that aren't high-contrast". "dim" is supposed to
+ mean "dark enough that the light produced by a white
+ background is eye-straining or distracting". The
+ lux values for "dim" typical begin below 50, and the
+ values for "bright" begin above 10000.
+ </p>
+
+
+ <p>
This is achieved by interrogating a photosensors or similar detectors
of a device.
</p>
@@ -99,7 +118,7 @@
</section>
<section>
- <h2>Device light</h2>
+ <h2>Device Light</h2>
<p>
The HTML5 specification [[!HTML5]] defines a <a>Window</a> interface,
which this specification extends:
@@ -190,6 +209,101 @@
</section>
</section>
</section>
+
+ <section>
+ <h2>Light Level</h2>
+ <p>
+ The HTML5 specification [[!HTML5]] defines a <a>Window</a> interface,
+ which this specification extends:
+ </p>
+ <dl title="partial interface Window" class="idl">
+ <dt>attribute EventHandler onlightlevel</dt>
+ <dd>
+ </dd>
+ </dl>
+ <p>
+ The <code>onlightlevel</code> event handler and its corresponding
+ event handler event type <code>lightlevel</code> MUST be supported
+ as an IDL attribute by all objects implementing the <a>Window</a>
+ interface.
+ </p>
+ <section>
+ <h2><a>LightLevelEvent</a> Interface</h2>
+ <dl title="[Constructor (DOMString type, optional LightLevelEventInit eventInitDict)]
+ interface LightLevelEvent : Event"
+ class="idl" data-merge='LightLevelEventInit'>
+ <dt>readonly attribute string value</dt>
+ <dd>
+ The <a>light level</a> may be one of the following
+ strings: "normal", "dim", or "bright". The
+ corresponding lux values are left up to the UA.
+ </dd>
+ </dl>
+ <dl title="dictionary LightLevelEventInit : EventInit" class='idl'>
+ <dt>
+ string value
+ </dt>
+ <dd></dd>
+ </dl>
+ <p>
+ When a <dfn>user agent</dfn> is required to <dfn>fire a light
+ level event</dfn>, the <dfn>user agent</dfn> MUST run the
+ following steps:
+ </p>
+ <ol class="rule">
+ <li>
+ <a>Create an event</a> that uses the <a>LightLevelEvent</a>
+ interface, with the name <code>lightlevel</code>, which
+ bubbles, is not cancelable, and has no default action, that also
+ meets the following conditions:
+ <ol>
+ <li>
+ If the implementation is unable to report the <a>current
+ light level</a>, initialize the <code>value</code>
+ attribute to empty string, otherwise initialize the
+ attribute to the <a>current light level</a>.
+ </li>
+ </ol>
+ </li>
+ <li>
+ <a>Queue a task</a> to dispatch the newly created event at the
+ <a>Window</a> object.
+ </li>
+ </ol>
+ <p>
+ When <a>the current light</a> changes, the <a>user
+ agent</a> MUST <a>fire a light level event</a>.
+ </p>
+ <div class="note">
+ The definition of granularity i.e. how often the event is fired is
+ left to the implementation. Implementations may fire the event if
+ they have reason to believe that the page does not have sufficiently
+ fresh data.
+ </div>
+ <section>
+ <h2>Event handlers</h2>
+ <p>
+ The following are the <a>event handlers</a> (and their corresponding
+ <a>event handler event types</a>) that MUST be supported as
+ attributes by the <code>Window</code> object:
+ </p>
+ <table class="simple">
+ <thead>
+ <tr>
+ <th>event handler</th>
+ <th>event handler event type</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><strong><code>onlightlevel</code></strong></td>
+ <td><code>lightlevel</code></td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+ </section>
+ </section>
<section class="appendix">
<h2>Acknowledgements</h2>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/light/tests/submissions/marcosc/manifest.txt Tue Oct 02 18:07:01 2012 -0700
@@ -0,0 +1,3 @@
+index.html
+index.html
+
--- a/media-stream-capture/scenarios.html Tue Oct 02 18:05:58 2012 -0700
+++ b/media-stream-capture/scenarios.html Tue Oct 02 18:07:01 2012 -0700
@@ -12,7 +12,7 @@
company: "Microsoft Corp.",
url: "mailto:travis.leithead@microsoft.com?subject=MediaStream Capture Scenarios Feedback",
companyURL: "http://www.microsoft.com"}],
- publishDate: "2012-03-06",
+ publishDate: "2012-08-31",
edDraftURI: "http://dvcs.w3.org/hg/dap/raw-file/tip/media-stream-capture/scenarios.html",
previousPublishDate: null,
prevED: "http://dvcs.w3.org/hg/dap/raw-file/a8e255b904df/media-stream-capture/scenarios.html",
@@ -158,7 +158,57 @@
networking and peer-to-peer RTC scenarios.
</p>
</section>
-
+ <section>
+ <h2>Concepts and Definitions</h2>
+ <p>
+ This section describes some terminology and concepts that frame an understanding of the design considerations
+ that follow. It is helpful to have a common understanding of some core concepts to ensure that the prose is
+ interpreted uniformly.
+ </p>
+ <dl>
+ <dt> Media Stream and Stream</dt>
+ <dd>This document uses these terms interchangeably. They are intended to be
+ a generalization of the more specific <code>MediaStream</code> interface as currently defined in the
+ WebRTC spec. Generally, a stream can be understood as a tube or conduit between sources (the stream's
+ generators) and destinations (the sinks). Streams don't generally include any type of significant buffer, that is,
+ content pushed into the stream from a source does not collect into any buffer for later collection. Rather, content
+ is simply dropped on the floor if the stream is not connected to a sink. The content flowing through a media
+ stream is not in any particular underlying format. (Note that the
+ the WebRTC specification makes a similar assertion about the content flowing
+ through a <code>MediaStream</code>.)
+ </dd>
+ <dt>Media Capture versus Recording</dt>
+ <dd>This document uses 'media capture' to refer to the process of obtaining a stream of data
+ from a device. As noted above, that data is not assumed to be in any particular format.
+ 'Recording', on the other hand, refers to the capture of media under application control
+ and in a specific, known, format. Such data can be written to a local file or sent to a
+ remote destination.</dd>
+ <dt>Shared devices, devices with manipulatable state, and virtualization</dt>
+ <dd>
+ <p>A shared device (in this document) is a media device (camera or microphone) that is usable by more than
+ one application at a time. When considering sharing a device (or not), an operating system must evaluate
+ whether applications consuming the device will have the ability to manipulate the state of the device. A shared device
+ with manipulatable state has the side-effect of allowing one application to make changes to a device that will then
+ affect other applications who are also sharing.
+ </p>
+ <p>To avoid these effects and unexpected state changes in applications, operating systems may virtualize a
+ device. Device virtualization (in a simplistic view) is an abstraction of the actual device, so that the abstraction
+ is provided to the application rather than providing the actual device. When an application manipulates the state
+ of the virtualized device, changes occur only in the virtualized layer, and do not affect other applications that
+ may be sharing the device.
+ </p>
+ <p>Audio devices are commonly virtualized. This allows many applications to share the audio device and manipulate its
+ state (e.g., apply different input volume levels) without affecting other applications.
+ </p>
+ <p>Video virtualization is more challenging and not as common. For example, the Microsoft Windows operating system does
+ not virtualize webcam devices, and thus chooses not to share the webcam between applications. As a result, in order
+ for an application to use the webcam either 1) another application already using the webcam must yield it up or 2)
+ the requesting application may be allowed to "steal" the device.
+ </p>
+ </dd>
+ </dl>
+ </p>
+ </section>
<section>
<h2>Scenarios</h2>
<p>
@@ -187,15 +237,6 @@
<p>Requirements: <a href="#p1">P1</a>, <a href="#p1">P2</a>, <a href="#lm1">LM1</a>,
<a href="#lm2">LM2</a>,<a href="#lm3">LM3</a>,<a href="#LM12">LM12</a>, <a href="#mc1">MC1</a>,
<a href="#mc2">MC2</a>.</p>
- <ol>
- <li>Browser requires webcam and microphone permissions (one-time-use example)</li>
- <li>Local webcam video preview</li>
- <li>Image capture from webcam</li>
- <li>Image resizing after capture (scenario out of scope)</li>
- <li>Local microphone preview via equalizer visualization</li>
- <li>Local microphone stops capturing automatically after a period of silence</li>
- <li>Upload captured image and audio to server</li>
- </ol>
<section>
@@ -227,19 +268,6 @@
<a href="#rm2">RM2</a>, <a href="#rm3">RM3</a>,<a href="#rm4">RM4</a>, <a href="#mc3">MC3</a>,
<a href="#mc6">MC6</a>.
</p>
- <ol>
- <li>Browser persisted webcam and microphone permissions</li>
- <li>Local webcam video preview</li>
- <li>Approval/authentication before sending/receiving real-time video between browsers</li>
- <li>Remote connection video + audio preview</li>
- <li>Video capture from local webcam + microphone</li>
- <li>Capture combined audio from local microphone/remote connections</li>
- <li>Persisting the capture while in a background tab</li>
- <li>Disabling video on a video+audio remote connection</li>
- <li>Switching a running video+audio capture between local/remote connection without interruption</li>
- <li>Adding an video+audio remote connection to a running video capture</li>
- <li>Upload of video/audio capture to server while capture is running</li>
- </ol>
<section>
<h4>Variations</h4>
@@ -264,15 +292,6 @@
<p>Requirements:<a href="#lm1">LM1</a>, <a href="#lm6">LM6</a>, <a href="#lm7">LM7</a>,
<a href="#mc1">MC1</a>,
<a href="#mc4">MC4</a>, <a href="#mc5">MC5</a>. </p>
- <ol>
- <li>Image frames can be extracted from local webcam video</li>
- <li>Modified image frames can be inserted/combined into a video capture</li>
- <li>Assign (and check for) a specific video capture encoding format</li>
- <li>Local webcam video preview</li>
- <li>Enforce (or check for) video capture size constraints and recording time limits</li>
- <li>Set the webcam into a low-resolution (320x200 or as supported by the hardware) capture mode</li>
- <li>Captured video format is available for upload prerequisite inspection.</li>
- </ol>
<section>
<h4>Variations</h4>
@@ -298,15 +317,7 @@
</p>
<p>Requirements: <a href="#p2">P2</a>, <a href="#lm9">LM9</a>,
<a href="#mc1">MC1</a>, <a href="#mc6">MC6</a>, <a href="#mc7">MC8</a>.</p>
- <ol>
- <li>Web app presents multiple webcams and microphones for activation</li>
- <li>Local video previews from two separate webcams simultaneously</li>
- <li>Image capture from webcam (high resolution)</li>
- <li>Video capture from local webcam + microphone</li>
- <li>Switching a running video+audio capture between two local webcams without interruption</li>
- <li>Use of battery status to automatically manage video and audio capture</li>
- <li>Recording termination (error recovery) when camera(s) stop.</li>
- </ol>
+
<section>
<h4>Variations</h4>
@@ -320,9 +331,7 @@
evening news.
</p>
<p>Requirements: <a href="#mc9">MC9</a>.</p>
- <ol>
- <li>Capture from three cameras + microphone at the same time (to separate captures)</li>
- </ol>
+
</section>
<section>
<h5>Picture-in-picture (capture a composed video)</h5>
@@ -334,10 +343,7 @@
Albert is happy that he didn't miss the moment by having to switch between cameras.
</p>
<p>Requirements: <a href="#lm9">LM9</a>, <a href="#lmc10">MC10</a>.</p>
- <ol>
- <li>Preview two webcams at the same time</li>
- <li>Combining two webcams + microphone into one capture</li>
- </ol>
+
</section>
</section>
</section>
@@ -365,21 +371,7 @@
<a href="#rm5">RM5</a>, <a href="#rm6">RM6</a>, <a href="#mc1">MC1</a>, <a href="#mc6">MC6</a>,
<a href="#mc11">MC11</a>, <a href="#mc12">MC12</a>, <a href="#mc13">MC13</a>.
</p>
- <ol>
- <li>Approval/authentication before sending/receiving real-time video between browsers</li>
- <li>Remote connection video + audio preview</li>
- <li>Browser requires webcam(s) and microphone permissions before use</li>
- <li>Local webcam video preview</li>
- <li>Video capture from local webcam + microphone</li>
- <li>Video capture from remote connections (audio + video)</li>
- <li>Capture combined audio from local microphone/remote connections</li>
- <li>Comparing audio input level from among various local/remote connections</li>
- <li>Switching a running video+audio capture between local webcam/remote connections without interruption</li>
- <li>Send an image through a remote [video] connection</li>
- <li>Pause/resume video+audio capture</li>
- <li>Rewind captured video and re-play</li>
- <li>Remote connection termination and removal of video+audio preview</li>
- </ol>
+
<section>
<h4>Variations</h4>
@@ -392,9 +384,7 @@
source and send that video to the group as he demonstrates the UI elements.
</p>
<p>Requirements: <a href="#lm10">LM10</a>.</p>
- <ol>
- <li>Video capture from local screen/display</li>
- </ol>
+
</section>
</section>
</section>
@@ -412,9 +402,7 @@
as if their competitor's devices were broken in order to convince users to purchase their own brand of webcam.
</p>
<p>Requirements: <a href="#p5">P5</a>.</p>
- <ol>
- <li>Browser requires webcam(s) and microphone permissions before use</li>
- </ol>
+
<section>
<h4>Variations</h4>
@@ -425,9 +413,9 @@
<section>
<h2>Requirements</h2>
- <p>
+ <p>PERMISSIONS</p>
<ol>
- <p>PERMISSIONS</p>
+
<li ><a name="p1">The UA must </a> request the user's permission before accessing any media devices.</li>
<li><a name="p2">The UA must </a>allow the user to grant permission to specific devices. (Example: front camera is ok, back camera is not.)</li>
<li><a name="p3">The UA must </a>request the user's permission before sending or receiving a media stream to or from another user.</li>
@@ -447,106 +435,55 @@
<li><a name="lm7">The UA must </a>be able to insert image frames into a local video stream (or capture).</li>
<li><a name="lm8">The UA must </a>be able to modify stream parameters such as size and frame rate within the
limits set by the local hardware. </li>
- <li><a name="lm9">The UA must </a>be able to show previews of multiple local or remote streams simultaneously.</li>
+ <li><a name="lm9">The UA must </a>be able to display multiple local or remote streams simultaneously.</li>
<li><a name="lm10">The UA must </a>support the use of the local screen/display as a video source.</li>
<li><a name="lm11">The UA must </a>allow the user to pause or stop media streams via UXes (and not just the
- buttons on the underlying hardware.)</li>
+ buttons on the underlying hardware.) The UX provided by the chrome must override any UX provided
+ by the Application. </li>
<li><a name="lm12">The UA must </a>provide a UX letting the user know when it is using one or more of
his media devices.</li>
</ol>
<p>REMOTE MEDIA</p>
+<p>These requirements for remote media are outside the scope of the Media Capture task force, but are relevant to
+ the related WebRTC/rtcWeb work, which is a joint effort of the W3C and the IETF. The <a href="http://datatracker.ietf.org/doc/draft-ietf-rtcweb-use-cases-and-requirements">
+ scenarios
+ and requirements document</a> for that effort contains requirements that are similar to those given here.
+ They are listed in parentheses after each item. .</p>
<ol>
-<li><a name="rm1">The UA must </a>be able to transmit media to one or more remote sites and to receive media from them.</li>
-<li><a name="rm2">The UA must </a>be able to offer a preview of audio and video media received from a remote site.</li>
-<li><a name="rm3">The UA must </a>be able to stop or pause the reception and/or transmission of any media stream independent of any other streams.</li>
-<li><a name="rm4">The UA must </a>be able to add new remote media connections while a capture is running. The new remote streams
- may or may not be included in the capture. </li>
- <li><a name="rm5">The UA must </a>be able to send or receive a still image over a video stream.</li>
- <li><a name="rm6">The UA must </a>provide the Application with the parameters of all streams (for example, audio level). </li>
-<p>The following requirement was suggested on the mailing list but is not part of any of the
- scenarios:</p>
-<li>Ability for user simply drag a image over a area of website, so the image is send to all of the other users</li>
+<li><a name="rm1">The UA must </a>be able to transmit media to one or more remote sites and to receive media from them. (rtcWeb: F2, F4, F11, F12)</li>
+<li><a name="rm2">The UA must </a>be able to play audio and video media received from a remote site. (rtcWeb: F4, F10)</li>
+<li><a name="rm3">The UA must </a>be able to stop or pause the reception and/or transmission of any media stream independent of any other streams. (rtcWeb: A8)</li>
+<li><a name="rm4">The UA must </a>be able to add new remote media connections while a recording is running. The new remote streams
+ may or may not be included in the recording. </li>
+ <li><a name="rm5">The UA must </a>be able to send or receive a still image over a video stream. </li>
+ <li><a name="rm6">The UA must </a>provide the Application with the parameters of all streams (for example, audio level). (rtcWeb: F14, F38, A12, A14) </li>
+
</ol>
-<p>Media Capture</p>
+<p>RECORDING</p>
<ol>
-<li><a name="mc1">The UA must </a>be able to capture local or remote audio streams, video streams or still images from a camera or microphone
- and store the result as a [local?] file.</li>
-<li><a name="mc2"> The UA must </a>enable the Application to trigger media capture either from a button click or a timer event.</li>
-<li><a name="mc3">The UA must </a>be able to send captured media to one or more remote locations while capture is running.</li>
-<li><a name="mc4">The UA must </a>enable the Application to select the capture format and resolution from those available on the local hardware.</li>
-<li><a name="mc5">the UA must </a>enable the Application to set size contraints and time limits on media capture. </li>
-<li><a name="mc6">The UA must </a>allow the user to switch capture between one or more local and remote streams without interruption.</li>
+<li><a name="mc1">The UA must </a>be able to record local or remote audio streams, video streams or still images from a camera or microphone
+ and store the result as a file.</li>
+<li><a name="mc2"> The UA must </a>enable the Application to trigger recording either from a button click or a timer event.</li>
+<li><a name="mc3">The UA must </a>be able to send recorded media to one or more remote locations while recording is running.</li>
+<li><a name="mc4">The UA must </a>enable the Application to select the recording format and resolution from those available on the local hardware.</li>
+<li><a name="mc5">the UA must </a>enable the Application to set size contraints and time limits on recording. </li>
+<li><a name="mc6">The UA must </a>allow the user to switch recording between one or more local and remote streams without interruption.</li>
<li><a name="mc7">The UA must </a>enable the Application to use device properties, such as battery level, to determine when to terminate media capture.</li>
-<li><a name="mc8">The UA must </a>enable error recovery in the case of premature termination of media capture.</li>
-<li><a name="mc9">The UA must </a>support simultaneous recording from multiple devices into separate captures.</li>
-<li><a name="mc10">The UA must </a>support simultaneous recording from multiple devices into a single capture. </li>
-<li><a name="mc11">The UA must </a>support the dynamic addition and deletion of streams from a capture.</li>
-<li><a name="mc12">The UA must </a>enable the Application to pause and resume the capture of local or remote streams.</li>
-<li><a name="mc13">The UA must </a>enable the Application to rewind and replay a paused capture stream.</li>
-<p>The following three requirements were suggested on the mailing list but are not part of any of the
- scenarios:</p>
-<li>Ability for user to request recorded video/audio stream from secretary for preview or reference in discussion</li>
-<li>Ability for user or secretary to playback the capture video/audio to new comers to a arbitrary time point for his quickly catch-up</li>
-<li>Ability for user simply drag a image over video of other attendee to directly send the image(to other user without open a new window</li>
+<li><a name="mc8">The UA must </a>enable error recovery in the case of premature termination of recording.</li>
+<li><a name="mc9">The UA must </a>support simultaneous recording from multiple devices into separate recordings.</li>
+<li><a name="mc10">The UA must </a>support simultaneous recording from multiple devices into a single recording. </li>
+<li><a name="mc11">The UA must </a>support the dynamic addition and deletion of streams from a recording.</li>
+<li><a name="mc12">The UA must </a>enable the Application to pause and resume the recording of local or remote streams.</li>
+<li><a name="mc13">The UA must </a>enable the Application to rewind and replay a paused recorded stream.</li>
+
</ol>
- </p>
+
</section>
- <section>
- <h2>Concepts and Definitions</h2>
- <p>
- This section describes some terminology and concepts that frame an understanding of the design considerations
- that follow. It is helpful to have a common understanding of some core concepts to ensure that the prose is
- interpreted uniformly.
- </p>
- <dl>
- <dt><code>MediaStream</code> vs "media stream" or "stream"</dt>
- <dd>In some cases, I use these terms interchangeably; my usage of the term "media stream" or "stream" is intended as
- a generalization of the more specific <code>MediaStream</code> interface as currently defined in the
- WebRTC spec. Generally, a stream can be conceptually understood as a tube or conduit between sources (the stream's
- generators) and destinations (the sinks). Streams don't generally include any type of significant buffer, that is,
- content pushed into the stream from a source does not collect into any buffer for later collection. Rather, content
- is simply dropped on the floor if the stream is not connected to a sink. This document assumes the non-buffered view
- of streams as previously described.
- </dd>
- <dt><code>MediaStream</code> format</dt>
- <dd>As stated in the WebRTC specification, the content flowing through a <code>MediaStream</code> is not in
- any particular underlying format:</dd>
- <dd><blockquote>[The data from a <code>MediaStream</code> object does not necessarily have a canonical binary form; for
- example, it could just be "the video currently coming from the user's video camera". This allows user agents
- to manipulate media streams in whatever fashion is most suitable on the user's platform.]</blockquote></dd>
- <dd>This document reinforces that view, especially when dealing with capturing of the <code>MediaStream</code> content
- and the potential interaction with the Streams API.
- </dd>
- <dt>Shared devices, devices with manipulatable state, and virtualization</dt>
- <dd>
- <p>A shared device (in this document) is a media device (camera or microphone) that is usable by more than
- one application at a time. When considering sharing a device (or not), an operating system must evaluate
- whether applications consuming the device will have the ability to manipulate the state of the device. A shared device
- with manipulatable state has the side-effect of allowing one application to make changes to a device that will then
- affect other applications who are also sharing.
- </p>
- <p>To avoid these effects and unexpected state changes in applications, operating systems may virtualize a
- device. Device virtualization (in a simplistic view) is an abstraction of the actual device, so that the abstraction
- is provided to the application rather than providing the actual device. When an application manipulates the state
- of the virtualized device, changes occur only in the virtualized layer, and do not affect other applications that
- may be sharing the device.
- </p>
- <p>Audio devices are commonly virtualized. This allows many applications to share the audio device and manipulate its
- state (e.g., apply different input volume levels) without affecting other applications.
- </p>
- <p>Video virtualization is more challenging and not as common. For example, the Microsoft Windows operating system does
- not virtualize webcam devices, and thus chooses not to share the webcam between applications. As a result, in order
- for an application to use the webcam either 1) another application already using the webcam must yield it up or 2)
- the requesting application may be allowed to "steal" the device.
- </p>
- </dd>
- </dl>
- </p>
- </section>
+
<section>
<h2>Design Considerations and Remarks</h2>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/pressure/Overview.html Tue Oct 02 18:07:01 2012 -0700
@@ -0,0 +1,200 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <title>Atmospheric Pressure Events</title>
+ <meta charset="utf-8"/>
+ <script src='http://www.w3.org/Tools/respec/respec-w3c-common' class='remove'></script>
+ <!--script src='http://dev.w3.org/2009/dap/ReSpec.js/js/respec.js' class='remove'></script-->
+ <script class="remove">
+ var respecConfig = {
+ specStatus: "unofficial",
+ shortName: "atmpressure",
+ //publishDate: "yyyy-mm-dd",
+ //previousPublishDate: "yyyy-mm-dd",
+ previousMaturity: "ED",
+ edDraftURI: "http://dvcs.w3.org/hg/dap/raw-file/tip/pressure/Overview.html",
+ //lcEnd: "yyyy-mm-dd",
+ editors: [
+ { name: "Dzung D Tran", company: "Intel", companyURL: "http://intel.com/" }
+ ],
+ inlineCSS: true,
+ noIDLIn: true,
+ //extraCSS: ["../ReSpec.js/css/respec.css"],
+ extraCSS: ["http://dev.w3.org/2009/dap/ReSpec.js/css/respec.css"],
+ wg: "Device APIs Working Group",
+ wgURI: "http://www.w3.org/2009/dap/",
+ wgPublicList: "public-device-apis",
+ wgPatentURI: "http://www.w3.org/2004/01/pp-impl/43696/status",
+ };
+ </script>
+ </head>
+<body>
+ <section id="abstract">
+ This specification defines a means to receive events that correspond to changes in
+ atmospheric pressure.
+ </section>
+
+ <section id="sotd">
+
+ </section>
+
+ <section class="informative">
+ <h2>Introduction</h2>
+ <p>
+ The <a>AtmPressureEvent</a> interface provides web developers
+ information about the atmospheric pressure levels measured at the hosting device.
+ </p>
+ <p>
+ This is achieved by interrogating a barometer or similar detectors
+ of the hosting device. Not all devices contain a barometer, and when
+ there is no barometer, this API is still exposed to the
+ scripting environment but it does nothing.
+ </p>
+
+ <section>
+ <h3>Use Cases</h3>
+ <p>Altitude sensing applications which make use of the relationship between changes in pressure relative to the altitude.</p>
+ <p>Weather prediction applications which make use of barometric pressure to predict weather conditions such as rain is coming.</p>
+ <p>Simple informative weather application that reports atmospheric pressure along with other data.</p>
+ </section>
+
+ </section>
+
+ <section id="conformance">
+ <p>
+ This specification defines conformance criteria that apply to a single
+ product: the <dfn>user agent</dfn> that implements the
+ interfaces that it contains.
+ </p>
+ </section>
+
+ <section>
+ <h2>Terminology</h2>
+ <p>
+ The <code><a href="http://dev.w3.org/html5/spec/webappapis.html#eventhandler">
+ EventHandler</a></code> interface represents a <a href="http://www.w3.org/TR/WebIDL/#idl-callback-functions">callback function</a> used for <a href="http://dev.w3.org/html5/spec/webappapis.html#event-handlers">event
+ handlers</a> as defined in [[!HTML5]]. </p>
+ <p>
+ The concepts <dfn><a href="http://dev.w3.org/html5/spec/webappapis.html#queue-a-task">
+ queue a task</a></dfn> and
+ <dfn><a href="http://dev.w3.org/html5/spec/webappapis.html#fire-a-simple-event">
+ fires a simple event</a></dfn> are defined in [[!HTML5]].
+ </p>
+ <p>
+ The terms <dfn><a href="http://dev.w3.org/html5/spec/webappapis.html#event-handlers">
+ event handlers</a></dfn> and
+ <dfn><a href="http://dev.w3.org/html5/spec/webappapis.html#event-handler-event-type">
+ event handler event types</a></dfn> are defined in [[!HTML5]].
+ </p>
+ <p>The concepts <dfn>
+ <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#constructing-events">
+ create an event</a></dfn> and <dfn>
+ <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#firing-events">
+ fire an event</a></dfn> are defined in [[!DOM4]].
+ <p>
+ The <dfn>current atmospheric pressure</dfn> is a value that represents the
+ force per unit area exerted onto the hosting device around the pressure sensor by the weight of air above that surface in the atmosphere of Earth in hPA (millibar).
+ </p>
+ </section>
+
+ <section>
+ <h2>Security and privacy considerations</h2>
+ <p>
+ </p>
+ </section>
+
+ <section>
+ <h2>Atmospheric Pressure</h2>
+ <p>
+ The HTML5 specification [[!HTML5]] defines a <a>Window</a> interface,
+ which this specification extends:
+ </p>
+ <dl title="partial interface Window" class="idl">
+ <dt>attribute EventHandler onatmpressure</dt>
+ <dd>
+ </dd>
+ </dl>
+ <p>
+ The <code>onatmpressure</code> event handler and its corresponding
+ event handler event type <code>atmpressure</code> MUST be supported
+ as an IDL attribute by all objects implementing the <a>Window</a>
+ interface.
+ </p>
+ <section>
+ <h2><a>AtmPressureEvent</a> Interface</h2>
+ <dl title="[Constructor (DOMString type, optional AtmPressureEventInit eventInitDict)]
+ interface AtmPressureEvent : Event"
+ class="idl" data-merge='AtmPressureEventInit'>
+ <dt>readonly attribute double value</dt>
+ <dd>
+ The <a>current atmospheric pressure</a>.
+ </dd>
+ </dl>
+ <dl title="dictionary AtmPressureEventInit : EventInit" class='idl'>
+ <dt>
+ double value
+ </dt>
+ <dd></dd>
+ </dl>
+ <p>
+ When a <dfn>user agent</dfn> is required to <dfn>fire an atmospheric pressure event</dfn>, the <dfn>user agent</dfn> MUST run the
+ following steps:
+ </p>
+ <ol class="rule">
+ <li>
+ <a>Create an event</a> that uses the <a>AtmPressureEvent</a>
+ interface, with the name <code>atmpressure</code>, which
+ bubbles, is not cancelable, and has no default action, that also
+ meets the following conditions:
+ <ol>
+ <li>
+ If the implementation is unable to report the <a>current
+ atmospheric pressure</a>, initialize the <code>value</code>
+ attribute to positive Infinity, otherwise initialize the
+ attribute to the <a>current atmospheric pressure</a>.
+ </li>
+ </ol>
+ </li>
+ <li>
+ <a>Queue a task</a> to dispatch the newly created event at the
+ <a>Window</a> object.
+ </li>
+ </ol>
+ <p>
+ When the <a>current atmospheric pressure</a> changes, the <a>user
+ agent</a> MUST <a>fire a atmospheric pressure event</a>.
+ </p>
+ <div class="note">
+ The definition of granularity i.e. how often the event is fired is
+ left to the implementation. Implementations may fire the event if
+ they have reason to believe that the page does not have sufficiently
+ fresh data.
+ </div>
+ <section>
+ <h2>Event handlers</h2>
+ <p>
+ The following are the <a>event handlers</a> (and their corresponding
+ <a>event handler event types</a>) that MUST be supported as
+ attributes by the <code>Window</code> object:
+ </p>
+ <table class="simple">
+ <thead>
+ <tr>
+ <th>event handler</th>
+ <th>event handler event type</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><strong><code>onatmpressure</code></strong></td>
+ <td><code>atmpressure</code></td>
+ </tr>
+ </tbody>
+ </table>
+ </section>
+ </section>
+ </section>
+
+ <section class="appendix"></section>
+</body>
+</html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/proximity/tests/submissions/marcos/manifest.txt Tue Oct 02 18:07:01 2012 -0700
@@ -0,0 +1,3 @@
+index.html
+index.html
+
Binary file wi-addendum-local-services/FPWD/Example1_registration_page/Slide1.png has changed
Binary file wi-addendum-local-services/FPWD/Example_device_and_service_description_pages/Slide1.png has changed
Binary file wi-addendum-local-services/FPWD/Example_device_and_service_description_pages/Slide2.png has changed
Binary file wi-addendum-local-services/FPWD/Example_scenario_1/Slide1.png has changed
Binary file wi-addendum-local-services/FPWD/Example_scenario_1/Slide2.png has changed
Binary file wi-addendum-local-services/FPWD/Example_scenario_1/Slide3.png has changed
Binary file wi-addendum-local-services/FPWD/Example_scenario_2/Slide1.png has changed
Binary file wi-addendum-local-services/FPWD/Example_scenario_2/Slide2.png has changed
Binary file wi-addendum-local-services/FPWD/Example_scenario_2/Slide3.png has changed
Binary file wi-addendum-local-services/FPWD/Example_scenario_2/Slide4.png has changed
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/wi-addendum-local-services/FPWD/FPWD.html Tue Oct 02 18:07:01 2012 -0700
@@ -0,0 +1,990 @@
+<!DOCTYPE html>
+<html lang="en" dir="ltr">
+<head>
+ <title>Web Intents Addendum - Local Services</title>
+ <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
+ <!--
+ === NOTA BENE ===
+ For the three scripts below, if your spec resides on dev.w3 you can check them
+ out in the same tree and use relative links so that they'll work offline,
+ -->
+
+
+
+ <style type="text/css">
+
+ /* Add addition spacing to <ol> and <ul> for rule definition */
+ ol.rule li, ul.rule li { padding:0.6em; }
+
+ </style>
+
+
+ <style>/*****************************************************************
+ * ReSpec 3 CSS
+ * Robin Berjon - http://berjon.com/
+ *****************************************************************/
+
+/* --- INLINES --- */
+em.rfc2119 {
+ text-transform: lowercase;
+ font-variant: small-caps;
+ font-style: normal;
+ color: #900;
+}
+
+h1 acronym, h2 acronym, h3 acronym, h4 acronym, h5 acronym, h6 acronym, a acronym,
+h1 abbr, h2 abbr, h3 abbr, h4 abbr, h5 abbr, h6 abbr, a abbr {
+ border: none;
+}
+
+dfn {
+ font-weight: bold;
+}
+
+a.internalDFN {
+ color: inherit;
+ border-bottom: 1px solid #99c;
+ text-decoration: none;
+}
+
+a.externalDFN {
+ color: inherit;
+ border-bottom: 1px dotted #ccc;
+ text-decoration: none;
+}
+
+a.bibref {
+ text-decoration: none;
+}
+
+cite .bibref {
+ font-style: normal;
+}
+
+code {
+ color: #ff4500;
+}
+
+
+/* --- --- */
+ol.algorithm { counter-reset:numsection; list-style-type: none; }
+ol.algorithm li { margin: 0.5em 0; }
+ol.algorithm li:before { font-weight: bold; counter-increment: numsection; content: counters(numsection, ".") ") "; }
+
+/* --- TOC --- */
+.toc a, .tof a {
+ text-decoration: none;
+}
+
+a .secno, a .figno {
+ color: #000;
+}
+
+ul.tof, ol.tof {
+ list-style: none outside none;
+}
+
+.caption {
+ margin-top: 0.5em;
+ font-style: italic;
+}
+
+/* --- TABLE --- */
+table.simple {
+ border-spacing: 0;
+ border-collapse: collapse;
+ border-bottom: 3px solid #005a9c;
+}
+
+.simple th {
+ background: #005a9c;
+ color: #fff;
+ padding: 3px 5px;
+ text-align: left;
+}
+
+.simple th[scope="row"] {
+ background: inherit;
+ color: inherit;
+ border-top: 1px solid #ddd;
+}
+
+.simple td {
+ padding: 3px 10px;
+ border-top: 1px solid #ddd;
+}
+
+.simple tr:nth-child(even) {
+ background: #f0f6ff;
+}
+
+/* --- DL --- */
+.section dd > p:first-child {
+ margin-top: 0;
+}
+
+.section dd > p:last-child {
+ margin-bottom: 0;
+}
+
+.section dd {
+ margin-bottom: 1em;
+}
+
+.section dl.attrs dd, .section dl.eldef dd {
+ margin-bottom: 0;
+}
+</style><style>/* --- EXAMPLES --- */
+div.example-title {
+ min-width: 7.5em;
+ color: #b9ab2d;
+}
+div.example-title span {
+ text-transform: uppercase;
+}
+aside.example, div.example, div.illegal-example {
+ padding: 0.5em;
+ margin: 1em 0;
+ position: relative;
+ clear: both;
+}
+div.illegal-example { color: red }
+div.illegal-example p { color: black }
+aside.example, div.example {
+ padding: .5em;
+ border-left-width: .5em;
+ border-left-style: solid;
+ border-color: #e0cb52;
+ background: #fcfaee;
+}
+
+aside.example div.example {
+ border-left-width: .1em;
+ border-color: #999;
+ background: #fff;
+}
+aside.example div.example div.example-title {
+ color: #999;
+}
+</style><style>/* --- ISSUES/NOTES --- */
+div.issue-title, div.note-title {
+ padding-right: 1em;
+ min-width: 7.5em;
+ color: #b9ab2d;
+}
+div.issue-title { color: #e05252; }
+div.note-title { color: #52e052; }
+div.issue-title span, div.note-title span {
+ text-transform: uppercase;
+}
+div.note, div.issue {
+ margin-top: 1em;
+ margin-bottom: 1em;
+}
+.note > p:first-child, .issue > p:first-child { margin-top: 0 }
+.issue, .note {
+ padding: .5em;
+ border-left-width: .5em;
+ border-left-style: solid;
+}
+div.issue, div.note {
+ padding: 0.5em;
+ margin: 1em 0;
+ position: relative;
+ clear: both;
+}
+span.note, span.issue { padding: .1em .5em .15em; }
+
+.issue {
+ border-color: #e05252;
+ background: #fbe9e9;
+}
+.note {
+ border-color: #52e052;
+ background: #e9fbe9;
+}
+
+
+</style><style>/* HIGHLIGHTS */
+code.prettyprint {
+ color: inherit;
+}
+
+/* this from google-code-prettify */
+.pln{color:#000}@media screen{.str{color:#080}.kwd{color:#008}.com{color:#800}.typ{color:#606}.lit{color:#066}.pun,.opn,.clo{color:#660}.tag{color:#008}.atn{color:#606}.atv{color:#080}.dec,.var{color:#606}.fun{color:red}}@media print,projection{.str{color:#060}.kwd{color:#006;font-weight:bold}.com{color:#600;font-style:italic}.typ{color:#404;font-weight:bold}.lit{color:#044}.pun,.opn,.clo{color:#440}.tag{color:#006;font-weight:bold}.atn{color:#404}.atv{color:#060}}ol.linenums{margin-top:0;margin-bottom:0}li.L0,li.L1,li.L2,li.L3,li.L5,li.L6,li.L7,li.L8{list-style-type:none}li.L1,li.L3,li.L5,li.L7,li.L9{background:#eee}
+</style><link rel="stylesheet" href="http://www.w3.org/StyleSheets/TR/W3C-WD"><!--[if lt IE 9]><script src='undefined://www.w3.org/2008/site/js/html5shiv.js'></script><![endif]--></head><body><div class="head">
+ <p>
+
+ <a href="http://www.w3.org/"><img width="72" height="48" src="http://www.w3.org/Icons/w3c_home" alt="W3C"></a>
+
+ </p>
+ <h1 class="title" id="title">Web Intents Addendum - Local Services</h1>
+
+ <h2 id="w3c-working-draft-04-october-2012"><abbr title="World Wide Web Consortium">W3C</abbr> Working Draft 04 October 2012</h2>
+ <dl>
+
+ <dt>This version:</dt>
+ <dd><a href="http://www.w3.org/TR/2012/WD-webintents-local-services-20121004/">http://www.w3.org/TR/2012/WD-webintents-local-services-20121004/</a></dd>
+ <dt>Latest published version:</dt>
+ <dd><a href="http://www.w3.org/TR/webintents-local-services/">http://www.w3.org/TR/webintents-local-services/</a></dd>
+
+
+ <dt>Latest editor's draft:</dt>
+ <dd><a href="http://w3c-test.org/dap/wi-addendum-local-services/">http://w3c-test.org/dap/wi-addendum-local-services/</a></dd>
+
+
+
+
+
+
+ <dt>Editors:</dt>
+ <dd><span>Claes Nilsson</span>, <a href="http://www.sonymobile.com/se/">Sony Mobile</a></dd>
+<dd><span>Norifumi Kikkawa</span>, <a href="http://www.sony.net/">Sony Corporation</a></dd>
+
+
+ </dl>
+
+
+
+
+
+ <p class="copyright">
+ <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright">Copyright</a> ©
+ 2012
+
+ <a href="http://www.w3.org/"><abbr title="World Wide Web Consortium">W3C</abbr></a><sup>®</sup>
+ (<a href="http://www.csail.mit.edu/"><abbr title="Massachusetts Institute of Technology">MIT</abbr></a>,
+ <a href="http://www.ercim.eu/"><abbr title="European Research Consortium for Informatics and Mathematics">ERCIM</abbr></a>,
+ <a href="http://www.keio.ac.jp/">Keio</a>), All Rights Reserved.
+ <abbr title="World Wide Web Consortium">W3C</abbr> <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>,
+ <a href="http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a> and
+ <a href="http://www.w3.org/Consortium/Legal/copyright-documents">document use</a> rules apply.
+ </p>
+
+
+ <hr>
+</div>
+ <section id="abstract" class="introductory"><h2>Abstract</h2><p>
+ This specification is an addendum to Web Intents, [<cite><a class="bibref" href="#bib-WEBINTENTS">WEBINTENTS</a></cite>], that defines how Web Intents enabled User Agents can discover and communicate
+ with local Web Intents Services.
+ </p></section><section id="sotd" class="introductory"><h2>Status of This Document</h2>
+
+
+
+ <p>
+ <em>This section describes the status of this document at the time of its publication. Other
+ documents may supersede this document. A list of current <abbr title="World Wide Web Consortium">W3C</abbr> publications and the latest revision
+ of this technical report can be found in the <a href="http://www.w3.org/TR/"><abbr title="World Wide Web Consortium">W3C</abbr> technical reports
+ index</a> at http://www.w3.org/TR/.</em>
+ </p>
+
+ <p>
+ This document was published by the <a href="http://www.w3.org/2009/dap/">Device Applications (DAP) Working Group</a> and <a href="http://www.w3.org/2008/webapps/">Web Applications (WebApps) Working Group</a> as a First Public Working Draft.
+
+ This document is intended to become a <abbr title="World Wide Web Consortium">W3C</abbr> Recommendation.
+
+ If you wish to make comments regarding this document, please send them to
+ <a href="mailto:public-web-intents@w3.org">public-web-intents@w3.org</a>
+ (<a href="mailto:public-web-intents-request@w3.org?subject=subscribe">subscribe</a>,
+ <a href="http://lists.w3.org/Archives/Public/public-web-intents/">archives</a>).
+
+
+ All feedback is welcome.
+ </p>
+
+ <p>
+ Publication as a Working Draft does not imply endorsement by the <abbr title="World Wide Web Consortium">W3C</abbr> Membership.
+ This is a draft document and may be updated, replaced or obsoleted by other documents at
+ any time. It is inappropriate to cite this document as other than work in progress.
+ </p>
+
+
+ <p>
+
+ This document was produced by a group operating under the
+ <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/">5 February 2004 <abbr title="World Wide Web Consortium">W3C</abbr> Patent Policy</a>.
+
+
+
+
+ <abbr title="World Wide Web Consortium">W3C</abbr> maintains a public list of any patent disclosures (<a href="http://www.w3.org/2004/01/pp-impl/43696/status" rel="disclosure">Device Applications (DAP) Working Group</a>, <a href="http://www.w3.org/2004/01/pp-impl/42538/status" rel="disclosure">Web Applications (WebApps) Working Group</a>)
+
+ made in connection with the deliverables of the group; that page also includes instructions for
+ disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains
+ <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#def-essential">Essential Claim(s)</a> must disclose the
+ information in accordance with <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#sec-Disclosure">section
+ 6 of the <abbr title="World Wide Web Consortium">W3C</abbr> Patent Policy</a>.
+
+
+ </p>
+
+
+
+
+</section><section id="toc"><h2 class="introductory">Table of Contents</h2><ul class="toc"><li class="tocline"><a href="#introduction" class="tocxref"><span class="secno">1. </span>Introduction</a></li><li class="tocline"><a href="#conformance" class="tocxref"><span class="secno">2. </span>Conformance</a><ul class="toc"><li class="tocline"><a href="#dependencies" class="tocxref"><span class="secno">2.1 </span>Dependencies</a></li></ul></li><li class="tocline"><a href="#terminology" class="tocxref"><span class="secno">3. </span>Terminology</a><ul class="toc"><li class="tocline"><a href="#upnp-related-terms" class="tocxref"><span class="secno">3.1 </span>UPnP related terms</a></li><li class="tocline"><a href="#mdns-related-terms" class="tocxref"><span class="secno">3.2 </span>mDNS related terms</a></li></ul></li><li class="tocline"><a href="#upnp-adaptation" class="tocxref"><span class="secno">4. </span>UPnP adaptation</a><ul class="toc"><li class="tocline"><a href="#web-intents-enabled-upnp-device" class="tocxref"><span class="secno">4.1 </span><span class="formerLink">Web Intents enabled UPnP device</span></a><ul class="toc"><li class="tocline"><a href="#upnp-web-intents-servicetype" class="tocxref"><span class="secno">4.1.1 </span>UPnP Web Intents serviceType</a></li><li class="tocline"><a href="#web-intents-specific-ssdp-headers" class="tocxref"><span class="secno">4.1.2 </span>Web Intents specific SSDP headers</a></li><li class="tocline"><a href="#web-intents-document" class="tocxref"><span class="secno">4.1.3 </span>Web Intents document</a></li><li class="tocline"><a href="#web-intents-service-pages" class="tocxref"><span class="secno">4.1.4 </span>Web Intents Service pages</a></li></ul></li><li class="tocline"><a href="#upnp-enabled-user-agent" class="tocxref"><span class="secno">4.2 </span><span class="formerLink">UPnP enabled User Agent</span></a><ul class="toc"><li class="tocline"><a href="#dynamic-service-registration-based-on-m-search" class="tocxref"><span class="secno">4.2.1 </span>Dynamic Service registration based on M-SEARCH</a></li><li class="tocline"><a href="#dynamic-service-registration-based-on-notify" class="tocxref"><span class="secno">4.2.2 </span>Dynamic Service registration based on NOTIFY</a></li><li class="tocline"><a href="#support-for-web-intents-and-upnp" class="tocxref"><span class="secno">4.2.3 </span>Support for Web Intents and UPnP</a></li><li class="tocline"><a href="#service-availability-management" class="tocxref"><span class="secno">4.2.4 </span>Service availability management</a></li></ul></li></ul></li><li class="tocline"><a href="#mdns-dns-sd-adaptation" class="tocxref"><span class="secno">5. </span>mDNS (DNS-SD) adaptation</a><ul class="toc"><li class="tocline"><a href="#web-intents-enabled-mdns-device" class="tocxref"><span class="secno">5.1 </span>Web Intents enabled mDNS device</a><ul class="toc"><li class="tocline"><a href="#web-intents-service-type-for-dns-sd" class="tocxref"><span class="secno">5.1.1 </span>Web Intents service type for DNS-SD</a></li></ul></li><li class="tocline"><a href="#mdns-enabled-user-agent" class="tocxref"><span class="secno">5.2 </span>mDNS enabled User Agent</a><ul class="toc"><li class="tocline"><a href="#dynamic-service-registration" class="tocxref"><span class="secno">5.2.1 </span>Dynamic Service registration</a></li></ul></li><li class="tocline"><a href="#sample-records" class="tocxref"><span class="secno">5.3 </span>Sample Records</a></li></ul></li><li class="tocline"><a href="#apis-protocols-client---service" class="tocxref"><span class="secno">6. </span>APIs / protocols Client - Service </a></li><li class="tocline"><a href="#examples-and-scenarios" class="tocxref"><span class="secno">A. </span>Examples and scenarios</a><ul class="toc"><li class="tocline"><a href="#view-and-control-video-on-remote-device-through-service-page-control-buttons" class="tocxref"><span class="secno">A.1 </span>View and control video on remote device through Service page control buttons</a></li><li class="tocline"><a href="#view-and-control-video-on-remote-device-through-client-page-control-buttons" class="tocxref"><span class="secno">A.2 </span>View and control video on remote device through Client page control buttons</a></li><li class="tocline"><a href="#example-of-web-intents-document" class="tocxref"><span class="secno">A.3 </span>Example of Web Intents document</a></li><li class="tocline"><a href="#example-of-upnp-device-description-document" class="tocxref"><span class="secno">A.4 </span>Example of UPnP Device description document</a></li></ul></li><li class="tocline"><a href="#acknowledgements" class="tocxref"><span class="secno">B. </span>Acknowledgements</a></li><li class="tocline"><a href="#references" class="tocxref"><span class="secno">C. </span>References</a><ul class="toc"><li class="tocline"><a href="#normative-references" class="tocxref"><span class="secno">C.1 </span>Normative references</a></li></ul></li></ul></section>
+
+ <section class="informative" id="introduction">
+ <!--OddPage--><h2><span class="secno">1. </span>Introduction</h2><p><em>This section is non-normative.</em></p>
+ <p>
+ Web Intents,[<cite><a class="bibref" href="#bib-WEBINTENTS">WEBINTENTS</a></cite>], is a service discovery and light-weight RPC mechanism for web applications. The concept enables rich integration between web applications.
+ A typical Web Intents scenario is:
+ </p>
+ <ol class="rule">
+ <li>Web Intents Services register their intention to handle an action for the user </li>
+ <li>A web application requests to start an action (share, edit, pick, view, ...)</li>
+ <li>The user selects which service to handle the action</li>
+ <li>The selected service executes the action</li>
+ </ol>
+ <p>
+ A Web Intents Service is represented by a web page that declaratively marks itself as providing handling functionality for particular intents. Users register Web Intents Services
+ by visiting web pages that contain registration markup.
+ However, the strength of Web Intents is the ability to provide web applications with access to Services residing not only in the cloud but also in local environments.
+ </p>
+ <p>
+ This specification defines optional extensions to Web Intents enabled User Agents to discover and dynamically register local Web Intents
+ Services. Note that all details of the specific low level protocols used to discover and communicate with the local services are hidden to
+ the Client Web Applications.
+ </p>
+ <p>
+ The following code illustrates how a web application containing links to videos, can initiate video playback by creating and invoking a "video intent" as defined in [<cite><a class="bibref" href="#bib-WEBINTENTS">WEBINTENTS</a></cite>].
+ This code is the same irrespective of whether the Service executing the intent action is a cloud based Service or a local Service.
+ </p>
+ <div class="example"><div class="example-title"><span>Example 1</span></div><pre class="example highlight prettyprint"><span class="com">// Create a new intent</span><span class="pln">
+</span><span class="kwd">var</span><span class="pln"> intent </span><span class="pun">=</span><span class="pln"> </span><span class="kwd">new</span><span class="pln"> </span><span class="typ">Intent</span><span class="pun">(</span><span class="pln"> </span><span class="str">"http://webintents.org/view"</span><span class="pun">,</span><span class="str">"video/mp4"</span><span class="pun">,{</span><span class="pln"> </span><span class="str">"src"</span><span class="pun">:</span><span class="pln">videoCanvas</span><span class="pun">.</span><span class="pln">src</span><span class="pun">,</span><span class="pln"> </span><span class="str">"img"</span><span class="pun">:</span><span class="pln"> videoCanvas</span><span class="pun">.</span><span class="pln">poster</span><span class="pun">});</span><span class="pln">
+
+</span><span class="com">// Start intents picker </span><span class="pln">
+navigator</span><span class="pun">.</span><span class="pln">startActivity</span><span class="pun">(</span><span class="pln">intent</span><span class="pun">,</span><span class="pln">
+ </span><span class="com">// On Result</span><span class="pln">
+ </span><span class="kwd">function</span><span class="pun">(</span><span class="pln">intentData</span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">console</span><span class="pun">.</span><span class="pln">log</span><span class="pun">(</span><span class="str">"player.html: On Result"</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> intentData</span><span class="pun">);},</span><span class="pln">
+ </span><span class="com">// On Failure</span><span class="pln">
+ </span><span class="kwd">function</span><span class="pun">(</span><span class="pln">intentData</span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span><span class="pln">console</span><span class="pun">.</span><span class="pln">log</span><span class="pun">(</span><span class="str">"player.html: On Failure"</span><span class="pln"> </span><span class="pun">+</span><span class="pln"> intentData</span><span class="pun">);});</span></pre></div>
+ <p>
+ The example below briefly describes the steps taken when a Service on a local network, e.g. UPnP or mDNS, device is discovered and selected by
+ the user.
+ </p>
+
+ <ol class="rule">
+ <li>Triggered by navigator.startActivity the User Agent will start local network discovery of Web Intents Services.</li>
+ <li>Replies from Web Intents enabled devices contain a URL to a Web Intents document, containing Web Intents Service registration
+ markup, in the device. </li>
+ <li>The Web Intents documents are retrieved by the User Agent and the dynamically registered Services are visible in the Web Intents Service picker. </li>
+ <li>User selects Service.</li>
+ <li>User Agent retrieves the Service page from the the Web Intents local network device and invokes it. </li>
+ <li>The Service page handles the intent. </li>
+ <li>When handling the intent is finished, the Service page issues window.intent.postResult and closes itself. </li>
+ </ol>
+
+ </section>
+
+ <section id="conformance"><!--OddPage--><h2><span class="secno">2. </span>Conformance</h2>
+<p>
+ As well as sections marked as non-normative, all authoring guidelines, diagrams, examples,
+ and notes in this specification are non-normative. Everything else in this specification is
+ normative.
+</p>
+<p>
+ The key words <em class="rfc2119" title="must">must</em>, <em class="rfc2119" title="must not">must not</em>, <em class="rfc2119" title="required">required</em>, <em class="rfc2119" title="should">should</em>, <em class="rfc2119" title="should not">should not</em>, <em class="rfc2119" title="recommended">recommended</em>, <em class="rfc2119" title="may">may</em>,
+ and <em class="rfc2119" title="optional">optional</em> in this specification are to be interpreted as described in [<cite><a class="bibref" href="#bib-RFC2119">RFC2119</a></cite>].
+</p>
+
+ <p>
+ This specification defines conformance criteria that apply to:
+ </p>
+ <ul class="rule">
+ <li><dfn id="dfn-upnp-enabled-user-agent">UPnP enabled User Agent</dfn>: A <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> <em class="rfc2119" title="must">must</em> support Web Intents [<cite><a class="bibref" href="#bib-WEBINTENTS">WEBINTENTS</a></cite>] and the conformance criteria
+ stated in this specification. </li>
+ <li><dfn id="dfn-web-intents-enabled-upnp-device">Web Intents enabled UPnP device</dfn>: A <a href="#dfn-web-intents-enabled-upnp-device" class="internalDFN">Web Intents enabled UPnP device</a> <em class="rfc2119" title="must">must</em> support [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH">UPNP-DEVICEARCH</a></cite>] and the conformance criteria
+ stated in this specification. </li>
+ <li><dfn id="dfn-mdns-enabled-user-agent">mDNS enabled User Agent</dfn>: An <a href="#dfn-mdns-enabled-user-agent" class="internalDFN">mDNS enabled User Agent</a> <em class="rfc2119" title="must">must</em> support Web Intents [<cite><a class="bibref" href="#bib-WEBINTENTS">WEBINTENTS</a></cite>] and the conformance criteria
+ stated in this specification. </li>
+ <li><dfn id="dfn-web-intents-enabled-mdns-device">Web Intents enabled mDNS device</dfn>: A <a href="#dfn-web-intents-enabled-mdns-device" class="internalDFN">Web Intents enabled mDNS device</a> <em class="rfc2119" title="must">must</em> support [<cite><a class="bibref" href="#bib-DNS-SD">DNS-SD</a></cite>], [<cite><a class="bibref" href="#bib-MDNS">MDNS</a></cite>] and the conformance criteria
+ stated in this specification. </li>
+ </ul>
+
+ <p>
+ Implementations that use ECMAScript to implement the APIs defined in
+ this specification must implement them in a manner consistent with the
+ ECMAScript Bindings defined in the Web IDL specification [<cite><a class="bibref" href="#bib-WEBIDL">WEBIDL</a></cite>],
+ as this specification uses that specification and terminology.
+ </p>
+ <section id="dependencies">
+ <h3><span class="secno">2.1 </span>Dependencies</h3>
+ <p>
+ This specification relies on the following specifications:
+ </p>
+
+ <dl>
+ <dt>Web Intents</dt>
+ <dd>This addendum specification is dependent on and defines optional extensions to the basic Web Intents specification, [<cite><a class="bibref" href="#bib-WEBINTENTS">WEBINTENTS</a></cite>]. </dd>
+ <dt>UPnP Device Architecture 1.0</dt>
+ <dd>This addendum specification is dependent on and defines vendor specific extensions to the UPnP Device Architecture 1.0 specification, [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH">UPNP-DEVICEARCH</a></cite>]. </dd>
+ <dt>IANA Service Name and Transport Protocol Port Number Registry</dt>
+ <dd>This addendum specification adds new entry on it, [<cite><a class="bibref" href="#bib-IANA-SRVPORT-REG">IANA-SRVPORT-REG</a></cite>]. </dd>
+ <dt>DNS-SD</dt>
+ <dd>This addendum specification is dependent on it, [<cite><a class="bibref" href="#bib-DNS-SD">DNS-SD</a></cite>]. </dd>
+ <dt>mDNS</dt>
+ <dd>This addendum specification is dependent on it, [<cite><a class="bibref" href="#bib-MDNS">MDNS</a></cite>]. </dd>
+ </dl>
+
+
+ </section>
+ </section>
+
+ <section id="terminology">
+ <!--OddPage--><h2><span class="secno">3. </span>Terminology</h2>
+ <p>
+ Web Intents related terms are used according to section "Terminology" in [<cite><a class="bibref" href="#bib-WEBINTENTS">WEBINTENTS</a></cite>].
+ </p>
+
+ <section id="upnp-related-terms">
+ <h3><span class="secno">3.1 </span>UPnP related terms</h3>
+ <p>
+ UPnP related terms are used according to [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH">UPNP-DEVICEARCH</a></cite>].
+ </p>
+ <p>
+ The <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> has the role of a <dfn id="dfn-control-point">control point</dfn> according to UPnP terminology.
+ </p>
+ <p>
+ The <a href="#dfn-web-intents-enabled-upnp-device" class="internalDFN">Web Intents enabled UPnP device</a> discovered by the <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> has the roles of <dfn id="dfn-device">device</dfn> according to UPnP terminology.
+ </p>
+ </section>
+
+ <section id="mdns-related-terms">
+ <h3><span class="secno">3.2 </span>mDNS related terms</h3>
+ <p>
+ The <a href="#dfn-mdns-enabled-user-agent" class="internalDFN">mDNS enabled User Agent</a> has the role of a <dfn id="dfn-DNS-client">DNS client</dfn> with capability of [<cite><a class="bibref" href="#bib-DNS-SD">DNS-SD</a></cite>].
+ </p>
+ <p>
+ The <a href="#dfn-web-intents-enabled-mdns-device" class="internalDFN">Web Intents enabled mDNS device</a> discovered by the <a href="#dfn-mdns-enabled-user-agent" class="internalDFN">mDNS enabled User Agent</a> has the roles of <dfn id="dfn-service">service</dfn> according to [<cite><a class="bibref" href="#bib-MDNS">MDNS</a></cite>] and [<cite><a class="bibref" href="#bib-DNS-SD">DNS-SD</a></cite>].
+ </p>
+ </section>
+
+
+ </section>
+
+ <section id="upnp-adaptation">
+
+ <!--OddPage--><h2><span class="secno">4. </span>UPnP adaptation</h2>
+
+ <section id="web-intents-enabled-upnp-device">
+
+ <h3><span class="secno">4.1 </span><a href="#dfn-web-intents-enabled-upnp-device" class="internalDFN">Web Intents enabled UPnP device</a></h3>
+
+ <p>
+ The <a href="#dfn-web-intents-enabled-upnp-device" class="internalDFN">Web Intents enabled UPnP device</a> <em class="rfc2119" title="must">must</em> support this section.
+ </p>
+
+ <section id="upnp-web-intents-servicetype">
+
+ <h4><span class="secno">4.1.1 </span>UPnP Web Intents serviceType</h4>
+
+ <p>
+ The <a href="#dfn-web-intents-enabled-upnp-device" class="internalDFN">Web Intents enabled UPnP device</a> <em class="rfc2119" title="must">must</em> support one UPnP service which serviceType is the <code>urn:schemas-webintents-org:service:WebIntents:1</code>
+ as a vendor specific serviceType according to [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH">UPNP-DEVICEARCH</a></cite>]. It is vendor dependent how the <a href="#dfn-web-intents-enabled-upnp-device" class="internalDFN">Web Intents enabled UPnP device</a> implements the serviceType,
+ i.e. a device description of any deviceType could include this serviceType.
+ </p>
+
+ <p>
+ The Web Intents serviceType <em class="rfc2119" title="must">must</em> have a dummy state variable, <code>X_State</code> of <code>boolean</code> data type to comform to [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH">UPNP-DEVICEARCH</a></cite>]
+ which requires one or more state variables in a serviceType. The <code>X_State</code> state variable is not used with a value and is never evented.
+ </p>
+ <p>
+ The Web Intents serviceType has no standard action.
+ </p>
+
+ <p>
+ See below for the UPnP Service description document of the Web Intents serviceType.
+ </p>
+
+ <p><img src="Example_device_and_service_description_pages/Slide2.png" alt="Service description page" width="600" height="600"><br>
+ (<a href="Example_device_and_service_description_pages/Slide2.png">View as PNG</a>)
+ </p>
+
+
+ </section>
+
+ <section id="web-intents-specific-ssdp-headers">
+
+ <h4><span class="secno">4.1.2 </span>Web Intents specific SSDP headers</h4>
+
+ <p>
+ The <a href="#dfn-web-intents-enabled-upnp-device" class="internalDFN">Web Intents enabled UPnP device</a> <em class="rfc2119" title="must">must</em> support SSDP discovery process based on standard UPnP Discovery extended with 2 additional
+ SSDP headers for M-SEARCH response and NOTIFY when ST/NT headers are:<code>urn:schemas-webintents-org:service:WebIntents:1</code>
+ </p>
+
+ <ul class="rule">
+ <li>
+ <code>location.webintents.org</code>: <em class="rfc2119" title="required">required</em>. States the location to the Web Intents document in the <a href="#dfn-web-intents-enabled-upnp-device" class="internalDFN">Web Intents enabled UPnP device</a>.
+ If the value of this header is a relative URL the base URL is the base URL of the <code>LOCATION</code> header.
+ </li>
+ <li>
+ <code>action.webintents.org</code>: <em class="rfc2119" title="optional">optional</em>. If supported, states the Web Intents
+ <code>action</code> of the supported Web Intents Services and <em class="rfc2119" title="must">must</em>
+ match the <code>action</code> attributes of the Service registration markup in the Web Intents document. To support more than
+ one Web Intents <code>action</code> the action strings <em class="rfc2119" title="must">must</em> be separated with
+ comma. Commas included in action strings <em class="rfc2119" title="must">must</em> be percent-encoded as
+ defined in [<cite><a class="bibref" href="#bib-RFC3986">RFC3986</a></cite>], section-2.1.
+ <br>
+ This header allows the <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> to filter received SSDP messages so that the <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> only has to
+ retrieve Web Intents documents for matching Web Intents Actions.
+ </li>
+ </ul>
+
+ </section>
+
+ <section id="web-intents-document">
+
+ <h4><span class="secno">4.1.3 </span>Web Intents document</h4>
+
+ <p>
+ The <a href="#dfn-web-intents-enabled-upnp-device" class="internalDFN">Web Intents enabled UPnP device</a> <em class="rfc2119" title="must">must</em> host Web Intents documents for the Web Intents Services the <a href="#dfn-web-intents-enabled-upnp-device" class="internalDFN">Web Intents enabled UPnP device</a> supports.
+ Web Intents documents are html pages that contain Web Intents Service registration markup according to the rules for Web Intents Service registration defined
+ by [<cite><a class="bibref" href="#bib-WEBINTENTS">WEBINTENTS</a></cite>]. They may also contain Service handler code for Services registered within the same document.
+ </p>
+
+ </section>
+
+ <section id="web-intents-service-pages">
+
+ <h4><span class="secno">4.1.4 </span>Web Intents Service pages</h4>
+
+ <p>
+ The <a href="#dfn-web-intents-enabled-upnp-device" class="internalDFN">Web Intents enabled UPnP device</a> <em class="rfc2119" title="must">must</em> host a Web Intents Service page for each Service that is
+ referred in Web Intents documents through <code>href</code> attributes in the registration markup.
+ </p>
+ <p>
+ Service pages contain Service handler code and fulfills the rules for Web Intents Services as defined by [<cite><a class="bibref" href="#bib-WEBINTENTS">WEBINTENTS</a></cite>].
+ </p>
+
+ </section>
+
+ </section>
+
+ <section id="upnp-enabled-user-agent">
+
+ <h3><span class="secno">4.2 </span><a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a></h3>
+
+ <p>
+ The <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> <em class="rfc2119" title="must">must</em> support discovery of <a href="#dfn-web-intents-enabled-upnp-device" class="internalDFN">Web Intents enabled UPnP device</a>s through SSDP Discovery or through Advertisement
+ or through both methods according to [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH">UPNP-DEVICEARCH</a></cite>] and according to the Web Intents serviceType and Web Intents specific SSDP headers
+ defined in this specification, section 4.1.
+ </p>
+
+ <p>
+ The sections below describe typical steps using these methods.
+ </p>
+
+ <section class="informative" id="dynamic-service-registration-based-on-m-search">
+ <h4><span class="secno">4.2.1 </span>Dynamic Service registration based on M-SEARCH</h4><p><em>This section is non-normative.</em></p>
+
+ <p>
+ The section describes the discovery process based on standard UPnP M-SEARCH multicast request.
+ </p>
+
+ <p>
+ When the navigator.startActivity method [<cite><a class="bibref" href="#bib-WEBINTENTS">WEBINTENTS</a></cite>] is called, the <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> runs the following steps:
+ </p>
+
+ <ol class="rule">
+ <li>
+ Send a multicast request with the method M-SEARCH in the format specified by [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH">UPNP-DEVICEARCH</a></cite>].
+ <br>
+ The <code>ST</code> header is set to: <code>urn:schemas-webintents-org:service:WebIntents:1</code>
+ </li>
+
+ <li>
+ For each matching M-SEARCH response, i.e. the response ST header is <code>urn:schemas-webintents-org:service:WebIntents:1</code> and the <code>action.webintents.org</code>
+ header, if present, matches the Action of the invoked intent,
+ the <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> attempts to retrieve the Web Intents document from the discovered <a href="#dfn-web-intents-enabled-upnp-device" class="internalDFN">Web Intents enabled UPnP device</a>.
+ The value of the <code>location.webintents.org</code> header is the location for the Web Intents document.
+ If this value is a relative URL the <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> uses the base URL of the <code>LOCATION</code> header as base URL for the location of the
+ Web Intents document.
+ <br> <br>
+ If the <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> fails to retrieve the Web Intents document it silently disregards the received M-SEARCH response.
+ <br> <br>
+ If the <code>action.webintents.org</code> header is present and does not match the <code>action</code> attributes of the Services registered in the retrieved Web Intents
+ document the <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> silently disregards the the received M-SEARCH response.
+ </li>
+
+ <li>
+ It is expected that the Web Intents document contains registration markup and the <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> interprets this
+ registration markup according to the rules for registration defined by [<cite><a class="bibref" href="#bib-WEBINTENTS">WEBINTENTS</a></cite>] and register the Services accordingly.
+ </li>
+
+ <li>
+ The <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> makes each dynamically registered Service, that matches the Action of the invoked intent, available for selection
+ by the user, typically by making them visible and selectable in a Web Intents Service picker.
+ </li>
+
+ <li>
+ Based on user selection of a dynamically registered Service the <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> loads the
+ Service handler code as defined by the <code>href</code> attribute in the registration markup for this Service according to the rules for
+ loading Service pages defined in [<cite><a class="bibref" href="#bib-WEBINTENTS">WEBINTENTS</a></cite>].
+ </li>
+
+ </ol>
+
+ </section>
+
+ <section class="informative" id="dynamic-service-registration-based-on-notify">
+ <h4><span class="secno">4.2.2 </span>Dynamic Service registration based on NOTIFY</h4><p><em>This section is non-normative.</em></p>
+ <p>
+ This section describes the discovery process based on standard UPnP Advertisement with NOTIFY message.
+ </p>
+
+ <p>
+ The <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> <em class="rfc2119" title="may">may</em> continuously listen to and act on advertisments according to the following steps:
+ </p>
+ <ol class="rule">
+
+ <li>
+ The <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> maintains a list of announced UPnP services based on received SSDP NOTIFY messages
+ with <code>NT</code> header equal to <code>urn:schemas-webintents-org:service:WebIntents:1</code>.
+ </li>
+
+ <li>
+ When the navigator.startActivity method [<cite><a class="bibref" href="#bib-WEBINTENTS">WEBINTENTS</a></cite>] is called the <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> checks the list
+ of of announced services and attempts to retrieve the Web Intents document from the discovered <a href="#dfn-web-intents-enabled-upnp-device" class="internalDFN">Web Intents enabled UPnP device</a> in the following cases:
+ <ul>
+ <li>
+ The received NOTIFY message contains an <code>action.webintents.org</code> header and this header matches the Action of the invoked intent.
+ </li>
+ <li>
+ The received NOTIFY message does not contain an <code>action.webintents.org</code> header.
+ </li>
+ </ul>
+ <br>
+ The location of the Web Intents document is the value of the <code>location.webintents.org</code> header. If this value is a relative URL the
+ base URL is the base URL of the <code>LOCATION</code> header.
+ <br> <br>
+ If the <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> fails to retrieve the Web Intents document it silently disregards the received NOTIFY message.
+ <br> <br>
+ If the <code>action.webintents.org</code> header does not match the <code>action</code> attribute in the retrieved Web Intents document
+ the <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> silently disregards the received NOTIFY message.
+ </li>
+
+ <li>
+ It is expected that the Web Intents document contains registration markup and the <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> interprets the
+ Web Intents document according to the rules for registration defined by [<cite><a class="bibref" href="#bib-WEBINTENTS">WEBINTENTS</a></cite>] and register the Services accordingly.
+ </li>
+
+ <li>
+ The <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> makes each dynamically registered Service, that matches the Action of the invoked intent, available for selection
+ by the user, typically by making them visible and selectable in a Web Intents Service picker.
+ </li>
+
+ <li>
+ Based on user selection of a dynamically registered Service the <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> loads the
+ Service handler code as defined by the <code>href</code> attribute in the registration markup for this Service according to the rules for
+ loading Service pages defined in [<cite><a class="bibref" href="#bib-WEBINTENTS">WEBINTENTS</a></cite>].
+ </li>
+ </ol>
+
+ <div class="note"><div class="note-title"><span>Note</span></div><p class="">
+ Power consumption in battery powered devices should be considered. If power consumption is severe continuously listening to SSDP advertisement in the background
+ should not be used..
+ </p></div>
+
+ </section>
+
+ <section class="informative" id="support-for-web-intents-and-upnp">
+ <h4><span class="secno">4.2.3 </span>Support for Web Intents and UPnP</h4><p><em>This section is non-normative.</em></p>
+ <p>
+ In addition to the normative statements defined in this specification a <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> that complies to this specification
+ supports Web Intents according to [<cite><a class="bibref" href="#bib-WEBINTENTS">WEBINTENTS</a></cite>] and UPnP Discovery, Description and Control according to [<cite><a class="bibref" href="#bib-UPNP-DEVICEARCH">UPNP-DEVICEARCH</a></cite>].
+ However, it is implementation dependent whether this is supported natively in the User Agent or supported through some external component,
+ e.g. an in-device web server.
+ </p>
+ </section>
+
+ <section class="informative" id="service-availability-management">
+
+ <h4><span class="secno">4.2.4 </span>Service availability management</h4><p><em>This section is non-normative.</em></p>
+
+ <p>
+ The <a href="#dfn-upnp-enabled-user-agent" class="internalDFN">UPnP enabled User Agent</a> should manage the availability of UPnP services. For example detect when contact with a <a href="#dfn-web-intents-enabled-upnp-device" class="internalDFN">Web Intents enabled UPnP device</a> is lost through standard
+ UPnP life cycle management and remove a previously discovered and registered Service from the Service picker. However, for battery powered devices
+ power consumption should be considered and long lasting "keep alive" sessions" should be avoided.
+ </p>
+
+ </section>
+
+ </section>
+
+
+
+ </section>
+
+ <section id="mdns-dns-sd-adaptation">
+
+ <!--OddPage--><h2><span class="secno">5. </span>mDNS (DNS-SD) adaptation</h2>
+
+ <p>
+ This section describes how the User Agent handles Web Intents Services provided by local devices supporting mDNS and DNS-SD.
+ </p>
+
+ <section id="web-intents-enabled-mdns-device">
+
+ <h3><span class="secno">5.1 </span>Web Intents enabled mDNS device</h3>
+
+ <p>
+ The <a href="#dfn-web-intents-enabled-mdns-device" class="internalDFN">Web Intents enabled mDNS device</a> <em class="rfc2119" title="must">must</em> support this section.
+ </p>
+
+ <section id="web-intents-service-type-for-dns-sd">
+
+ <h4><span class="secno">5.1.1 </span>Web Intents service type for DNS-SD</h4>
+
+ <p>
+ The <a href="#dfn-web-intents-enabled-mdns-device" class="internalDFN">Web Intents enabled mDNS device</a> <em class="rfc2119" title="must">must</em> support [<cite><a class="bibref" href="#bib-DNS-SD">DNS-SD</a></cite>] with a SRV record of the <code>webintents</code> service type.
+ </p>
+
+ <div class="note"><div class="note-title"><span>Note</span></div><p class="">
+ A service type <code>webintents</code> should be registered in [<cite><a class="bibref" href="#bib-IANA-SRVPORT-REG">IANA-SRVPORT-REG</a></cite>].
+ </p></div>
+
+ <p>
+ The TXT record for the <code>webintents</code> service must have following parameters:
+ </p>
+ <ul class="rule">
+ <li>
+ <code>location</code>: <em class="rfc2119" title="required">required</em>. States the location to the Web Intents document in the <a href="#dfn-web-intents-enabled-mdns-device" class="internalDFN">Web Intents enabled mDNS device</a>.
+ The value of this header is path to be concatenated with a host of the <a href="#dfn-web-intents-enabled-mdns-device" class="internalDFN">Web Intents enabled mDNS device</a> to determine the location. The definition of the Web Intents document is the same as for UPnP.
+ </li>
+ <li>
+ <code>action</code>: <em class="rfc2119" title="optional">optional</em>. If supported, states the Web Intents
+ <code>action</code> of the supported Web Intents Services and <em class="rfc2119" title="must">must</em>
+ match the <code>action</code> attributes of the Service registration markup in the Web Intents document. To support more than
+ one Web Intents <code>action</code> the action strings <em class="rfc2119" title="must">must</em> be separated with
+ comma. Commas included in action strings <em class="rfc2119" title="must">must</em> be percent-encoded as
+ defined in [<cite><a class="bibref" href="#bib-RFC3986">RFC3986</a></cite>], section-2.1.
+ <br>
+ This allows the <a href="#dfn-mdns-enabled-user-agent" class="internalDFN">mDNS enabled User Agent</a> to filter received mDNS messages so that the <a href="#dfn-mdns-enabled-user-agent" class="internalDFN">mDNS enabled User Agent</a> only has to
+ retrieve Web Intents documents for matching Web Intents Actions.
+ </li>
+ </ul>
+
+ </section>
+
+ </section>
+ <section id="mdns-enabled-user-agent">
+ <h3><span class="secno">5.2 </span>mDNS enabled User Agent</h3>
+
+ <p>
+ The <a href="#dfn-mdns-enabled-user-agent" class="internalDFN">mDNS enabled User Agent</a> <em class="rfc2119" title="must">must</em> support discovery of <a href="#dfn-web-intents-enabled-mdns-device" class="internalDFN">Web Intents enabled mDNS device</a>s through mDNS and DNS-SD
+ according to [<cite><a class="bibref" href="#bib-MDNS">MDNS</a></cite>], [<cite><a class="bibref" href="#bib-DNS-SD">DNS-SD</a></cite>] and according to the Web Intents specific DNS records defined in this specification, section 5.1.
+ </p>
+
+ <section class="informative" id="dynamic-service-registration">
+ <h4><span class="secno">5.2.1 </span>Dynamic Service registration</h4><p><em>This section is non-normative.</em></p>
+ <p>
+ When the navigator.startActivity method [<cite><a class="bibref" href="#bib-WEBINTENTS">WEBINTENTS</a></cite>] is called, the <a href="#dfn-mdns-enabled-user-agent" class="internalDFN">mDNS enabled User Agent</a> typically runs the following steps:
+ </p>
+
+ <ol class="rule">
+ <li>
+ Send a multicast PTR query of the <code>_webintents._tcp.local</code> in the format specified by [<cite><a class="bibref" href="#bib-MDNS">MDNS</a></cite>] and [<cite><a class="bibref" href="#bib-DNS-SD">DNS-SD</a></cite>].
+ <br>
+ </li>
+
+ <li>
+ For each response, send a unicast TXT query of the webintents service instance in the PTR answer.
+ <br>
+ <p>This step can be omitted in case that the <a href="#dfn-web-intents-enabled-mdns-device" class="internalDFN">Web Intents enabled mDNS device</a> attaches a TXT answer with the previous answer.
+ </p></li>
+
+ <li>
+ For each matching response, i.e. the response TXT record does not have an action parameter or does have an <code>action</code> parameter matching the Action of the invoked intent,
+ send a unicast request with a SRV query of the webintens service instance.
+ <br>
+ <p>This step can be omitted in case that the <a href="#dfn-web-intents-enabled-mdns-device" class="internalDFN">Web Intents enabled mDNS device</a> attaches a SRV answer with the previous answer.
+ </p></li>
+
+ <li>
+ For each response, send a unicast A and/or AAAA query of the host name in the SRV answer.
+ <br>
+ <p>This step can be omitted in case that the <a href="#dfn-web-intents-enabled-mdns-device" class="internalDFN">Web Intents enabled mDNS device</a> attaches an A and/or AAAA answer with the previous answer.
+ </p></li>
+
+ <li>
+ The <a href="#dfn-mdns-enabled-user-agent" class="internalDFN">mDNS enabled User Agent</a> attempts to retrieve the Web Intents document from the discovered <a href="#dfn-web-intents-enabled-mdns-device" class="internalDFN">Web Intents enabled mDNS device</a>.
+ The destination URL consists of an IP address in the A or AAAA answer, a port number in the SRV record and an absolute path in the <code>location</code> parameter of the TXT record.
+ <br> <br>
+ If the <a href="#dfn-mdns-enabled-user-agent" class="internalDFN">mDNS enabled User Agent</a> fails to retrieve the Web Intents document it silently disregards the received response.
+ <br> <br>
+ If the <code>action</code> parameter is present and does not match the <code>action</code> attributes of the Services registered in the retrieved Web Intents
+ document the <a href="#dfn-mdns-enabled-user-agent" class="internalDFN">mDNS enabled User Agent</a> silently disregards the the received response.
+ <br> <br>
+ Note that following steps are identical to those of UPnP described in 4.2.
+ </li>
+
+ <li>
+ It is expected that the Web Intents document contains registration markup and the <a href="#dfn-mdns-enabled-user-agent" class="internalDFN">mDNS enabled User Agent</a> interprets this
+ registration markup according to the rules for registration defined by [<cite><a class="bibref" href="#bib-WEBINTENTS">WEBINTENTS</a></cite>] and register the Services accordingly.
+ </li>
+
+ <li>
+ The <a href="#dfn-mdns-enabled-user-agent" class="internalDFN">mDNS enabled User Agent</a> makes each dynamically registered Service, that matches the Action of the invoked intent, available for selection
+ by the user, typically by making them visible and selectable in a Web Intents Service picker.
+ </li>
+
+ <li>
+ Based on user selection of a dynamically registered Service the <a href="#dfn-mdns-enabled-user-agent" class="internalDFN">mDNS enabled User Agent</a> loads the
+ Service handler code as defined by the <code>href</code> attribute in the registration markup for this Service according to the rules for
+ loading Service pages defined in [<cite><a class="bibref" href="#bib-WEBINTENTS">WEBINTENTS</a></cite>].
+ </li>
+
+ </ol>
+
+ </section>
+
+ </section>
+ <section class="informative" id="sample-records">
+ <h3><span class="secno">5.3 </span>Sample Records</h3><p><em>This section is non-normative.</em></p>
+
+ <p>
+ See below for the example records for Web Intents. An <a href="#dfn-mdns-enabled-user-agent" class="internalDFN">mDNS enabled User Agent</a> looking for devices supporting http://webintents.org/view Web Intents can understand that
+ it is possible to get a Web Intents document for "LivingRoomTV" at http://192.168.1.47:3619/webintents.html.
+ </p>
+
+ <ul class="rule">
+ <li>
+ <code>_webintents._tcp.local. 120 IN PTR LivingRoomTV._webintents._tcp.local.</code>: A LivingRoomTV instance serves webintents service.
+ </li>
+ <li>
+ <code>LivingRoomTV._webintents._tcp.local. 120 IN SRV 0 0 3619 TV40EX-W2000.local.</code>: A host "TV40EX-W2000" in the link local network offers the LivingRoomTV webintents service instance in its port 3619.
+ </li>
+ <li>
+ <code>LivingRoomTV._webintents._tcp.local. 120 IN TXT location=/webintents.html action=http://webintents.org/view</code>: It offers http://webintents.org/view type of Web Intents. The absolute path for its Web Intents document is "/webintents.html". Note that the actual binary format of the TXT record value is concatinating key-value pairs each of which is a single byte length followed by 0-255 length key=value character string as defined in [DNS-SD].
+ </li>
+ <li>
+ <code>TV40EX-W2000 120 IN A 192.168.1.47</code>: A host "TV40EX-W2000" is on 192.168.1.47.
+ </li>
+ </ul>
+
+ </section>
+
+ </section>
+
+
+ <section class="informative" id="apis-protocols-client---service">
+ <!--OddPage--><h2><span class="secno">6. </span>APIs / protocols Client - Service </h2><p><em>This section is non-normative.</em></p>
+ <p>
+ The APIs / protocols for interaction between Client and Service pages are not defined by this specification. It is assumed that Web Intents
+ based APIs and protocols will be standardized by <abbr title="World Wide Web Consortium">W3C</abbr> and that these will be applicable for Client and Service applications running on User Agents that
+ comply to this specification. Different use cases will require different ways of interaction patterns between Client and Service.
+ </p>
+
+ <p>
+ Examples:
+ </p>
+ <ul class="rule">
+ <li>
+ A Client application invoking a "View" intent provides, as intent payload data, a link to a video to be displayed at the remote <a href="#dfn-web-intents-enabled-upnp-device" class="internalDFN">Web Intents enabled UPnP device</a>.
+ The Service application takes full control of the video playback by providing control buttons and sends UPnP commands to the remote device.
+ So in this case there the simple "API" just gives the link to the video to play.
+ </li>
+ <li>
+ Some use cases require a longer lasting relation between the Client and Service applications. By using the MessagePort[] attribute of the intent object
+ a message channel can be established between the Client and Service page. This message channel can be used to run Service specific protocols,
+ for example a protocol that allows the Client application to send simple video playback control commands to a Service application.
+ </li>
+ </ul>
+
+ </section>
+
+ <section class="informative appendix" id="examples-and-scenarios">
+ <!--OddPage--><h2><span class="secno">A. </span>Examples and scenarios</h2><p><em>This section is non-normative.</em></p>
+ <section id="view-and-control-video-on-remote-device-through-service-page-control-buttons">
+ <h3><span class="secno">A.1 </span>View and control video on remote device through Service page control buttons</h3><p><em>This section is non-normative.</em></p>
+ <p>
+ The following scenario describes how a Client page uses Web Intents to discover a remote video view service. The Service page
+ contains the UI for controlling the video playback.
+ </p>
+
+ <p><img src="Example_scenario_1/Slide1.png" alt="Example scenario 1/Slide1" width="700" height="700"><br>
+ (<a href="Example_scenario_1/Slide1.png">View as PNG</a>)
+ </p>
+
+ <p><img src="Example_scenario_1/Slide2.png" alt="Example scenario 1/Slide2" width="700" height="700"><br>
+ (<a href="Example_scenario_1/Slide2.png">View as PNG</a>)
+ </p>
+
+ <p><img src="Example_scenario_1/Slide3.png" alt="Example scenario 1/Slide3" width="700" height="700"><br>
+ (<a href="Example_scenario_1/Slide3.png">View as PNG</a>)
+ </p>
+ </section>
+
+ <section id="view-and-control-video-on-remote-device-through-client-page-control-buttons">
+ <h3><span class="secno">A.2 </span>View and control video on remote device through Client page control buttons</h3>
+ <p>
+ The following scenario describes how a Client page uses Web Intents to discover a remote video view service. The UI stays in the Client page,
+ which contains the UI controls for the video playback. This means that there is a need for continuous communication between the Client page and the Service page,
+ which is "hidden", i.e. it has no UI. The Client page creates a messaging channel and sends the messaging channel port to the Service page trhrough the intent invocation.
+ A high level "TV control" protocol, supporting commands such as "play", "pause" and "stop, runs on top of the messaging channel.
+ </p>
+ <p>
+ In this example the assumption is that he Client invokes an intent to discover a Service that supports a specified protocol running on top of the message channel So the
+ "discover" intent Action is used and Type is set to the specific protocol used to communicate with the Service.
+ </p>
+
+ <div class="issue"><div class="issue-title"><span>Issue 1</span></div><p class="">
+ This scenario assumes the possibility to have hidden/background Service pages or Service pages that are visible inline the Client page.
+ Currently [<cite><a class="bibref" href="#bib-WEBINTENTS">WEBINTENTS</a></cite>] does not allow this but <abbr title="World Wide Web Consortium">W3C</abbr> DAP Action http://www.w3.org/2009/dap/track/actions/519 should add a proposal for a hidden disposition.
+ </p></div>
+
+ <p><img src="Example_scenario_2/Slide1.png" alt="Example scenario 2/Slide1" width="700" height="700"><br>
+ (<a href="Example_scenario_2/Slide1.png">View as PNG</a>)
+ </p>
+
+ <p><img src="Example_scenario_2/Slide2.png" alt="Example scenario 2/Slide2" width="700" height="700"><br>
+ (<a href="Example_scenario_2/Slide2.png">View as PNG</a>)
+ </p>
+
+ <p><img src="Example_scenario_2/Slide3.png" alt="Example scenario 2/Slide3" width="700" height="700"><br>
+ (<a href="Example_scenario_2/Slide3.png">View as PNG</a>)
+ </p>
+
+ <p><img src="Example_scenario_2/Slide4.png" alt="Example scenario 2/Slide4" width="700" height="700"><br>
+ (<a href="Example_scenario_2/Slide4.png">View as PNG</a>)
+ </p>
+ </section>
+
+
+
+ <section id="example-of-web-intents-document">
+ <h3><span class="secno">A.3 </span>Example of Web Intents document</h3>
+
+ <p><img src="Example1_registration_page/Slide1.png" alt="Example1 registration page" width="280" height="280"><br>
+ (<a href="Example1_registration_page/Slide1.png">View as PNG</a>)
+ </p>
+ </section>
+
+ <section id="example-of-upnp-device-description-document">
+ <h3><span class="secno">A.4 </span>Example of UPnP Device description document</h3>
+ <p><img src="Example_device_and_service_description_pages/Slide1.png" alt="Example device and service description pages/Slide1" width="600" height="600"><br>
+ (<a href="Example_device_and_service_description_pages/Slide1.png">View as PNG</a>)
+ </p>
+ </section>
+
+ </section>
+
+ <section class="appendix" id="acknowledgements">
+ <!--OddPage--><h2><span class="secno">B. </span>Acknowledgements</h2>
+ <p>
+ Many thanks to Sony colleagues Anders Isberg, Naoyuki Sato, Tatsuya Igarashi, Anders Edenbrandt and Björn Ekberg for all support.
+ <br> <br>
+ Many thanks to Robin Berjon for making our lives so much easier with his cool specification editing tool.
+ </p>
+ </section>
+
+
+<section id="references" class="appendix"><!--OddPage--><h2><span class="secno">C. </span>References</h2><section id="normative-references"><h3><span class="secno">C.1 </span>Normative references</h3><dl class="bibliography"><dt id="bib-DNS-SD">[DNS-SD]</dt><dd>S. Cheshire; M. Krochmal. <a href="http://files.dns-sd.org/draft-cheshire-dnsext-dns-sd.txt"><cite>DNS-Based Service Discovery.</cite></a> 27 February 2011. IETF Draft. URL: <a href="http://files.dns-sd.org/draft-cheshire-dnsext-dns-sd.txt">http://files.dns-sd.org/draft-cheshire-dnsext-dns-sd.txt</a>
+</dd><dt id="bib-IANA-SRVPORT-REG">[IANA-SRVPORT-REG]</dt><dd><a href="http://www.iana.org/form/ports-services">IANA Service Name and Transport Protocol Port Number Registry</a>. URL: <a href="http://www.iana.org/form/ports-services">http://www.iana.org/form/ports-services</a>
+</dd><dt id="bib-MDNS">[MDNS]</dt><dd>S. Cheshire; M. Krochmal. <a href="http://files.multicastdns.org/draft-cheshire-dnsext-multicastdns.txt"><cite>Multicast DNS.</cite></a> 14 February 2011. IETF Draft. URL: <a href="http://files.multicastdns.org/draft-cheshire-dnsext-multicastdns.txt">http://files.multicastdns.org/draft-cheshire-dnsext-multicastdns.txt</a>
+</dd><dt id="bib-RFC2119">[RFC2119]</dt><dd>S. Bradner. <a href="http://www.ietf.org/rfc/rfc2119.txt"><cite>Key words for use in RFCs to Indicate Requirement Levels.</cite></a> March 1997. Internet RFC 2119. URL: <a href="http://www.ietf.org/rfc/rfc2119.txt">http://www.ietf.org/rfc/rfc2119.txt</a>
+</dd><dt id="bib-RFC3986">[RFC3986]</dt><dd>T. Berners-Lee; R. Fielding; L. Masinter. <a href="http://www.ietf.org/rfc/rfc3986.txt"><cite>Uniform Resource Identifier (URI): Generic Syntax.</cite></a> January 2005. Internet RFC 3986. URL: <a href="http://www.ietf.org/rfc/rfc3986.txt">http://www.ietf.org/rfc/rfc3986.txt</a>
+</dd><dt id="bib-UPNP-DEVICEARCH">[UPNP-DEVICEARCH]</dt><dd><a href="http://www.upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.0-20081015.pdf"><cite>UPnP Device Architecture 1.0</cite></a>. 15 October 2008. UPnP Forum. For UPnP Version 1.0. PDF document. URL: <a href="http://www.upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.0-20081015.pdf">http://www.upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.0-20081015.pdf</a>
+</dd><dt id="bib-WEBIDL">[WEBIDL]</dt><dd>Cameron McCormack. <a href="http://www.w3.org/TR/2011/WD-WebIDL-20110927/"><cite>Web IDL.</cite></a> 27 September 2011. W3C Working Draft. (Work in progress.) URL: <a href="http://www.w3.org/TR/2011/WD-WebIDL-20110927/">http://www.w3.org/TR/2011/WD-WebIDL-20110927/</a>
+</dd><dt id="bib-WEBINTENTS">[WEBINTENTS]</dt><dd>Greg Billock; James Hawkins; Paul Kinlan. <a href="http://dvcs.w3.org/hg/web-intents/raw-file/tip/spec/Overview.html"><cite>Web Intents.</cite></a> Editors' Draft. (Work in progress.) URL: <a href="http://dvcs.w3.org/hg/web-intents/raw-file/tip/spec/Overview.html">http://dvcs.w3.org/hg/web-intents/raw-file/tip/spec/Overview.html</a>
+</dd></dl></section></section></body></html>
\ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/wi-addendum-local-services/FPWD/FPWD_src.html Tue Oct 02 18:07:01 2012 -0700
@@ -0,0 +1,746 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <title>Web Intents Addendum - Local Services</title>
+ <meta http-equiv='Content-Type' content='text/html;charset=utf-8'/>
+ <!--
+ === NOTA BENE ===
+ For the three scripts below, if your spec resides on dev.w3 you can check them
+ out in the same tree and use relative links so that they'll work offline,
+ -->
+ <script src='http://www.w3.org/Tools/respec/respec-w3c-common' class='remove'></script>
+ <script class='remove'>
+ var respecConfig = {
+ // specification status (e.g. WD, LCWD, NOTE, etc.). If in doubt use ED.
+ specStatus: "FPWD",
+
+ // the specification's short name, as in http://www.w3.org/TR/short-name/
+ shortName: "webintents-local-services",
+
+ // if your specification has a subtitle that goes below the main
+ // formal title, define it here
+ // subtitle : "an excellent document",
+
+ // if you wish the publication date to be other than today, set this
+ publishDate: "2012-10-04",
+
+ // if the specification's copyright date is a range of years, specify
+ // the start date here:
+ // copyrightStart: "2005"
+
+ // if there is a previously published draft, uncomment this and set its YYYY-MM-DD date
+ // and its maturity status
+ // previousPublishDate: "1977-03-15",
+ // previousMaturity: "WD",
+
+ // if there a publicly available Editor's Draft, this is the link
+ edDraftURI: "http://w3c-test.org/dap/wi-addendum-local-services/",
+
+ // if this is a LCWD, uncomment and set the end of its review period
+ // lcEnd: "2009-08-05",
+
+ // if you want to have extra CSS, append them to this list
+ // it is recommended that the respec.css stylesheet be kept
+ extraCSS: ["http://dev.w3.org/2009/dap/ReSpec.js/css/respec.css"],
+
+ // editors, add as many as you like
+ // only "name" is required
+ editors: [
+ { name: "Claes Nilsson",
+ company: "Sony Mobile", companyURL: "http://www.sonymobile.com/se/" },
+ { name: "Norifumi Kikkawa",
+ company: "Sony Corporation", companyURL: "http://www.sony.net/"},
+ ],
+
+ // authors, add as many as you like.
+ // This is optional, uncomment if you have authors as well as editors.
+ // only "name" is required. Same format as editors.
+
+ //authors: [
+ // { name: "Your Name", url: "http://example.org/",
+ // company: "Your Company", companyURL: "http://example.com/" },
+ //],
+
+
+ // name of the WG
+ wg: ["Device Applications (DAP) Working Group", "Web Applications (WebApps) Working Group"],
+
+ // URI of the public WG page
+ wgURI: ["http://www.w3.org/2009/dap/", "http://www.w3.org/2008/webapps/"],
+
+ // name (without the @w3c.org) of the public mailing to which comments are due
+ wgPublicList: "public-web-intents",
+
+ // URI of the patent status for this WG, for Rec-track documents
+ // !!!! IMPORTANT !!!!
+ // This is important for Rec-track documents, do not copy a patent URI from a random
+ // document unless you know what you're doing. If in doubt ask your friendly neighbourhood
+ // Team Contact.
+ wgPatentURI: ["http://www.w3.org/2004/01/pp-impl/43696/status", "http://www.w3.org/2004/01/pp-impl/42538/status"]
+ };
+ </script>
+
+ <style type="text/css">
+
+ /* Add addition spacing to <ol> and <ul> for rule definition */
+ ol.rule li, ul.rule li { padding:0.6em; }
+
+ </style>
+
+
+ </head>
+ <body>
+ <section id='abstract'>
+ This specification is an addendum to Web Intents, [[!WEBINTENTS]], that defines how Web Intents enabled User Agents can discover and communicate
+ with local Web Intents Services.
+ </section>
+
+ <section class='informative'>
+ <h2>Introduction</h2>
+ <p>
+ Web Intents,[[!WEBINTENTS]], is a service discovery and light-weight RPC mechanism for web applications. The concept enables rich integration between web applications.
+ A typical Web Intents scenario is:
+ </p>
+ <ol class="rule">
+ <li>Web Intents Services register their intention to handle an action for the user </li>
+ <li>A web application requests to start an action (share, edit, pick, view, ...)</li>
+ <li>The user selects which service to handle the action</li>
+ <li>The selected service executes the action</li>
+ </ol>
+ <p>
+ A Web Intents Service is represented by a web page that declaratively marks itself as providing handling functionality for particular intents. Users register Web Intents Services
+ by visiting web pages that contain registration markup.
+ However, the strength of Web Intents is the ability to provide web applications with access to Services residing not only in the cloud but also in local environments.
+ </p>
+ <p>
+ This specification defines optional extensions to Web Intents enabled User Agents to discover and dynamically register local Web Intents
+ Services. Note that all details of the specific low level protocols used to discover and communicate with the local services are hidden to
+ the Client Web Applications.
+ </p>
+ <p>
+ The following code illustrates how a web application containing links to videos, can initiate video playback by creating and invoking a "video intent" as defined in [[!WEBINTENTS]].
+ This code is the same irrespective of whether the Service executing the intent action is a cloud based Service or a local Service.
+ </p>
+ <pre class="example sh_javascript_dom">
+
+ // Create a new intent
+var intent = new Intent( "http://webintents.org/view","video/mp4",{ "src":videoCanvas.src, "img": videoCanvas.poster});
+
+// Start intents picker
+navigator.startActivity(intent,
+ // On Result
+ function(intentData) {console.log("player.html: On Result" + intentData);},
+ // On Failure
+ function(intentData) {console.log("player.html: On Failure" + intentData);});
+ </pre>
+ <p>
+ The example below briefly describes the steps taken when a Service on a local network, e.g. UPnP or mDNS, device is discovered and selected by
+ the user.
+ </p>
+
+ <ol class="rule">
+ <li>Triggered by navigator.startActivity the User Agent will start local network discovery of Web Intents Services.</li>
+ <li>Replies from Web Intents enabled devices contain a URL to a Web Intents document, containing Web Intents Service registration
+ markup, in the device. </li>
+ <li>The Web Intents documents are retrieved by the User Agent and the dynamically registered Services are visible in the Web Intents Service picker. </li>
+ <li>User selects Service.</li>
+ <li>User Agent retrieves the Service page from the the Web Intents local network device and invokes it. </li>
+ <li>The Service page handles the intent. </li>
+ <li>When handling the intent is finished, the Service page issues window.intent.postResult and closes itself. </li>
+ </ol>
+
+ </section>
+
+ <section id="conformance">
+ <p>
+ This specification defines conformance criteria that apply to:
+ </p>
+ <ul class="rule">
+ <li><dfn>UPnP enabled User Agent</dfn>: A <a>UPnP enabled User Agent</a> MUST support Web Intents [[!WEBINTENTS]] and the conformance criteria
+ stated in this specification. </li>
+ <li><dfn>Web Intents enabled UPnP device</dfn>: A <a>Web Intents enabled UPnP device</a> MUST support [[!UPNP-DEVICEARCH]] and the conformance criteria
+ stated in this specification. </li>
+ <li><dfn>mDNS enabled User Agent</dfn>: An <a>mDNS enabled User Agent</a> MUST support Web Intents [[!WEBINTENTS]] and the conformance criteria
+ stated in this specification. </li>
+ <li><dfn>Web Intents enabled mDNS device</dfn>: A <a>Web Intents enabled mDNS device</a> MUST support [[!DNS-SD]], [[!MDNS]] and the conformance criteria
+ stated in this specification. </li>
+ </ul>
+
+ <p>
+ Implementations that use ECMAScript to implement the APIs defined in
+ this specification must implement them in a manner consistent with the
+ ECMAScript Bindings defined in the Web IDL specification [[!WEBIDL]],
+ as this specification uses that specification and terminology.
+ </p>
+ <section>
+ <h2>Dependencies</h2>
+ <p>
+ This specification relies on the following specifications:
+ </p>
+
+ <dl>
+ <dt>Web Intents</dt>
+ <dd>This addendum specification is dependent on and defines optional extensions to the basic Web Intents specification, [[!WEBINTENTS]]. </dd>
+ <dt>UPnP Device Architecture 1.0</dt>
+ <dd>This addendum specification is dependent on and defines vendor specific extensions to the UPnP Device Architecture 1.0 specification, [[!UPNP-DEVICEARCH]]. </dd>
+ <dt>IANA Service Name and Transport Protocol Port Number Registry</dt>
+ <dd>This addendum specification adds new entry on it, [[!IANA-SRVPORT-REG]]. </dd>
+ <dt>DNS-SD</dt>
+ <dd>This addendum specification is dependent on it, [[!DNS-SD]]. </dd>
+ <dt>mDNS</dt>
+ <dd>This addendum specification is dependent on it, [[!MDNS]]. </dd>
+ </dl>
+
+
+ </section>
+ </section>
+
+ <section>
+ <h2>Terminology</h2>
+ <p>
+ Web Intents related terms are used according to section "Terminology" in [[!WEBINTENTS]].
+ </p>
+
+ <section>
+ <h3>UPnP related terms</h3>
+ <p>
+ UPnP related terms are used according to [[!UPNP-DEVICEARCH]].
+ </p>
+ <p>
+ The <a>UPnP enabled User Agent</a> has the role of a <dfn id="dfn-control-point">control point</dfn> according to UPnP terminology.
+ </p>
+ <p>
+ The <a>Web Intents enabled UPnP device</a> discovered by the <a>UPnP enabled User Agent</a> has the roles of <dfn id="dfn-device">device</dfn> according to UPnP terminology.
+ </p>
+ </section>
+
+ <section>
+ <h3>mDNS related terms</h3>
+ <p>
+ The <a>mDNS enabled User Agent</a> has the role of a <dfn id="dfn-DNS-client">DNS client</dfn> with capability of [[!DNS-SD]].
+ </p>
+ <p>
+ The <a>Web Intents enabled mDNS device</a> discovered by the <a>mDNS enabled User Agent</a> has the roles of <dfn id="dfn-service">service</dfn> according to [[!MDNS]] and [[!DNS-SD]].
+ </p>
+ </section>
+
+
+ </section>
+
+ <section>
+
+ <h2>UPnP adaptation</h2>
+
+ <section>
+
+ <h3><a>Web Intents enabled UPnP device</a></h3>
+
+ <p>
+ The <a>Web Intents enabled UPnP device</a> <em class="rfc2119" title="must">must</em> support this section.
+ </p>
+
+ <section>
+
+ <h4>UPnP Web Intents serviceType</h4>
+
+ <p>
+ The <a>Web Intents enabled UPnP device</a> <em class="rfc2119" title="must">must</em> support one UPnP service which serviceType is the <code>urn:schemas-webintents-org:service:WebIntents:1</code>
+ as a vendor specific serviceType according to [[!UPNP-DEVICEARCH]]. It is vendor dependent how the <a>Web Intents enabled UPnP device</a> implements the serviceType,
+ i.e. a device description of any deviceType could include this serviceType.
+ </p>
+
+ <p>
+ The Web Intents serviceType <em class="rfc2119" title="must">must</em> have a dummy state variable, <code>X_State</code> of <code>boolean</code> data type to comform to [[!UPNP-DEVICEARCH]]
+ which requires one or more state variables in a serviceType. The <code>X_State</code> state variable is not used with a value and is never evented.
+ </p>
+ <p>
+ The Web Intents serviceType has no standard action.
+ </p>
+
+ <p>
+ See below for the UPnP Service description document of the Web Intents serviceType.
+ </p>
+
+ <p><img src="Example_device_and_service_description_pages/Slide2.png" alt="Service description page" width="600" height="600" ><br>
+ (<a href="Example_device_and_service_description_pages/Slide2.png">View as PNG</a>)
+ </p>
+
+
+ </section>
+
+ <section>
+
+ <h4>Web Intents specific SSDP headers</h4>
+
+ <p>
+ The <a>Web Intents enabled UPnP device</a> <em class="rfc2119" title="must">must</em> support SSDP discovery process based on standard UPnP Discovery extended with 2 additional
+ SSDP headers for M-SEARCH response and NOTIFY when ST/NT headers are:<code>urn:schemas-webintents-org:service:WebIntents:1</code>
+ </p>
+
+ <ul class="rule">
+ <li>
+ <code>location.webintents.org</code>: <em class="rfc2119" title="required">required</em>. States the location to the Web Intents document in the <a>Web Intents enabled UPnP device</a>.
+ If the value of this header is a relative URL the base URL is the base URL of the <code>LOCATION</code> header.
+ </li>
+ <li>
+ <code>action.webintents.org</code>: <em class="rfc2119" title="optional">optional</em>. If supported, states the Web Intents
+ <code>action</code> of the supported Web Intents Services and <em class="rfc2119" title="must">must</em>
+ match the <code>action</code> attributes of the Service registration markup in the Web Intents document. To support more than
+ one Web Intents <code>action</code> the action strings <em class="rfc2119" title="must">must</em> be separated with
+ comma. Commas included in action strings <em class="rfc2119" title="must">must</em> be percent-encoded as
+ defined in [[!RFC3986]], section-2.1.
+ <br />
+ This header allows the <a>UPnP enabled User Agent</a> to filter received SSDP messages so that the <a>UPnP enabled User Agent</a> only has to
+ retrieve Web Intents documents for matching Web Intents Actions.
+ </li>
+ </ul>
+
+ </section>
+
+ <section>
+
+ <h4>Web Intents document</h4>
+
+ <p>
+ The <a>Web Intents enabled UPnP device</a> <em class="rfc2119" title="must">must</em> host Web Intents documents for the Web Intents Services the <a>Web Intents enabled UPnP device</a> supports.
+ Web Intents documents are html pages that contain Web Intents Service registration markup according to the rules for Web Intents Service registration defined
+ by [[!WEBINTENTS]]. They may also contain Service handler code for Services registered within the same document.
+ </p>
+
+ </section>
+
+ <section>
+
+ <h4>Web Intents Service pages</h4>
+
+ <p>
+ The <a>Web Intents enabled UPnP device</a> <em class="rfc2119" title="must">must</em> host a Web Intents Service page for each Service that is
+ referred in Web Intents documents through <code>href</code> attributes in the registration markup.
+ </p>
+ <p>
+ Service pages contain Service handler code and fulfills the rules for Web Intents Services as defined by [[!WEBINTENTS]].
+ </p>
+
+ </section>
+
+ </section>
+
+ <section>
+
+ <h3><a>UPnP enabled User Agent</a></h3>
+
+ <p>
+ The <a>UPnP enabled User Agent</a> <em class="rfc2119" title="must">must</em> support discovery of <a>Web Intents enabled UPnP device</a>s through SSDP Discovery or through Advertisement
+ or through both methods according to [[!UPNP-DEVICEARCH]] and according to the Web Intents serviceType and Web Intents specific SSDP headers
+ defined in this specification, section 4.1.
+ </p>
+
+ <p>
+ The sections below describe typical steps using these methods.
+ </p>
+
+ <section class='informative'>
+ <h4>Dynamic Service registration based on M-SEARCH</h4>
+
+ <p>
+ The section describes the discovery process based on standard UPnP M-SEARCH multicast request.
+ </p>
+
+ <p>
+ When the navigator.startActivity method [[!WEBINTENTS]] is called, the <a>UPnP enabled User Agent</a> runs the following steps:
+ </p>
+
+ <ol class="rule">
+ <li>
+ Send a multicast request with the method M-SEARCH in the format specified by [[!UPNP-DEVICEARCH]].
+ <br />
+ The <code>ST</code> header is set to: <code>urn:schemas-webintents-org:service:WebIntents:1</code>
+ </li>
+
+ <li>
+ For each matching M-SEARCH response, i.e. the response ST header is <code>urn:schemas-webintents-org:service:WebIntents:1</code> and the <code>action.webintents.org</code>
+ header, if present, matches the Action of the invoked intent,
+ the <a>UPnP enabled User Agent</a> attempts to retrieve the Web Intents document from the discovered <a>Web Intents enabled UPnP device</a>.
+ The value of the <code>location.webintents.org</code> header is the location for the Web Intents document.
+ If this value is a relative URL the <a>UPnP enabled User Agent</a> uses the base URL of the <code>LOCATION</code> header as base URL for the location of the
+ Web Intents document.
+ <br /> <br />
+ If the <a>UPnP enabled User Agent</a> fails to retrieve the Web Intents document it silently disregards the received M-SEARCH response.
+ <br /> <br />
+ If the <code>action.webintents.org</code> header is present and does not match the <code>action</code> attributes of the Services registered in the retrieved Web Intents
+ document the <a>UPnP enabled User Agent</a> silently disregards the the received M-SEARCH response.
+ </li>
+
+ <li>
+ It is expected that the Web Intents document contains registration markup and the <a>UPnP enabled User Agent</a> interprets this
+ registration markup according to the rules for registration defined by [[!WEBINTENTS]] and register the Services accordingly.
+ </li>
+
+ <li>
+ The <a>UPnP enabled User Agent</a> makes each dynamically registered Service, that matches the Action of the invoked intent, available for selection
+ by the user, typically by making them visible and selectable in a Web Intents Service picker.
+ </li>
+
+ <li>
+ Based on user selection of a dynamically registered Service the <a>UPnP enabled User Agent</a> loads the
+ Service handler code as defined by the <code>href</code> attribute in the registration markup for this Service according to the rules for
+ loading Service pages defined in [[!WEBINTENTS]].
+ </li>
+
+ </ol>
+
+ </section>
+
+ <section class='informative'>
+ <h4>Dynamic Service registration based on NOTIFY</h4>
+ <p>
+ This section describes the discovery process based on standard UPnP Advertisement with NOTIFY message.
+ </p>
+
+ <p>
+ The <a>UPnP enabled User Agent</a> <em class="rfc2119" title="may">may</em> continuously listen to and act on advertisments according to the following steps:
+ </p>
+ <ol class="rule">
+
+ <li>
+ The <a>UPnP enabled User Agent</a> maintains a list of announced UPnP services based on received SSDP NOTIFY messages
+ with <code>NT</code> header equal to <code>urn:schemas-webintents-org:service:WebIntents:1</code>.
+ </li>
+
+ <li>
+ When the navigator.startActivity method [[!WEBINTENTS]] is called the <a>UPnP enabled User Agent</a> checks the list
+ of of announced services and attempts to retrieve the Web Intents document from the discovered <a>Web Intents enabled UPnP device</a> in the following cases:
+ <ul>
+ <li>
+ The received NOTIFY message contains an <code>action.webintents.org</code> header and this header matches the Action of the invoked intent.
+ </li>
+ <li>
+ The received NOTIFY message does not contain an <code>action.webintents.org</code> header.
+ </li>
+ </ul>
+ <br />
+ The location of the Web Intents document is the value of the <code>location.webintents.org</code> header. If this value is a relative URL the
+ base URL is the base URL of the <code>LOCATION</code> header.
+ <br /> <br />
+ If the <a>UPnP enabled User Agent</a> fails to retrieve the Web Intents document it silently disregards the received NOTIFY message.
+ <br /> <br />
+ If the <code>action.webintents.org</code> header does not match the <code>action</code> attribute in the retrieved Web Intents document
+ the <a>UPnP enabled User Agent</a> silently disregards the received NOTIFY message.
+ </li>
+
+ <li>
+ It is expected that the Web Intents document contains registration markup and the <a>UPnP enabled User Agent</a> interprets the
+ Web Intents document according to the rules for registration defined by [[!WEBINTENTS]] and register the Services accordingly.
+ </li>
+
+ <li>
+ The <a>UPnP enabled User Agent</a> makes each dynamically registered Service, that matches the Action of the invoked intent, available for selection
+ by the user, typically by making them visible and selectable in a Web Intents Service picker.
+ </li>
+
+ <li>
+ Based on user selection of a dynamically registered Service the <a>UPnP enabled User Agent</a> loads the
+ Service handler code as defined by the <code>href</code> attribute in the registration markup for this Service according to the rules for
+ loading Service pages defined in [[!WEBINTENTS]].
+ </li>
+ </ol>
+
+ <p class="note">
+ Power consumption in battery powered devices should be considered. If power consumption is severe continuously listening to SSDP advertisement in the background
+ should not be used..
+ </p>
+
+ </section>
+
+ <section class='informative'>
+ <h4>Support for Web Intents and UPnP</h4>
+ <p>
+ In addition to the normative statements defined in this specification a <a>UPnP enabled User Agent</a> that complies to this specification
+ supports Web Intents according to [[!WEBINTENTS]] and UPnP Discovery, Description and Control according to [[!UPNP-DEVICEARCH]].
+ However, it is implementation dependent whether this is supported natively in the User Agent or supported through some external component,
+ e.g. an in-device web server.
+ </p>
+ </section>
+
+ <section class='informative'>
+
+ <h4>Service availability management</h4>
+
+ <p>
+ The <a>UPnP enabled User Agent</a> should manage the availability of UPnP services. For example detect when contact with a <a>Web Intents enabled UPnP device</a> is lost through standard
+ UPnP life cycle management and remove a previously discovered and registered Service from the Service picker. However, for battery powered devices
+ power consumption should be considered and long lasting "keep alive" sessions" should be avoided.
+ </p>
+
+ </section>
+
+ </section>
+
+
+
+ </section>
+
+ <section>
+
+ <h2>mDNS (DNS-SD) adaptation</h2>
+
+ <p>
+ This section describes how the User Agent handles Web Intents Services provided by local devices supporting mDNS and DNS-SD.
+ </p>
+
+ <section>
+
+ <h3>Web Intents enabled mDNS device</h3>
+
+ <p>
+ The <a>Web Intents enabled mDNS device</a> <em class="rfc2119" title="must">must</em> support this section.
+ </p>
+
+ <section>
+
+ <h4>Web Intents service type for DNS-SD</h4>
+
+ <p>
+ The <a>Web Intents enabled mDNS device</a> <em class="rfc2119" title="must">must</em> support [[!DNS-SD]] with a SRV record of the <code>webintents</code> service type.
+ </p>
+
+ <p class="note">
+ A service type <code>webintents</code> should be registered in [[!IANA-SRVPORT-REG]].
+ </p>
+
+ <p>
+ The TXT record for the <code>webintents</code> service must have following parameters:
+ </p>
+ <ul class="rule">
+ <li>
+ <code>location</code>: <em class="rfc2119" title="required">required</em>. States the location to the Web Intents document in the <a>Web Intents enabled mDNS device</a>.
+ The value of this header is path to be concatenated with a host of the <a>Web Intents enabled mDNS device</a> to determine the location. The definition of the Web Intents document is the same as for UPnP.
+ </li>
+ <li>
+ <code>action</code>: <em class="rfc2119" title="optional">optional</em>. If supported, states the Web Intents
+ <code>action</code> of the supported Web Intents Services and <em class="rfc2119" title="must">must</em>
+ match the <code>action</code> attributes of the Service registration markup in the Web Intents document. To support more than
+ one Web Intents <code>action</code> the action strings <em class="rfc2119" title="must">must</em> be separated with
+ comma. Commas included in action strings <em class="rfc2119" title="must">must</em> be percent-encoded as
+ defined in [[!RFC3986]], section-2.1.
+ <br>
+ This allows the <a>mDNS enabled User Agent</a> to filter received mDNS messages so that the <a>mDNS enabled User Agent</a> only has to
+ retrieve Web Intents documents for matching Web Intents Actions.
+ </li>
+ </ul>
+
+ </section>
+
+ </section>
+ <section>
+ <h3>mDNS enabled User Agent</h3>
+
+ <p>
+ The <a>mDNS enabled User Agent</a> <em class="rfc2119" title="must">must</em> support discovery of <a>Web Intents enabled mDNS device</a>s through mDNS and DNS-SD
+ according to [[!MDNS]], [[!DNS-SD]] and according to the Web Intents specific DNS records defined in this specification, section 5.1.
+ </p>
+
+ <section class='informative'>
+ <h4>Dynamic Service registration</h4>
+ <p>
+ When the navigator.startActivity method [[!WEBINTENTS]] is called, the <a>mDNS enabled User Agent</a> typically runs the following steps:
+ </p>
+
+ <ol class="rule">
+ <li>
+ Send a multicast PTR query of the <code>_webintents._tcp.local</code> in the format specified by [[!MDNS]] and [[!DNS-SD]].
+ <br />
+ </li>
+
+ <li>
+ For each response, send a unicast TXT query of the webintents service instance in the PTR answer.
+ <br />
+ <p>This step can be omitted in case that the <a>Web Intents enabled mDNS device</a> attaches a TXT answer with the previous answer.
+ </li>
+
+ <li>
+ For each matching response, i.e. the response TXT record does not have an action parameter or does have an <code>action</code> parameter matching the Action of the invoked intent,
+ send a unicast request with a SRV query of the webintens service instance.
+ <br />
+ <p>This step can be omitted in case that the <a>Web Intents enabled mDNS device</a> attaches a SRV answer with the previous answer.
+ </li>
+
+ <li>
+ For each response, send a unicast A and/or AAAA query of the host name in the SRV answer.
+ <br />
+ <p>This step can be omitted in case that the <a>Web Intents enabled mDNS device</a> attaches an A and/or AAAA answer with the previous answer.
+ </li>
+
+ <li>
+ The <a>mDNS enabled User Agent</a> attempts to retrieve the Web Intents document from the discovered <a>Web Intents enabled mDNS device</a>.
+ The destination URL consists of an IP address in the A or AAAA answer, a port number in the SRV record and an absolute path in the <code>location</code> parameter of the TXT record.
+ <br /> <br />
+ If the <a>mDNS enabled User Agent</a> fails to retrieve the Web Intents document it silently disregards the received response.
+ <br /> <br />
+ If the <code>action</code> parameter is present and does not match the <code>action</code> attributes of the Services registered in the retrieved Web Intents
+ document the <a>mDNS enabled User Agent</a> silently disregards the the received response.
+ <br /> <br />
+ Note that following steps are identical to those of UPnP described in 4.2.
+ </li>
+
+ <li>
+ It is expected that the Web Intents document contains registration markup and the <a>mDNS enabled User Agent</a> interprets this
+ registration markup according to the rules for registration defined by [[!WEBINTENTS]] and register the Services accordingly.
+ </li>
+
+ <li>
+ The <a>mDNS enabled User Agent</a> makes each dynamically registered Service, that matches the Action of the invoked intent, available for selection
+ by the user, typically by making them visible and selectable in a Web Intents Service picker.
+ </li>
+
+ <li>
+ Based on user selection of a dynamically registered Service the <a>mDNS enabled User Agent</a> loads the
+ Service handler code as defined by the <code>href</code> attribute in the registration markup for this Service according to the rules for
+ loading Service pages defined in [[!WEBINTENTS]].
+ </li>
+
+ </ol>
+
+ </section>
+
+ </section>
+ <section class="informative">
+ <h3>Sample Records</h3>
+
+ <p>
+ See below for the example records for Web Intents. An <a>mDNS enabled User Agent</a> looking for devices supporting http://webintents.org/view Web Intents can understand that
+ it is possible to get a Web Intents document for "LivingRoomTV" at http://192.168.1.47:3619/webintents.html.
+ </p>
+
+ <ul class="rule">
+ <li>
+ <code>_webintents._tcp.local. 120 IN PTR LivingRoomTV._webintents._tcp.local.</code>: A LivingRoomTV instance serves webintents service.
+ </li>
+ <li>
+ <code>LivingRoomTV._webintents._tcp.local. 120 IN SRV 0 0 3619 TV40EX-W2000.local.</code>: A host "TV40EX-W2000" in the link local network offers the LivingRoomTV webintents service instance in its port 3619.
+ </li>
+ <li>
+ <code>LivingRoomTV._webintents._tcp.local. 120 IN TXT location=/webintents.html action=http://webintents.org/view</code>: It offers http://webintents.org/view type of Web Intents. The absolute path for its Web Intents document is "/webintents.html". Note that the actual binary format of the TXT record value is concatinating key-value pairs each of which is a single byte length followed by 0-255 length key=value character string as defined in [DNS-SD].
+ </li>
+ <li>
+ <code>TV40EX-W2000 120 IN A 192.168.1.47</code>: A host "TV40EX-W2000" is on 192.168.1.47.
+ </li>
+ </ul>
+
+ </section>
+
+ </section>
+
+
+ <section class='informative'>
+ <h2>APIs / protocols Client - Service </h2>
+ <p>
+ The APIs / protocols for interaction between Client and Service pages are not defined by this specification. It is assumed that Web Intents
+ based APIs and protocols will be standardized by W3C and that these will be applicable for Client and Service applications running on User Agents that
+ comply to this specification. Different use cases will require different ways of interaction patterns between Client and Service.
+ </p>
+
+ <p>
+ Examples:
+ </p>
+ <ul class="rule">
+ <li>
+ A Client application invoking a "View" intent provides, as intent payload data, a link to a video to be displayed at the remote <a>Web Intents enabled UPnP device</a>.
+ The Service application takes full control of the video playback by providing control buttons and sends UPnP commands to the remote device.
+ So in this case there the simple "API" just gives the link to the video to play.
+ </li>
+ <li>
+ Some use cases require a longer lasting relation between the Client and Service applications. By using the MessagePort[] attribute of the intent object
+ a message channel can be established between the Client and Service page. This message channel can be used to run Service specific protocols,
+ for example a protocol that allows the Client application to send simple video playback control commands to a Service application.
+ </li>
+ </ul>
+
+ </section>
+
+ <section class='informative appendix'>
+ <h2>Examples and scenarios</h2>
+ <section>
+ <h3>View and control video on remote device through Service page control buttons</h3>
+ <p>
+ The following scenario describes how a Client page uses Web Intents to discover a remote video view service. The Service page
+ contains the UI for controlling the video playback.
+ </p>
+
+ <p><img src="Example_scenario_1/Slide1.png" alt="Example scenario 1/Slide1" width="700" height="700" ><br>
+ (<a href="Example_scenario_1/Slide1.png">View as PNG</a>)
+ </p>
+
+ <p><img src="Example_scenario_1/Slide2.png" alt="Example scenario 1/Slide2" width="700" height="700" ><br>
+ (<a href="Example_scenario_1/Slide2.png">View as PNG</a>)
+ </p>
+
+ <p><img src="Example_scenario_1/Slide3.png" alt="Example scenario 1/Slide3" width="700" height="700" ><br>
+ (<a href="Example_scenario_1/Slide3.png">View as PNG</a>)
+ </p>
+ </section>
+
+ <section>
+ <h3>View and control video on remote device through Client page control buttons</h3>
+ <p>
+ The following scenario describes how a Client page uses Web Intents to discover a remote video view service. The UI stays in the Client page,
+ which contains the UI controls for the video playback. This means that there is a need for continuous communication between the Client page and the Service page,
+ which is "hidden", i.e. it has no UI. The Client page creates a messaging channel and sends the messaging channel port to the Service page trhrough the intent invocation.
+ A high level "TV control" protocol, supporting commands such as "play", "pause" and "stop, runs on top of the messaging channel.
+ </p>
+ <p>
+ In this example the assumption is that he Client invokes an intent to discover a Service that supports a specified protocol running on top of the message channel So the
+ "discover" intent Action is used and Type is set to the specific protocol used to communicate with the Service.
+ </p>
+
+ <p class="issue">
+ This scenario assumes the possibility to have hidden/background Service pages or Service pages that are visible inline the Client page.
+ Currently [[!WEBINTENTS]] does not allow this but W3C DAP Action http://www.w3.org/2009/dap/track/actions/519 should add a proposal for a hidden disposition.
+ </p>
+
+ <p><img src="Example_scenario_2/Slide1.png" alt="Example scenario 2/Slide1" width="700" height="700" ><br>
+ (<a href="Example_scenario_2/Slide1.png">View as PNG</a>)
+ </p>
+
+ <p><img src="Example_scenario_2/Slide2.png" alt="Example scenario 2/Slide2" width="700" height="700" ><br>
+ (<a href="Example_scenario_2/Slide2.png">View as PNG</a>)
+ </p>
+
+ <p><img src="Example_scenario_2/Slide3.png" alt="Example scenario 2/Slide3" width="700" height="700" ><br>
+ (<a href="Example_scenario_2/Slide3.png">View as PNG</a>)
+ </p>
+
+ <p><img src="Example_scenario_2/Slide4.png" alt="Example scenario 2/Slide4" width="700" height="700" ><br>
+ (<a href="Example_scenario_2/Slide4.png">View as PNG</a>)
+ </p>
+ </section>
+
+
+
+ <section>
+ <h3>Example of Web Intents document</h3>
+
+ <p><img src="Example1_registration_page/Slide1.png" alt="Example1 registration page" width="280" height="280" ><br>
+ (<a href="Example1_registration_page/Slide1.png">View as PNG</a>)
+ </p>
+ </section>
+
+ <section>
+ <h3>Example of UPnP Device description document</h3>
+ <p><img src="Example_device_and_service_description_pages/Slide1.png" alt="Example device and service description pages/Slide1" width="600" height="600" ><br>
+ (<a href="Example_device_and_service_description_pages/Slide1.png">View as PNG</a>)
+ </p>
+ </section>
+
+ </section>
+
+ <section class='appendix'>
+ <h3>Acknowledgements</h3>
+ <p>
+ Many thanks to Sony colleagues Anders Isberg, Naoyuki Sato, Tatsuya Igarashi, Anders Edenbrandt and Björn Ekberg for all support.
+ <br /> <br />
+ Many thanks to Robin Berjon for making our lives so much easier with his cool specification editing tool.
+ </p>
+ </section>
+ </body>
+</html>
--- a/wi-addendum-local-services/Overview.html Tue Oct 02 18:05:58 2012 -0700
+++ b/wi-addendum-local-services/Overview.html Tue Oct 02 18:07:01 2012 -0700
@@ -15,7 +15,7 @@
specStatus: "ED",
// the specification's short name, as in http://www.w3.org/TR/short-name/
- shortName: "Web Intents-LD addendum",
+ shortName: "webintents-local-services",
// if your specification has a subtitle that goes below the main
// formal title, define it here
@@ -49,7 +49,7 @@
{ name: "Claes Nilsson",
company: "Sony Mobile", companyURL: "http://www.sonymobile.com/se/" },
{ name: "Norifumi Kikkawa",
- company: "Sony Corporation", companyURL: "tbd"},
+ company: "Sony Corporation", companyURL: "http://www.sony.net/"},
],
// authors, add as many as you like.
@@ -65,10 +65,10 @@
edDraftURI: "http://w3c-test.org/dap/wi-addendum-local-services/",
// name of the WG
- wg: "DAP/Web Apps Web Intents task force",
+ wg: ["Device Applications (DAP) Working Group", "Web Applications (WebApps) Working Group"],
// URI of the public WG page
- wgURI: "http://www.w3.org/2009/dap/",
+ wgURI: ["http://www.w3.org/2009/dap/", "http://www.w3.org/2008/webapps/"],
// name (without the @w3c.org) of the public mailing to which comments are due
wgPublicList: "public-web-intents",
@@ -78,9 +78,18 @@
// This is important for Rec-track documents, do not copy a patent URI from a random
// document unless you know what you're doing. If in doubt ask your friendly neighbourhood
// Team Contact.
- wgPatentURI: "",
+ wgPatentURI: ["http://www.w3.org/2004/01/pp-impl/43696/status", "http://www.w3.org/2004/01/pp-impl/42538/status"]
};
</script>
+
+ <style type="text/css">
+
+ /* Add addition spacing to <ol> and <ul> for rule definition */
+ ol.rule li, ul.rule li { padding:0.6em; }
+
+ </style>
+
+
</head>
<body>
<section id='abstract'>
@@ -94,10 +103,11 @@
Web Intents,[[!WEBINTENTS]], is a service discovery and light-weight RPC mechanism for web applications. The concept enables rich integration between web applications.
A typical Web Intents scenario is:
</p>
- <ol>
+ <ol class="rule">
<li>Web Intents Services register their intention to handle an action for the user </li>
<li>A web application requests to start an action (share, edit, pick, view, ...)</li>
<li>The user selects which service to handle the action</li>
+ <li>The selected service executes the action</li>
</ol>
<p>
A Web Intents Service is represented by a web page that declaratively marks itself as providing handling functionality for particular intents. Users register Web Intents Services
@@ -130,7 +140,7 @@
the user.
</p>
- <ol>
+ <ol class="rule">
<li>Triggered by navigator.startActivity the User Agent will start local network discovery of Web Intents Services.</li>
<li>Replies from Web Intents enabled devices contain a URL to a Web Intents document, containing Web Intents Service registration
markup, in the device. </li>
@@ -146,17 +156,18 @@
<section id="conformance">
<p>
This specification defines conformance criteria that apply to:
- <ul>
- <li><dfn>UPnP enabled User Agent</dfn>: A <a>UPnP enabled User Agent</a> MUST support Web Intents [[!WEBINTENTS]] and the conformance criteria
- stated in this specification. </li>
- <li><dfn>Web Intents enabled UPnP device</dfn>: A <a>Web Intents enabled UPnP device</a> MUST support [[!UPNP-DEVICEARCH]] and the conformance criteria
- stated in this specification. </li>
- <li><dfn>mDNS enabled User Agent</dfn>: An <a>mDNS enabled User Agent</a> MUST support Web Intents [[!WEBINTENTS]] and the conformance criteria
- stated in this specification. </li>
- <li><dfn>Web Intents enabled mDNS device</dfn>: A <a>Web Intents enabled mDNS device</a> MUST support [[!DNS-SD]], [[!MDNS]] and the conformance criteria
- stated in this specification. </li>
- </ul>
- </p>
+ </p>
+ <ul class="rule">
+ <li><dfn>UPnP enabled User Agent</dfn>: A <a>UPnP enabled User Agent</a> MUST support Web Intents [[!WEBINTENTS]] and the conformance criteria
+ stated in this specification. </li>
+ <li><dfn>Web Intents enabled UPnP device</dfn>: A <a>Web Intents enabled UPnP device</a> MUST support [[!UPNP-DEVICEARCH]] and the conformance criteria
+ stated in this specification. </li>
+ <li><dfn>mDNS enabled User Agent</dfn>: An <a>mDNS enabled User Agent</a> MUST support Web Intents [[!WEBINTENTS]] and the conformance criteria
+ stated in this specification. </li>
+ <li><dfn>Web Intents enabled mDNS device</dfn>: A <a>Web Intents enabled mDNS device</a> MUST support [[!DNS-SD]], [[!MDNS]] and the conformance criteria
+ stated in this specification. </li>
+ </ul>
+
<p>
Implementations that use ECMAScript to implement the APIs defined in
this specification must implement them in a manner consistent with the
@@ -167,21 +178,22 @@
<h2>Dependencies</h2>
<p>
This specification relies on the following specifications:
+ </p>
- <dl>
- <dt>Web Intents</dt>
- <dd>This addendum specification is dependent on and defines optional extensions to the basic Web Intents specification, [[!WEBINTENTS]]. </dd>
- <dt>UPnP Device Architecture 1.0</dt>
- <dd>This addendum specification is dependent on and defines vendor specific extensions to the UPnP Device Architecture 1.0 specification, [[!UPNP-DEVICEARCH]]. </dd>
- <dt>IANA Service Name and Transport Protocol Port Number Registry</dt>
- <dd>This addendum specification adds new entry on it, [[!IANA-SRVPORT-REG]]. </dd>
- <dt>DNS-SD</dt>
- <dd>This addendum specification is dependent on it, [[!DNS-SD]]. </dd>
- <dt>mDNS</dt>
- <dd>This addendum specification is dependent on it, [[!MDNS]]. </dd>
- </dl>
+ <dl>
+ <dt>Web Intents</dt>
+ <dd>This addendum specification is dependent on and defines optional extensions to the basic Web Intents specification, [[!WEBINTENTS]]. </dd>
+ <dt>UPnP Device Architecture 1.0</dt>
+ <dd>This addendum specification is dependent on and defines vendor specific extensions to the UPnP Device Architecture 1.0 specification, [[!UPNP-DEVICEARCH]]. </dd>
+ <dt>IANA Service Name and Transport Protocol Port Number Registry</dt>
+ <dd>This addendum specification adds new entry on it, [[!IANA-SRVPORT-REG]]. </dd>
+ <dt>DNS-SD</dt>
+ <dd>This addendum specification is dependent on it, [[!DNS-SD]]. </dd>
+ <dt>mDNS</dt>
+ <dd>This addendum specification is dependent on it, [[!MDNS]]. </dd>
+ </dl>
- </p>
+
</section>
</section>
@@ -197,20 +209,20 @@
UPnP related terms are used according to [[!UPNP-DEVICEARCH]].
</p>
<p>
- The <a>UPnP enabled User Agent</a> has the role of a <dfn id="dfn-registration">control point</dfn> according to UPnP terminology.
+ The <a>UPnP enabled User Agent</a> has the role of a <dfn id="dfn-control-point">control point</dfn> according to UPnP terminology.
</p>
<p>
- The <a>Web Intents enabled UPnP device</a> discovered by the <a>UPnP enabled User Agent</a> has the roles of <dfn id="dfn-registration">device</dfn> according to UPnP terminology.
+ The <a>Web Intents enabled UPnP device</a> discovered by the <a>UPnP enabled User Agent</a> has the roles of <dfn id="dfn-device">device</dfn> according to UPnP terminology.
</p>
</section>
<section>
<h3>mDNS related terms</h3>
<p>
- The <a>mDNS enabled User Agent</a> has the role of a <dfn id="dfn-registration">DNS client</dfn> with capability of [[!DNS-SD]].
+ The <a>mDNS enabled User Agent</a> has the role of a <dfn id="dfn-DNS-client">DNS client</dfn> with capability of [[!DNS-SD]].
</p>
<p>
- The <a>Web Intents enabled mDNS device</a> discovered by the <a>mDNS enabled User Agent</a> has the roles of <dfn id="dfn-registration">service</dfn> according to [[!MDNS]] and [[!DNS-SD]].
+ The <a>Web Intents enabled mDNS device</a> discovered by the <a>mDNS enabled User Agent</a> has the roles of <dfn id="dfn-service">service</dfn> according to [[!MDNS]] and [[!DNS-SD]].
</p>
</section>
@@ -251,7 +263,7 @@
See below for the UPnP Service description document of the Web Intents serviceType.
</p>
- <p align="left"><img src="Example_device_and_service_description_pages/Slide2.png" alt="Service description page" width="600" height="600" ><br>
+ <p><img src="Example_device_and_service_description_pages/Slide2.png" alt="Service description page" width="600" height="600" ><br>
(<a href="Example_device_and_service_description_pages/Slide2.png">View as PNG</a>)
</p>
@@ -267,7 +279,7 @@
SSDP headers for M-SEARCH response and NOTIFY when ST/NT headers are:<code>urn:schemas-webintents-org:service:WebIntents:1</code>
</p>
- <ul>
+ <ul class="rule">
<li>
<code>location.webintents.org</code>: <em class="rfc2119" title="required">required</em>. States the location to the Web Intents document in the <a>Web Intents enabled UPnP device</a>.
If the value of this header is a relative URL the base URL is the base URL of the <code>LOCATION</code> header.
@@ -279,7 +291,7 @@
one Web Intents <code>action</code> the action strings <em class="rfc2119" title="must">must</em> be separated with
comma. Commas included in action strings <em class="rfc2119" title="must">must</em> be percent-encoded as
defined in [[!RFC3986]], section-2.1.
- <br /> <br />
+ <br />
This header allows the <a>UPnP enabled User Agent</a> to filter received SSDP messages so that the <a>UPnP enabled User Agent</a> only has to
retrieve Web Intents documents for matching Web Intents Actions.
</li>
@@ -320,7 +332,7 @@
<h3><a>UPnP enabled User Agent</a></h3>
<p>
- The <a>UPnP enabled User Agent</a> <em class="rfc2119" title="must">must</em> support discovery of <a>Web Intents enabled UPnP device<a>s through SSDP Discovery or through Advertisement
+ The <a>UPnP enabled User Agent</a> <em class="rfc2119" title="must">must</em> support discovery of <a>Web Intents enabled UPnP device</a>s through SSDP Discovery or through Advertisement
or through both methods according to [[!UPNP-DEVICEARCH]] and according to the Web Intents serviceType and Web Intents specific SSDP headers
defined in this specification, section 4.1.
</p>
@@ -346,7 +358,7 @@
<br />
The <code>ST</code> header is set to: <code>urn:schemas-webintents-org:service:WebIntents:1</code>
</li>
- <br />
+
<li>
For each matching M-SEARCH response, i.e. the response ST header is <code>urn:schemas-webintents-org:service:WebIntents:1</code> and the <code>action.webintents.org</code>
header, if present, matches the Action of the invoked intent,
@@ -360,17 +372,17 @@
If the <code>action.webintents.org</code> header is present and does not match the <code>action</code> attributes of the Services registered in the retrieved Web Intents
document the <a>UPnP enabled User Agent</a> silently disregards the the received M-SEARCH response.
</li>
- <br />
+
<li>
It is expected that the Web Intents document contains registration markup and the <a>UPnP enabled User Agent</a> interprets this
registration markup according to the rules for registration defined by [[!WEBINTENTS]] and register the Services accordingly.
</li>
- <br />
+
<li>
The <a>UPnP enabled User Agent</a> makes each dynamically registered Service, that matches the Action of the invoked intent, available for selection
by the user, typically by making them visible and selectable in a Web Intents Service picker.
</li>
- <br />
+
<li>
Based on user selection of a dynamically registered Service the <a>UPnP enabled User Agent</a> loads the
Service handler code as defined by the <code>href</code> attribute in the registration markup for this Service according to the rules for
@@ -396,7 +408,7 @@
The <a>UPnP enabled User Agent</a> maintains a list of announced UPnP services based on received SSDP NOTIFY messages
with <code>NT</code> header equal to <code>urn:schemas-webintents-org:service:WebIntents:1</code>.
</li>
- <br />
+
<li>
When the navigator.startActivity method [[!WEBINTENTS]] is called the <a>UPnP enabled User Agent</a> checks the list
of of announced services and attempts to retrieve the Web Intents document from the discovered <a>Web Intents enabled UPnP device</a> in the following cases:
@@ -417,17 +429,17 @@
If the <code>action.webintents.org</code> header does not match the <code>action</code> attribute in the retrieved Web Intents document
the <a>UPnP enabled User Agent</a> silently disregards the received NOTIFY message.
</li>
- <br />
+
<li>
It is expected that the Web Intents document contains registration markup and the <a>UPnP enabled User Agent</a> interprets the
Web Intents document according to the rules for registration defined by [[!WEBINTENTS]] and register the Services accordingly.
</li>
- <br />
+
<li>
The <a>UPnP enabled User Agent</a> makes each dynamically registered Service, that matches the Action of the invoked intent, available for selection
by the user, typically by making them visible and selectable in a Web Intents Service picker.
</li>
- <br />
+
<li>
Based on user selection of a dynamically registered Service the <a>UPnP enabled User Agent</a> loads the
Service handler code as defined by the <code>href</code> attribute in the registration markup for this Service according to the rules for
@@ -501,10 +513,10 @@
<p>
The TXT record for the <code>webintents</code> service must have following parameters:
</p>
- <ul>
+ <ul class="rule">
<li>
- <code>location</code>: <em class="rfc2119" title="required">required</em>. States the location to the Web Intents document in the <a class="internalDFN" href="#dfn-web-intents-enabled-mdns-device">Web Intents enabled mDNS device</a>.
- The value of this header is path to be concatenated with a host of the <a class="internalDFN" href="#dfn-web-intents-enabled-mdns-device">Web Intents enabled mDNS device</a> to determine the location. The definition of the Web Intents document is the same as for UPnP.
+ <code>location</code>: <em class="rfc2119" title="required">required</em>. States the location to the Web Intents document in the <a>Web Intents enabled mDNS device</a>.
+ The value of this header is path to be concatenated with a host of the <a>Web Intents enabled mDNS device</a> to determine the location. The definition of the Web Intents document is the same as for UPnP.
</li>
<li>
<code>action</code>: <em class="rfc2119" title="optional">optional</em>. If supported, states the Web Intents
@@ -513,7 +525,7 @@
one Web Intents <code>action</code> the action strings <em class="rfc2119" title="must">must</em> be separated with
comma. Commas included in action strings <em class="rfc2119" title="must">must</em> be percent-encoded as
defined in [[!RFC3986]], section-2.1.
- <br> <br>
+ <br>
This allows the <a>mDNS enabled User Agent</a> to filter received mDNS messages so that the <a>mDNS enabled User Agent</a> only has to
retrieve Web Intents documents for matching Web Intents Actions.
</li>
@@ -526,7 +538,7 @@
<h3>mDNS enabled User Agent</h3>
<p>
- The <a>mDNS enabled User Agent</a> <em class="rfc2119" title="must">must</em> support discovery of <a>Web Intents enabled mDNS device<a>s through mDNS and DNS-SD
+ The <a>mDNS enabled User Agent</a> <em class="rfc2119" title="must">must</em> support discovery of <a>Web Intents enabled mDNS device</a>s through mDNS and DNS-SD
according to [[!MDNS]], [[!DNS-SD]] and according to the Web Intents specific DNS records defined in this specification, section 5.1.
</p>
@@ -541,26 +553,26 @@
Send a multicast PTR query of the <code>_webintents._tcp.local</code> in the format specified by [[!MDNS]] and [[!DNS-SD]].
<br />
</li>
- <br />
+
<li>
For each response, send a unicast TXT query of the webintents service instance in the PTR answer.
<br />
- <p>This step can be omitted in case that the Web Intents enabled mDNS device attaches a TXT answer with the previous answer.
+ <p>This step can be omitted in case that the <a>Web Intents enabled mDNS device</a> attaches a TXT answer with the previous answer.
</li>
- <br />
+
<li>
For each matching response, i.e. the response TXT record does not have an action parameter or does have an <code>action</code> parameter matching the Action of the invoked intent,
send a unicast request with a SRV query of the webintens service instance.
<br />
- <p>This step can be omitted in case that the Web Intents enabled mDNS device attaches a SRV answer with the previous answer.
+ <p>This step can be omitted in case that the <a>Web Intents enabled mDNS device</a> attaches a SRV answer with the previous answer.
</li>
- <br />
+
<li>
For each response, send a unicast A and/or AAAA query of the host name in the SRV answer.
<br />
- <p>This step can be omitted in case that the Web Intents enabled mDNS device attaches an A and/or AAAA answer with the previous answer.
+ <p>This step can be omitted in case that the <a>Web Intents enabled mDNS device</a> attaches an A and/or AAAA answer with the previous answer.
</li>
- <br />
+
<li>
The <a>mDNS enabled User Agent</a> attempts to retrieve the Web Intents document from the discovered <a>Web Intents enabled mDNS device</a>.
The destination URL consists of an IP address in the A or AAAA answer, a port number in the SRV record and an absolute path in the <code>location</code> parameter of the TXT record.
@@ -572,17 +584,17 @@
<br /> <br />
Note that following steps are identical to those of UPnP described in 4.2.
</li>
- <br />
+
<li>
It is expected that the Web Intents document contains registration markup and the <a>mDNS enabled User Agent</a> interprets this
registration markup according to the rules for registration defined by [[!WEBINTENTS]] and register the Services accordingly.
</li>
- <br />
+
<li>
The <a>mDNS enabled User Agent</a> makes each dynamically registered Service, that matches the Action of the invoked intent, available for selection
by the user, typically by making them visible and selectable in a Web Intents Service picker.
</li>
- <br />
+
<li>
Based on user selection of a dynamically registered Service the <a>mDNS enabled User Agent</a> loads the
Service handler code as defined by the <code>href</code> attribute in the registration markup for this Service according to the rules for
@@ -602,7 +614,7 @@
it is possible to get a Web Intents document for "LivingRoomTV" at http://192.168.1.47:3619/webintents.html.
</p>
- <ul>
+ <ul class="rule">
<li>
<code>_webintents._tcp.local. 120 IN PTR LivingRoomTV._webintents._tcp.local.</code>: A LivingRoomTV instance serves webintents service.
</li>
@@ -610,7 +622,7 @@
<code>LivingRoomTV._webintents._tcp.local. 120 IN SRV 0 0 3619 TV40EX-W2000.local.</code>: A host "TV40EX-W2000" in the link local network offers the LivingRoomTV webintents service instance in its port 3619.
</li>
<li>
- <code>LivingRoomTV._webintents._tcp.local. 120 IN TXT location=/webintents.html action=http://webintents.org/view</code>: It offers http://webintents.org/view type of Web Intents. The absolete path for its Web Intents document is "/webintents.html". Note that the actual binary format of the TXT record value is concatinating key-value pairs each of which is a single byte length followed by 0-255 length key=value character string as defined in [DNS-SD].
+ <code>LivingRoomTV._webintents._tcp.local. 120 IN TXT location=/webintents.html action=http://webintents.org/view</code>: It offers http://webintents.org/view type of Web Intents. The absolute path for its Web Intents document is "/webintents.html". Note that the actual binary format of the TXT record value is concatinating key-value pairs each of which is a single byte length followed by 0-255 length key=value character string as defined in [DNS-SD].
</li>
<li>
<code>TV40EX-W2000 120 IN A 192.168.1.47</code>: A host "TV40EX-W2000" is on 192.168.1.47.
@@ -633,7 +645,7 @@
<p>
Examples:
</p>
- <ul>
+ <ul class="rule">
<li>
A Client application invoking a "View" intent provides, as intent payload data, a link to a video to be displayed at the remote <a>Web Intents enabled UPnP device</a>.
The Service application takes full control of the video playback by providing control buttons and sends UPnP commands to the remote device.
@@ -657,15 +669,15 @@
contains the UI for controlling the video playback.
</p>
- <p align="left"><img src="Example_scenario_1/Slide1.png" alt="Example scenario 1/Slide1" width="700" height="700" ><br>
+ <p><img src="Example_scenario_1/Slide1.png" alt="Example scenario 1/Slide1" width="700" height="700" ><br>
(<a href="Example_scenario_1/Slide1.png">View as PNG</a>)
</p>
- <p align="left"><img src="Example_scenario_1/Slide2.png" alt="Example scenario 1/Slide2" width="700" height="700" ><br>
+ <p><img src="Example_scenario_1/Slide2.png" alt="Example scenario 1/Slide2" width="700" height="700" ><br>
(<a href="Example_scenario_1/Slide2.png">View as PNG</a>)
</p>
- <p align="left"><img src="Example_scenario_1/Slide3.png" alt="Example scenario 1/Slide3" width="700" height="700" ><br>
+ <p><img src="Example_scenario_1/Slide3.png" alt="Example scenario 1/Slide3" width="700" height="700" ><br>
(<a href="Example_scenario_1/Slide3.png">View as PNG</a>)
</p>
</section>
@@ -688,19 +700,19 @@
Currently [[!WEBINTENTS]] does not allow this but W3C DAP Action http://www.w3.org/2009/dap/track/actions/519 should add a proposal for a hidden disposition.
</p>
- <p align="left"><img src="Example_scenario_2/Slide1.png" alt="Example scenario 2/Slide1" width="700" height="700" ><br>
+ <p><img src="Example_scenario_2/Slide1.png" alt="Example scenario 2/Slide1" width="700" height="700" ><br>
(<a href="Example_scenario_2/Slide1.png">View as PNG</a>)
</p>
- <p align="left"><img src="Example_scenario_2/Slide2.png" alt="Example scenario 2/Slide2" width="700" height="700" ><br>
+ <p><img src="Example_scenario_2/Slide2.png" alt="Example scenario 2/Slide2" width="700" height="700" ><br>
(<a href="Example_scenario_2/Slide2.png">View as PNG</a>)
</p>
- <p align="left"><img src="Example_scenario_2/Slide3.png" alt="Example scenario 2/Slide3" width="700" height="700" ><br>
+ <p><img src="Example_scenario_2/Slide3.png" alt="Example scenario 2/Slide3" width="700" height="700" ><br>
(<a href="Example_scenario_2/Slide3.png">View as PNG</a>)
</p>
- <p align="left"><img src="Example_scenario_2/Slide4.png" alt="Example scenario 2/Slide4" width="700" height="700" ><br>
+ <p><img src="Example_scenario_2/Slide4.png" alt="Example scenario 2/Slide4" width="700" height="700" ><br>
(<a href="Example_scenario_2/Slide4.png">View as PNG</a>)
</p>
</section>
@@ -710,14 +722,14 @@
<section>
<h3>Example of Web Intents document</h3>
- <p align="left"><img src="Example1_registration_page/Slide1.png" alt="Example1 registration page" width="280" height="280" ><br>
+ <p><img src="Example1_registration_page/Slide1.png" alt="Example1 registration page" width="280" height="280" ><br>
(<a href="Example1_registration_page/Slide1.png">View as PNG</a>)
</p>
</section>
<section>
<h3>Example of UPnP Device description document</h3>
- <p align="left"><img src="Example_device_and_service_description_pages/Slide1.png" alt="Example device and service description pages/Slide1" width="600" height="600" ><br>
+ <p><img src="Example_device_and_service_description_pages/Slide1.png" alt="Example device and service description pages/Slide1" width="600" height="600" ><br>
(<a href="Example_device_and_service_description_pages/Slide1.png">View as PNG</a>)
</p>
</section>