# Print output for @column tags ?>
Developers

- Design
- Develop
- Distribute

Developer Console

## Most visited

## Recently visited

## Results for

Summary: Constants | Methods | Inherited Methods

# BluetoothSocket

`public final class BluetoothSocket`
`extends Object` `implements Closeable`

java.lang.Object
↳ | android.bluetooth.BluetoothSocket

A connected or connecting 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 `BluetoothSocket` for connecting to a known device, use `BluetoothDevice#createRfcommSocketToServiceRecord`. Then call `connect()` to attempt a connection to the remote device. This call will block until a connection is established or the connection fails.

To create a `BluetoothSocket` as a server (or "host"), see the `BluetoothServerSocket` documentation.

Once the socket is connected, whether initiated as a client or accepted as a server, open the IO streams by calling `getInputStream()` and `getOutputStream()` in order to retrieve `InputStream` and `OutputStream` objects, respectively, which are automatically connected to the socket.

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

Note: Requires the `Manifest.permission.BLUETOOTH` permission.

### Developer Guides

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

See also:

- `BluetoothServerSocket`
- `InputStream`
- `OutputStream`

## Summary

### Constants
`int` | `TYPE_L2CAP` L2CAP socket
`int` | `TYPE_RFCOMM` RFCOMM socket
`int` | `TYPE_SCO` SCO socket

### Public methods
`void` | `close()` Closes this stream and releases any system resources associated with it.
`void` | `connect()` Attempt to connect to a remote device.
`int` | `getConnectionType()` Get the type of the underlying connection.
`InputStream` | `getInputStream()` Get the input stream associated with this socket.
`int` | `getMaxReceivePacketSize()` Get the maximum supported Receive packet size for the underlying transport.
`int` | `getMaxTransmitPacketSize()` Get the maximum supported Transmit packet size for the underlying transport.
`OutputStream` | `getOutputStream()` Get the output stream associated with this socket.
`BluetoothDevice` | `getRemoteDevice()` Get the remote device this socket is connecting, or connected, to.
`boolean` | `isConnected()` Get the connection status of this socket, ie, whether there is an active connection with remote device.

### Inherited methods
From class `java.lang.Object`
`Object` | `clone()` Creates and returns a copy of this object.
`boolean` | `equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void` | `finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>` | `getClass()` Returns the runtime class of this `Object`.
`int` | `hashCode()` Returns a hash code value for the object.
`final void` | `notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void` | `notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String` | `toString()` Returns a string representation of the object.
`final void` | `wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void` | `wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void` | `wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
From interface `java.io.Closeable`
`abstract void` | `close()` Closes this stream and releases any system resources associated with it.
From interface `java.lang.AutoCloseable`
`abstract void` | `close()` Closes this resource, relinquishing any underlying resources.

## Constants

### TYPE_L2CAP

    public static final int TYPE_L2CAP

L2CAP socket

Constant Value: 3 (0x00000003)

### TYPE_RFCOMM

    public static final int TYPE_RFCOMM

RFCOMM socket

Constant Value: 1 (0x00000001)

### TYPE_SCO

    public static final int TYPE_SCO

SCO socket

Constant Value: 2 (0x00000002)

## Public methods

### close

    public void close ()

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`.

Throws
`IOException` |

### connect

    public void connect ()

Attempt to connect to a remote device.

This method will block until a connection is made or the connection fails. If this method returns without an exception then this socket is now connected.

Creating new connections to remote Bluetooth devices should not be attempted while device discovery is in progress. Device discovery is a heavyweight procedure on the Bluetooth adapter and will significantly slow a device connection. Use `BluetoothAdapter#cancelDiscovery()` to cancel an ongoing discovery. Discovery is not managed by the Activity, but is run as a system service, so an application should always call `BluetoothAdapter#cancelDiscovery()` even if it did not directly request a discovery, just to be sure.

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

Throws
`IOException` | on error, for example connection failure

### getConnectionType

    public int getConnectionType ()

Get the type of the underlying connection.

Returns
`int` | one of `TYPE_RFCOMM`, `TYPE_SCO` or `TYPE_L2CAP`

### getInputStream

    public InputStream getInputStream ()

Get the input stream associated with this socket.

The input stream will be returned even if the socket is not yet connected, but operations on that stream will throw IOException until the associated socket is connected.

Returns
`InputStream` | InputStream

Throws
`IOException` |

### getMaxReceivePacketSize

    public int getMaxReceivePacketSize ()

Get the maximum supported Receive packet size for the underlying transport. Use this to optimize the reads done on the input stream, as any call to read will return a maximum of this amount of bytes - or for some transports a multiple of this value.

Returns
`int` | the maximum supported Receive packet size for the underlying transport.

### getMaxTransmitPacketSize

    public int getMaxTransmitPacketSize ()

Get the maximum supported Transmit packet size for the underlying transport. Use this to optimize the writes done to the output socket, to avoid sending half full packets.

Returns
`int` | the maximum supported Transmit packet size for the underlying transport.

### getOutputStream

    public OutputStream getOutputStream ()

Get the output stream associated with this socket.

The output stream will be returned even if the socket is not yet connected, but operations on that stream will throw IOException until the associated socket is connected.

Returns
`OutputStream` | OutputStream

Throws
`IOException` |

### getRemoteDevice

    public BluetoothDevice getRemoteDevice ()

Get the remote device this socket is connecting, or connected, to.

Returns
`BluetoothDevice` | remote device

### isConnected

    public boolean isConnected ()

Get the connection status of this socket, ie, whether there is an active connection with remote device.

Returns
`boolean` | true if connected false if not connected

Full name *
Email address *
Company / developer name
One of your Play Store app URLs *
Which best describes your business:*
Apps
Games
Apps & Games
*
*