NsdManager

ACTION_NSD_STATE_CHANGED

static val ACTION_NSD_STATE_CHANGED: String

Broadcast intent action to indicate whether network service discovery is enabled or disabled. An extra EXTRA_NSD_STATE provides the state information as int.

Value: "android.net.nsd.STATE_CHANGED"

EXTRA_NSD_STATE

static val EXTRA_NSD_STATE: String

The lookup key for an int that indicates whether network service discovery is enabled or disabled. Retrieve it with android.content.Intent#getIntExtra(String,int).

Value: "nsd_state"

FAILURE_ALREADY_ACTIVE

static val FAILURE_ALREADY_ACTIVE: Int

Indicates that the operation failed because it is already active.

Value: 3

FAILURE_BAD_PARAMETERS

static val FAILURE_BAD_PARAMETERS: Int

Indicates that the service has failed to resolve because of bad parameters. This failure is passed with ServiceInfoCallback.onServiceInfoCallbackRegistrationFailed.

Value: 6

FAILURE_INTERNAL_ERROR

static val FAILURE_INTERNAL_ERROR: Int

Failures are passed with RegistrationListener.onRegistrationFailed, RegistrationListener.onUnregistrationFailed, DiscoveryListener.onStartDiscoveryFailed, DiscoveryListener.onStopDiscoveryFailed or ResolveListener.onResolveFailed. Indicates that the operation failed due to an internal error.

Value: 0

FAILURE_MAX_LIMIT

static val FAILURE_MAX_LIMIT: Int

Indicates that the operation failed because the maximum outstanding requests from the applications have reached.

Value: 4

FAILURE_OPERATION_NOT_RUNNING

static val FAILURE_OPERATION_NOT_RUNNING: Int

Indicates that the stop operation failed because it is not running. This failure is passed with ResolveListener.onStopResolutionFailed.

Value: 5

NSD_STATE_DISABLED

static val NSD_STATE_DISABLED: Int

Network service discovery is disabled

Value: 1

NSD_STATE_ENABLED

static val NSD_STATE_ENABLED: Int

Network service discovery is enabled

Value: 2

PROTOCOL_DNS_SD

static val PROTOCOL_DNS_SD: Int

Dns based service discovery protocol

Value: 1

discoverServices

fun discoverServices(
    discoveryRequest: DiscoveryRequest, 
    executor: Executor, 
    listener: NsdManager.DiscoveryListener
): Unit

Initiates service discovery to browse for instances of a service type. Service discovery consumes network bandwidth and will continue until the application calls stopServiceDiscovery.

The function call immediately returns after sending a request to start service discovery to the framework. The application is notified of a success to initiate discovery through the callback DiscoveryListener.onDiscoveryStarted or a failure through DiscoveryListener.onStartDiscoveryFailed.

Upon successful start, application is notified when a service is found with DiscoveryListener.onServiceFound or when a service is lost with DiscoveryListener.onServiceLost.

Upon failure to start, service discovery is not active and application does not need to invoke stopServiceDiscovery

The application should call stopServiceDiscovery when discovery of this service type is no longer required, and/or whenever the application is paused or stopped.

discoverServices

fun discoverServices(
    serviceType: String, 
    protocolType: Int, 
    network: Network?, 
    executor: Executor, 
    listener: NsdManager.DiscoveryListener
): Unit

Initiate service discovery to browse for instances of a service type. Service discovery consumes network bandwidth and will continue until the application calls stopServiceDiscovery.

The function call immediately returns after sending a request to start service discovery to the framework. The application is notified of a success to initiate discovery through the callback DiscoveryListener.onDiscoveryStarted or a failure through DiscoveryListener.onStartDiscoveryFailed.

Upon successful start, application is notified when a service is found with DiscoveryListener.onServiceFound or when a service is lost with DiscoveryListener.onServiceLost.

Upon failure to start, service discovery is not active and application does not need to invoke stopServiceDiscovery

The application should call stopServiceDiscovery when discovery of this service type is no longer required, and/or whenever the application is paused or stopped.

discoverServices

fun discoverServices(
    serviceType: String, 
    protocolType: Int, 
    networkRequest: NetworkRequest, 
    executor: Executor, 
    listener: NsdManager.DiscoveryListener
): Unit

Initiate service discovery to browse for instances of a service type. Service discovery consumes network bandwidth and will continue until the application calls stopServiceDiscovery.

The function call immediately returns after sending a request to start service discovery to the framework. The application is notified of a success to initiate discovery through the callback DiscoveryListener.onDiscoveryStarted or a failure through DiscoveryListener.onStartDiscoveryFailed.

Upon successful start, application is notified when a service is found with DiscoveryListener.onServiceFound or when a service is lost with DiscoveryListener.onServiceLost.

Upon failure to start, service discovery is not active and application does not need to invoke stopServiceDiscovery

The application should call stopServiceDiscovery when discovery of this service type is no longer required, and/or whenever the application is paused or stopped.

During discovery, new networks may connect or existing networks may disconnect - for example if wifi is reconnected. When a service was found on a network that disconnects, DiscoveryListener.onServiceLost will be called. If a new network connects that matches the NetworkRequest, DiscoveryListener.onServiceFound will be called for services found on that network. Applications that do not want to track networks themselves are encouraged to use this method instead of other overloads of discoverServices, as they will receive proper notifications when a service becomes available or unavailable due to network changes.
Requires android.Manifest.permission#ACCESS_NETWORK_STATE

discoverServices

fun discoverServices(
    serviceType: String!, 
    protocolType: Int, 
    listener: NsdManager.DiscoveryListener!
): Unit

Initiate service discovery to browse for instances of a service type. Service discovery consumes network bandwidth and will continue until the application calls stopServiceDiscovery.

The function call immediately returns after sending a request to start service discovery to the framework. The application is notified of a success to initiate discovery through the callback DiscoveryListener.onDiscoveryStarted or a failure through DiscoveryListener.onStartDiscoveryFailed.

Upon successful start, application is notified when a service is found with DiscoveryListener.onServiceFound or when a service is lost with DiscoveryListener.onServiceLost.

Upon failure to start, service discovery is not active and application does not need to invoke stopServiceDiscovery

The application should call stopServiceDiscovery when discovery of this service type is no longer required, and/or whenever the application is paused or stopped.

registerService

fun registerService(
    serviceInfo: NsdServiceInfo!, 
    protocolType: Int, 
    listener: NsdManager.RegistrationListener!
): Unit

Register a service to be discovered by other services.

The function call immediately returns after sending a request to register service to the framework. The application is notified of a successful registration through the callback RegistrationListener.onServiceRegistered or a failure through RegistrationListener.onRegistrationFailed.

The application should call unregisterService when the service registration is no longer required, and/or whenever the application is stopped.

registerService

fun registerService(
    serviceInfo: NsdServiceInfo, 
    protocolType: Int, 
    executor: Executor, 
    listener: NsdManager.RegistrationListener
): Unit

Register a service to be discovered by other services.

The function call immediately returns after sending a request to register service to the framework. The application is notified of a successful registration through the callback RegistrationListener.onServiceRegistered or a failure through RegistrationListener.onRegistrationFailed.

The application should call unregisterService when the service registration is no longer required, and/or whenever the application is stopped.

registerServiceInfoCallback

fun registerServiceInfoCallback(
    serviceInfo: NsdServiceInfo, 
    executor: Executor, 
    listener: NsdManager.ServiceInfoCallback
): Unit

Register a callback to listen for updates to a service. An application can listen to a service to continuously monitor availability of given service. The callback methods will be called on the passed executor. And service updates are sent with continuous calls to ServiceInfoCallback.onServiceUpdated. This is different from #resolveService which provides one shot service information.

An application can listen to a service once a time. It needs to cancel the registration before registering other callbacks. Upon failure to register a callback for example if it's a duplicated registration, the application is notified through ServiceInfoCallback.onServiceInfoCallbackRegistrationFailed with FAILURE_BAD_PARAMETERS.

resolveService

fun resolveService(
    serviceInfo: NsdServiceInfo!, 
    listener: NsdManager.ResolveListener!
): Unit

Deprecated: the returned ServiceInfo may get stale at any time after resolution, including immediately after the callback is called, and may not contain some service information that could be delivered later, like additional host addresses. Prefer using registerServiceInfoCallback, which will keep the application up-to-date with the state of the service.

Resolve a discovered service. An application can resolve a service right before establishing a connection to fetch the IP and port details on which to setup the connection.

resolveService

fun resolveService(
    serviceInfo: NsdServiceInfo, 
    executor: Executor, 
    listener: NsdManager.ResolveListener
): Unit

Deprecated: the returned ServiceInfo may get stale at any time after resolution, including immediately after the callback is called, and may not contain some service information that could be delivered later, like additional host addresses. Prefer using registerServiceInfoCallback, which will keep the application up-to-date with the state of the service.

Resolve a discovered service. An application can resolve a service right before establishing a connection to fetch the IP and port details on which to setup the connection.

stopServiceDiscovery

fun stopServiceDiscovery(listener: NsdManager.DiscoveryListener!): Unit

Stop service discovery initiated with #discoverServices. An active service discovery is notified to the application with DiscoveryListener.onDiscoveryStarted and it stays active until the application invokes a stop service discovery. A successful stop is notified to with a call to DiscoveryListener.onDiscoveryStopped.

Upon failure to stop service discovery, application is notified through DiscoveryListener.onStopDiscoveryFailed.

stopServiceResolution

fun stopServiceResolution(listener: NsdManager.ResolveListener): Unit

Stop service resolution initiated with #resolveService. A successful stop is notified with a call to ResolveListener.onResolutionStopped.

Upon failure to stop service resolution for example if resolution is done or the requester stops resolution repeatedly, the application is notified ResolveListener.onStopResolutionFailed with FAILURE_OPERATION_NOT_RUNNING

unregisterService

fun unregisterService(listener: NsdManager.RegistrationListener!): Unit

Unregister a service registered through #registerService. A successful unregister is notified to the application with a call to RegistrationListener.onServiceUnregistered.

unregisterServiceInfoCallback

fun unregisterServiceInfoCallback(listener: NsdManager.ServiceInfoCallback): Unit

Unregister a callback registered with registerServiceInfoCallback. A successful unregistration is notified with a call to ServiceInfoCallback.onServiceInfoCallbackUnregistered. The same callback can only be reused after this is called.

If the callback is not already registered, this will throw with IllegalArgumentException.