ej.library.iot.rcommand.bluetooth

Class EventSerializer

java.lang.Object

ej.library.iot.rcommand.bluetooth.EventSerializer

All Implemented Interfaces:

ConnectionListener, LocalServiceListener, RemoteServiceListener

public class EventSerializer
extends Object
implements ConnectionListener, RemoteServiceListener, LocalServiceListener

Constructor Summary

Constructors

Constructor and Description
EventSerializer(BluetoothController controller)

Method Summary

Modifier and Type	Method and Description
void	onAdvertisementCompleted() Called when an ongoing advertisement is completed.
void	onConnected(BluetoothConnection connection) Called when a connection attempt is successful or when a remote device connects to the adapter.
void	onConnectFailed(BluetoothAddress address) Called when a connection attempt fails.
void	onDisconnected(BluetoothConnection connection) Called when the connection with a device is closed.
void	onDiscoveryCompleted(BluetoothConnection connection) Called when a service discovery is completed.
void	onDiscoveryResult(BluetoothConnection connection, BluetoothService service) Called when a service provided by a device has been discovered.
void	onExecuteWriteRequest(BluetoothConnection connection, BluetoothAttribute attribute, boolean execute) Called when an execute write request is received.
void	onNotificationReceived(BluetoothConnection connection, BluetoothCharacteristic characteristic, byte[] value) Called when a characteristic notification or indication is received.
void	onNotificationSent(BluetoothConnection connection, BluetoothCharacteristic characteristic, boolean success) Called when a characteristic notification or indication is sent.
void	onPairCompleted(BluetoothConnection connection, boolean success) Called when the pairing procedure with a device is completed.
void	onPairRequest(BluetoothConnection connection) Called when a pairing request from a device is received.
void	onPasskeyGenerated(BluetoothConnection connection, int passkey) Called when a passkey is generated to be displayed to the user.
void	onPasskeyRequest(BluetoothConnection connection) Called when a passkey request from a device is received.
void	onPrepareWriteRequest(BluetoothConnection connection, BluetoothAttribute attribute, byte[] value, int offset) Called when a prepare write request is received.
void	onReadBlobRequest(BluetoothConnection connection, BluetoothAttribute attribute, int offset) Called when a read blob request is received.
void	onReadCompleted(BluetoothConnection connection, BluetoothAttribute attribute, byte status, byte[] value) Called when a response to a read request is received.
void	onReadRequest(BluetoothConnection connection, BluetoothAttribute attribute) Called when a read request is received.
void	onScanCompleted() Called when an ongoing scan is completed.
void	onScanResult(BluetoothAddress address, byte[] advertisementData, int rssi) Called when a advertisement or a scan response is received.
void	onWriteCompleted(BluetoothConnection connection, BluetoothAttribute attribute, byte status) Called when a response to a write request is received.
void	onWriteRequest(BluetoothConnection connection, BluetoothAttribute attribute, byte[] value) Called when a write request is received.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventSerializer

public EventSerializer(BluetoothController controller)

Method Detail

onAdvertisementCompleted

public void onAdvertisementCompleted()

Description copied from interface: ConnectionListener

Called when an ongoing advertisement is completed.

Specified by:

onAdvertisementCompleted in interface ConnectionListener

See Also:

BluetoothAdapter.startAdvertising(byte[]), BluetoothAdapter.stopAdvertising()

onConnected

public void onConnected(BluetoothConnection connection)

Description copied from interface: ConnectionListener

Called when a connection attempt is successful or when a remote device connects to the adapter.

Specified by:

onConnected in interface ConnectionListener

Parameters:

connection - the connection which was established.

See Also:

BluetoothAdapter.connect(BluetoothAddress), BluetoothAdapter.startAdvertising(byte[])

onConnectFailed

public void onConnectFailed(BluetoothAddress address)

Description copied from interface: ConnectionListener

Called when a connection attempt fails.

Specified by:

onConnectFailed in interface ConnectionListener

Parameters:

address - the address of the device to which the connection has failed.

See Also:

BluetoothAdapter.connect(BluetoothAddress)

onDisconnected

public void onDisconnected(BluetoothConnection connection)

Description copied from interface: ConnectionListener

Called when the connection with a device is closed.

Specified by:

onDisconnected in interface ConnectionListener

Parameters:

connection - the connection which was closed.

See Also:

BluetoothConnection.disconnect()

onDiscoveryCompleted

public void onDiscoveryCompleted(BluetoothConnection connection)

Description copied from interface: ConnectionListener

Called when a service discovery is completed.

Specified by:

onDiscoveryCompleted in interface ConnectionListener

Parameters:

connection - the connection with the device with which the discovery was initiated.

See Also:

BluetoothConnection.discoverServices(), BluetoothConnection.discoverService(ej.bluetooth.BluetoothUuid)

onDiscoveryResult

public void onDiscoveryResult(BluetoothConnection connection,
                              BluetoothService service)

Description copied from interface: ConnectionListener

Called when a service provided by a device has been discovered.

Specified by:

onDiscoveryResult in interface ConnectionListener

Parameters:

connection - the connection with the device which provides the service.

service - the service which has been discovered.

See Also:

BluetoothConnection.discoverServices(), BluetoothConnection.discoverService(ej.bluetooth.BluetoothUuid)

onExecuteWriteRequest

public void onExecuteWriteRequest(BluetoothConnection connection,
                                  BluetoothAttribute attribute,
                                  boolean execute)

Description copied from interface: LocalServiceListener

Called when an execute write request is received. All pending prepared write operations are executed or cancelled.

Specified by:

onExecuteWriteRequest in interface LocalServiceListener

Parameters:

connection - the connection with the device which has sent the request.

attribute - the attribute to write.

execute - true if the pending prepared writes should be executed, false if they should be cancelled.

onNotificationReceived

public void onNotificationReceived(BluetoothConnection connection,
                                   BluetoothCharacteristic characteristic,
                                   byte[] value)

Description copied from interface: RemoteServiceListener

Called when a characteristic notification or indication is received.

Specified by:

onNotificationReceived in interface RemoteServiceListener

Parameters:

connection - the connection with the device which has sent the notification.

characteristic - the characteristic which has changed.

value - the value of the characteristic.

onNotificationSent

public void onNotificationSent(BluetoothConnection connection,
                               BluetoothCharacteristic characteristic,
                               boolean success)

Description copied from interface: LocalServiceListener

Called when a characteristic notification or indication is sent.

If a notification was sent, this method is called as soon as the notification is sent to the device. If an indication was sent, this method is called when the device acknowledges the indication.

Specified by:

onNotificationSent in interface LocalServiceListener

Parameters:

connection - the connection with the device to which the notification was sent.

characteristic - the characteristic which has changed.

success - true if the notification was sent successfully, false otherwise.

See Also:

BluetoothConnection.sendNotification(BluetoothCharacteristic, byte[], boolean)

onPairCompleted

public void onPairCompleted(BluetoothConnection connection,
                            boolean success)

Description copied from interface: ConnectionListener

Called when the pairing procedure with a device is completed.

Specified by:

onPairCompleted in interface ConnectionListener

Parameters:

connection - the connection with the device with which the pairing procedure was completed.

success - true if the pairing procedure was successful, false otherwise.

See Also:

BluetoothConnection.sendPairRequest(), BluetoothConnection.sendPairResponse(boolean)

onPairRequest

public void onPairRequest(BluetoothConnection connection)

Description copied from interface: ConnectionListener

Called when a pairing request from a device is received.

Specified by:

onPairRequest in interface ConnectionListener

Parameters:

connection - the connection with the device from which the pairing request was received.

See Also:

BluetoothConnection.sendPairResponse(boolean)

onPasskeyGenerated

public void onPasskeyGenerated(BluetoothConnection connection,
                               int passkey)

Description copied from interface: ConnectionListener

Called when a passkey is generated to be displayed to the user.

Specified by:

onPasskeyGenerated in interface ConnectionListener

Parameters:

connection - the connection with the device to which the passkey request was sent.

passkey - the passkey which was generated.

See Also:

BluetoothConnection.sendPasskeyResponse(boolean, int)

onPasskeyRequest

public void onPasskeyRequest(BluetoothConnection connection)

Description copied from interface: ConnectionListener

Called when a passkey request from a device is received.

Specified by:

onPasskeyRequest in interface ConnectionListener

Parameters:

connection - the connection with the device from which the passkey request was received.

See Also:

BluetoothConnection.sendPasskeyResponse(boolean, int)

onPrepareWriteRequest

public void onPrepareWriteRequest(BluetoothConnection connection,
                                  BluetoothAttribute attribute,
                                  byte[] value,
                                  int offset)

Description copied from interface: LocalServiceListener

Called when a prepare write request is received. The write operation is queued until an execute write request is received.

Specified by:

onPrepareWriteRequest in interface LocalServiceListener

Parameters:

connection - the connection with the device which has sent the request.

attribute - the attribute to write.

value - the value to write.

offset - the offset of the first octet to write.

onReadBlobRequest

public void onReadBlobRequest(BluetoothConnection connection,
                              BluetoothAttribute attribute,
                              int offset)

Description copied from interface: LocalServiceListener

Called when a read blob request is received.

Specified by:

onReadBlobRequest in interface LocalServiceListener

Parameters:

connection - the connection with the device which has sent the request.

attribute - the attribute to read.

offset - the offset of the first octet to read.

onReadCompleted

public void onReadCompleted(BluetoothConnection connection,
                            BluetoothAttribute attribute,
                            byte status,
                            byte[] value)

Description copied from interface: RemoteServiceListener

Called when a response to a read request is received.

Specified by:

onReadCompleted in interface RemoteServiceListener

Parameters:

connection - the connection with the device which has sent the response.

attribute - the attribute which was read.

status - the response status (see BluetoothStatus).

value - the value of the attribute.

See Also:

BluetoothConnection.sendReadRequest(BluetoothAttribute)

onReadRequest

public void onReadRequest(BluetoothConnection connection,
                          BluetoothAttribute attribute)

Description copied from interface: LocalServiceListener

Called when a read request is received.

Specified by:

onReadRequest in interface LocalServiceListener

Parameters:

connection - the connection with the device which has sent the request.

attribute - the attribute to read.

onScanCompleted

public void onScanCompleted()

Description copied from interface: ConnectionListener

Called when an ongoing scan is completed.

Specified by:

onScanCompleted in interface ConnectionListener

See Also:

BluetoothAdapter.startScanning(ej.bluetooth.BluetoothScanFilter), BluetoothAdapter.stopScanning()

onScanResult

public void onScanResult(BluetoothAddress address,
                         byte[] advertisementData,
                         int rssi)

Description copied from interface: ConnectionListener

Called when a advertisement or a scan response is received.

Specified by:

onScanResult in interface ConnectionListener

Parameters:

address - the address of the device which has sent the advertisement.

advertisementData - the advertisement data.

rssi - the RSSI measurement.

See Also:

BluetoothAdapter.startScanning(ej.bluetooth.BluetoothScanFilter), BluetoothAdapter.stopScanning()

onWriteCompleted

public void onWriteCompleted(BluetoothConnection connection,
                             BluetoothAttribute attribute,
                             byte status)

Description copied from interface: RemoteServiceListener

Called when a response to a write request is received.

Specified by:

onWriteCompleted in interface RemoteServiceListener

Parameters:

connection - the connection with the device which has sent the response.

attribute - the attribute which was written.

status - the response status (see BluetoothStatus).

See Also:

BluetoothConnection.sendWriteRequest(BluetoothAttribute, byte[])

onWriteRequest

public void onWriteRequest(BluetoothConnection connection,
                           BluetoothAttribute attribute,
                           byte[] value)

Description copied from interface: LocalServiceListener

Called when a write request is received.

Specified by:

onWriteRequest in interface LocalServiceListener

Parameters:

connection - the connection with the device which has sent the request.

attribute - the attribute to write.

value - the value to write.