129 lines
5.2 KiB
Java
129 lines
5.2 KiB
Java
/*
|
|
* Copyright (C) 2009 The Android Open Source Project
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
package android.bluetooth;
|
|
|
|
import android.os.Handler;
|
|
|
|
import java.io.Closeable;
|
|
import java.io.IOException;
|
|
|
|
/**
|
|
* A listening Bluetooth socket.
|
|
*
|
|
* <p>The interface for Bluetooth Sockets is similar to that of TCP sockets:
|
|
* {@link java.net.Socket} and {@link java.net.ServerSocket}. On the server
|
|
* side, use a {@link BluetoothServerSocket} to create a listening server
|
|
* socket. When a connection is accepted by the {@link BluetoothServerSocket},
|
|
* it will return a new {@link BluetoothSocket} to manage the connection.
|
|
* On the client side, use a single {@link BluetoothSocket} to both initiate
|
|
* an outgoing connection and to manage the connection.
|
|
*
|
|
* <p>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).
|
|
*
|
|
* <p>To create a listening {@link BluetoothServerSocket} that's ready for
|
|
* incoming connections, use
|
|
* {@link BluetoothAdapter#listenUsingRfcommWithServiceRecord
|
|
* BluetoothAdapter.listenUsingRfcommWithServiceRecord()}. Then call
|
|
* {@link #accept()} to listen for incoming connection requests. This call
|
|
* will block until a connection is established, at which point, it will return
|
|
* a {@link BluetoothSocket} to manage the connection. Once the {@link
|
|
* BluetoothSocket} is acquired, it's a good idea to call {@link #close()} on
|
|
* the {@link BluetoothServerSocket} when it's no longer needed for accepting
|
|
* connections. Closing the {@link BluetoothServerSocket} will <em>not</em>
|
|
* close the returned {@link BluetoothSocket}.
|
|
*
|
|
* <p>{@link BluetoothServerSocket} is thread
|
|
* safe. In particular, {@link #close} will always immediately abort ongoing
|
|
* operations and close the server socket.
|
|
*
|
|
* <p class="note"><strong>Note:</strong>
|
|
* Requires the {@link android.Manifest.permission#BLUETOOTH} permission.
|
|
*
|
|
* {@see BluetoothSocket}
|
|
*/
|
|
public final class BluetoothServerSocket implements Closeable {
|
|
|
|
/*package*/ final BluetoothSocket mSocket;
|
|
private Handler mHandler;
|
|
private int mMessage;
|
|
|
|
/**
|
|
* Construct a socket for incoming connections.
|
|
* @param type type of socket
|
|
* @param auth require the remote device to be authenticated
|
|
* @param encrypt require the connection to be encrypted
|
|
* @param port remote port
|
|
* @throws IOException On error, for example Bluetooth not available, or
|
|
* insufficient privileges
|
|
*/
|
|
/*package*/ BluetoothServerSocket(int type, boolean auth, boolean encrypt, int port)
|
|
throws IOException {
|
|
mSocket = new BluetoothSocket(type, -1, auth, encrypt, null, port, null);
|
|
}
|
|
|
|
/**
|
|
* Block until a connection is established.
|
|
* <p>Returns a connected {@link BluetoothSocket} on successful connection.
|
|
* <p>Once this call returns, it can be called again to accept subsequent
|
|
* incoming connections.
|
|
* <p>{@link #close} can be used to abort this call from another thread.
|
|
* @return a connected {@link BluetoothSocket}
|
|
* @throws IOException on error, for example this call was aborted, or
|
|
* timeout
|
|
*/
|
|
public BluetoothSocket accept() throws IOException {
|
|
return accept(-1);
|
|
}
|
|
|
|
/**
|
|
* Block until a connection is established, with timeout.
|
|
* <p>Returns a connected {@link BluetoothSocket} on successful connection.
|
|
* <p>Once this call returns, it can be called again to accept subsequent
|
|
* incoming connections.
|
|
* <p>{@link #close} can be used to abort this call from another thread.
|
|
* @return a connected {@link BluetoothSocket}
|
|
* @throws IOException on error, for example this call was aborted, or
|
|
* timeout
|
|
*/
|
|
public BluetoothSocket accept(int timeout) throws IOException {
|
|
return mSocket.accept(timeout);
|
|
}
|
|
|
|
/**
|
|
* Immediately close this socket, and release all associated resources.
|
|
* <p>Causes blocked calls on this socket in other threads to immediately
|
|
* throw an IOException.
|
|
* <p>Closing the {@link BluetoothServerSocket} will <em>not</em>
|
|
* close any {@link BluetoothSocket} received from {@link #accept()}.
|
|
*/
|
|
public void close() throws IOException {
|
|
synchronized (this) {
|
|
if (mHandler != null) {
|
|
mHandler.obtainMessage(mMessage).sendToTarget();
|
|
}
|
|
}
|
|
mSocket.close();
|
|
}
|
|
|
|
/*package*/ synchronized void setCloseHandler(Handler handler, int message) {
|
|
mHandler = handler;
|
|
mMessage = message;
|
|
}
|
|
}
|