# Modules.Bluetooth.BluetoothServerSocket

A listening Bluetooth socket.

Availability

1.0.0

Extends

# Overview

The purpose of the BluetoothSocketServer object is to listen for incoming connection requests and provide a connected BluetoothSocket after a request is accepted.

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

# 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

# close

Availability

1.0.0

close() → void

Closes the server socket.

This method, when called, closes the server socket. One cannot start accepting connections again after calling this method. On error, this method will throw an exception.

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

# isAccepting

Availability

1.0.0

isAccepting() → Boolean

Determines whether the server socket is currently accepting connections.

Returns

True if the server socket is accepting connections, 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

# startAccept

Availability

1.0.0

startAccept([keepListening]) → void

Inform the server socket to start accepting incoming connections.

This method, when called, starts listening for the incoming Bluetooth connections and block until a connection is established. Listen for the connectionReceived event to be notified when a connection is received or the error event when an error occured during accepting connection.

Parameters

Name	Type	Description
`keepListening`	Boolean	Defines whether the server socket should keep listening after an incoming connection was received. If this parameter is false, it will stop accepting connections after a single connection is recieved.

Returns

Type: void

# stopAccept

Availability

1.0.0

stopAccept() → void

Inform the server socket to stop accepting incoming connections.

This method, when called stop accepting incoming connections. One can again start accepting connections via startAccept method after calling this method. On error, this method will throw an exception.

Returns

Type: void

# Events

# connectionReceived

Availability

1.0.0

Fired when the server socket receives an incoming connection.

Properties

Name	Type	Description
socket	Modules.Bluetooth.BluetoothSocket	The socket object bind to the connection.
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 a socket operation fails.

Properties

Name	Type	Description
errorMessage	String	Description of the error.
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.