# Modules.Bluetooth.BluetoothSocket

A connected or connecting Bluetooth socket.

Availability

1.0.0

Extends

# Overview

The BluetoothSocket object used to make a connection to the remote device. It is used to both initiate an outgoing connection and to manage the connection.

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

# readBufferSize

Availability

1.0.0

readBufferSize :Number

The size of the read buffer in bytes. By default, the buffer size is 4*1024 bytes.

# Methods

# addEventListener

Availability

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

# cancelConnect

Availability

1.0.0

cancelConnect() → void

Drops the ongoing connection attempt if in progress.

If there is no connection attempt in progress, it does nothing.

Returns

Type: void

# close

Availability

1.0.0

close() → void

Closes the socket.

Listen for the disconnected event to be notified when socket is closed or the error in case of failure.

Returns

Type: void

# connect

Availability

1.0.0

connect() → void

Starts the connection to the remote device.

This call will block until a connection is established or the connection fails. Listen for the connected event to be notified when the connection is established.

Returns

Type: void

# fireEvent

Availability

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

getReadBufferSize() → Number

Get the size of the read buffer in bytes.

Returns

Size of the read buffer in bytes.

Type: Number

# getRemoteDevice

Availability

1.0.0

getRemoteDevice() → Modules.Bluetooth.BluetoothDevice

Get the remote device this socket is associated with.

Returns

The object representing the device to which this socket is connected to.

Type: Modules.Bluetooth.BluetoothDevice

# isConnected

Availability

1.0.0

isConnected() → Boolean

Determines whether there is an active connection with the remote device.

Returns

connection status of this socket

Type: Boolean

# isConnecting

Availability

1.0.0

isConnecting() → Boolean

Determines whether there is an ongoing connection attempt in progress.

Returns

True if connection attempt in progress false otherwise

Type: Boolean

# removeEventListener

Availability

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

setReadBufferSize(newReadBufferSize) → 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 connection. By default, the buffer size is 4*1024 bytes.

Parameters

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

Returns

Type: void

# write

Availability

1.0.0

write(buffer) → void

Sends an array of bytes over the socket.

If the socket is not connected, then this method will throw an error.

Parameters

Name	Type	Description
`buffer`	Titanium.Buffer	Represents the data to be sent over the socket.

Returns

Type: void

# Events

# connected

Availability

1.0.0

Fired when the connection through the socket is established.

Properties

Name	Type	Description
socket	Modules.Bluetooth.BluetoothSocket	The socket through which the connection was made.
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.

# disconnected

Availability

1.0.0

Fired when connection to the socket is lost.

Properties

Name	Type	Description
socket	Modules.Bluetooth.BluetoothSocket	The socket on which the data was received.
message	String	The localized message of the exception that accompanies the disconnect event. The localized message is `Socket is Disconnected`.
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.

# error

Availability

1.0.0

Fired when an operation fails.

Properties

Name	Type	Description
socket	Modules.Bluetooth.BluetoothSocket	The socket that encounter the error.
errorMessage	String	The error message for the error encountered on the socket. The error can be encountered while performing any socket operations like- socket connecting to remote device, cancelling the connecting operation, closing the socket, socket connection gets lost etc. Note:- If the error message "Device connection was lost." comes, that signifies the connection with the socket is lost which can occur if the device goes out of bluetooth range, remote device deliberately disconnects the connection, etc.
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.

# receivedData

Availability

1.0.0

Fired when data is received on this socket.

Properties

Name	Type	Description
socket	Modules.Bluetooth.BluetoothSocket	The socket on which the data was received.
data	Titanium.Buffer	A buffer object holding the data received.
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.