Added in API level 36
Also in U Extensions 17

L2capNetworkSpecifier

Kotlin |Java

class L2capNetworkSpecifier : NetworkSpecifier, Parcelable

kotlin.Any
↳	android.net.NetworkSpecifier
	↳	android.net.L2capNetworkSpecifier

A NetworkSpecifier used to identify an L2CAP network over BLE. An L2CAP network is not symmetrical, meaning there exists both a server (Bluetooth peripheral) and a client (Bluetooth central) node. This specifier contains the information required to request a client L2CAP network using android.net.ConnectivityManager#requestNetwork while specifying the remote MAC address, and Protocol/Service Multiplexer (PSM). It can also contain information allocated by the system when reserving a server network using ConnectivityManager.reserveNetwork such as the Protocol/Service Multiplexer (PSM). In both cases, the header compression option must be specified. An L2CAP server network allocates a Protocol/Service Multiplexer (PSM) to be advertised to the client. A new server network must always be reserved using ConnectivityManager#reserveNetwork. The subsequent ConnectivityManager.NetworkCallback.onReserved(NetworkCapabilities) callback includes an L2CapNetworkSpecifier. The getPsm() method will return the Protocol/Service Multiplexer (PSM) of the reserved network so that the server can advertise it to the client and the client can connect. An L2CAP server network is backed by a android.bluetooth.BluetoothServerSocket which can, in theory, accept many connections. However, before SDK version Build.VERSION_CODES.VANILLA_ICE_CREAM Bluetooth APIs do not expose the channel ID, so these connections are indistinguishable. In practice, this means that the network matching semantics in ConnectivityService will tear down all but the first connection. When the connection between client and server completes, a Network whose capabilities satisfy this L2capNetworkSpecifier will connect and the usual callbacks, such as NetworkCallback#onAvailable, will be called on the callback object passed to ConnectivityManager#reserveNetwork or ConnectivityManager#requestNetwork.

Summary

Nested classes
	`Builder` A builder class for L2capNetworkSpecifier.

Constants
static Int	`HEADER_COMPRESSION_6LOWPAN` Use 6lowpan header compression as specified in rfc6282.
static Int	`HEADER_COMPRESSION_ANY` Accept any form of header compression.
static Int	`HEADER_COMPRESSION_NONE` Do not compress packets on this network.
static Int	`PSM_ANY` Match any Protocol/Service Multiplexer (PSM).
static Int	`ROLE_ANY` Match any role.
static Int	`ROLE_CLIENT` Specifier describes a client network, i.
static Int	`ROLE_SERVER` Specifier describes a server network, i.

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 methods
Boolean	`canBeSatisfiedBy(other: NetworkSpecifier!)`
Int	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
Int	`getHeaderCompression()` Returns the compression mechanism for this network.
Int	`getPsm()` Returns the Protocol/Service Multiplexer (PSM) for this network to connect to.
MacAddress?	`getRemoteAddress()` Returns the remote MAC address for this network to connect to.
Int	`getRole()` Returns the role to be used for this network.
Int	`hashCode()` Returns a hash code value for the object.
NetworkSpecifier?	`redact()`
String	`toString()` Returns a string representation of the object.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<L2capNetworkSpecifier!>	`CREATOR`

Constants

HEADER_COMPRESSION_6LOWPAN

Added in API level 36
Also in U Extensions 17

static val HEADER_COMPRESSION_6LOWPAN: Int

Use 6lowpan header compression as specified in rfc6282.

Value: 2

HEADER_COMPRESSION_ANY

Added in API level 36
Also in U Extensions 17

static val HEADER_COMPRESSION_ANY: Int

Accept any form of header compression. This option is only meaningful in NetworkRequests. Specifiers for actual L2CAP networks never have this option set.

Value: 0

HEADER_COMPRESSION_NONE

Added in API level 36
Also in U Extensions 17

static val HEADER_COMPRESSION_NONE: Int

Do not compress packets on this network.

Value: 1

PSM_ANY

Added in API level 36
Also in U Extensions 17

static val PSM_ANY: Int

Match any Protocol/Service Multiplexer (PSM). This PSM value is only meaningful in NetworkRequests. Specifiers for actual L2CAP networks never have this value set.

Value: 0

ROLE_ANY

Added in API level 36
Also in U Extensions 17

static val ROLE_ANY: Int

Match any role. This role is only meaningful in NetworkRequests. Specifiers for actual L2CAP networks never have this role set.

Value: 0

ROLE_CLIENT

Added in API level 36
Also in U Extensions 17

static val ROLE_CLIENT: Int

Specifier describes a client network, i.e., the device is the Bluetooth central.

Value: 1

ROLE_SERVER

Added in API level 36
Also in U Extensions 17

static val ROLE_SERVER: Int

Specifier describes a server network, i.e., the device is the Bluetooth peripheral.

Value: 2

Public methods

canBeSatisfiedBy

Added in API level 36
Also in U Extensions 17

fun canBeSatisfiedBy(other: NetworkSpecifier!): Boolean

describeContents

Added in API level 36

fun describeContents(): Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

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

equals

Added in API level 36

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
`obj`	the reference object with which to compare.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getHeaderCompression

Added in API level 36
Also in U Extensions 17

fun getHeaderCompression(): Int

Returns the compression mechanism for this network.

Return
`Int`	Value is one of the following: `HEADER_COMPRESSION_ANY` `HEADER_COMPRESSION_NONE` `HEADER_COMPRESSION_6LOWPAN`

getPsm

Added in API level 36
Also in U Extensions 17

fun getPsm(): Int

Returns the Protocol/Service Multiplexer (PSM) for this network to connect to.

getRemoteAddress

Added in API level 36
Also in U Extensions 17

fun getRemoteAddress(): MacAddress?

Returns the remote MAC address for this network to connect to. The remote address is only meaningful for networks that have ROLE_CLIENT. When receiving this L2capNetworkSpecifier from Connectivity APIs such as a ConnectivityManager.NetworkCallback, the MAC address is redacted.

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

getRole

Added in API level 36
Also in U Extensions 17

fun getRole(): Int

Returns the role to be used for this network.

Return
`Int`	Value is one of the following: `ROLE_ANY` `ROLE_CLIENT` `ROLE_SERVER`

hashCode

Added in API level 36

fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Return
`Int`	a hash code value for this object.

redact

Added in API level 36
Also in U Extensions 17

fun redact(): NetworkSpecifier?

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

toString

Added in API level 36

fun toString(): String

Returns a string representation of the object.

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 36

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

Flatten this object in to a Parcel.

Parameters
`dest`	Parcel: 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 the following: `PARCELABLE_WRITE_RETURN_VALUE`

Properties

CREATOR

Added in API level 36
Also in U Extensions 17

static val CREATOR: Parcelable.Creator<L2capNetworkSpecifier!>