Android APIs
public final class

BluetoothServerSocket

extends Object
implements Closeable
java.lang.Object
   ↳ android.bluetooth.BluetoothServerSocket

Class Overview

A listening Bluetooth socket.

The interface for Bluetooth Sockets is similar to that of TCP sockets: Socket and ServerSocket. On the server side, use a BluetoothServerSocket to create a listening server socket. When a connection is accepted by the BluetoothServerSocket, it will return a new BluetoothSocket to manage the connection. On the client side, use a single BluetoothSocket to both initiate an outgoing connection and to manage the connection.

The most common type of Bluetooth socket is RFCOMM, which is the type supported by the Android APIs. RFCOMM is a connection-oriented, streaming transport over Bluetooth. It is also known as the Serial Port Profile (SPP).

To create a listening BluetoothServerSocket that's ready for incoming connections, use BluetoothAdapter.listenUsingRfcommWithServiceRecord(). Then call accept() to listen for incoming connection requests. This call will block until a connection is established, at which point, it will return a BluetoothSocket to manage the connection. Once the BluetoothSocket is acquired, it's a good idea to call close() on the BluetoothServerSocket when it's no longer needed for accepting connections. Closing the BluetoothServerSocket will not close the returned BluetoothSocket.

BluetoothServerSocket is thread safe. In particular, close() will always immediately abort ongoing operations and close the server socket.

Note: Requires the BLUETOOTH permission.

Developer Guides

For more information about using Bluetooth, read the Bluetooth developer guide.

See also:

Summary

Public Methods
BluetoothSocket accept(int timeout)
Block until a connection is established, with timeout.
BluetoothSocket accept()
Block until a connection is established.
void close()
Immediately close this socket, and release all associated resources.
String toString()
Returns a string containing a concise, human-readable description of this object.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.io.Closeable
From interface java.lang.AutoCloseable

Public Methods

public BluetoothSocket accept (int timeout)

Added in API level 5

Block until a connection is established, with timeout.

Returns a connected BluetoothSocket on successful connection.

Once this call returns, it can be called again to accept subsequent incoming connections.

close() can be used to abort this call from another thread.

Parameters
timeout int
Returns
BluetoothSocket a connected BluetoothSocket
Throws
IOException on error, for example this call was aborted, or timeout

public BluetoothSocket accept ()

Added in API level 5

Block until a connection is established.

Returns a connected BluetoothSocket on successful connection.

Once this call returns, it can be called again to accept subsequent incoming connections.

close() can be used to abort this call from another thread.

Returns
BluetoothSocket a connected BluetoothSocket
Throws
IOException on error, for example this call was aborted, or timeout

public void close ()

Added in API level 5

Immediately close this socket, and release all associated resources.

Causes blocked calls on this socket in other threads to immediately throw an IOException.

Closing the BluetoothServerSocket will not close any BluetoothSocket received from accept().

Throws
IOException

public String toString ()

Added in API level 5

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
String a printable representation of this object.