discovery-api/Overview.src.html
author Daniel Danciu <danieldanciu@google.com>
Thu, 25 Oct 2012 19:49:39 +0200
changeset 330 78129450e57a
parent 288 ec6f8e4f894e
child 331 43b139afeba9
permissions -rw-r--r--
Added DIAL support
richt@180
     1
<!DOCTYPE html>
richt@239
     2
<!--
richt@239
     3
richt@239
     4
  THIS IS THE WORKING VERSION OF THE CURRENT SPECIFICATION!
richt@239
     5
richt@239
     6
  This specification is built using ReSpec.js <http://dev.w3.org/2009/dap/ReSpec.js/documentation.html>
richt@239
     7
richt@239
     8
  From time to time it's necessary to HTML5 Tidy this document using the tool @ <http://w3c.github.com/tidy-html5/>.
richt@239
     9
richt@239
    10
  The command used to format this document (Overview.src.html) is as follows (replacing all = signs with - signs!):
richt@239
    11
richt@239
    12
  @> 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
richt@239
    13
richt@239
    14
  To publish a new compiled version (Overview.html), we need to open this file (Overview.src.html) in any web browser.
richt@239
    15
  Once it has loaded we press 'Ctrl + Shift + S' (or 'Cmd' + 'Shift' + 'S' on Mac) and then select
richt@239
    16
  'Save as HTML (Source)' from the resulting menu.
richt@239
    17
richt@239
    18
  We then replace Overview.html with the produced HTML source of this process.
richt@239
    19
richt@239
    20
  Next we run HTML5 Tidy over our new Overview.html file with the following command (replacing all = signs with - signs!):
richt@239
    21
richt@239
    22
  @> 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
richt@239
    23
richt@239
    24
  Now the specification is ready to be published :)
richt@239
    25
richt@239
    26
-->
richt@180
    27
<html>
richt@180
    28
  <head>
richt@239
    29
    <title>
richt@239
    30
      Network Service Discovery
richt@239
    31
    </title>
richt@239
    32
    <meta http-equiv='Content-Type'
richt@239
    33
          content='text/html; charset=utf-8'>
richt@239
    34
    <script type="text/javascript"
richt@239
    35
          class='remove'>
richt@239
    36
var respecConfig = {
frederick@288
    37
<<<<<<< local
frederick@288
    38
          specStatus:   "WD",
frederick@288
    39
          publishDate:  "2012-10-04",
frederick@288
    40
=======
richt@191
    41
          specStatus:   "ED",
richt@254
    42
          //publishDate:  "2012-10-04",
frederick@288
    43
>>>>>>> other
richt@191
    44
          shortName:    "discovery-api",
richt@230
    45
          edDraftURI:   "http://dvcs.w3.org/hg/dap/raw-file/tip/discovery-api/Overview.html",
richt@241
    46
          previousMaturity: "FPWD",
richt@191
    47
          previousPublishDate: "2012-08-07",
richt@180
    48
          editors: [
richt@191
    49
            {
richt@191
    50
              name:       "Rich Tibbett",
richt@191
    51
              //url:        "http://richt.me/",
richt@191
    52
              company:    "Opera Software ASA",
richt@191
    53
              companyURL: "http://opera.com/"
richt@191
    54
            },
richt@191
    55
            {
richt@191
    56
              name:       "Clarke Stevens",
richt@191
    57
              //url:      "",
richt@191
    58
              company:    "CableLabs",
richt@191
    59
              companyURL: "http://cablelabs.com/"
richt@191
    60
            }
richt@180
    61
          ],
richt@191
    62
          noIDLIn:      true,
richt@241
    63
          wg:           "Device APIs Working Group",
richt@180
    64
          wgURI:        "http://www.w3.org/2009/dap/",
richt@180
    65
          wgPublicList: "public-device-apis",
richt@191
    66
          wgPatentURI:  "http://www.w3.org/2004/01/pp-impl/43696/status"
richt@180
    67
      };
richt@180
    68
    </script>
richt@239
    69
    <script src='http://www.w3.org/Tools/respec/respec-w3c-common'
richt@239
    70
          type="text/javascript"
richt@239
    71
          class='remove'
richt@239
    72
          async="">
richt@239
    73
</script>
richt@180
    74
    <style type="text/css">
richt@239
    75
/* Custom ReSpec CSS (by Rich Tibbett) */
richt@180
    76
richt@180
    77
      /* Add better spacing to sections */
richt@180
    78
      section, .section { margin-bottom: 2em; }
richt@180
    79
richt@180
    80
      /* Reduce note & issue render size */
richt@180
    81
      .note, .issue { font-size:0.8em; }
richt@180
    82
richt@180
    83
      /* Add addition spacing to <ol> and <ul> for rule definition */
richt@180
    84
      ol.rule li, ul.rule li { padding:0.6em; }
richt@180
    85
richt@180
    86
      pre.widl { border: solid thin; background: #EEEEEE; color: black; padding: 0.5em 1em; position: relative; }
richt@180
    87
      pre.widl :link, pre.widl :visited { color: #000; background: transparent; }
richt@180
    88
      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 }
richt@180
    89
richt@180
    90
      div.example { border: solid thin red; background: #F7DFE5; color: black; padding: 0.5em 1em; position: relative; margin: 1em 0 1em 4.6em; width: auto; }
richt@180
    91
      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 }
richt@180
    92
richt@180
    93
      dl.domintro { color: green; margin: 2em 0 2em 2em; padding: 0.5em 1em; border: none; background: #DDFFDD; }
richt@180
    94
      hr + dl.domintro, div.impl + dl.domintro { margin-top: 2.5em; margin-bottom: 1.5em; }
richt@180
    95
      dl.domintro dt, dl.domintro dt * { color: black; text-decoration: none; }
richt@180
    96
      dl.domintro dd { margin: 0.5em 0 1em 2em; padding: 0; }
richt@180
    97
      dl.domintro dd p { margin: 0.5em 0; }
richt@180
    98
      dl.domintro code {font-size: inherit; font-style: italic; }
richt@180
    99
      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; }
richt@238
   100
richt@238
   101
      table { border-collapse:collapse; border-style:hidden hidden none hidden }
richt@238
   102
      table thead { border-bottom:solid }
richt@238
   103
      table tbody th:first-child { border-left:solid }
richt@238
   104
      table td, table th { border-left:solid; border-right:solid; border-bottom:solid thin; vertical-align:top; padding:0.2em }
richt@180
   105
    </style>
richt@180
   106
  </head>
richt@180
   107
  <body>
richt@180
   108
    <section id='abstract'>
richt@180
   109
      <p>
richt@239
   110
        This specification defines a mechanism for an HTML document to discover and subsequently communicate with
richt@239
   111
        <abbr title="Hypertext Transfer Protocol">HTTP</abbr>-based services advertised via common discovery protocols
richt@239
   112
        within the current network.
richt@180
   113
      </p>
richt@180
   114
    </section>
richt@180
   115
    <section id='sotd'>
richt@180
   116
      <p>
richt@239
   117
        This document represents the early consensus of the group on the scope and features of the proposed API.
richt@180
   118
      </p>
richt@180
   119
    </section>
richt@180
   120
    <section class="informative">
richt@239
   121
      <h3>
richt@239
   122
        Introduction
richt@239
   123
      </h3>
richt@180
   124
      <p>
richt@239
   125
        To enable Web pages to connect and communicate with Local-networked Services provided over HTTP, this
richt@239
   126
        specification introduces the <a href="#navigatornetworkservice"><code>NavigatorNetworkService</code></a>
richt@239
   127
        interface.
richt@180
   128
      </p>
richt@180
   129
      <p>
richt@239
   130
        Using this <abbr title="Application Programming Interface">API</abbr> consists of requesting a well-known
richt@239
   131
        service type, known by developers and advertised by Local-networked Devices. User authorization, where the user
richt@254
   132
        connects the web page to discovered services, is expected before the web page is able to interact
richt@239
   133
        with any Local-networked Services.
richt@180
   134
      </p>
richt@180
   135
      <p>
richt@239
   136
        A web page creates a request to obtain connectivity to services running in the network by specifying a
richt@239
   137
        well-known discovery service type that it wishes to interact with.
richt@180
   138
      </p>
richt@180
   139
      <p>
richt@250
   140
        The user agent, having captured all advertised services on the network from the <a>service discovery
richt@250
   141
        mechanisms</a> included in this recommendation, attempts to match the requested service type to a discovered
richt@250
   142
        service according to the processing described herein.
richt@180
   143
      </p>
richt@180
   144
      <p>
richt@239
   145
        If a service connectivity request is successful then the Web page is provided with the necessary information to
richt@239
   146
        communicate with the authorized Local-networked Service. If the request fails then the Web page will receive an
richt@239
   147
        error callback containing an error code describing the cause of Local-networked Service connectivity failure.
richt@180
   148
      </p>
richt@239
   149
      <p>
richt@239
   150
        Once connected to a Local-networked Service the Web page can send requests and receive responses to the
richt@239
   151
        Local-networked Service via the messaging format and appropriate channel inferred from the service type
richt@239
   152
        authorized via the provided API. The Web page, once connected, can also receive service-pushed events, in the
richt@239
   153
        messaging format supported by the Local-networked Device, if such event subscription functionality is provided
richt@239
   154
        by the connected Local-networked Service.
richt@239
   155
      </p>
richt@180
   156
      <div class="example">
richt@239
   157
        <p>
richt@239
   158
          Example of requesting a DNS-SD advertised service:
richt@239
   159
        </p>
richt@239
   160
        <hr>
richt@239
   161
        <pre class="highlight">
richt@239
   162
function showServices( services ) {
richt@180
   163
  // Show a list of all the services provided to the web page
richt@239
   164
  for(var i = 0, l = services.length; i &lt; l; i++) console.log( services[i].name );
richt@180
   165
}
richt@180
   166
richt@239
   167
navigator.getNetworkServices('zeroconf:_boxee-jsonrpc._tcp', showServices);
richt@239
   168
</pre>
richt@180
   169
      </div>
richt@180
   170
      <div class="example">
richt@239
   171
        <p>
richt@239
   172
          Example of requesting a UPnP advertised service, also handling error conditions:
richt@239
   173
        </p>
richt@239
   174
        <hr>
richt@239
   175
        <pre class="highlight">
richt@239
   176
function showServices( services ) {
richt@180
   177
  // Show a list of all the services provided to the web page
richt@239
   178
  for(var i = 0, l = services.length; i &lt; l; i++) console.log( services[i].name );
richt@180
   179
}
richt@180
   180
richt@180
   181
function error( e ) {
richt@180
   182
  console.log( "Error occurred: " + e.code );
richt@180
   183
}
richt@180
   184
richt@239
   185
navigator.getNetworkServices('upnp:urn:schemas-upnp-org:service:ContentDirectory:1', showServices, error);
richt@239
   186
</pre>
richt@180
   187
      </div>
richt@180
   188
      <div class="example">
richt@239
   189
        <p>
richt@239
   190
          Example of requesting either a DNS-SD or UPnP advertised service:
richt@239
   191
        </p>
richt@239
   192
        <hr>
richt@239
   193
        <pre class="highlight">
richt@239
   194
function showServices( services ) {
richt@180
   195
  // Show a list of all the services provided to the web page (+ service type)
richt@239
   196
  for(var i = 0, l = services.length; i &lt; l; i++)
richt@180
   197
     console.log( services[i].name + '(' + services[i].type + ')' );
richt@180
   198
}
richt@180
   199
richt@180
   200
navigator.getNetworkServices([
richt@180
   201
  'zeroconf:_boxee-jsonrpc._tcp',
richt@180
   202
  'upnp:urn:schemas-upnp-org:service:ContentDirectory:1'
richt@239
   203
], showServices);
richt@239
   204
</pre>
richt@180
   205
      </div>
richt@239
   206
      <p>
richt@239
   207
        For more detailed examples see the <a href="#examples">Examples</a> section.
richt@239
   208
      </p>
richt@180
   209
    </section>
richt@239
   210
    <section id='conformance'>
richt@239
   211
      <p>
richt@239
   212
        Requirements phrased in the imperative as part of algorithms (such as "strip any leading space characters" or
richt@239
   213
        "return false and abort these steps") are to be interpreted with the meaning of the key word ("must", "should",
richt@239
   214
        "may", etc) used in introducing the algorithm.
richt@239
   215
      </p>
richt@239
   216
      <p>
richt@239
   217
        Some conformance requirements are phrased as requirements on attributes, methods or objects. Such requirements
richt@239
   218
        are to be interpreted as requirements on user agents.
richt@239
   219
      </p>
richt@239
   220
      <p>
richt@250
   221
        Conformance requirements phrased as algorithms or specific steps MAY be implemented in any manner, so long as
richt@250
   222
        the end result is equivalent. (In particular, the algorithms defined in this specification are intended to be
richt@250
   223
        easy to follow, and not intended to be performant.)
richt@239
   224
      </p>
richt@239
   225
      <p>
richt@239
   226
        The only conformance class defined by this specification is a <dfn>user agent</dfn>.
richt@239
   227
      </p>
richt@239
   228
      <p>
richt@250
   229
        User agents MAY impose implementation-specific limits on otherwise unconstrained inputs, e.g. to prevent denial
richt@250
   230
        of service attacks, to guard against running out of memory, or to work around platform-specific limitations.
richt@239
   231
      </p>
richt@239
   232
      <p>
richt@239
   233
        When support for a feature is disabled (e.g. as an emergency measure to mitigate a security problem, or to aid
richt@250
   234
        in development, or for performance reasons), user agents MUST act as if they had no support for the feature
richt@250
   235
        whatsoever, and as if the feature was not mentioned in this specification. For example, if a particular feature
richt@250
   236
        is accessed via an attribute in a Web IDL interface, the attribute itself would be omitted from the objects
richt@250
   237
        that implement that interface - leaving the attribute on the object but making it return null or throw an
richt@250
   238
        exception is insufficient.
richt@239
   239
      </p>
richt@180
   240
      <section>
richt@239
   241
        <h3>
richt@239
   242
          Dependencies
richt@239
   243
        </h3>This specification relies on several other underlying specifications.
richt@239
   244
        <dl>
richt@239
   245
          <dt>
richt@239
   246
            HTML
richt@239
   247
          </dt>
richt@239
   248
          <dd>
richt@239
   249
            Many fundamental concepts from HTML are used by this specification. [[!HTML5]]
richt@239
   250
          </dd>
richt@239
   251
          <dt>
richt@239
   252
            WebIDL
richt@239
   253
          </dt>
richt@239
   254
          <dd>
richt@239
   255
            The IDL blocks in this specification use the semantics of the WebIDL specification. [[!WEBIDL]]
richt@239
   256
          </dd>
richt@239
   257
        </dl>
richt@180
   258
      </section>
richt@180
   259
    </section>
richt@180
   260
    <section>
richt@239
   261
      <h3>
richt@239
   262
        Terminology
richt@239
   263
      </h3>
richt@180
   264
      <p>
richt@239
   265
        The construction "a <code>Foo</code> object", where <code>Foo</code> is actually an interface, is sometimes
richt@239
   266
        used instead of the more accurate "an object implementing the interface <code>Foo</code>".
richt@180
   267
      </p>
richt@180
   268
      <p>
richt@239
   269
        The term DOM is used to refer to the API set made available to scripts in Web applications, and does not
richt@239
   270
        necessarily imply the existence of an actual <code>Document</code> object or of any other <code>Node</code>
richt@239
   271
        objects as defined in the DOM Core specifications. [[!DOM4]]
richt@180
   272
      </p>
richt@180
   273
      <p>
richt@239
   274
        An IDL attribute is said to be <em>getting</em> when its value is being retrieved (e.g. by author script), and
richt@239
   275
        is said to be <em>setting</em> when a new value is assigned to it.
richt@180
   276
      </p>
richt@180
   277
      <p>
danieldanciu@330
   278
        A <dfn>valid service type</dfn> is any of the following:
danieldanciu@330
   279
        <ul>
danieldanciu@330
   280
           <li>
danieldanciu@330
   281
              a string that begins with <code>upnp:</code> or <code>zeroconf:</code>
danieldanciu@330
   282
              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,
danieldanciu@330
   283
              U+0030 to U+0039, U+0041 to U+005A, U+005E to U+007E.
danieldanciu@330
   284
           </li>
danieldanciu@330
   285
           <li>
danieldanciu@330
   286
              a string that begins with <code>dial:</code> followed by an integer version.
danieldanciu@330
   287
           </li>
danieldanciu@330
   288
        </ul>
richt@180
   289
      </p>
richt@180
   290
      <p>
richt@239
   291
        A <a>valid service type</a> provided in the <code>type</code> attribute of the <a href=
richt@239
   292
        "#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> method will be matched against the
richt@239
   293
        services currently contained in the <a>list of available service records</a> according to the algorithms
richt@239
   294
        defined in this specification.
richt@180
   295
      </p>
richt@230
   296
      <p>
richt@239
   297
        A <dfn>user-agent generated callback url</dfn> is a Local-network accessible URL endpoint that a <a>user
richt@239
   298
        agent</a> generates and maintains for receiving HTTP NOTIFY requests from UPnP Event sources. It is only
richt@239
   299
        required when the user agent implements UPnP Service Discovery as defined in this specification.
richt@230
   300
      </p>
richt@180
   301
    </section>
richt@180
   302
    <section>
richt@239
   303
      <h2>
richt@239
   304
        Requesting networked services
richt@239
   305
      </h2>
richt@239
   306
      <pre class="widl">
richt@239
   307
[Supplemental, NoInterfaceObject]
richt@180
   308
interface <dfn id="navigatornetworkservice">NavigatorNetworkService</dfn> {
richt@180
   309
  // Obtain a Local-networked Service
richt@180
   310
  void <a href="#dom-navigator-getnetworkservices">getNetworkServices</a>( in any type,
richt@239
   311
                           in <a href=
richt@239
   312
"#navigatornetworkservicesuccesscallback">NavigatorNetworkServiceSuccessCallback</a> successCallback,
richt@239
   313
                           in optional <a href=
richt@239
   314
"#navigatornetworkserviceerrorcallback">NavigatorNetworkServiceErrorCallback</a> errorCallback );
richt@180
   315
};
richt@239
   316
<a class="externalDFN"
richt@239
   317
     href=
richt@239
   318
     "http://www.whatwg.org/specs/web-apps/current-work/complete/timers.html#navigator">Navigator</a> implements <a href=
richt@239
   319
     "#navigatornetworkservice">NavigatorNetworkService</a>;
richt@180
   320
richt@180
   321
[Callback=FunctionOnly, NoInterfaceObject]
richt@180
   322
interface <dfn id="navigatornetworkservicesuccesscallback">NavigatorNetworkServiceSuccessCallback</dfn> {
richt@180
   323
  void handleEvent( in <a href="#networkservices">NetworkServices</a> services );
richt@180
   324
};
richt@180
   325
richt@180
   326
[NoInterfaceObject]
richt@180
   327
interface <dfn id="navigatornetworkserviceerror">NavigatorNetworkServiceError</dfn> {
richt@180
   328
  const unsigned short <a href="#dom-navigatornetworkserviceerror-permission_denied">PERMISSION_DENIED_ERR</a> = 1;
richt@180
   329
  const unsigned short <a href="#dom-navigatornetworkserviceerror-unknown_type_prefix">UNKNOWN_TYPE_PREFIX_ERR</a> = 2;
richt@180
   330
  readonly attribute unsigned short <a href="#dom-navigatornetworkserviceerror-code">code</a>;
richt@180
   331
};
richt@180
   332
richt@180
   333
[Callback=FunctionOnly, NoInterfaceObject]
richt@180
   334
interface <dfn id="navigatornetworkserviceerrorcallback">NavigatorNetworkServiceErrorCallback</dfn> {
richt@180
   335
  void handleEvent( in <a href="#navigatornetworkserviceerror">NavigatorNetworkServiceError</a> error );
richt@180
   336
};
richt@180
   337
</pre>
richt@239
   338
      <section>
richt@239
   339
        <h2>
richt@239
   340
          Methods
richt@239
   341
        </h2>
richt@239
   342
        <dl class="domintro">
richt@239
   343
          <dt>
richt@239
   344
            <var title="">window</var> . <code title="dom-navigator"><a href=
richt@239
   345
            "http://www.whatwg.org/specs/web-apps/current-work/complete/timers.html#navigator">navigator</a></code> .
richt@239
   346
            <code title="dom-navigator-getNetworkServices"><a href=
richt@239
   347
            "#dom-navigator-getnetworkservices">getNetworkServices</a></code> ( <var title="">type</var> , <var title=
richt@239
   348
            "">successCallback</var> [, <var title="">errorCallback</var> ] )
richt@239
   349
          </dt>
richt@239
   350
          <dd>
richt@239
   351
            <p>
richt@254
   352
              Prompts the user to select discovered network services that have advertised support for the
richt@239
   353
              requested service type.
richt@239
   354
            </p>
richt@239
   355
            <p>
richt@239
   356
              The <var title="">type</var> argument contains one or more <a>valid service type</a> tokens that the web
richt@239
   357
              page would like to interact with.
richt@239
   358
            </p>
richt@239
   359
            <p>
richt@254
   360
              If the user accepts, the <var title="">successCallback</var> is invoked, with zero or more <a href=
richt@240
   361
              "#networkservice"><code>NetworkService</code></a> objects as its argument.
richt@239
   362
            </p>
richt@239
   363
            <p>
richt@239
   364
              If the user declines, the <var title="">errorCallback</var> (if any) is invoked.
richt@239
   365
            </p>
richt@239
   366
          </dd>
richt@239
   367
        </dl>
richt@239
   368
        <div>
richt@180
   369
          <p>
richt@239
   370
            When the <dfn id="dom-navigator-getnetworkservices"
richt@239
   371
               title="dom-navigator-getnetworkservices"><code>getNetworkServices(type, successCallback[,
richt@250
   372
               errorCallback])</code></dfn> method is called, the <a>user agent</a> MUST run the following steps:
richt@180
   373
          </p>
richt@180
   374
          <ol class="rule">
richt@239
   375
            <li>Let <var>requested control types</var> be initially set to an empty array.
richt@239
   376
            </li>
richt@239
   377
            <li>If <var>type</var> is an array consisting of one or more <a>valid service type</a> tokens, then let
richt@239
   378
            <var>requested control types</var> by the value of <var>type</var>, removing any non-<a>valid service
richt@239
   379
            type</a> tokens from the resulting array.
richt@239
   380
            </li>
richt@239
   381
            <li>If <var>type</var> is a string consisting of one <a>valid service type</a> token, then let
richt@239
   382
            <var>requested control types</var> be an array containing one item with a value of <var>type</var>.
richt@239
   383
            </li>
richt@239
   384
            <li>If <var>requested control types</var> is an array that contains at least one or more <a title=
richt@239
   385
            "valid service type">valid service type</a> tokens then continue to the step labeled <em>process</em>
richt@240
   386
            below. Otherwise, the <a>user agent</a> MUST <a href=
richt@239
   387
            "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
richt@239
   388
                  class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an
richt@239
   389
                  object of type <code>Function</code>, with a new <a href=
richt@239
   390
                  "#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose <a href=
richt@239
   391
                  "#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 2
richt@239
   392
                  (<a href=
richt@239
   393
                  "#dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></a>) as
richt@239
   394
                  its argument, abort any remaining steps and return.
richt@239
   395
            </li>
richt@180
   396
            <li>
richt@239
   397
              <em>Process</em>: Let <var>services found</var> be an empty array.
richt@180
   398
            </li>
richt@239
   399
            <li>For each <var>available service</var> in the <a>list of available service records</a> run the following
richt@239
   400
            steps:
richt@239
   401
              <ol class="rule">
richt@239
   402
                <li>For each <var>requested control type</var> in <var>requested control types</var>: If <var>available
richt@239
   403
                service</var>'s <code>type</code> attribute equals the <var>requested control type</var> then let <var>
richt@239
   404
                  matched service</var> equal the value of <var>available service</var> and continue at the step
richt@239
   405
                  labeled <var>attach</var> below.
richt@239
   406
                </li>
richt@239
   407
                <li>Continue at the next <var>available service</var>.
richt@239
   408
                </li>
richt@239
   409
                <li>
richt@239
   410
                  <em>Attach</em>: If <var>matched service</var> is not empty then run the following steps:
richt@239
   411
                  <ol class="rule">
richt@239
   412
                    <li>Let <var>new service object</var> be a new <a href=
richt@239
   413
                    "#networkservice"><code>NetworkService</code></a> object, mapping the parameters of <var>matched
richt@239
   414
                    service</var> to this new object where possible.
richt@239
   415
                    </li>
richt@239
   416
                    <li>Append <var>new service object</var> to the <var>services found</var> array.
richt@239
   417
                    </li>
richt@239
   418
                  </ol>
richt@239
   419
                </li>
richt@239
   420
              </ol>
richt@180
   421
            </li>
richt@239
   422
            <li>Return, and run the remaining steps asynchronously.
richt@180
   423
            </li>
richt@239
   424
            <li>Optionally, e.g. based on a previously-established user preference, for security reasons, or due to
richt@240
   425
            platform limitations, the <a>user agent</a> MAY <a href=
richt@239
   426
            "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
richt@239
   427
                  class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an
richt@239
   428
                  object of type <code>Function</code>, with a new <a href=
richt@239
   429
                  "#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose <a href=
richt@239
   430
                  "#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
richt@239
   431
                  (<a href=
richt@239
   432
                  "#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its
richt@239
   433
                  argument, abort any remaining steps and return.
richt@180
   434
            </li>
richt@254
   435
            <li>If <var>services found</var> is not an empty array then the <a>user agent</a> MUST prompt the user in a
richt@254
   436
              user-agent-specific manner for permission to provide
richt@250
   437
            the <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/browsers.html#entry-script"
richt@239
   438
                  class="externalDFN">entry script</a>'s <a href=
richt@239
   439
                  "http://www.whatwg.org/specs/web-apps/current-work/complete/origin-0.html#origin"
richt@239
   440
                  class="externalDFN">origin</a> with an array of <a href=
richt@254
   441
                  "#networkservice"><code>NetworkService</code></a> objects representing the <a>user-authorized</a> subset
richt@254
   442
                  of <var>services found</var>.
richt@239
   443
              <p>
richt@239
   444
                If the user grants permission to access one or more networked services then the <a>user agent</a>
richt@239
   445
                SHOULD include an "ongoing local-network communication" indicator.
richt@180
   446
              </p>
richt@239
   447
              <p>
richt@240
   448
                If the user denies permission, then the <a>user agent</a> MUST <a href=
richt@239
   449
                "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
richt@239
   450
                   class="externalDFN">queue a task</a> to invoke <var>errorCallback</var>, if it is provided and is an
richt@239
   451
                   object of type <code>Function</code>, with a new <a href=
richt@239
   452
                   "#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object whose <a href=
richt@239
   453
                   "#dom-navigatornetworkserviceerror-code"><code>code</code></a> attribute has the numeric value 1
richt@239
   454
                   (<a href=
richt@239
   455
                   "#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a>) as its
richt@239
   456
                   argument, abort any remaining steps and return.
richt@239
   457
              </p>
richt@180
   458
              <p>
richt@180
   459
                If the user never responds, this algorithm stalls on this step.
richt@180
   460
              </p>
richt@180
   461
            </li>
richt@254
   462
            <li>Let <var>services</var> be an empty array.
richt@180
   463
            </li>
richt@254
   464
            <li>
richt@254
   465
               If <var>services found</var> is not an empty array then set <var>services</var> to be an array of one or more <a href=
richt@254
   466
            "#networkservice"><code>NetworkService</code></a> objects for which the user granted permission above - known as the
richt@254
   467
            current objects <dfn>user-authorized</dfn> services.
richt@254
   468
            </li>
richt@254
   469
            <li>For each Object <var>service</var> in <var>services</var>, if any, run the following sub-steps:
richt@239
   470
              <ol class="rule">
richt@239
   471
                <li>Add the <var>service</var>'s <code>url</code> parameter to the <a>entry script origin's
richt@239
   472
                  <abbr title="Uniform Resource Locator">URL</abbr> whitelist</a>.
richt@239
   473
                </li>
richt@239
   474
                <li>If <var>service</var>'s <code>type</code> parameter begins with the DOMString "<code>upnp:</code>"
richt@239
   475
                and the <var>service</var>'s <code>eventsUrl</code> parameter is not empty then <a>setup a UPnP Events
richt@239
   476
                Subscription</a> for <var>service</var>.
richt@239
   477
                </li>
richt@239
   478
              </ol>
richt@180
   479
            </li>
richt@239
   480
            <li>Let <var>services manager</var> be a new <a href="#networkservices"><code>NetworkServices</code></a>
richt@239
   481
            object.
richt@180
   482
            </li>
richt@239
   483
            <li>Set <var>services manager</var>'s <a href=
richt@239
   484
            "#dom-networkservices-servicesavailable"><code>servicesAvailable</code></a> attribute to the number of
richt@250
   485
            items currently found in the <a>list of available service records</a> whose <code>type</code> property
richt@239
   486
            matches any of the tokens requested in <var>requested control types</var>.
richt@180
   487
            </li>
richt@254
   488
            <li>Add <var>services</var>, if any, to the <var>services manager</var> object as its collection of <a>indexed
richt@254
   489
            properties</a>. If <var>services</var> is an empty array then the <var>services manager</var> does not have any
richt@254
   490
            <var>indexed properties</var>.
richt@250
   491
            </li>
richt@250
   492
            <li>Set <var>services manager</var>'s <a href="#dom-networkservices-length"><code>length</code></a>
richt@250
   493
            attribute to the number of items in <var>services</var>.
richt@250
   494
            </li>
richt@250
   495
            <li>Add <var>services manager</var> to the <a>list of active service managers</a>.
richt@180
   496
            </li>
richt@240
   497
            <li>The <a>user agent</a> MUST <a href=
richt@239
   498
            "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
richt@239
   499
                  class="externalDFN">queue a task</a> to invoke <var>successCallback</var> with <var>services
richt@239
   500
                  manager</var> as its argument.
richt@180
   501
            </li>
richt@180
   502
          </ol>
richt@180
   503
          <p>
richt@239
   504
            The <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#task-source"
richt@239
   505
               class="externalDFN">task source</a> for these <a href=
richt@239
   506
               "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#concept-task"
richt@239
   507
               class="externalDFN">tasks</a> is the <a href=
richt@239
   508
               "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#user-interaction-task-source"
richt@239
   509
               class="externalDFN">user interaction task source</a>.
richt@180
   510
          </p>
richt@180
   511
          <p>
richt@239
   512
            When a <a href="#networkservice"><code>NetworkService</code></a> object is provided to a Web page, the
richt@250
   513
            <a>user agent</a> MUST add the <code>url</code> property to the <dfn>entry script origin's URL
richt@250
   514
            whitelist</dfn>. This list enables the Web page to override and initiate cross-site resource requests
richt@250
   515
            towards these URLs, and any sub-resources of these URLs, within the current <a href=
richt@239
   516
            "http://www.whatwg.org/specs/web-apps/current-work/complete/browsers.html#entry-script"
richt@239
   517
               class="externalDFN">entry script</a>'s <a href=
richt@239
   518
               "http://www.whatwg.org/specs/web-apps/current-work/complete/origin-0.html#origin"
richt@239
   519
               class="externalDFN">origin</a> via various existing mechanisms (e.g. Web Sockets, Server-Sent Events,
richt@239
   520
               Web Messaging, XMLHttpRequest).
richt@239
   521
          </p>
richt@180
   522
          <p>
richt@254
   523
            If the user navigates away from the
richt@254
   524
            <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/browsers.html#entry-script"
richt@254
   525
                  class="externalDFN">entry script</a>'s <a href=
richt@254
   526
                  "http://www.whatwg.org/specs/web-apps/current-work/complete/origin-0.html#origin"
richt@254
   527
                  class="externalDFN">origin</a> then the <a>user agent</a> <em class=
richt@239
   528
            "ct">MUST</em> remove all previously whitelisted urls from the <a>entry script origin's URL whitelist</a>.
richt@239
   529
            There is no persistence to network service selections provided to a web page. It is not possible to access
richt@239
   530
            a previously white-listed networked service without the necessary user authorization in all of the
richt@239
   531
            following cases:
richt@180
   532
          </p>
richt@239
   533
          <ul>
richt@239
   534
            <li>If the current script is reloaded at any point in the same or different window.
richt@239
   535
            </li>
richt@239
   536
            <li>if the current script reinvokes the <a href=
richt@239
   537
            "#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> method at any point in its
richt@239
   538
            execution.
richt@239
   539
            </li>
richt@239
   540
            <li>If the user navigates forward or back in their history to reload the current page.
richt@239
   541
            </li>
richt@239
   542
            <li>If a script is running in a different origin.
richt@239
   543
            </li>
richt@239
   544
          </ul>
richt@239
   545
        </div>
richt@180
   546
      </section>
richt@180
   547
      <section>
richt@239
   548
        <h3>
richt@239
   549
          Error Handling
richt@239
   550
        </h3>
richt@239
   551
        <dl class="domintro">
richt@239
   552
          <dt>
richt@239
   553
            <var title="">error</var> . <code title="dom-NavigatorNetworkServiceError-code"><a href=
richt@239
   554
            "#dom-navigatornetworkserviceerror-code">code</a></code>
richt@239
   555
          </dt>
richt@239
   556
          <dd>
richt@239
   557
            <p>
richt@239
   558
              Returns the current error's error code. At the current time, this will be <code>1</code> or
richt@239
   559
              <code>2</code>, for which the corresponding error constants <a href=
richt@239
   560
              "#dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></a> and <a href=
richt@239
   561
              "#dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></a> are
richt@239
   562
              defined.
richt@239
   563
            </p>
richt@239
   564
          </dd>
richt@239
   565
        </dl>
richt@239
   566
        <p>
richt@239
   567
          The <dfn id="dom-navigatornetworkserviceerror-code"
richt@239
   568
             title="dom-navigatornetworkserviceerror-code"><code>code</code></dfn> attribute of a <a href=
richt@239
   569
             "#navigatornetworkserviceerror"><code>NavigatorNetworkServiceError</code></a> object <em class=
richt@239
   570
             "ct">MUST</em> return the code for the error, which will be one of the following:
richt@239
   571
        </p>
richt@239
   572
        <dl>
richt@239
   573
          <dt>
richt@239
   574
            <dfn id="dom-navigatornetworkserviceerror-permission_denied"
richt@239
   575
                title="dom-navigatornetworkserviceerror-permission_denied"><code>PERMISSION_DENIED_ERR</code></dfn>
richt@239
   576
                (numeric value 1)
richt@239
   577
          </dt>
richt@239
   578
          <dd>
richt@239
   579
            The user or user agent denied the page permission to access any services.
richt@239
   580
          </dd>
richt@239
   581
          <dt>
richt@239
   582
            <dfn id="dom-navigatornetworkserviceerror-unknown_type_prefix"
richt@239
   583
                title="dom-navigatornetworkserviceerror-unknown_type_prefix"><code>UNKNOWN_TYPE_PREFIX_ERR</code></dfn>
richt@239
   584
                (numeric value 2)
richt@239
   585
          </dt>
richt@239
   586
          <dd>
richt@239
   587
            No <a>valid service type</a> tokens were provided in the method invocation.
richt@239
   588
          </dd>
richt@239
   589
        </dl>
richt@239
   590
      </section>
richt@239
   591
    </section>
richt@239
   592
    <section>
richt@239
   593
      <h2>
richt@239
   594
        Obtaining networked services
richt@239
   595
      </h2>
richt@180
   596
      <p>
richt@254
   597
        The <a href="#networkservices"><code>NetworkServices</code></a> interface represents a collection of zero
richt@254
   598
        or more <dfn>indexed properties</dfn> that are
richt@254
   599
        each a <a>user-authorized</a> <a href="#networkservice"><code>NetworkService</code></a> object.
richt@254
   600
      </p>
richt@254
   601
      <p>
richt@254
   602
        A <a href="#networkservices"><code>NetworkServices</code></a> object is the top level success callback
richt@254
   603
        parameter from a call to
richt@254
   604
        <a href="#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a>.
richt@180
   605
      </p>
richt@239
   606
      <pre class="widl">
richt@180
   607
[NoInterfaceObject]
richt@180
   608
interface <dfn id="networkservices">NetworkServices</dfn> {
richt@180
   609
  readonly attribute unsigned long    <a href="#dom-networkservices-length">length</a>;
richt@180
   610
  getter <a href="#networkservice">NetworkService</a> (unsigned long index);
richt@239
   611
  <a href="#networkservice">NetworkService</a>? <a href=
richt@239
   612
"#dom-networkservices-getservicebyid">getServiceById</a>(DOMString id);
richt@180
   613
richt@180
   614
  readonly attribute unsigned long    <a href="#dom-networkservices-servicesavailable">servicesAvailable</a>;
richt@180
   615
richt@180
   616
  // event handler attributes
richt@239
   617
           attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler"
richt@239
   618
     class="externalDFN">EventHandler</a>     <a href="#dom-networkservices-onserviceavailable">onserviceavailable</a>;
richt@239
   619
           attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler"
richt@239
   620
     class="externalDFN">EventHandler</a>     <a href=
richt@239
   621
     "#dom-networkservices-onserviceunavailable">onserviceunavailable</a>;
richt@180
   622
richt@180
   623
};
richt@180
   624
richt@239
   625
<a href="#networkservices">NetworkServices</a> implements <a href=
richt@239
   626
"http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#interface-eventtarget"
richt@239
   627
     class="externalDFN">EventTarget</a>;
richt@180
   628
</pre>
richt@180
   629
      <section>
richt@239
   630
        <h2>
richt@239
   631
          Attributes
richt@239
   632
        </h2>
richt@180
   633
        <dl class="domintro">
richt@180
   634
          <dt>
richt@239
   635
            <code title="dom-networkservices-length"><a href="#dom-networkservices-length">length</a></code>
richt@180
   636
          </dt>
richt@180
   637
          <dd>
richt@180
   638
            <p>
richt@250
   639
              Returns the current number of items in the current object's collection of <a href=
richt@250
   640
              "#networkservice"><code>NetworkService</code></a> objects.
richt@180
   641
            </p>
richt@180
   642
          </dd>
richt@180
   643
          <dt>
richt@239
   644
            <code title="dom-networkservices-servicesavailable"><a href=
richt@239
   645
            "#dom-networkservices-servicesavailable">servicesAvailable</a></code>
richt@180
   646
          </dt>
richt@180
   647
          <dd>
richt@180
   648
            <p>
richt@250
   649
              Returns the current number of items matching one of the app-requested <a>valid service type</a> tokens in
richt@250
   650
              the <a>list of available service records</a>.
richt@180
   651
            </p>
richt@180
   652
          </dd>
richt@180
   653
        </dl>
richt@180
   654
        <div>
richt@239
   655
          <p>
richt@250
   656
            The <dfn id="dom-networkservices-length"><code>length</code></dfn> attribute MUST return the number of
richt@250
   657
            <a href="#networkservice"><code>NetworkService</code></a> objects represented by the collection.
richt@239
   658
          </p>
richt@239
   659
          <p>
richt@250
   660
            The <dfn id="dom-networkservices-servicesavailable"><code>servicesAvailable</code></dfn> attribute MUST
richt@250
   661
            return the number of services in the <a>list of available service records</a> whose <code>type</code>
richt@250
   662
            attribute matches any of the <a>valid service type</a> tokens that was initially used to create the current
richt@250
   663
            <a href="#networkservices"><code>NetworkServices</code></a> object.
richt@239
   664
          </p>
richt@180
   665
        </div>
richt@180
   666
      </section>
richt@180
   667
      <section>
richt@239
   668
        <h2>
richt@239
   669
          Methods
richt@239
   670
        </h2>
richt@180
   671
        <dl class="domintro">
richt@239
   672
          <dt>
richt@239
   673
            <code title="networkservices-getter"><a href="#networkservices">services</a></code> [ <var title=
richt@239
   674
            "">index</var> ]
richt@239
   675
          </dt>
richt@239
   676
          <dd>
richt@239
   677
            <p>
richt@239
   678
              Returns the specified <a href="#networkservice"><code>NetworkService</code></a> object.
richt@239
   679
            </p>
richt@239
   680
          </dd>
richt@239
   681
          <dt>
richt@239
   682
            <code title="networkservices-getter"><a href="#networkservices">services</a></code> . <code title=
richt@239
   683
            "dom-networkservices-getservicebyid"><a href=
richt@239
   684
            "#dom-networkservices-getservicebyid">getServiceById</a></code> ( <var title="">id</var> )
richt@239
   685
          </dt>
richt@239
   686
          <dd>
richt@239
   687
            <p>
richt@239
   688
              Returns the <a href="#networkservice"><code>NetworkService</code></a> object with the given identifier,
richt@239
   689
              or null if no service has that identifier.
richt@239
   690
            </p>
richt@239
   691
          </dd>
richt@239
   692
        </dl>
richt@239
   693
        <p>
richt@254
   694
          A <a href="#networkservices"><code>NetworkServices</code></a> object represents the current collection of zero
richt@254
   695
          or more <a href="#networkservice"><code>NetworkService</code></a> objects - its <a>indexed properties</a>. A <a href=
richt@254
   696
          "#networkservices"><code>NetworkServices</code></a> object is <span>immutable</span> meaning that
richt@254
   697
          <a>indexed properties</a> cannot be added and <a>indexed properties</a> cannot be removed for the lifetime of
richt@254
   698
          a <a href="#networkservices"><code>NetworkServices</code></a> object.
richt@239
   699
        </p>
richt@239
   700
        <p class="note">
richt@239
   701
          Each service in a <a href="#networkservices"><code>NetworkServices</code></a> object thus has an index; the
richt@239
   702
          first has the index 0, and each subsequent service is numbered one higher than the previous one.
richt@239
   703
        </p>
richt@239
   704
        <p>
richt@239
   705
          The <a href=
richt@239
   706
          "http://www.whatwg.org/specs/web-apps/current-work/multipage/infrastructure.html#supported-property-indices"
richt@239
   707
             class="externalDFN">supported property indices</a> of <a href=
richt@239
   708
             "#networkservices"><code>NetworkServices</code></a> objects at any instant are the numbers from zero to
richt@250
   709
             the number of the <a href="#networkservice"><code>NetworkService</code></a> objects in the collection
richt@250
   710
             minus one.
richt@239
   711
        </p>
richt@239
   712
        <p>
richt@239
   713
          To <a href=
richt@239
   714
          "http://www.whatwg.org/specs/web-apps/current-work/multipage/infrastructure.html#determine-the-value-of-an-indexed-property"
richt@239
   715
             class="externalDFN">determine the value of an indexed property</a> for a given index <var>index</var> in a
richt@250
   716
             <a href="#networkservices"><code>NetworkServices</code></a> object the user agent MUST return the <a href=
richt@250
   717
             "#networkservice"><code>NetworkService</code></a> object that represents the <var>index</var>th item in
richt@250
   718
             the collection.
richt@239
   719
        </p>
richt@239
   720
        <p>
richt@239
   721
          The <dfn id="dom-networkservices-getservicebyid"><code>getServiceById(id)</code></dfn> method <em class=
richt@239
   722
          "ct">MUST</em> return the first <a href="#networkservice"><code>NetworkService</code></a> object in the
richt@250
   723
          collection whose <a href="#dom-networkservice-id"><code>id</code></a> attribute is equal to the value of the
richt@250
   724
          <var>id</var> argument provided. When no <a href="#networkservice"><code>NetworkService</code></a> objects
richt@250
   725
          match the given argument, the method MUST return null.
richt@239
   726
        </p>
richt@239
   727
        <p>
richt@239
   728
          Services available within the local network can connect and disconnect at different times during the
richt@239
   729
          execution of a web page. A <a>user agent</a> can inform a web page when the state of networked services
richt@239
   730
          matching the requested <a>valid service type</a> change. Web pages can use this information to enable in-page
richt@239
   731
          experiences for communicating the state of networked services with the ability to change the particular
richt@239
   732
          service or set of services the page is connected to by re-invoking the <a href=
richt@239
   733
          "#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> method.
richt@239
   734
        </p>
richt@180
   735
      </section>
richt@180
   736
      <section>
richt@239
   737
        <h2>
richt@239
   738
          Events
richt@239
   739
        </h2>
richt@239
   740
        <p>
richt@239
   741
          The following are the event handlers (and their corresponding event handler event types) that <em class=
richt@239
   742
          "ct">MUST</em> be supported, as IDL attributes, by all objects implementing the <a href=
richt@239
   743
          "#networkservices"><code>NetworkServices</code></a> interface:
richt@239
   744
        </p>
richt@243
   745
        <table border="1">
richt@239
   746
          <thead>
richt@239
   747
            <tr>
richt@239
   748
              <th>
richt@239
   749
                <span title="event handlers">Event handler</span>
richt@239
   750
              </th>
richt@239
   751
              <th>
richt@239
   752
                <span>Event handler event type</span>
richt@239
   753
              </th>
richt@239
   754
            </tr>
richt@239
   755
          </thead>
richt@239
   756
          <tbody>
richt@239
   757
            <tr>
richt@239
   758
              <td>
richt@239
   759
                <dfn id="dom-networkservices-onserviceavailable"
richt@239
   760
                    title="dom-NetworkServices-onserviceavailable"><code>onserviceavailable</code></dfn>
richt@239
   761
              </td>
richt@239
   762
              <td>
richt@239
   763
                <a href="#event-serviceavailable"><code>serviceavailable</code></a>
richt@239
   764
              </td>
richt@239
   765
            </tr>
richt@239
   766
            <tr>
richt@239
   767
              <td>
richt@239
   768
                <dfn id="dom-networkservices-onserviceunavailable"
richt@239
   769
                    title="dom-NetworkServices-onserviceunavailable"><code>onserviceunavailable</code></dfn>
richt@239
   770
              </td>
richt@239
   771
              <td>
richt@239
   772
                <a href="#event-serviceunavailable"><code>serviceunavailable</code></a>
richt@239
   773
              </td>
richt@239
   774
            </tr>
richt@239
   775
          </tbody>
richt@239
   776
        </table>
richt@180
   777
      </section>
richt@180
   778
    </section>
richt@180
   779
    <section>
richt@239
   780
      <h2>
richt@239
   781
        Communicating with a networked service
richt@239
   782
      </h2>
richt@239
   783
      <p>
richt@239
   784
        The <a href="#networkservice"><code>NetworkService</code></a> interface is used to provide a set of connection
richt@239
   785
        information for an HTTP service endpoint and if available, service events, running on a networked device.
richt@239
   786
      </p>
richt@239
   787
      <pre class="widl">
richt@180
   788
[NoInterfaceObject]
richt@180
   789
interface <dfn id="networkservice">NetworkService</dfn> {
richt@180
   790
  readonly attribute DOMString        <a href="#dom-networkservice-id">id</a>;
richt@180
   791
  readonly attribute DOMString        <a href="#dom-networkservice-name">name</a>;
richt@180
   792
  readonly attribute DOMString        <a href="#dom-networkservice-type">type</a>;
richt@180
   793
  readonly attribute DOMString        <a href="#dom-networkservice-url">url</a>;
richt@180
   794
  readonly attribute DOMString        <a href="#dom-networkservice-config">config</a>;
richt@180
   795
richt@191
   796
  readonly attribute boolean          <a href="#dom-networkservice-online">online</a>;
richt@180
   797
richt@180
   798
  // event handler attributes
richt@239
   799
           attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler"
richt@239
   800
     class="externalDFN">EventHandler</a>     <a href="#dom-networkservice-onserviceonline">onserviceonline</a>;
richt@239
   801
           attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler"
richt@239
   802
     class="externalDFN">EventHandler</a>     <a href="#dom-networkservice-onserviceoffline">onserviceoffline</a>;
richt@191
   803
richt@239
   804
           attribute <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#eventhandler"
richt@239
   805
     class="externalDFN">EventHandler</a>     <a href="#dom-networkservice-onnotify">onnotify</a>;
richt@180
   806
};
richt@180
   807
richt@239
   808
<a href="#networkservice">NetworkService</a> implements <a href=
richt@239
   809
"http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#interface-eventtarget"
richt@239
   810
     class="externalDFN">EventTarget</a>;
richt@180
   811
</pre>
richt@239
   812
      <section>
richt@239
   813
        <h2>
richt@239
   814
          Attributes
richt@239
   815
        </h2>
richt@239
   816
        <dl class="domintro">
richt@239
   817
          <dt>
richt@239
   818
            <var title="">service</var> . <code title="dom-networkservice-id"><a href=
richt@239
   819
            "#dom-networkservice-id">id</a></code>
richt@239
   820
          </dt>
richt@239
   821
          <dd>
richt@239
   822
            <p>
richt@239
   823
              A unique identifier for the given user-selected service instance.
richt@239
   824
            </p>
richt@239
   825
          </dd>
richt@239
   826
          <dt>
richt@239
   827
            <var title="">service</var> . <code title="dom-networkservice-name"><a href=
richt@239
   828
            "#dom-networkservice-name">name</a></code>
richt@239
   829
          </dt>
richt@239
   830
          <dd>
richt@239
   831
            <p>
richt@239
   832
              The name of the user-selected service.
richt@239
   833
            </p>
richt@239
   834
          </dd>
richt@239
   835
          <dt>
richt@239
   836
            <var title="">service</var> . <code title="dom-networkservice-type"><a href=
richt@239
   837
            "#dom-networkservice-type">type</a></code>
richt@239
   838
          </dt>
richt@239
   839
          <dd>
richt@239
   840
            <p>
richt@239
   841
              The <a>valid service type</a> token value of the user-selected service.
richt@239
   842
            </p>
richt@239
   843
          </dd>
richt@239
   844
          <dt>
richt@239
   845
            <var title="">service</var> . <code title="dom-networkservice-url"><a href=
richt@239
   846
            "#dom-networkservice-url">url</a></code>
richt@239
   847
          </dt>
richt@239
   848
          <dd>
richt@239
   849
            <p>
richt@239
   850
              The control URL endpoint (including any required port information) of the user-selected control service
richt@239
   851
              that has been added to the <a>entry script origin's URL whitelist</a>.
richt@239
   852
            </p>
richt@239
   853
          </dd>
richt@239
   854
          <dt>
richt@239
   855
            <var title="">service</var> . <code title="dom-networkservice-config"><a href=
richt@239
   856
            "#dom-networkservice-config">config</a></code>
richt@239
   857
          </dt>
richt@239
   858
          <dd>
richt@239
   859
            <p>
richt@239
   860
              The configuration information associated with the service depending on the requested service type.
richt@239
   861
            </p>
richt@239
   862
          </dd>
richt@239
   863
        </dl>
richt@239
   864
        <p>
richt@239
   865
          The <dfn id="dom-networkservice-id"><code>id</code></dfn> attribute is a unique identifier for the service.
richt@250
   866
          The same service provided at different times or on different objects MUST have the same <a href=
richt@250
   867
          "#dom-networkservice-id"><code>id</code></a> value.
richt@239
   868
        </p>
richt@239
   869
        <p>
richt@239
   870
          The <dfn id="dom-networkservice-name"><code>name</code></dfn> attribute represents a human-readable title for
richt@239
   871
          the service.
richt@239
   872
        </p>
richt@239
   873
        <p>
richt@239
   874
          The <dfn id="dom-networkservice-type"><code>type</code></dfn> attribute reflects the value of the <a>valid
richt@239
   875
          service type</a> of the service.
richt@239
   876
        </p>
richt@239
   877
        <p>
richt@239
   878
          The <dfn id="dom-networkservice-url"><code>url</code></dfn> attribute is an <a href=
richt@239
   879
          "http://www.w3.org/TR/html5/urls.html#absolute-url"
richt@239
   880
             class="externalDFN">absolute URL</a> pointing to the root HTTP endpoint for the service that has been
richt@239
   881
             added to the <a>entry script origin's URL whitelist</a>. Web pages can subsequently use this value for
richt@239
   882
             implicit cross-document messaging via various existing mechanisms (e.g. Web Sockets, Server-Sent Events,
richt@239
   883
             Web Messaging, XMLHttpRequest).
richt@239
   884
        </p>
richt@239
   885
        <p>
richt@239
   886
          The <dfn id="dom-networkservice-config"><code>config</code></dfn> attribute provides the raw configuration
richt@239
   887
          information extracted from the given network service.
richt@239
   888
        </p>
richt@239
   889
      </section>
richt@239
   890
      <section>
richt@239
   891
        <h3>
richt@239
   892
          States
richt@239
   893
        </h3>
richt@239
   894
        <dl class="domintro">
richt@239
   895
          <dt>
richt@239
   896
            <var title="">service</var> . <code title="dom-networkservice-online"><a href=
richt@239
   897
            "#dom-networkservice-online">online</a></code>
richt@239
   898
          </dt>
richt@239
   899
          <dd>
richt@239
   900
            <p>
richt@239
   901
              Returns <code>true</code> if the service is reporting that it is accessible on the local network or
richt@239
   902
              <code>false</code> if the service is reporting that it is no longer accessible (temporarily or
richt@239
   903
              permanently) on the local network.
richt@239
   904
            </p>
richt@239
   905
          </dd>
richt@239
   906
        </dl>
richt@239
   907
        <p>
richt@239
   908
          The <dfn id="dom-networkservice-online"><code>online</code></dfn> attribute indicates whether the service is
richt@239
   909
          reporting itself as being either <var>online</var>, and therefore accessible on the local network, in which
richt@239
   910
          case this attribute will return <code>true</code> or, <var>offline</var>, and therefore not accessible on the
richt@239
   911
          local network, either temporarily or permanently, in which case this attribute will return
richt@240
   912
          <code>false</code>. This attribute MUST default to <code>true</code>.
richt@239
   913
        </p>
richt@239
   914
      </section>
richt@239
   915
      <section>
richt@239
   916
        <h3>
richt@239
   917
          Events
richt@239
   918
        </h3>
richt@239
   919
        <p>
richt@239
   920
          The following are the event handlers (and their corresponding event handler event types) that <em class=
richt@239
   921
          "ct">MUST</em> be supported, as IDL attributes, by all objects implementing the <a href=
richt@239
   922
          "#networkservice"><code>NetworkService</code></a> interface:
richt@239
   923
        </p>
richt@243
   924
        <table border="1">
richt@239
   925
          <thead>
richt@239
   926
            <tr>
richt@239
   927
              <th>
richt@239
   928
                <span title="event handlers">Event handler</span>
richt@239
   929
              </th>
richt@239
   930
              <th>
richt@239
   931
                <span>Event handler event type</span>
richt@239
   932
              </th>
richt@239
   933
            </tr>
richt@239
   934
          </thead>
richt@239
   935
          <tbody>
richt@239
   936
            <tr>
richt@239
   937
              <td>
richt@239
   938
                <dfn id="dom-networkservice-onnotify"
richt@239
   939
                    title="dom-NetworkService-onnotify"><code>onnotify</code></dfn>
richt@239
   940
              </td>
richt@239
   941
              <td>
richt@239
   942
                <a href="#event-notify"><code>notify</code></a>
richt@239
   943
              </td>
richt@239
   944
            </tr>
richt@239
   945
            <tr>
richt@239
   946
              <td>
richt@239
   947
                <dfn id="dom-networkservice-onserviceonline"
richt@239
   948
                    title="dom-NetworkService-onserviceonline"><code>onserviceonline</code></dfn>
richt@239
   949
              </td>
richt@239
   950
              <td>
richt@239
   951
                <a href="#event-serviceonline"><code>serviceonline</code></a>
richt@239
   952
              </td>
richt@239
   953
            </tr>
richt@239
   954
            <tr>
richt@239
   955
              <td>
richt@239
   956
                <dfn id="dom-networkservice-onserviceoffline"
richt@239
   957
                    title="dom-NetworkService-onserviceoffline"><code>onserviceoffline</code></dfn>
richt@239
   958
              </td>
richt@239
   959
              <td>
richt@239
   960
                <a href="#event-serviceoffline"><code>serviceoffline</code></a>
richt@239
   961
              </td>
richt@239
   962
            </tr>
richt@239
   963
          </tbody>
richt@239
   964
        </table>
richt@239
   965
      </section>
richt@239
   966
    </section>
richt@239
   967
    <section>
richt@239
   968
      <h2>
richt@239
   969
        Service Discovery
richt@239
   970
      </h2>
richt@239
   971
      <p>
richt@243
   972
        A <a>user agent</a> conforming to this specification MAY implement <abbr title=
danieldanciu@330
   973
        "Simple Service Discovery Protocol">SSDP</abbr> [[!UPNP-DEVICEARCH11]], Zeroconf [[!DNS-SD]] + [[!MDNS]] or
danieldanciu@330
   974
        <abbr title="Discovery and Launch Protocol">DIAL</abbr> [<a href = "https://sites.google.com/a/dial-multiscreen.org/dial/dial-protocol-specification">DIAL</a>]
richt@250
   975
        <dfn>service discovery mechanisms</dfn> - the requirements detailed in this section of the specification - to
richt@250
   976
        enable Web pages to request and connect with HTTP services running on networked devices, discovered via either
richt@250
   977
        mechanism, through this API. When a <a>user agent</a> implements either of these <a>service discovery
richt@250
   978
        mechanisms</a>, then it MUST conform to the corresponding algorithms provided in this section of the
richt@250
   979
        specification.
richt@239
   980
      </p>
richt@239
   981
      <p>
richt@250
   982
        This section presents how the results of these two <a>service discovery mechanisms</a> will be matched to
richt@254
   983
        requested service types, how the user agent stores available and active services and how their properties are
richt@250
   984
        applied to any resulting <a href="#networkservice"><code>NetworkService</code></a> objects.
richt@239
   985
      </p>
richt@239
   986
      <p>
richt@250
   987
        It is expected that user agents will perform these <a>service discovery mechanisms</a> asynchronously and
richt@250
   988
        periodically update the <a>list of available service records</a> as required. The timing of any <a>service
richt@250
   989
        discovery mechanisms</a> is an implementation detail left to the discretion of the implementer (e.g. by
richt@250
   990
        continuously monitoring the network as a background process or on invocation of this API from a Web page).
richt@239
   991
      </p>
richt@239
   992
      <p>
richt@239
   993
        The <dfn>list of available service records</dfn> is a single dynamic internal lookup table within user agents
richt@239
   994
        that is used to track all the services that have been discovered and are available in the current network at
richt@250
   995
        any given time. At any point during the running of either of the two <a>service discovery mechanisms</a> then
richt@250
   996
        existing entries within this table can be updated, entries can be added and entries can be removed as the
richt@250
   997
        status of networked services changes according to the rules defined in this specification.
richt@239
   998
      </p>
richt@239
   999
      <p>
richt@250
  1000
        The <dfn>list of active service managers</dfn> is an internal list within user agents that is used to track all
richt@250
  1001
        <a href="#networkservices"><code>NetworkServices</code></a> objects currently being shared with any web pages
richt@254
  1002
        at the current time within the user agent. Each <a href="#networkservices"><code>NetworkServices</code></a> object
richt@254
  1003
        in the <a>list of
richt@254
  1004
        active service managers</a> represents a collection of zero or more <a href=
richt@250
  1005
        "#networkservice"><code>NetworkService</code></a> objects - known as its <dfn>indexed properties</dfn>.
richt@250
  1006
        <a href="#networkservice"><code>NetworkService</code></a> objects are attached as the <a>indexed properties</a>
richt@250
  1007
        of a <a href="#networkservices"><code>NetworkServices</code></a> object as part of the <a href=
richt@239
  1008
        "#dom-navigator-getnetworkservices"><code>getNetworkServices()</code></a> algorithm.
richt@239
  1009
      </p>
richt@239
  1010
      <p>
richt@239
  1011
        The rule for <dfn>adding an available service</dfn> is the process of adding a new service or updating an
richt@239
  1012
        existing service in the <a>list of available service records</a> that is generally available on the user's
richt@239
  1013
        current network. This rule takes one argument, <var>network service record</var>, and consists of running the
richt@239
  1014
        following steps:
richt@239
  1015
      </p>
richt@239
  1016
      <ol class="rule">
richt@239
  1017
        <li>Let <var>new service registration flag</var> be <code>true</code>.
richt@239
  1018
        </li>
richt@239
  1019
        <li>For each <var>existing service record</var> in the current <a>list of available service records</a>, run
richt@239
  1020
        the following sub-steps:
richt@239
  1021
          <ol class="rule">
richt@239
  1022
            <li>If the <var>existing service record</var>'s <code>id</code> property does not equal <var>network
richt@239
  1023
            service record</var>'s <code>id</code> property then abort any remaining sub-steps and continue at the next
richt@239
  1024
            available <var>existing service record</var>.
richt@239
  1025
            </li>
richt@239
  1026
            <li>Set <var>new service registration flag</var> to <code>false</code>.
richt@239
  1027
            </li>
richt@239
  1028
            <li>Replace the value of <var>existing service record</var> in the current <a>list of available service
richt@239
  1029
            records</a> with the value of <var>network service record</var>.
richt@239
  1030
            </li>
richt@239
  1031
          </ol>
richt@239
  1032
        </li>
richt@239
  1033
        <li>If <var>new service registration flag</var> is set to <code>true</code> then add <var>network service
richt@250
  1034
        record</var> to the <a>list of available service records</a> as a new item.
richt@239
  1035
        </li>
richt@250
  1036
        <li>For each <var>service manager</var> in the <a>list of active service managers</a> run the following steps:
richt@239
  1037
          <ol class="rule">
richt@250
  1038
            <li>Let <var>service type in current service manager flag</var> be <code>false</code>.
richt@239
  1039
            </li>
richt@250
  1040
            <li>For each <var>active service</var> in <var>service manager</var> run the following steps:
richt@250
  1041
              <ol class="rule">
richt@250
  1042
                <li>If <var>network service record</var>'s <code>type</code> property does not equal <var>active
richt@250
  1043
                service</var>'s <code>type</code> attribute then abort any remaining sub-steps for this <var>active
richt@250
  1044
                service</var> and continue at the next available <var>active service</var>.
richt@250
  1045
                </li>
richt@250
  1046
                <li>Set the <var>service type in current service manager flag</var> to <code>true</code>.
richt@250
  1047
                </li>
richt@250
  1048
                <li>If the <var>new service registration flag</var> is set to <code>false</code>, the <var>network
richt@250
  1049
                service record</var>'s <code>id</code> property equals the <var>active service</var>'s <code>id</code>
richt@250
  1050
                attribute and <var>active service</var>'s <a href="#dom-networkservice-online"><code>online</code></a>
richt@250
  1051
                attribute is currently set to <code>false</code> then set <var>active service</var>'s <a href=
richt@250
  1052
                "#dom-networkservice-online"><code>online</code></a> attribute to <code>true</code> and then <a href=
richt@250
  1053
                "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
richt@250
  1054
                      class="externalDFN">queue a task</a> to dispatch a newly created event with the name <a href=
richt@250
  1055
                      "#event-serviceonline"><code>serviceonline</code></a> that uses the <a href=
richt@250
  1056
                      "http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
richt@250
  1057
                      class="externalDFN"><code>Event</code></a> interface, which does not bubble, is not cancellable,
richt@250
  1058
                      and has no default action, at the current <var>active service</var> object.
richt@250
  1059
                </li>
richt@250
  1060
              </ol>
richt@250
  1061
            </li>
richt@250
  1062
            <li>If the <var>new service registration flag</var> is set to <code>true</code> and the <var>service type
richt@250
  1063
            in current service manager flag</var> is also set to <code>true</code> then increment <var>service
richt@250
  1064
            manager</var>'s <a href="#dom-networkservices-servicesavailable"><code>servicesAvailable</code></a>
richt@250
  1065
            attribute by <code>1</code> and then <a href=
richt@250
  1066
            "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
richt@239
  1067
                  class="externalDFN">queue a task</a> to dispatch a newly created event with the name <a href=
richt@239
  1068
                  "#event-serviceavailable"><code>serviceavailable</code></a> that uses the <a href=
richt@239
  1069
                  "http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
richt@239
  1070
                  class="externalDFN"><code>Event</code></a> interface, which does not bubble, is not cancellable, and
richt@250
  1071
                  has no default action, at the current <var>service manager</var> object.
richt@239
  1072
            </li>
richt@239
  1073
          </ol>
richt@239
  1074
        </li>
richt@239
  1075
      </ol>
richt@239
  1076
      <p>
richt@239
  1077
        The rule for <dfn>removing an available service</dfn> is the general process of removing a service from the
richt@239
  1078
        <a>list of available service records</a> that has left the user's current network or has otherwise expired.
richt@239
  1079
        This rule takes one argument, <var>service identifier</var>, and consists of running the following steps:
richt@239
  1080
      </p>
richt@239
  1081
      <ol class="rule">
richt@239
  1082
        <li>For each <var>existing service record</var> in the current <a>list of available service records</a>, run
richt@239
  1083
        the following sub-steps:
richt@239
  1084
          <ol class="rule">
richt@239
  1085
            <li>If the <var>existing service record</var>'s <code>id</code> property does not match <var>service
richt@239
  1086
            identifier</var> then skip any remaining sub-steps for the current <var>existing service record</var> and
richt@239
  1087
            continue at the next available <var>existing service record</var>.
richt@239
  1088
            </li>
richt@239
  1089
            <li>If the <var>existing service record</var>'s <code>type</code> property begins with the DOMString
richt@239
  1090
            "<code>upnp:</code>" and <var>existing service record</var>'s <code>eventsURL</code> property is set then
richt@239
  1091
            run the rule to <a>terminate an existing UPnP Events Subscription</a>, if one is currently active (as a
richt@239
  1092
            result of having previously called <a>setup a UPnP Events Subscription</a> against the current
richt@239
  1093
            <var>existing service record</var>).
richt@239
  1094
            </li>
richt@250
  1095
            <li>For each <var>service manager</var> in the <a>list of active service managers</a> run the following
richt@239
  1096
            steps:
richt@239
  1097
              <ol class="rule">
richt@250
  1098
                <li>Let <var>service type in current service manager flag</var> be <code>false</code>.
richt@239
  1099
                </li>
richt@250
  1100
                <li>For each <var>active service</var> in <var>service manager</var> run the following steps:
richt@250
  1101
                  <ol class="rule">
richt@250
  1102
                    <li>If <var>existing service record</var>'s <code>type</code> property does not equal the
richt@250
  1103
                    <var>active service</var>'s <code>type</code> attribute then abort any remaining sub-steps for this
richt@250
  1104
                    <var>active service</var> and continue at the next available <var>active service</var>.
richt@250
  1105
                    </li>
richt@250
  1106
                    <li>Set the <var>service type in current service manager flag</var> to <code>true</code>.
richt@250
  1107
                    </li>
richt@250
  1108
                    <li>If <var>existing service record</var>'s <code>id</code> property equals the <var>active
richt@250
  1109
                    service</var>'s <code>id</code> attribute and <var>active service</var>'s <a href=
richt@250
  1110
                    "#dom-networkservice-online"><code>online</code></a> attribute is currently set to
richt@250
  1111
                    <code>true</code> then set <var>active service</var>'s <a href="#dom-networkservice-online"><code>
richt@250
  1112
                      online</code></a> attribute to <code>false</code> and then <a href=
richt@250
  1113
                      "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
richt@250
  1114
                          class="externalDFN">queue a task</a> to dispatch a newly created event with the name <a href=
richt@250
  1115
                          "#event-serviceoffline"><code>serviceoffline</code></a> that uses the <a href=
richt@250
  1116
                          "http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
richt@250
  1117
                          class="externalDFN"><code>Event</code></a> interface, which does not bubble, is not
richt@250
  1118
                          cancellable, and has no default action, at the current <var>active service</var>.
richt@250
  1119
                    </li>
richt@250
  1120
                  </ol>
richt@250
  1121
                </li>
richt@250
  1122
                <li>If the <var>service type in current service manager flag</var> is set to <code>true</code> then
richt@250
  1123
                decrement <var>service manager</var>'s <a href=
richt@250
  1124
                "#dom-networkservices-servicesavailable"><code>servicesAvailable</code></a> attribute by <code>1</code>
richt@250
  1125
                and then <a href=
richt@239
  1126
                "http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
richt@239
  1127
                      class="externalDFN">queue a task</a> to dispatch a newly created event with the name <a href=
richt@239
  1128
                      "#event-serviceunavailable"><code>serviceunavailable</code></a> that uses the <a href=
richt@239
  1129
                      "http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
richt@239
  1130
                      class="externalDFN"><code>Event</code></a> interface, which does not bubble, is not cancellable,
richt@250
  1131
                      and has no default action, at the current <var>service manager</var> object.
richt@239
  1132
                </li>
richt@239
  1133
              </ol>
richt@239
  1134
            </li>
richt@239
  1135
            <li>Remove <var>existing service record</var> from the current <a>list of available service records</a>.
richt@239
  1136
            </li>
richt@239
  1137
          </ol>
richt@239
  1138
        </li>
richt@239
  1139
      </ol>
richt@239
  1140
      <p>
richt@250
  1141
        User agents SHOULD expire a service record from the <a>list of available service records</a> when its
richt@250
  1142
        <code>expiryTimestamp</code> attribute exceeds the current UTC timestamp. When this condition is met the
richt@250
  1143
        <a>user agent</a> SHOULD run the rule for <a>removing an available service</a>, passing in the expired service
richt@250
  1144
        record's <code>id</code> attribute as the only argument.
richt@239
  1145
      </p>
richt@239
  1146
      <section>
richt@239
  1147
        <h4>
richt@239
  1148
          Zeroconf (<abbr title="Multicast DNS">mDNS</abbr> + <abbr title="Domain Name System">DNS</abbr>-<abbr title=
richt@239
  1149
          "Service Discovery">SD</abbr>)
richt@239
  1150
        </h4>
richt@239
  1151
        <p>
richt@239
  1152
          For each DNS response received from a user-agent-initiated Multicast DNS Browse for <abbr title=
richt@239
  1153
          "DNS Pointer Record">PTR</abbr> records with the name <code>_services._dns-sd._udp</code> on the resolved
richt@250
  1154
          recommended automatic browsing domain [[!MDNS]], the <a>user agent</a> MUST run the following steps:
richt@239
  1155
        </p>
richt@239
  1156
        <ol class="rule">
richt@239
  1157
          <li>Let <var>service mDNS responses</var> be an array of PTR records received by issuing a Multicast DNS
richt@239
  1158
          Browse for PTR records with the name of the current discovered service type.
richt@239
  1159
          </li>
richt@239
  1160
          <li>For each Object <var>service mDNS response</var> in <var>service mDNS responses</var>, run the following
richt@239
  1161
          steps:
richt@239
  1162
            <ol>
richt@239
  1163
              <li>Let <var>network service record</var> be an Object consisting of the following empty properties:
richt@239
  1164
              <code>id</code>, <code>name</code>, <code>type</code>, <code>url</code>, <code>config</code>,
richt@239
  1165
              <code>expiryTimestamp</code>.
richt@239
  1166
              </li>
richt@239
  1167
              <li>Set <var>network service record</var>'s <code>id</code> property to the value of the full PTR Service
richt@239
  1168
              Instance Name [[!MDNS]].
richt@239
  1169
              </li>
richt@239
  1170
              <li>Set <var>network service record</var>'s <code>name</code> property to the value of the PTR Service
richt@239
  1171
              Instance Name's <var>Instance</var> component [[!MDNS]].
richt@239
  1172
              </li>
richt@239
  1173
              <li>Set <var>network service record</var>'s <code>type</code> property to the concatenation of the string
richt@239
  1174
              <code>zeroconf:</code> followed be the value of the PTR Service Instance Name's <var>Service</var>
richt@239
  1175
              component [[!MDNS]].
richt@239
  1176
              </li>
richt@239
  1177
              <li>Set <var>network service record</var>'s <code>url</code> property to the resolvable Service URL
richt@239
  1178
              obtained from performing an DNS-SD Lookup [[!DNS-SD]] of the current service from the PTR record provided
richt@239
  1179
              [[!MDNS]].
richt@239
  1180
              </li>
richt@239
  1181
              <li>Set <var>network service record</var>'s <code>config</code> property to the string value of the
richt@239
  1182
              contents of the first DNS-SD TXT record associated with the <var>service mDNS response</var> as defined
richt@239
  1183
              in [[!DNS-SD]].
richt@239
  1184
              </li>
richt@239
  1185
              <li>Set <var>network service record</var>'s <code>expiryTimestamp</code> property to the value of the
richt@239
  1186
              current date, in UTC timestamp format, plus a value of <code>120</code> seconds.
richt@239
  1187
              </li>
richt@239
  1188
              <li>Run the general rule for <a>adding an available service</a>, passing in the current <var>network
richt@239
  1189
              service record</var> as the only argument.
richt@239
  1190
              </li>
richt@239
  1191
            </ol>
richt@239
  1192
          </li>
richt@239
  1193
        </ol>
richt@239
  1194
      </section>
richt@239
  1195
      <section>
richt@239
  1196
        <h5>
richt@239
  1197
          Simple Service Discovery Protocol (<abbr title="Simple Service Discovery Protocol">SSDP</abbr>)
richt@239
  1198
        </h5>
richt@239
  1199
        <p>
richt@250
  1200
          A user agent that implements UPnP service discovery MUST issue a <dfn>search request for UPnP root
richt@250
  1201
          devices</dfn> against the user's current local network according to the full normative text and timing
richt@250
  1202
          provided in 'Section 1.3.2: Search request with M-SEARCH' detailed in [[!UPNP-DEVICEARCH11]].
richt@239
  1203
        </p>
richt@239
  1204
        <p>
richt@250
  1205
          The user agent MUST issue all <a title="search request for UPnP root devices">search requests for UPnP root
richt@250
  1206
          devices</a> with a HTTP request line equal to <code>M-SEARCH * HTTP/1.1</code>, with a HOST header equal to
richt@250
  1207
          the reserved multicast address and port of <code>239.255.255.250:1900</code>, a MAN header equal to
richt@250
  1208
          <code>ssdp:discover</code>, an ST header equal to <code>upnp:rootdevice</code> and a user-agent defined MX
richt@250
  1209
          header equal to a <dfn>maximum UPnP advertisement response wait time</dfn> value between <code>1</code> and
richt@250
  1210
          <code>5</code> seconds.
richt@239
  1211
        </p>
richt@239
  1212
        <p>
richt@250
  1213
          The user agent MUST listen for any incoming responses to any <a>search request for UPnP root devices</a>.
richt@239
  1214
        </p>
richt@239
  1215
        <p>
richt@250
  1216
          For each <dfn>HTTP Response</dfn> following an initial <a>search request for UPnP root devices</a> sent on a
richt@240
  1217
          <a>standard UPnP address and port</a> the user agent MUST run the following steps:
richt@239
  1218
        </p>
richt@239
  1219
        <ol class="rule">
richt@239
  1220
          <li>If the <a>HTTP Response</a> is not a HTTP 200 OK response then this response is invalid and the user
richt@250
  1221
          agent MUST discard this response, abort any remaining steps and return. The user agent MAY issue a new
richt@250
  1222
          <a>search request for UPnP root devices</a> as a result of this error occurring.
richt@250
  1223
          </li>
richt@250
  1224
          <li>If the <a>maximum UPnP advertisement response wait time</a> has been exceeded since the initial <a>search
richt@250
  1225
          request for UPnP root devices</a> was sent then the <a>HTTP Response</a> is invalid and the user agent MUST
richt@250
  1226
          discard this response, abort any remaining steps and return. The user agent MAY stop listening for responses
richt@250
  1227
          from the current <a>search request for UPnP root devices</a> as a result of this error occurring. Equally,
richt@250
  1228
          the user agent MAY issue a new <a>search request for UPnP root devices</a> as a result of this error
richt@239
  1229
          occurring.
richt@239
  1230
          </li>
richt@239
  1231
          <li>Let <var>ssdp device</var> be an Object with a property for each HTTP header received in the <a>HTTP
richt@239
  1232
          Response</a>, with each key being the name of a HTTP response header and each value being that HTTP response
richt@239
  1233
          header's value.
richt@239
  1234
          </li>
richt@239
  1235
          <li>If <var>ssdp device</var> does not contain at least one <var>CACHE-CONTROL</var> entry, at least one
richt@239
  1236
          <var>USN</var> entry, at least one <var>ST</var> entry and at least one <var>LOCATION</var> entry or the
richt@239
  1237
          value of its <var>ST</var> entry is not <code>upnp:rootdevice</code>, then the <a>HTTP Response</a> is
richt@250
  1238
          invalid and the <a>user agent</a> MUST discard this response, abort any remaining steps and return.
richt@239
  1239
          </li>
richt@250
  1240
          <li>The user agent MUST run the rule for <a>obtaining a UPnP Device Description File</a> passing in the first
richt@250
  1241
          occurrence of <var>LOCATION</var> from <var>ssdp device</var> as the <var>device descriptor URL</var>
richt@250
  1242
          argument and the first occurrence of <var>USN</var> from <var>ssdp device</var> as the <var>device
richt@250
  1243
          identifier</var> argument and the first occurrence of <var>CACHE-CONTROL</var> from <var>ssdp device</var>
richt@250
  1244
          (minus the leading string of <code>max-age=</code>) as the <var>device expiry</var> argument.
richt@239
  1245
          </li>
richt@239
  1246
        </ol>
richt@239
  1247
        <p>
richt@250
  1248
          The user agent MUST listen for incoming requests on the <dfn>standard UPnP address and port</dfn> on all
richt@250
  1249
          current local network interface addresses with the port <code>1900</code>.
richt@250
  1250
        </p>
richt@250
  1251
        <p>
richt@250
  1252
          For each <dfn>HTTP Request</dfn> received on a <a>standard UPnP address and port</a> the user agent MUST run
richt@250
  1253
          the following steps:
richt@239
  1254
        </p>
richt@239
  1255
        <ol class="rule">
richt@239
  1256
          <li>If the <a>HTTP Request</a> is not a HTTP NOTIFY request then it is not a valid UPnP Request and the user
richt@250
  1257
          agent MUST discard this request, abort any remaining steps and return.
richt@239
  1258
          </li>
richt@239
  1259
          <li>Let <var>ssdp device</var> be an Object with a property for each HTTP header received in the <a>HTTP
richt@239
  1260
          Request</a>, with each key being the name of a HTTP header and each value being that HTTP header's value.
richt@239
  1261
          </li>
richt@239
  1262
          <li>If <var>ssdp device</var> does not contain at least one <var>CACHE-CONTROL</var> entry, at least one
richt@239
  1263
          <var>USN</var> entry, at least one <var>NT</var> entry, at least one <var>NTS</var> entry and at least one
richt@239
  1264
          <var>LOCATION</var> entry or the value of its <var>NT</var> entry is not <code>upnp:rootdevice</code>, then
richt@250
  1265
          the <a>HTTP Request</a> is a malformed UPnP Request and the <a>user agent</a> MUST discard this request,
richt@250
  1266
          abort any remaining steps and return.
richt@239
  1267
          </li>
richt@250
  1268
          <li>If <var>ssdp device</var>'s <var>NTS</var> entry is equal to <code>ssdp:alive</code> then the user agent
richt@250
  1269
          MUST run the rule for <a>obtaining a UPnP Device Description File</a> passing in the first occurrence of
richt@250
  1270
          <var>LOCATION</var> from <var>ssdp device</var> as the <var>device descriptor URL</var> argument and the
richt@250
  1271
          first occurrence of <var>USN</var> from <var>ssdp device</var> as the <var>device identifier</var> argument
richt@250
  1272
          and the first occurrence of <var>CACHE-CONTROL</var> from <var>ssdp device</var> (minus the leading string of
richt@250
  1273
          <code>max-age=</code>) as the <var>device expiry</var>.<br>
richt@239
  1274
            <br>
richt@239
  1275
            Otherwise, if <var>ssdp device</var>'s <var>NTS</var> entry is equal to <code>ssdp:byebye</code> then the
richt@250
  1276
            user agent MUST run the rule for <a>removing all services from a registered UPnP Device</a> passing in the
richt@250
  1277
            first occurrence of <var>USN</var> from <var>ssdp device</var> as the <var>device identifier</var>
richt@250
  1278
            argument.
richt@239
  1279
          </li>
richt@239
  1280
        </ol>
richt@239
  1281
        <p>
richt@239
  1282
          The rule for <dfn>obtaining a UPnP Device Description File</dfn> is the process of obtaining the contents of
richt@239
  1283
          a standard UPnP Device Description [[!UPNP-DEVICEARCH11]] from a URL-based resource. This rule takes three
richt@239
  1284
          arguments - <var>device descriptor URL</var>, <var>device identifier</var> and <var>device expiry</var> - and
richt@240
  1285
          when called the user agent MUST run the following steps:
richt@239
  1286
        </p>
richt@239
  1287
        <ol class="rule">
richt@239
  1288
          <li>Let <var>device descriptor file</var> contain the contents of the file located at the URL provided in
richt@239
  1289
          <var>device descriptor URL</var> obtained according to the rules defined in 'Section 2.11: Retrieving a
richt@239
  1290
          description using HTTP' in [[!UPNP-DEVICEARCH11]].
richt@239
  1291
          </li>
richt@239
  1292
          <li>If the value provided in <var>device descriptor URL</var> cannot be resolved as a reachable URL on the
richt@250
  1293
          current network or the <var>device descriptor file</var> remains empty then it is invalid and the <a>user
richt@250
  1294
          agent</a> MUST abort any remaining steps and return.
richt@239
  1295
          </li>
richt@239
  1296
          <li>Run the rule for <a>processing a UPnP Device Description File</a>, passing in the current <var>device
richt@239
  1297
          descriptor file</var>, <var>device identifier</var> and <var>device expiry</var> arguments.
richt@239
  1298
          </li>
richt@239
  1299
        </ol>
richt@239
  1300
        <p>
richt@239
  1301
          The rule for <dfn>processing a UPnP Device Description File</dfn> is the process of parsing the contents of a
richt@239
  1302
          standard UPnP Device Description [[!UPNP-DEVICEARCH11]] and registering the UPnP services contained therein
richt@239
  1303
          within the <a>list of available service records</a>.
richt@239
  1304
        </p>
richt@239
  1305
        <p>
richt@239
  1306
          The rule for <a>processing a UPnP Device Description File</a> takes three arguments - <var>device descriptor
richt@250
  1307
          file</var>, <var>device identifier</var> and <var>device expiry</var> - and when called the user agent MUST
richt@250
  1308
          run the following steps:
richt@239
  1309
        </p>
richt@239
  1310
        <ol class="rule">
richt@239
  1311
          <li>Let <var>advertised services</var> be a list of all advertised services obtained from the <var>device
richt@239
  1312
          descriptor file</var> containing the value of the first occurrence of the <code>&lt;serviceList&gt;</code>
richt@239
  1313
          element as it is defined in 'Section 2.3: Device Description' in [[!UPNP-DEVICEARCH11]].
richt@239
  1314
          </li>
richt@239
  1315
          <li>For each <code>&lt;service&gt;</code> element - known as an <var>advertised service</var> - in
richt@239
  1316
          <var>advertised services</var> run the following steps:
richt@239
  1317
            <ol class="rule">
richt@239
  1318
              <li>Let <var>network service record</var> be a new Object consisting of the following empty properties:
richt@239
  1319
              <code>id</code>, <code>deviceId</code>, <code>name</code>, <code>type</code>, <code>url</code>,
richt@239
  1320
              <code>eventsUrl</code>, <code>config</code>, <code>expiryTimestamp</code>.
richt@239
  1321
              </li>
richt@239
  1322
              <li>Set <var>network service record</var>'s <code>id</code> property to the concatenated string value of
richt@250
  1323
              the first occurrence of the <code>&lt;UDN&gt;</code> element in the <var>device descriptor file</var>
richt@250
  1324
              with the <var>advertised service</var>'s <code>&lt;serviceId&gt;</code> sub-element.
richt@239
  1325
              </li>
richt@239
  1326
              <li>Set <var>network service record</var>'s <code>deviceId</code> property to the value of <var>device
richt@239
  1327
              identifier</var>.
richt@239
  1328
              </li>
richt@239
  1329
              <li>Set <var>network service record</var>'s <code>name</code> property to the string value of the first
richt@239
  1330
              occurrence of the <var>advertised service</var>'s <code>&lt;serviceId&gt;</code> sub-element.
richt@239
  1331
              </li>
richt@239
  1332
              <li>Set <var>network service record</var>'s <code>type</code> property to the concatenation of the string
richt@239
  1333
              <code>upnp:</code> followed by the string value of the first occurrence of the <var>advertised
richt@239
  1334
              service</var>'s <code>&lt;serviceType&gt;</code> sub-element.
richt@239
  1335
              </li>
richt@239
  1336
              <li>Set <var>network service record</var>'s <code>url</code> property to the string value of the first
richt@239
  1337
              occurrence of the <var>advertised service</var>'s <code>&lt;controlURL&gt;</code> sub-element.
richt@239
  1338
              </li>
richt@239
  1339
              <li>Set <var>network service record</var>'s <code>config</code> property to the string value of the
richt@239
  1340
              contents of the first occurrence of the <code>&lt;device&gt;</code> element in the <var>device descriptor
richt@239
  1341
              file</var>.
richt@239
  1342
              </li>
richt@239
  1343
              <li>If <var>advertised service</var>'s <code>&lt;eventSubURL&gt;</code> sub-element is not empty, then
richt@239
  1344
              set <var>network service record</var>'s <code>eventsUrl</code> property to the string value of the first
richt@239
  1345
              occurrence of the <var>advertised service</var>'s <code>&lt;eventSubURL&gt;</code> sub-element.
richt@239
  1346
              Otherwise, do not set <var>network service record</var>'s <code>eventsUrl</code> property.
richt@239
  1347
              </li>
richt@239
  1348
              <li>Set <var>network service record</var>'s <code>expiryTimestamp</code> property to the value of the
richt@239
  1349
              current date, in UTC timestamp format, plus the value of <var>device expiry</var>.
richt@239
  1350
              </li>
richt@239
  1351
              <li>Run the general rule for <a>adding an available service</a>, passing in the current <var>network
richt@239
  1352
              service record</var> as the only argument.
richt@239
  1353
              </li>
richt@239
  1354
            </ol>
richt@239
  1355
          </li>
richt@250
  1356
          <li>If <var>device descriptor file</var> contains a <code>&lt;deviceList&gt;</code> element then for each
richt@250
  1357
          <code>&lt;device&gt;</code> element within <code>&lt;deviceList&gt;</code> - herein known as an <var>embedded
richt@250
  1358
          device descriptor file</var> - the user agent MUST run the rule for <a>processing a UPnP Device Description
richt@250
  1359
          File</a>, passing in the current <var>embedded device descriptor file</var> as the <var>device descriptor
richt@250
  1360
          file</var> argument, along with the current <var>device identifier</var> and <var>device expiry</var>
richt@250
  1361
          arguments.
richt@250
  1362
          </li>
richt@239
  1363
        </ol>
richt@239
  1364
        <p>
richt@239
  1365
          The rule for <dfn>removing all services from a registered UPnP Device</dfn> is the process of removing all
richt@239
  1366
          services associated with a device from the <a>list of available service records</a> that has left the user's
richt@239
  1367
          current network or has otherwise timed out or expired. This rule takes one argument, <var>device
richt@239
  1368
          identifier</var>, and consists of running the following steps:
richt@239
  1369
        </p>
richt@239
  1370
        <ol class="rule">
richt@239
  1371
          <li>For each <var>existing service record</var> in the current <a>list of available service records</a>, run
richt@239
  1372
          the following sub-steps:
richt@239
  1373
            <ol class="rule">
richt@239
  1374
              <li>If the <var>existing service record</var>'s <code>deviceId</code> property does not match <var>device
richt@239
  1375
              identifier</var> then skip any remaining sub-steps for the current <var>existing service record</var> and
richt@239
  1376
              continue at the next available <var>existing service record</var>.
richt@239
  1377
              </li>
richt@239
  1378
              <li>Run the general rule for <a>removing an available service</a> passing in <var>existing service
richt@239
  1379
              record</var>'s <code>id</code> property as the only argument.
richt@239
  1380
              </li>
richt@239
  1381
            </ol>
richt@239
  1382
          </li>
richt@239
  1383
        </ol>
richt@239
  1384
        <p>
richt@239
  1385
          When the <a>user agent</a> is to <dfn>setup a UPnP Events Subscription</dfn>, it is to run the following
richt@239
  1386
          steps with the current <var>network service record</var> object as defined in 'Section 4.1.2: SUBSCRIBE with
richt@239
  1387
          NT and CALLBACK' in [[!UPNP-DEVICEARCH11]]:
richt@239
  1388
        </p>
richt@239
  1389
        <ol class="rule">
richt@239
  1390
          <li>If <var>network service record</var>'s <code>eventsUrl</code> property is empty then the <a>user
richt@240
  1391
          agent</a> MUST abort these steps.
richt@239
  1392
          </li>
richt@239
  1393
          <li>Let <var>callback URL</var> be the value of creating a new <a>user-agent generated callback url</a>.
richt@239
  1394
          </li>
richt@239
  1395
          <li>Send a HTTP SUBSCRIBE request with a <em>NT</em> header with a string value of <code>upnp:event</code>, a
richt@239
  1396
          <em>TIMEOUT</em> header with a user-agent defined timeout value (in the form <code>Second-XX</code> where
richt@239
  1397
          <code>XX</code> is the user-agent defined timeout value in seconds) and a <em>CALLBACK</em> header with a
richt@239
  1398
          string value of <var>callback URL</var> towards the <var>network service record</var>'s
richt@239
  1399
          <code>eventsUrl</code> property.
richt@239
  1400
          </li>
richt@250
  1401
          <li>If a non-200 OK response is received from the HTTP SUBSCRIBE request then the <a>user agent</a> MUST
richt@250
  1402
          abort these steps.
richt@239
  1403
          </li>
richt@239
  1404
          <li>On receiving a valid 200 OK response, run the following steps:
richt@239
  1405
            <ol class="rule">
richt@239
  1406
              <li>Let <var>callback ID</var> equal the string value of the first included <em>SID</em> header, if it
richt@239
  1407
              exists.
richt@239
  1408
              </li>
richt@239
  1409
              <li>Let <var>timeout date</var> equal the sum of the current UTC date value plus the integer value of the
richt@239
  1410
              first included <em>TIMEOUT</em> header (minus the leading string of <code>Second-</code>), if it exists.
richt@239
  1411
              </li>
richt@240
  1412
              <li>Run the following steps asynchronously and continue to the step labeled <em>listen</em> below.
richt@239
  1413
              </li>
richt@239
  1414
              <li>
richt@239
  1415
                <em>Refresh Subscription</em>: Run the following steps at a set interval (X) within the <a>user
richt@239
  1416
                agent</a>:
richt@239
  1417
                <ol class="rule">
richt@239
  1418
                  <li>Let <var>current date</var> equal the current UTC date.
richt@239
  1419
                  </li>
richt@239
  1420
                  <li>If <var>current date</var> is less than the <var>timeout date</var> then continue to the step
richt@239
  1421
                  labeled <em>refresh subscription</em> above.
richt@239
  1422
                  </li>
richt@239
  1423
                  <li>Send a HTTP SUBSCRIBE request with a <em>SID</em> header with the string value of <var>callback
richt@239
  1424
                  ID</var> and a user-agent defined <em>TIMEOUT</em> header (in the form <code>Second-XX</code> where
richt@239
  1425
                  <code>XX</code> is the user-agent defined timeout value in seconds) towards the <var>network service
richt@239
  1426
                  record</var>'s <code>eventsUrl</code> property.
richt@239
  1427
                  </li>
richt@239
  1428
                  <li>On receiving a valid 200 OK, update <var>callback ID</var> with the string value of the first
richt@250
  1429
                  included <em>SID</em> header and set <var>timeout date</var> to the sum of the current UTC date value
richt@250
  1430
                  plus the integer value of the first included <em>TIMEOUT</em> header (minus the leading string of
richt@250
  1431
                  <code>Second-</code>), if it exists. If the current date is greater than or equal to <var>timeout
richt@250
  1432
                  date</var> then the <a>user agent</a> SHOULD continue from the step labeled <em>refresh
richt@250
  1433
                  subscription</em> above. For all non 200 OK responses the <a>user agent</a> SHOULD continue from the
richt@250
  1434
                  step labeled <em>refresh subscription</em> above.
richt@239
  1435
                  </li>
richt@239
  1436
                </ol>
richt@239
  1437
              </li>
richt@239
  1438
              <li>
richt@239
  1439
                <em>Listen</em>: For each HTTP NOTIFY request received at the <var>callback URL</var> the <a>user
richt@239
  1440
                agent</a> is to run the following steps:
richt@239
  1441
                <ol class="rule">
richt@239
  1442
                  <li>Let <var>content clone</var> be the result of obtaining the message body of the HTTP NOTIFY
richt@250
  1443
                  request. If <var>content clone</var> is empty, then the <a>user agent</a> MUST abort these steps.
richt@239
  1444
                  </li>
richt@239
  1445
                  <li>Let <var>notification event</var> be a new simple event that uses the <a href=
richt@239
  1446
                  "http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
richt@239
  1447
                        class="externalDFN"><code>Event</code></a> interface with the name <a href=
richt@239
  1448
                        "#event-notify"><code>notify</code></a>, which does not bubble, is not cancellable, and has no
richt@239
  1449
                        default action.
richt@239
  1450
                  </li>
richt@239
  1451
                  <li>Let the <code>data</code> attribute of <var>notification event</var> have the DOMString value of
richt@239
  1452
                  <var>content clone</var>.
richt@239
  1453
                  </li>
richt@239
  1454
                  <li>
richt@239
  1455
                    <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/webappapis.html#queue-a-task"
richt@239
  1456
                        class="externalDFN">Queue a task</a> to dispatch <var>notification event</var> at the current
richt@239
  1457
                        <a><code>NetworkService</code></a> object.
richt@239
  1458
                  </li>
richt@250
  1459
                  <li>Return a HTTP 200 OK response to the sender of the HTTP NOTIFY request.
richt@250
  1460
                  </li>
richt@239
  1461
                </ol>
richt@239
  1462
              </li>
richt@239
  1463
            </ol>
richt@239
  1464
          </li>
richt@239
  1465
        </ol>
richt@239
  1466
        <p>
richt@250
  1467
          A <a>user agent</a> can <dfn>terminate an existing UPnP Events Subscription</dfn> at any time for a
richt@250
  1468
          <var>network service record</var> by sending an HTTP UNSUBSCRIBE request - as defined in 'Section 4.1.4:
richt@250
  1469
          Cancelling a subscription with UNSUBSCRIBE' in [[!UPNP-DEVICEARCH11]] - with a HOST header set to that
richt@250
  1470
          <var>active service</var>'s <code>eventsUrl</code> property and a SID header set to the <var>callback
richt@250
  1471
          ID</var> obtained when the initial <a>setup a UPnP Events Subscription</a> action occurred.
richt@239
  1472
        </p>
richt@239
  1473
      </section>
richt@239
  1474
      <section>
danieldanciu@330
  1475
        <h5>
danieldanciu@330
  1476
          Discovery and Launch Protocol (<abbr title="Discovery and Launch Protocol">DIAL</abbr>)
danieldanciu@330
  1477
        </h5>
danieldanciu@330
  1478
         <p>
danieldanciu@330
  1479
          A user agent that implements DIAL service discovery MUST issue a <dfn>search request for DIAL-enabled
danieldanciu@330
  1480
          devices</dfn> against the user's current local network according to the full normative text and timing
danieldanciu@330
  1481
          provided in 'Section 1.3.2: Search request with M-SEARCH' detailed in [[!UPNP-DEVICEARCH11]].
danieldanciu@330
  1482
        </p>
danieldanciu@330
  1483
        <p>
danieldanciu@330
  1484
          Let <var>dial version</var> be the version number specified in the <a>valid service type</a> token.
danieldanciu@330
  1485
          Let <var>dial search target</var> be the concatentation of the 
danieldanciu@330
  1486
          <code>urn:dial-multiscreen-org:service:dial:</code> string constant with the <var>dial version</var>
danieldanciu@330
  1487
          (currently, <var>dial version</var> can only be <code>1</code>) 
danieldanciu@330
  1488
        </p>
danieldanciu@330
  1489
        <p>
danieldanciu@330
  1490
          The user agent MUST issue all <a title="search request for DIAL devices">search requests for DIAL
danieldanciu@330
  1491
          devices</a> with a HTTP request line equal to <code>M-SEARCH * HTTP/1.1</code>, with a HOST header equal to
danieldanciu@330
  1492
          the reserved multicast address and port of <code>239.255.255.250:1900</code>, a MAN header equal to
danieldanciu@330
  1493
          <code>ssdp:discover</code>, an ST header equal to <var>dial search target</var>
danieldanciu@330
  1494
          and a user-agent defined MX header equal to a <dfn>maximum UPnP advertisement response wait time</dfn>
danieldanciu@330
  1495
          value between <code>1</code> and <code>5</code> seconds.
danieldanciu@330
  1496
        </p>
danieldanciu@330
  1497
        <p>
danieldanciu@330
  1498
          The user agent MUST listen for any incoming responses to a <a>search request for DIAL devices</a>.
danieldanciu@330
  1499
        </p>
danieldanciu@330
  1500
        <p>
danieldanciu@330
  1501
          For each <dfn>HTTP Response</dfn> following an initial <a>search request for DIAL devices</a> sent on a
danieldanciu@330
  1502
          <a>standard UPnP address and port</a> the user agent MUST run the following steps:
danieldanciu@330
  1503
        </p>
danieldanciu@330
  1504
        <ol class="rule">
danieldanciu@330
  1505
          <li>If the <a>HTTP Response</a> is not a HTTP 200 OK response then this response is invalid and the user
danieldanciu@330
  1506
          agent MUST discard this response, abort any remaining steps and return. The user agent MAY issue a new
danieldanciu@330
  1507
          <a>search request for DIAL devices</a> as a result of this error occurring.
danieldanciu@330
  1508
          </li>
danieldanciu@330
  1509
          <li>If the <a>maximum UPnP advertisement response wait time</a> has been exceeded since the initial <a>search
danieldanciu@330
  1510
          request for DIAL devices</a> was sent then the <a>HTTP Response</a> is invalid and the user agent MUST
danieldanciu@330
  1511
          discard this response, abort any remaining steps and return. The user agent MAY stop listening for responses
danieldanciu@330
  1512
          from the current <a>search request for DIAL devices</a> as a result of this error occurring. Equally,
danieldanciu@330
  1513
          the user agent MAY issue a new <a>search request for DIAL devices</a> as a result of this error
danieldanciu@330
  1514
          occurring.
danieldanciu@330
  1515
          </li>
danieldanciu@330
  1516
          <li>Let <var>dial device</var> be an Object with a property for each HTTP header received in the <a>HTTP
danieldanciu@330
  1517
          Response</a>, with each key being the name of a HTTP response header and each value being that HTTP response
danieldanciu@330
  1518
          header's value.
danieldanciu@330
  1519
          </li>
danieldanciu@330
  1520
          <li>If <var>dial device</var> does not contain at least one <var>CACHE-CONTROL</var> entry, at least one
danieldanciu@330
  1521
          <var>USN</var> entry, at least one <var>ST</var> entry and at least one <var>LOCATION</var> entry or the
danieldanciu@330
  1522
          value of its <var>ST</var> entry is not <var>dial search target</var>, then the
danieldanciu@330
  1523
          <a>HTTP Response</a> is invalid and the <a>user agent</a> MUST discard this response, abort any remaining
danieldanciu@330
  1524
          steps and return.
danieldanciu@330
  1525
          </li>
danieldanciu@330
  1526
          <li>The user agent MUST run the rule for <a>obtaining a UPnP Device Description File</a> passing in the first
danieldanciu@330
  1527
          occurrence of <var>LOCATION</var> from <var>dial device</var> as the <var>device descriptor URL</var>
danieldanciu@330
  1528
          argument and the first occurrence of <var>USN</var> from <var>dial device</var> as the <var>device
danieldanciu@330
  1529
          identifier</var> argument and the first occurrence of <var>CACHE-CONTROL</var> from <var>dial device</var>
danieldanciu@330
  1530
          (minus the leading string of <code>max-age=</code>) as the <var>device expiry</var> argument.
danieldanciu@330
  1531
          </li>
danieldanciu@330
  1532
        </ol>
danieldanciu@330
  1533
        <p>
danieldanciu@330
  1534
          The rule for <dfn>obtaining a UPnP Device Description File</dfn> is the process of obtaining the contents of
danieldanciu@330
  1535
          a standard UPnP Device Description [[!UPNP-DEVICEARCH11]] from a URL-based resource. This rule takes three
danieldanciu@330
  1536
          arguments - <var>device descriptor URL</var>, <var>device identifier</var> and <var>device expiry</var> - and
danieldanciu@330
  1537
          when called the user agent MUST run the following steps:
danieldanciu@330
  1538
        </p>
danieldanciu@330
  1539
        <ol class="rule">
danieldanciu@330
  1540
          <li>Let <var>device descriptor file</var> contain the contents of the file located at the URL provided in
danieldanciu@330
  1541
          <var>device descriptor URL</var> obtained according to the rules defined in 'Section 2.11: Retrieving a
danieldanciu@330
  1542
          description using HTTP' in [[!UPNP-DEVICEARCH11]].
danieldanciu@330
  1543
          </li>
danieldanciu@330
  1544
          <li>Let <var>application url</var> be the value of the first occurrence of the <code>Application-URL</code>
danieldanciu@330
  1545
          response header field obtained according to the rules defined in 'Section 5.4: Device Description Response' in
danieldanciu@330
  1546
          [<a href = "https://sites.google.com/a/dial-multiscreen.org/dial/dial-protocol-specification">DIAL</a>]
danieldanciu@330
  1547
          </li>
danieldanciu@330
  1548
          <li>If the value provided in <var>device descriptor URL</var> cannot be resolved as a reachable URL on the
danieldanciu@330
  1549
          current network or the <var>device descriptor file</var> remains empty or <var>application url</var> is undefined
danieldanciu@330
  1550
          then it is invalid and the <a>user agent</a> MUST abort any remaining steps and return.
danieldanciu@330
  1551
          </li>
danieldanciu@330
  1552
          <li>Run the following steps to add the newly discovered DIAL service:
danieldanciu@330
  1553
            <ol class="rule">
danieldanciu@330
  1554
              <li>Let <var>network service record</var> be a new Object consisting of the following empty properties:
danieldanciu@330
  1555
              <code>id</code>, <code>deviceId</code>, <code>name</code>, <code>type</code>, <code>url</code>,
danieldanciu@330
  1556
              <code>expiryTimestamp</code>.
danieldanciu@330
  1557
              </li>
danieldanciu@330
  1558
              <li>Set <var>network service record</var>'s <code>id</code> property to the first occurrence of the
danieldanciu@330
  1559
              <code>&lt;UDN&gt;</code> element in the <var>descriptor file</var> prefixed with the <code>dial:</code>
danieldanciu@330
  1560
              string constant
danieldanciu@330
  1561
              </li>
danieldanciu@330
  1562
              <li>Set <var>network service record</var>'s <code>deviceId</code> property to the value of <var>device
danieldanciu@330
  1563
              identifier</var>.
danieldanciu@330
  1564
              </li>
danieldanciu@330
  1565
              <li>Set <var>network service record</var>'s <code>name</code> property to the string value of the first
danieldanciu@330
  1566
              occurrence of the <code>&lt;friendlyName&gt;</code> element in the <var>descriptor file</var>.
danieldanciu@330
  1567
              </li>
danieldanciu@330
  1568
              <li>Set <var>network service record</var>'s <code>type</code> property to <var>dial search target</var>.
danieldanciu@330
  1569
              </li>
danieldanciu@330
  1570
              <li>Set <var>network service record</var>'s <code>url</code> property to the string value of the <var>
danieldanciu@330
  1571
              application url</var>.
danieldanciu@330
  1572
              </li>
danieldanciu@330
  1573
              <li>Set <var>network service record</var>'s <code>expiryTimestamp</code> property to the value of the
danieldanciu@330
  1574
              current date, in UTC timestamp format, plus the value of <var>device expiry</var>.
danieldanciu@330
  1575
              </li>
danieldanciu@330
  1576
              <li>Run the general rule for <a>adding an available service</a>, passing in the current <var>network
danieldanciu@330
  1577
              service record</var> as the only argument.
danieldanciu@330
  1578
              </li>
danieldanciu@330
  1579
            </ol>
danieldanciu@330
  1580
          </li>
danieldanciu@330
  1581
        </ol>
danieldanciu@330
  1582
      </section>
danieldanciu@330
  1583
      <section>
richt@239
  1584
        <h3>
richt@239
  1585
          Network Topology Monitoring
richt@239
  1586
        </h3>
richt@239
  1587
        <div>
richt@180
  1588
          <p>
richt@239
  1589
            When the <a>user agent</a> detects that the user has dropped from their connected network then, for each
richt@250
  1590
            <var>existing service record</var> in the <a>list of available service records</a>, the user agent MUST run
richt@250
  1591
            the general rule for <a>removing an available service</a> passing in each <var>existing service
richt@250
  1592
            record</var>'s <code>id</code> property as the only argument for each call.
richt@180
  1593
          </p>
richt@180
  1594
          <p>
richt@239
  1595
            When the <a>user agent</a> detects that the user has connected to a new network or reconnected to an
richt@250
  1596
            existing network, then it SHOULD restart its discovery mechanisms as defined in the <a href=
richt@250
  1597
            "#service-discovery">Service Discovery</a> section of this specification, maintaining the existing <a>list
richt@250
  1598
            of active service managers</a> currently in use.
richt@180
  1599
          </p>
richt@239
  1600
        </div>
richt@180
  1601
      </section>
richt@239
  1602
    </section>
richt@239
  1603
    <section>
richt@239
  1604
      <h3>
richt@239
  1605
        Events Summary
richt@239
  1606
      </h3>
richt@191
  1607
      <p>
richt@239
  1608
        The following events are dispatched on the <a href="#networkservices"><code>NetworkServices</code></a> and/or
richt@239
  1609
        <a href="#networkservice"><code>NetworkService</code></a> objects:
richt@191
  1610
      </p>
richt@243
  1611
      <table border="1">
richt@180
  1612
        <thead>
richt@180
  1613
          <tr>
richt@180
  1614
            <th>
richt@239
  1615
              <span>Event name</span>
richt@238
  1616
            </th>
richt@238
  1617
            <th>
richt@238
  1618
              <span>Interface</span>
richt@238
  1619
            </th>
richt@238
  1620
            <th>
richt@238
  1621
              <span>Dispatched when...</span>
richt@238
  1622
            </th>
richt@238
  1623
          </tr>
richt@238
  1624
        </thead>
richt@238
  1625
        <tbody>
richt@238
  1626
          <tr>
richt@238
  1627
            <td>
richt@239
  1628
              <dfn id="event-serviceavailable"><code>serviceavailable</code></dfn>
richt@238
  1629
            </td>
richt@238
  1630
            <td>
richt@239
  1631
              <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
richt@239
  1632
                  class="externalDFN"><code>Event</code></a>
richt@238
  1633
            </td>
richt@238
  1634
            <td>
richt@238
  1635
              When a new service that matches one of the <a>requested type tokens</a> is found in the current network.
richt@238
  1636
            </td>
richt@238
  1637
          </tr>
richt@238
  1638
          <tr>
richt@238
  1639
            <td>
richt@239
  1640
              <dfn id="event-serviceunavailable"><code>serviceunavailable</code></dfn>
richt@238
  1641
            </td>
richt@238
  1642
            <td>
richt@239
  1643
              <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
richt@239
  1644
                  class="externalDFN"><code>Event</code></a>
richt@238
  1645
            </td>
richt@238
  1646
            <td>
richt@239
  1647
              When an existing service that matches one of the <a>requested type tokens</a> gracefully leaves or
richt@239
  1648
              expires from the current network.
richt@238
  1649
            </td>
richt@238
  1650
          </tr>
richt@238
  1651
          <tr>
richt@238
  1652
            <td>
richt@239
  1653
              <dfn id="event-serviceonline"><code>serviceonline</code></dfn>
richt@238
  1654
            </td>
richt@238
  1655
            <td>
richt@239
  1656
              <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
richt@239
  1657
                  class="externalDFN"><code>Event</code></a>
richt@238
  1658
            </td>
richt@238
  1659
            <td>
richt@238
  1660
              When a current service renews its service registration within the current network.
richt@238
  1661
            </td>
richt@238
  1662
          </tr>
richt@238
  1663
          <tr>
richt@238
  1664
            <td>
richt@239
  1665
              <dfn id="event-serviceoffline"><code>serviceoffline</code></dfn>
richt@238
  1666
            </td>
richt@238
  1667
            <td>
richt@239
  1668
              <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
richt@239
  1669
                  class="externalDFN"><code>Event</code></a>
richt@238
  1670
            </td>
richt@238
  1671
            <td>
richt@238
  1672
              When a current service gracefully leaves or otherwise expires from the current network.
richt@238
  1673
            </td>
richt@238
  1674
          </tr>
richt@238
  1675
          <tr>
richt@238
  1676
            <td>
richt@239
  1677
              <dfn id="event-notify"><code>notify</code></dfn>
richt@238
  1678
            </td>
richt@238
  1679
            <td>
richt@239
  1680
              <a href="http://dvcs.w3.org/hg/domcore/raw-file/tip/Overview.html#event"
richt@239
  1681
                  class="externalDFN"><code>Event</code></a>
richt@238
  1682
            </td>
richt@238
  1683
            <td>
richt@239
  1684
              When a valid UPnP Events Subscription Message is received on a <a>user-agent generated callback url</a>
richt@239
  1685
              for a current service. This event never fires for Zeroconf-based services.
richt@238
  1686
            </td>
richt@238
  1687
          </tr>
richt@238
  1688
        </tbody>
richt@238
  1689
      </table>
richt@239
  1690
    </section>
richt@239
  1691
    <section>
richt@239
  1692
      <h3>
richt@239
  1693
        Garbage collection
richt@239
  1694
      </h3>
richt@180
  1695
      <p>
richt@250
  1696
        A user agent MUST only garbage collect a <a><code>NetworkServices</code></a> object and remove its entry from
richt@254
  1697
        the <a>list of active service managers</a> when the user has navigated away from the
richt@254
  1698
        <a href="http://www.whatwg.org/specs/web-apps/current-work/complete/browsers.html#entry-script"
richt@254
  1699
              class="externalDFN">entry script</a>'s <a href=
richt@254
  1700
              "http://www.whatwg.org/specs/web-apps/current-work/complete/origin-0.html#origin"
richt@254
  1701
              class="externalDFN">origin</a> in which
richt@254
  1702
        the current <a><code>NetworkServices</code></a> object was provided.
richt@250
  1703
      </p>
richt@250
  1704
      <p>
richt@250
  1705
        A user agent MUST NOT garbage collect individual <a><code>NetworkService</code></a> objects until their parent
richt@250
  1706
        <a><code>NetworkServices</code></a> object has been garbage collected.
richt@250
  1707
      </p>
richt@250
  1708
      <p>
richt@250
  1709
        A user agent MUST garbage collect the <a><code>NetworkService</code></a> <a>indexed properties</a> of a
richt@250
  1710
        <a><code>NetworkServices</code></a> object when that <a><code>NetworkServices</code></a> object itself has been
richt@250
  1711
        garbage-collected.
richt@180
  1712
      </p>
richt@239
  1713
    </section>
richt@180
  1714
    <section>
richt@239
  1715
      <h3>
richt@239
  1716
        Use Cases and Requirements
richt@239
  1717
      </h3>
richt@239
  1718
      <p>
richt@239
  1719
        This section covers what the requirements are for this API, as well as illustrates some use cases.
richt@239
  1720
      </p>
richt@180
  1721
      <ul class="rule">
richt@239
  1722
        <li>Once a user has given permission, user agents should provide the ability for Web pages to communicate
richt@239
  1723
        directly with a Local-networked Service.
richt@239
  1724
          <ul class="rule">
richt@239
  1725
            <li>Example: A web-based TV remote control. A Web page wants to control the current user's TV, changing the
richt@239
  1726
            programming shown or increasing/decreasing/muting the volume of the Local-networked Device. The Web page
richt@239
  1727
            requests a service type that is known to be implemented by television sets to which it has the application
richt@239
  1728
            logic to communicate. Local devices providing the request service types are discovered and presented to the
richt@239
  1729
            user for authorization. The user selects one or more of the discovered television sets to be accessible to
richt@239
  1730
            the current Web page and then clicks 'Share'. The Web page can now communicate directly with the
richt@239
  1731
            user-authorized Local-networked services.
richt@180
  1732
            </li>
richt@239
  1733
          </ul>
richt@239
  1734
        </li>
richt@239
  1735
        <li>Web pages should be able to communicate with Local-networked Services using the messaging channel supported
richt@239
  1736
        by those Devices.
richt@239
  1737
          <ul class="rule">
richt@239
  1738
            <li>Example: A Web page advertises that it is capable of controlling multiple Home Media Servers. The user
richt@239
  1739
            can select their Home Media Server type from a drop-down list, at which point the Web page sends a request
richt@239
  1740
            to the user agent to connect with the associated service type of the Home Media Server. The Media Server
richt@239
  1741
            selected implements a Web Socket channel for bi-directional service communication and so the Web page opens
richt@239
  1742
            a web socket to the requested Media Server and can communicate as required via that appropriate channel.
richt@180
  1743
            </li>
richt@239
  1744
          </ul>
richt@239
  1745
        </li>
richt@239
  1746
        <li>Web pages should be able to communicate with Local-networked Services using the messaging format supported
richt@239
  1747
        by those Devices.
richt@239
  1748
          <ul class="rule">
richt@239
  1749
            <li>Example: A Web page advertises that it is capable of interacting with and controlling multiple types of
richt@239
  1750
            Home Media Server. The user can select their Home Media Server type from a drop-down list or known Media
richt@239
  1751
            Servers, at which point the Web page sends a request to the user agent to connect with the associated
richt@240
  1752
            service type (and, optionally, the associated event type) of the Home Media Server. The communication
richt@239
  1753
            protocols supported by Home Media Servers typically vary between UPnP, JSON-RPC, Protocol Buffers or other
richt@239
  1754
            messaging formats depending on the Home Media Server requested. The Web page is able to communicate with
richt@239
  1755
            the user-selected Home Media Server in the messaging format supported by that Device, which, in this
richt@239
  1756
            example is a simple key/value pair text format.
richt@180
  1757
            </li>
richt@239
  1758
          </ul>
richt@239
  1759
        </li>
richt@239
  1760
        <li>Web pages should not be able to communicate with Local-networked Services that have not been authorized by
richt@239
  1761
        the user thereby maintaining the user's privacy.
richt@239
  1762
          <ul class="rule">
richt@239
  1763
            <li>Example: A Web page requests access to one type of Local-networked service. The user authorizes access
richt@239
  1764
            to that particular service. Other services running on that same device, and on other devices within the
richt@239
  1765
            network, should not be accessible to the current Web page.
richt@180
  1766
            </li>
richt@239
  1767
          </ul>
richt@239
  1768
        </li>
richt@239
  1769
        <li>A user should be able to share one or more Local-networked Services based on a particular service type
richt@239
  1770
        request from a Web page.
richt@239
  1771
          <ul class="rule">
richt@239
  1772
            <li>Example: A Web page is capable of interacting with a specific profile of Local-networked Service. As
richt@239
  1773
            such, it makes a request to the user agent to access those services, of which multiple matches are found.
richt@239
  1774
            The user is capable of selecting one or more of the discovered services to share with the Web page. The Web
richt@239
  1775
            page can then implement a drag-and-drop interface for the user to drag specific actions on to one or more
richt@239
  1776
            of the authorized Local-networked Services.
richt@239
  1777
            </li>
richt@239
  1778
          </ul>
richt@239
  1779
        </li>
richt@239
  1780
        <li>User agents should provide an API exposed to script that exposes the features above. The user is notified
richt@239
  1781
        by UI anytime interaction with Local-networked Services is requested, giving the user full ability to cancel or
richt@239
  1782
        abort the transaction. The user selects the Local-networked Services to be connected to the current Web page,
richt@239
  1783
        and can cancel these at any time. No invocations to these APIs occur silently without user intervention.
richt@239
  1784
        </li>
richt@180
  1785
      </ul>
richt@180
  1786
    </section>
richt@239
  1787
    <section class="informative appendix">
richt@239
  1788
      <h3>
richt@239
  1789
        Examples
richt@239
  1790
      </h3>
richt@239
  1791
      <div class="example">
richt@239
  1792
        <p>
richt@239
  1793
          This sample code exposes a button. When clicked, this button is disabled and the user is prompted to offer a
richt@239
  1794
          network service. The user may also select multiple network services. When the user has authorized a network
richt@239
  1795
          service to be connected to the web page then the web page issues a simple command to get a list of all the
richt@239
  1796
          albums stored on the connected media player service.
richt@239
  1797
        </p>
richt@239
  1798
        <p>
richt@239
  1799
          The button is re-enabled only when the connected network service disconnects for whatever reason (the service
richt@239
  1800
          becomes unavailable on the network, the user disconnects from their current network or the user revokes
richt@239
  1801
          access to the service from the current web page). At this point the user can re-click the button to select a
richt@239
  1802
          new network service to connect to the web page and the above steps are repeated.
richt@239
  1803
        </p>
richt@239
  1804
        <p>
richt@239
  1805
          The provided service type identifier and service interaction used in this example is based on the
richt@239
  1806
          well-defined service type and messaging format supported by the <a href="http://xbmc.org/about/">XBMC Media
richt@239
  1807
          Server</a>.
richt@239
  1808
        </p>
richt@239
  1809
        <hr>
richt@239
  1810
        <pre class="highlight">
richt@239
  1811
&lt;input type="button" value="Start" onclick="start()" id="startBtn"/&gt;
richt@239
  1812
&lt;div id="debugconsole"&gt;&lt;/div&gt;
richt@180
  1813
richt@239
  1814
&lt;script&gt;
richt@180
  1815
 var startBtn = document.getElementById('startBtn'),
richt@180
  1816
     debug = document.getElementById('debugconsole');
richt@180
  1817
richt@180
  1818
 function start() {
richt@180
  1819
   if(navigator.getNetworkServices) {
richt@180
  1820
      navigator.getNetworkServices('zeroconf:_xbmc-jsonrpc._tcp', gotXBMCService, error);
richt@180
  1821
      startBtn.disabled = true;
richt@180
  1822
   } else {
richt@191
  1823
      debug.innerHTML += "&lt;br&gt;Service Discovery not supported!";
richt@180
  1824
   }
richt@180
  1825
 }
richt@180
  1826
richt@180
  1827
 function gotXBMCService(services) {
richt@180
  1828
richt@180
  1829
// Listen for service disconnect messages
richt@180
  1830
richt@191
  1831
   services[0].addEventListener('serviceoffline', function ( e ) {
richt@239
  1832
       debug.innerHTML += "&lt;br&gt;" + services[0].name + " disconnected.";
richt@180
  1833
       startBtn.disabled = false;
richt@180
  1834
   }, false);
richt@180
  1835
richt@180
  1836
// Send a service message to get albums list (and process the service response)
richt@180
  1837
richt@180
  1838
   var svcXhr = new XMLHttpRequest();
richt@240
  1839
   svcXhr.open("POST", services[0].url + "/getAlbums"); // services[0].url and its sub-resources have been
richt@180
  1840
                                                        // whitelisted for cross-site XHR use in this
richt@180
  1841
                                                        // current browsing context.
richt@180
  1842
richt@180
  1843
   svcXhr.setRequestHeader('Content-Type', 'application/json-rpc');
richt@180
  1844
richt@180
  1845
   svcXhr.addEventListener('readystatechange', function ( response ) {
richt@180
  1846
     if( response.readyState != 4 || response.status != 200 )
richt@180
  1847
        return;
richt@239
  1848
     debug.innerHTML += "&lt;br&gt;" + services[0].name + " response received: ";
richt@180
  1849
     debug.textContent += JSON.parse(response.responseText);
richt@180
  1850
   }, false);
richt@180
  1851
richt@180
  1852
   var svcMsg = [
richt@180
  1853
     { "jsonrpc": "2.0", "method": "AudioLibrary.GetAlbums", "params": { "genreid": -1,
richt@180
  1854
         "artistid": -1, "start": -1, "end": -1 }, "id": "1" }
richt@180
  1855
   ];
richt@180
  1856
richt@180
  1857
   svcXhr.send(JSON.stringify(svcMsg));
richt@239
  1858
   debug.innerHTML += "&lt;br&gt;" + services[0].name + " request sent: ";
richt@180
  1859
   debug.textContent += JSON.stringify(svcMsg);
richt@180
  1860
richt@180
  1861
 }
richt@180
  1862
richt@180
  1863
 function error( err ) {
richt@239
  1864
   debug.innerHTML += "&lt;br&gt;An error occurred obtaining a local network service.";
richt@180
  1865
   startBtn.disabled = false;
richt@180
  1866
 }
richt@239
  1867
&lt;/script&gt;
richt@239
  1868
</pre>
richt@239
  1869
      </div>
richt@239
  1870
      <div class="example">
richt@239
  1871
        <p>
richt@239
  1872
          This sample exposes a drop-down list containing a number of common Home-based audio devices. When the user
richt@239
  1873
          selects an audio device from the list provided, they are prompted to authorize a network service based on the
richt@239
  1874
          service type requested. The user may also select multiple network services matching the selected service
richt@239
  1875
          type. In this example, the user selects their make as being <var>Sony</var> and their model as being
richt@239
  1876
          <var>Bravia S1000</var> from which the Web page can derive a service type
richt@239
  1877
          (<var>urn:schemas-upnp-org:service:RenderingControl:1</var>).<br>
richt@239
  1878
          <br>
richt@239
  1879
          Once the user has authorized the device, the web page sends a simple mute command according to the messaging
richt@239
  1880
          format supported by the device.
richt@239
  1881
        </p>
richt@239
  1882
        <hr>
richt@239
  1883
        <pre class="highlight">
richt@239
  1884
&lt;select name="make" id="make"&gt;
richt@180
  1885
  &lt;option selected="selected" disabled="disabled"&gt;Select make&lt;/option&gt;
richt@180
  1886
  &lt;option&gt;Sony&lt;/option&gt;
richt@180
  1887
  &lt;option&gt;Philips&lt;/option&gt;
richt@180
  1888
  &lt;option&gt;Alba&lt;/option&gt;
richt@180
  1889
&lt;/select&gt;
richt@180
  1890
&lt;select name="model" id="model"&gt;&lt;/select&gt;
richt@180
  1891
&lt;div id="debugconsole"&gt;&lt;/div&gt;
richt@180
  1892
richt@180
  1893
&lt;script&gt;
richt@180
  1894
  var debug = document.getElementById('debugconsole');
richt@180
  1895
richt@180
  1896
  var models = {
richt@180
  1897
    "Sony": [
richt@180
  1898
      {"name": "Bravia TV S1000", "type": "upnp", "service": "urn:schemas-upnp-org:service:RenderingControl:1" },
richt@180
  1899
      {"name": "Bravia TV S2000", "type": "zeroconf", "service": "_mediarenderer._http._tcp" },
richt@180
  1900
      {"name": "HiFi WD10", "type": "upnp", "service": "urn:schemas-upnp-org:service:RenderingControl:1" }
richt@180
  1901
    ],
richt@180
  1902
    "Philips": [ /* ... */ ],
richt@180
  1903
    "Alba": [ /* ... */ ]
richt@180
  1904
  };
richt@180
  1905
richt@180
  1906
  var makeEl = document.getElementById("make"),
richt@180
  1907
      modelEl = document.getElementById("model");
richt@180
  1908
richt@180
  1909
  makeEl.addEventListener('change', function() {
richt@180
  1910
    modelEl.innerHTML = ""; // reset
richt@180
  1911
    var defaultOption = document.createElement("option");
richt@180
  1912
    defaultOption.textContent = "Select model";
richt@180
  1913
    defaultOption.setAttribute("disabled", "disabled");
richt@180
  1914
    defaultOption.setAttribute("selected", "selected");
richt@180
  1915
    modelEl.appendChild(defaultOption);
richt@239
  1916
    for(var i = 0, l = models[makeEl.value].length; i &lt; l; i++) {
richt@180
  1917
      var option = document.createElement("option");
richt@180
  1918
      option.textContent = models[makeEl.value][i]["name"];
richt@180
  1919
      option.setAttribute("value", models[makeEl.value][i]["type"] + ":" + models[makeEl.value][i]["service"]);
richt@180
  1920
      modelEl.appendChild(option);
richt@180
  1921
    }
richt@180
  1922
  }, false);
richt@180
  1923
richt@180
  1924
  modelEl.addEventListener('change', function() {
richt@239
  1925
    if(navigator.getNetworkServices &amp;&amp;
richt@180
  1926
         modelEl.value == "upnp:urn:schemas-upnp-org:service:RenderingControl:1") {
richt@180
  1927
      navigator.getNetworkServices(modelEl.value, successCallback, errorCallback);
richt@180
  1928
    } else if (modelEl.value == "zeroconf:_mediarenderer._http._tcp") {
richt@180
  1929
      debug.innerHTML += "&lt;br&gt;Service type is not implemented by this application.";
richt@180
  1930
    } else {
richt@180
  1931
      debug.innerHTML += "&lt;br&gt;Service Discovery is not supported!";
richt@180
  1932
    }
richt@180
  1933
  }, false);
richt@180
  1934
&lt;/script&gt;
richt@180
  1935
richt@180
  1936
&lt;script&gt;
richt@180
  1937
  function successCallback( services ) {
richt@180
  1938
richt@191
  1939
  // Listen for service push notification messages
richt@180
  1940
richt@191
  1941
    services[0].addEventListener('notify', function ( msg ) {
richt@239
  1942
         debug.innerHTML += "&lt;br&gt;" + services[0].name + " event received: ";
richt@180
  1943
         debug.textContent += msg.data;
richt@180
  1944
    }, false);
richt@180
  1945
richt@180
  1946
 // Send a control signal to mute the service audio
richt@180
  1947
richt@180
  1948
    var svcXhr = new XMLHttpRequest();
richt@180
  1949
    svcXhr.open("POST", services[0].url); // services[0].url and its
richt@240
  1950
                                          // sub-resources have been whitelisted for
richt@180
  1951
                                          // cross-site XHR use in this current
richt@180
  1952
                                          // browsing context.
richt@180
  1953
richt@180
  1954
    svcXhr.setRequestHeader('SOAPAction', 'urn:schemas-upnp-org:service:RenderingControl:1#SetMute');
richt@180
  1955
    svcXhr.setRequestHeader('Content-Type', 'text/xml; charset="utf-8";');
richt@180
  1956
richt@180
  1957
    svcXhr.onreadystatechange = function ( response ) {
richt@180
  1958
      if( response.readyState != 4 || response.status != 200 )
richt@180
  1959
        return;
richt@180
  1960
      debug.innerHTML += "&lt;br&gt;" + services[0].name + " response received: ";
richt@180
  1961
      debug.textContent += response.responseXML;
richt@180
  1962
    }
richt@180
  1963
richt@180
  1964
    // Service messaging to mute the provided service
richt@180
  1965
    var svcMsg = '&lt;?xml version="1.0" encoding="utf-8"?&gt;' +
richt@180
  1966
                 '&lt;s:Envelope s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" ' +
richt@180
  1967
                   'xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"&gt;' +
richt@180
  1968
                   '&lt;s:Body&gt;' +
richt@180
  1969
                     '&lt;u:SetMute xmlns:u="urn:schemas-upnp-org:service:RenderingControl:1"&gt;' +
richt@180
  1970
                       '&lt;InstanceID&gt;0&lt;/InstanceID&gt;' +
richt@180
  1971
                       '&lt;Channel&gt;Master&lt;/Channel&gt;' +
richt@180
  1972
                       '&lt;DesiredMute&gt;true&lt;/DesiredMute&gt;' +
richt@180
  1973
                     '&lt;/u:SetMute&gt;' +
richt@180
  1974
                   '&lt;/s:Body&gt;' +
richt@180
  1975
                 '&lt;/s:Envelope&gt;';
richt@180
  1976
richt@180
  1977
    svcXhr.send(svcMsg);
richt@180
  1978
    debug.innerHTML += "&lt;br&gt;" + services[0].name + " request sent: ";
richt@180
  1979
    debug.textContent += svcMsg;
richt@180
  1980
  }
richt@180
  1981
richt@180
  1982
  function errorCallback( error ) {
richt@180
  1983
    debug.innerHTML += "&lt;br&gt;An error occurred: " + error.code;
richt@180
  1984
  }
richt@239
  1985
&lt;/script&gt;
richt@239
  1986
</pre>
richt@239
  1987
      </div>
richt@239
  1988
    </section>
richt@180
  1989
    <section>
richt@239
  1990
      <h3>
richt@239
  1991
        Acknowledgements
richt@239
  1992
      </h3>
richt@239
  1993
      <p>
richt@239
  1994
        Thanks are expressed by the editor to the following individuals for their feedback on this specification to
richt@239
  1995
        date (in alphabetical order):<br>
richt@239
  1996
        <br>
richt@239
  1997
        Gar Bergstedt, Lars-Erik Bolstad, Cathy Chan, Hari G Kumar, Bob Lund, Giuseppe Pascale, Marcin Simonides,
richt@239
  1998
        Clarke Stevens, Christian Söderström, Mark Vickers.
richt@239
  1999
      </p>
richt@239
  2000
      <p>
richt@239
  2001
        Thanks are also expressed by the editor to the following organizations and groups for their support in
richt@239
  2002
        producing this specification to date (in alphabetical order):<br>
richt@239
  2003
        <br>
richt@239
  2004
        CableLabs, Opera Software ASA, W3C Device APIs Working Group, W3C Web and TV Interest Group.
richt@239
  2005
      </p>
richt@180
  2006
    </section>
richt@239
  2007
  </body>
richt@180
  2008
</html>