chrome.mdns

Warning

This API is part of the deprecated Chrome Apps platform. Learn more about migrating your app.

Description
Use the chrome.mdns API to discover services over mDNS. This comprises a subset of the features of the NSD spec: http://www.w3.org/TR/discovery-api/
Permissions
mdns

Summary

Types
MDnsService
Properties
MAX_SERVICE_INSTANCES_PER_EVENT
Methods
forceDiscovery
chrome.mdns.forceDiscovery(callback: function)
Events
onServiceList

Types

MDnsService

Properties

ipAddress
string
The IP address of an mDNS advertised service.
serviceData
string[]
Metadata for an mDNS advertised service.
serviceHostPort
string
The host:port pair of an mDNS advertised service.
serviceName
string
The service name of an mDNS advertised service,..

Properties

MAX_SERVICE_INSTANCES_PER_EVENT

The maximum number of service instances that will be included in onServiceList events. If more instances are available, they may be truncated from the onServiceList event.

Value

number 2048

Methods

forceDiscovery

chrome.mdns.forceDiscovery(callback: function)

Immediately issues a multicast DNS query for all service types. |callback| is invoked immediately. At a later time, queries will be sent, and any service events will be fired.

Parameters

callback
function
Callback invoked after ForceDiscovery() has started.
The callback parameter should be a function that looks like this:
() => {...}

Events

onServiceList

chrome.mdns.onServiceList.addListener(listener: function)

Event fired to inform clients of the current complete set of known available services. Clients should only need to store the list from the most recent event. The service type that the extension is interested in discovering should be specified as the event filter with the 'serviceType' key. Not specifying an event filter will not start any discovery listeners.

Event

listener
function
The listener parameter should be a function that looks like this:
(services: MDnsService[]) => {...}
- services
  MDnsService[]