lightbulb_outline Please take our October 2018 developer survey. Start survey
added in API level 5

BluetoothServerSocket

public final class BluetoothServerSocket
extends Object implements Closeable

java.lang.Object
   ↳ android.bluetooth.BluetoothServerSocket


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 Manifest.permission.BLUETOOTH permission.

Developer Guides

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

See also:

Summary

Public methods

BluetoothSocket accept()

Block until a connection is established.

BluetoothSocket accept(int timeout)

Block until a connection is established, with timeout.

void close()

Immediately close this socket, and release all associated resources.

String toString()

Returns a string representation of the object.

Inherited methods

Public methods

accept

added in API level 5
public BluetoothSocket accept ()

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

accept

added in API level 5
public BluetoothSocket accept (int timeout)

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

close

added in API level 5
public void close ()

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

toString

added in API level 5
public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

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

Returns
String a string representation of the object.