FileDocCategorySizeDatePackage
BluetoothPan.javaAPI DocAndroid 5.1 API13795Thu Mar 12 22:22:10 GMT 2015android.bluetooth

BluetoothPan

public final class BluetoothPan extends Object implements BluetoothProfile
This class provides the APIs to control the Bluetooth Pan Profile.

BluetoothPan is a proxy object for controlling the Bluetooth Service via IPC. Use {@link BluetoothAdapter#getProfileProxy} to get the BluetoothPan proxy object.

Each method is protected with its appropriate permission.

hide

Fields Summary
private static final String
TAG
private static final boolean
DBG
private static final boolean
VDBG
public static final String
ACTION_CONNECTION_STATE_CHANGED
Intent used to broadcast the change in connection state of the Pan profile.

This intent will have 4 extras:

  • {@link #EXTRA_STATE} - The current state of the profile.
  • {@link #EXTRA_PREVIOUS_STATE}- The previous state of the profile.
  • {@link BluetoothDevice#EXTRA_DEVICE} - The remote device.
  • {@link #EXTRA_LOCAL_ROLE} - Which local role the remote device is bound to.

{@link #EXTRA_STATE} or {@link #EXTRA_PREVIOUS_STATE} can be any of {@link #STATE_DISCONNECTED}, {@link #STATE_CONNECTING}, {@link #STATE_CONNECTED}, {@link #STATE_DISCONNECTING}.

{@link #EXTRA_LOCAL_ROLE} can be one of {@link #LOCAL_NAP_ROLE} or {@link #LOCAL_PANU_ROLE}

Requires {@link android.Manifest.permission#BLUETOOTH} permission to receive.

public static final String
EXTRA_LOCAL_ROLE
Extra for {@link #ACTION_CONNECTION_STATE_CHANGED} intent The local role of the PAN profile that the remote device is bound to. It can be one of {@link #LOCAL_NAP_ROLE} or {@link #LOCAL_PANU_ROLE}.
public static final int
PAN_ROLE_NONE
public static final int
LOCAL_NAP_ROLE
The local device is acting as a Network Access Point.
public static final int
REMOTE_NAP_ROLE
public static final int
LOCAL_PANU_ROLE
The local device is acting as a PAN User.
public static final int
REMOTE_PANU_ROLE
public static final int
PAN_DISCONNECT_FAILED_NOT_CONNECTED
Return codes for the connect and disconnect Bluez / Dbus calls.
public static final int
PAN_CONNECT_FAILED_ALREADY_CONNECTED
public static final int
PAN_CONNECT_FAILED_ATTEMPT_FAILED
public static final int
PAN_OPERATION_GENERIC_FAILURE
public static final int
PAN_OPERATION_SUCCESS
private android.content.Context
mContext
private ServiceListener
mServiceListener
private BluetoothAdapter
mAdapter
private IBluetoothPan
mPanService
private final IBluetoothStateChangeCallback
mStateChangeCallback
private final android.content.ServiceConnection
mConnection
Constructors Summary
BluetoothPan(android.content.Context context, ServiceListener l)
Create a BluetoothPan proxy object for interacting with the local Bluetooth Service which handles the Pan profile


                          
    /*package*/     
        mContext = context;
        mServiceListener = l;
        mAdapter = BluetoothAdapter.getDefaultAdapter();
        try {
            mAdapter.getBluetoothManager().registerStateChangeCallback(mStateChangeCallback);
        } catch (RemoteException re) {
            Log.w(TAG,"Unable to register BluetoothStateChangeCallback",re);
        }
        if (VDBG) Log.d(TAG, "BluetoothPan() call bindService");
        doBind();
        if (VDBG) Log.d(TAG, "BluetoothPan(), bindService called");
Methods Summary
voidclose()

        if (VDBG) log("close()");

        IBluetoothManager mgr = mAdapter.getBluetoothManager();
        if (mgr != null) {
            try {
                mgr.unregisterStateChangeCallback(mStateChangeCallback);
            } catch (RemoteException re) {
                Log.w(TAG,"Unable to unregister BluetoothStateChangeCallback",re);
            }
        }

        synchronized (mConnection) {
            if (mPanService != null) {
                try {
                    mPanService = null;
                    mContext.unbindService(mConnection);
                } catch (Exception re) {
                    Log.e(TAG,"",re);
                }
            }
        }
        mServiceListener = null;
public booleanconnect(BluetoothDevice device)
Initiate connection to a profile of the remote bluetooth device.

This API returns false in scenarios like the profile on the device is already connected or Bluetooth is not turned on. When this API returns true, it is guaranteed that connection state intent for the profile will be broadcasted with the state. Users can get the connection state of the profile from this intent.

Requires {@link android.Manifest.permission#BLUETOOTH_ADMIN} permission.

param
device Remote Bluetooth Device
return
false on immediate error, true otherwise
hide


                                                                                                         
        
        if (DBG) log("connect(" + device + ")");
        if (mPanService != null && isEnabled() &&
            isValidDevice(device)) {
            try {
                return mPanService.connect(device);
            } catch (RemoteException e) {
                Log.e(TAG, "Stack:" + Log.getStackTraceString(new Throwable()));
                return false;
            }
        }
        if (mPanService == null) Log.w(TAG, "Proxy not attached to service");
        return false;
public booleandisconnect(BluetoothDevice device)
Initiate disconnection from a profile

This API will return false in scenarios like the profile on the Bluetooth device is not in connected state etc. When this API returns, true, it is guaranteed that the connection state change intent will be broadcasted with the state. Users can get the disconnection state of the profile from this intent.

If the disconnection is initiated by a remote device, the state will transition from {@link #STATE_CONNECTED} to {@link #STATE_DISCONNECTED}. If the disconnect is initiated by the host (local) device the state will transition from {@link #STATE_CONNECTED} to state {@link #STATE_DISCONNECTING} to state {@link #STATE_DISCONNECTED}. The transition to {@link #STATE_DISCONNECTING} can be used to distinguish between the two scenarios.

Requires {@link android.Manifest.permission#BLUETOOTH_ADMIN} permission.

param
device Remote Bluetooth Device
return
false on immediate error, true otherwise
hide

        if (DBG) log("disconnect(" + device + ")");
        if (mPanService != null && isEnabled() &&
            isValidDevice(device)) {
            try {
                return mPanService.disconnect(device);
            } catch (RemoteException e) {
                Log.e(TAG, "Stack:" + Log.getStackTraceString(new Throwable()));
                return false;
            }
        }
        if (mPanService == null) Log.w(TAG, "Proxy not attached to service");
        return false;
booleandoBind()

        Intent intent = new Intent(IBluetoothPan.class.getName());
        ComponentName comp = intent.resolveSystemService(mContext.getPackageManager(), 0);
        intent.setComponent(comp);
        if (comp == null || !mContext.bindServiceAsUser(intent, mConnection, 0,
                android.os.Process.myUserHandle())) {
            Log.e(TAG, "Could not bind to Bluetooth Pan Service with " + intent);
            return false;
        }
        return true;
protected voidfinalize()

        close();
public java.util.ListgetConnectedDevices()
{@inheritDoc}

        if (VDBG) log("getConnectedDevices()");
        if (mPanService != null && isEnabled()) {
            try {
                return mPanService.getConnectedDevices();
            } catch (RemoteException e) {
                Log.e(TAG, "Stack:" + Log.getStackTraceString(new Throwable()));
                return new ArrayList<BluetoothDevice>();
            }
        }
        if (mPanService == null) Log.w(TAG, "Proxy not attached to service");
        return new ArrayList<BluetoothDevice>();
public intgetConnectionState(BluetoothDevice device)
{@inheritDoc}

        if (VDBG) log("getState(" + device + ")");
        if (mPanService != null && isEnabled()
            && isValidDevice(device)) {
            try {
                return mPanService.getConnectionState(device);
            } catch (RemoteException e) {
                Log.e(TAG, "Stack:" + Log.getStackTraceString(new Throwable()));
                return BluetoothProfile.STATE_DISCONNECTED;
            }
        }
        if (mPanService == null) Log.w(TAG, "Proxy not attached to service");
        return BluetoothProfile.STATE_DISCONNECTED;
public java.util.ListgetDevicesMatchingConnectionStates(int[] states)
{@inheritDoc}

        if (VDBG) log("getDevicesMatchingStates()");
        if (mPanService != null && isEnabled()) {
            try {
                return mPanService.getDevicesMatchingConnectionStates(states);
            } catch (RemoteException e) {
                Log.e(TAG, "Stack:" + Log.getStackTraceString(new Throwable()));
                return new ArrayList<BluetoothDevice>();
            }
        }
        if (mPanService == null) Log.w(TAG, "Proxy not attached to service");
        return new ArrayList<BluetoothDevice>();
private booleanisEnabled()


       
       if (mAdapter.getState() == BluetoothAdapter.STATE_ON) return true;
       return false;
public booleanisTetheringOn()

        if (VDBG) log("isTetheringOn()");
        try {
            return mPanService.isTetheringOn();
        } catch (RemoteException e) {
            Log.e(TAG, "Stack:" + Log.getStackTraceString(new Throwable()));
        }
        return false;
private booleanisValidDevice(BluetoothDevice device)

       if (device == null) return false;

       if (BluetoothAdapter.checkBluetoothAddress(device.getAddress())) return true;
       return false;
private static voidlog(java.lang.String msg)

      Log.d(TAG, msg);
public voidsetBluetoothTethering(boolean value)

        if (DBG) log("setBluetoothTethering(" + value + ")");
        try {
            mPanService.setBluetoothTethering(value);
        } catch (RemoteException e) {
            Log.e(TAG, "Stack:" + Log.getStackTraceString(new Throwable()));
        }