# Modules.BLE.L2CAPChannel

L2Cap allow us to open a side channel, with it we can directly read and write without any framing limitation, packet size limitations. It’s a direct way to talk between our devices and accessories.

Availability

1.1.0

1.0.0

Extends

Titanium.Proxy

# Overview

L2Cap Channel on the lowest level is the stream of data between two devices. It’s actually the protocol that has been used underneath for all types of communication between two devices. So L2Cap has been used from the first day of Bluetooth communications. but now with the L2CAP class, we use is directly talk over these channels.

# Properties

# peer

Availability

1.0.0

peer :Modules.BLE.Peer

The peer connected to the channel

# psm

Availability

1.1.0

1.0.0

psm :Number

The PSM of the channel.

# Methods

# close

Availability

1.1.0

1.0.0

close() → void

closes the l2cap channel

Returns

Type: void

# getReadBufferSize

Availability

1.1.0

1.0.0

getReadBufferSize() → Number

Get the size of the read buffer in bytes.

Returns

Size of the read buffer in bytes.

Type: Number

# setReadBufferSize

Availability

1.1.0

1.0.0

setReadBufferSize(size) → void

Sets the size of the read buffer in bytes.

You can set the read buffer size at any time, but it will only take effect during the next read. By default, the buffer size is 1024 bytes.

Parameters

Name	Type	Description
`size`	Number	The desired size of the read buffer in bytes.

Returns

Type: void

# write

Availability

1.1.0

1.0.0

write(data) → void

write data to channel

Parameters

Name	Type	Description
`data`	Titanium.Buffer	Titanium.Buffer object to write data on channel

Returns

Type: void

# Events

# onDataReceived

Availability

1.1.0

1.0.0

Fired whenever new data recived on channel.

Properties

Name	Type	Description
data	Titanium.Buffer	Titanium.Buffer object which represent the read data
source	Object	Source object that fired the event.
type	String	Name of the event fired.
bubbles	Boolean	True if the event will try to bubble up if possible.
cancelBubble	Boolean	Set to true to stop the event from bubbling.

# onStreamError

Availability

1.1.0

1.0.0

Fired whenever there is some error in reading or writing.

Properties

Name	Type	Description
errorCode	String	The error code
errorDomain	String	The error domain
errorDescription	String	The error description
source	Object	Source object that fired the event.
type	String	Name of the event fired.
bubbles	Boolean	True if the event will try to bubble up if possible.
cancelBubble	Boolean	Set to true to stop the event from bubbling.

# onStreamEndEncountered

Availability

1.0.0

Fired whenever the end of the stream has been reached.