# 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

# apiName READONLY

Availability

3.2.0

apiName :String

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button returns Ti.UI.Button.

# bubbleParent

Availability

3.0.0

bubbleParent :Boolean

Indicates if the proxy will bubble an event to its parent.

Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.

Default: true

# lifecycleContainer

Availability

3.6.0

lifecycleContainer :Titanium.UI.Window | Titanium.UI.TabGroup

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.

# 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

# addEventListener

Availability

1.1.0

1.0.0

addEventListener(name, callback) → void

Adds the specified callback as an event listener for the named event.

Parameters

Name	Type	Description
`name`	String	Name of the event.
`callback`	Callback<Titanium.Event>	Callback function to invoke when the event is fired.

Returns

Type: void

# applyProperties

Availability

3.0.0

applyProperties(props) → void

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.

Parameters

Name	Type	Description
`props`	Dictionary	A dictionary of properties to apply.

Returns

Type: void

# close

Availability

1.1.0

1.0.0

close() → void

closes the l2cap channel

Returns

Type: void

# fireEvent

Availability

1.1.0

1.0.0

fireEvent(name[, event]) → void

Fires a synthesized event to any registered listeners.

Parameters

Name	Type	Description
`name`	String	Name of the event.
`event`	Dictionary	A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

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

# removeEventListener

Availability

1.1.0

1.0.0

removeEventListener(name, callback) → void

Removes the specified callback as an event listener for the named event.

Multiple listeners can be registered for the same event, so the callback parameter is used to determine which listener to remove.

When adding a listener, you must save a reference to the callback function in order to remove the listener later:

var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);

To remove the listener, pass in a reference to the callback function:

window.removeEventListener('click', listener);

Parameters

Name	Type	Description
`name`	String	Name of the event.
`callback`	Callback<Titanium.Event>	Callback function to remove. Must be the same function passed to `addEventListener`.

Returns

Type: void

# 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.