NsdServiceInfo

Kotlin |Java

class NsdServiceInfo : Parcelable

kotlin.Any
↳	android.net.nsd.NsdServiceInfo

A class representing service information for network service discovery

Summary

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public constructors
`NsdServiceInfo()`

Public methods
Int	`describeContents()` Implement the Parcelable interface
MutableMap<String!, ByteArray!>!	`getAttributes()` Retrieve attributes as a map of String keys to byte[] values.
InetAddress!	`getHost()` Get the host address.
MutableList<InetAddress!>	`getHostAddresses()` Get the host addresses.
Network?	`getNetwork()` Get the network where the service can be found.
Int	`getPort()` Get port number.
String!	`getServiceName()` Get the service name
String!	`getServiceType()` Get the service type
MutableSet<String!>	`getSubtypes()` Returns subtypes of this service instance.
Unit	`removeAttribute(key: String!)` Remove an attribute by key
Unit	`setAttribute(key: String!, value: String!)` Add a service attribute as a key/value pair.
Unit	`setHost(s: InetAddress!)` Set the host address
Unit	`setHostAddresses(addresses: MutableList<InetAddress!>)` Set the host addresses
Unit	`setNetwork(network: Network?)` Set the network where the service can be found.
Unit	`setPort(p: Int)` Set port number
Unit	`setServiceName(s: String!)` Set the service name
Unit	`setServiceType(s: String!)` Set the service type
Unit	`setSubtypes(subtypes: MutableSet<String!>)` Sets the subtypes to be advertised for this service instance.
String	`toString()`
Unit	`writeToParcel(dest: Parcel, flags: Int)` Implement the Parcelable interface

Properties
static Parcelable.Creator<NsdServiceInfo!>	`CREATOR` Implement the Parcelable interface

Public constructors

NsdServiceInfo

Added in API level 16

NsdServiceInfo()

Public methods

describeContents

Added in API level 16

fun describeContents(): Int

Implement the Parcelable interface

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

getAttributes

Added in API level 21

fun getAttributes(): MutableMap<String!, ByteArray!>!

Retrieve attributes as a map of String keys to byte[] values. The attributes map is only valid for a resolved service.

The returned map is unmodifiable; changes must be made through setAttribute and removeAttribute.

getHost

Added in API level 16
Deprecated in API level 36

fun getHost(): InetAddress!

Deprecated: Use getHostAddresses() to get the entire list of addresses for the host.

Get the host address. The host address is valid for a resolved service.

getHostAddresses

Added in API level 34
Also in T Extensions 7

fun getHostAddresses(): MutableList<InetAddress!>

Get the host addresses. All host addresses are valid for the resolved service. All addresses share the same port

Return
`MutableList<InetAddress!>`	This value cannot be `null`.

See Also

#getPort()

getNetwork

Added in API level 33
Also in T Extensions 3

fun getNetwork(): Network?

Get the network where the service can be found. This is set if this NsdServiceInfo was obtained from android.net.nsd.NsdManager#discoverServices or android.net.nsd.NsdManager#resolveService, unless the service was found on a network interface that does not have a Network (such as a tethering downstream, where services are advertised from devices connected to this device via tethering).

Return
`Network?`	This value may be `null`.

getPort

Added in API level 16

fun getPort(): Int

Get port number. The port number is valid for a resolved service. The port is valid for all addresses.

See Also

#getHostAddresses()

getServiceName

Added in API level 16

fun getServiceName(): String!

Get the service name

getServiceType

Added in API level 16

fun getServiceType(): String!

Get the service type

getSubtypes

Added in API level 35
Also in T Extensions 12

fun getSubtypes(): MutableSet<String!>

Returns subtypes of this service instance. When this object is returned by the service discovery/browse APIs (etc. NsdManager.DiscoveryListener), the return value may or may not include the subtypes of this service.

Return
`MutableSet<String!>`	This value cannot be `null`.

removeAttribute

Added in API level 21

fun removeAttribute(key: String!): Unit

Remove an attribute by key

setAttribute

Added in API level 21

fun setAttribute(
    key: String!, 
    value: String!
): Unit

Add a service attribute as a key/value pair.

Service attributes are included as DNS-SD TXT record pairs.

The key must be US-ASCII printable characters, excluding the '=' character. Values may be UTF-8 strings or null. The total length of key + value must be less than 255 bytes.

Keys should be short, ideally no more than 9 characters, and unique per instance of NsdServiceInfo. Calling setAttribute twice with the same key will overwrite first value.

setHost

Added in API level 16
Deprecated in API level 36

fun setHost(s: InetAddress!): Unit

Deprecated: Use setHostAddresses(java.util.List) to set multiple addresses for the host.

Set the host address

setHostAddresses

Added in API level 34
Also in T Extensions 7

fun setHostAddresses(addresses: MutableList<InetAddress!>): Unit

Set the host addresses

Parameters
`addresses`	MutableList<InetAddress!>: This value cannot be `null`.

setNetwork

Added in API level 33
Also in T Extensions 3

fun setNetwork(network: Network?): Unit

Set the network where the service can be found.

Parameters
`network`	Network?: The network, or null to search for, or to announce, the service on all connected networks.

setPort

Added in API level 16

fun setPort(p: Int): Unit

Set port number

setServiceName

Added in API level 16

fun setServiceName(s: String!): Unit

Set the service name

setServiceType

Added in API level 16

fun setServiceType(s: String!): Unit

Set the service type

setSubtypes

Added in API level 35
Also in T Extensions 12

fun setSubtypes(subtypes: MutableSet<String!>): Unit

Sets the subtypes to be advertised for this service instance. The elements in subtypes should be the subtype identifiers which have the trailing "._sub" removed. For example, the subtype should be "_printer" for "_printer._sub._http._tcp.local". Only one subtype will be registered if multiple elements of subtypes have the same case-insensitive value.

Parameters
`subtypes`	MutableSet<String!>: This value cannot be `null`.

toString

Added in API level 16

fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 16

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Implement the Parcelable interface

Parameters
`dest`	Parcel: The Parcel in which the object should be written. This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 16

static val CREATOR: Parcelable.Creator<NsdServiceInfo!>

Implement the Parcelable interface