Added in API level 36
Also in U Extensions 17

Summary: Nested Classes | Constants | Inherited Constants | Fields | Methods | Inherited Methods

L2capNetworkSpecifier

---

Kotlin |Java

public final class L2capNetworkSpecifier
extends NetworkSpecifier implements Parcelable

java.lang.Object
↳	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 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 ERROR(/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 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 ERROR(/NetworkCallback#onAvailable), will be called on the callback object passed to ConnectivityManager#reserveNetwork or ConnectivityManager#requestNetwork.

Summary

Nested classes
class	L2capNetworkSpecifier.Builder A builder class for L2capNetworkSpecifier.

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

Inherited constants

From interface android.os.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(Parcel, int): 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)".

Fields
public static final Creator<L2capNetworkSpecifier>	CREATOR

Public methods
boolean	canBeSatisfiedBy(NetworkSpecifier other)
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
boolean	equals(Object obj) 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.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Constants

HEADER_COMPRESSION_6LOWPAN

Added in API level 36
Also in U Extensions 17

public static final int HEADER_COMPRESSION_6LOWPAN

Use 6lowpan header compression as specified in rfc6282.

Constant Value: 2 (0x00000002)

HEADER_COMPRESSION_ANY

Added in API level 36
Also in U Extensions 17

public static final int HEADER_COMPRESSION_ANY

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

Constant Value: 0 (0x00000000)

HEADER_COMPRESSION_NONE

Added in API level 36
Also in U Extensions 17

public static final int HEADER_COMPRESSION_NONE

Do not compress packets on this network.

Constant Value: 1 (0x00000001)

PSM_ANY

Added in API level 36
Also in U Extensions 17

public static final int PSM_ANY

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

Constant Value: 0 (0x00000000)

ROLE_ANY

Added in API level 36
Also in U Extensions 17

public static final int ROLE_ANY

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

Constant Value: 0 (0x00000000)

ROLE_CLIENT

Added in API level 36
Also in U Extensions 17

public static final int ROLE_CLIENT

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

Constant Value: 1 (0x00000001)

ROLE_SERVER

Added in API level 36
Also in U Extensions 17

public static final int ROLE_SERVER

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

Constant Value: 2 (0x00000002)

Fields

CREATOR

Added in API level 36
Also in U Extensions 17

public static final Creator<L2capNetworkSpecifier> CREATOR

Public methods

canBeSatisfiedBy

Added in API level 36
Also in U Extensions 17

public boolean canBeSatisfiedBy (NetworkSpecifier other)

Parameters
other	NetworkSpecifier

Returns
boolean

describeContents

Added in API level 36

public int describeContents ()

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(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
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

public boolean equals (Object obj)

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	Object: the reference object with which to compare.

Returns
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

public int getHeaderCompression ()

Returns the compression mechanism for this network.

Returns
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

public int getPsm ()

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

Returns
int

getRemoteAddress

Added in API level 36
Also in U Extensions 17

public MacAddress getRemoteAddress ()

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.

Returns
MacAddress	This value may be null.

getRole

Added in API level 36
Also in U Extensions 17

public int getRole ()

Returns the role to be used for this network.

Returns
int	Value is one of the following: ROLE_ANY ROLE_CLIENT ROLE_SERVER

hashCode

Added in API level 36

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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.

Returns
int	a hash code value for this object.

redact

Added in API level 36
Also in U Extensions 17

public NetworkSpecifier redact ()

Returns
NetworkSpecifier	This value may be null.

toString

Added in API level 36

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 36

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE