Modules.Bluetooth.BluetoothSocket

A connected or connecting Bluetooth socket.

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.

Extends: Titanium.Proxy · Since: 1.0.0 · Platforms: android

Properties

readBufferSize

1.0.0

Type: Number

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

Methods

cancelConnect

1.0.0

Drops the ongoing connection attempt if in progress.

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

close

1.0.0

Closes the socket.

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

connect

1.0.0

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.

getReadBufferSize

1.0.0

Get the size of the read buffer in bytes.

Returns: Number — Size of the read buffer in bytes.

getRemoteDevice

1.0.0

Get the remote device this socket is associated with.

Returns: Modules.Bluetooth.BluetoothDevice — The object representing the device to which this socket is connected to.

isConnected

1.0.0

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

Returns: Boolean — connection status of this socket

isConnecting

1.0.0

Determines whether there is an ongoing connection attempt in progress.

Returns: Boolean — True if connection attempt in progress false otherwise

setReadBufferSize

1.0.0

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	Summary	Optional
newReadBufferSize	Number	The desired size of the read buffer in bytes.	No

write

1.0.0

Sends an array of bytes over the socket.

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

Parameters:

Name	Type	Summary	Optional
buffer	Titanium.Buffer	Represents the data to be sent over the socket.	No

Events

connected

1.0.0

Fired when the connection through the socket is established.

Event Properties:

Name	Type	Summary
socket	Modules.Bluetooth.BluetoothSocket	The socket through which the connection was made.

disconnected

1.0.0

Fired when connection to the socket is lost.

Event Properties:

Name	Type	Summary
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.

error

1.0.0

Fired when an operation fails.

Event Properties:

Name	Type	Summary
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.

receivedData

1.0.0

Fired when data is received on this socket.

Event Properties:

Name	Type	Summary
socket	Modules.Bluetooth.BluetoothSocket	The socket on which the data was received.
data	Titanium.Buffer	A buffer object holding the data received.