ej.bluetooth.util.services.sps

Class SerialPortServer

java.lang.Object

ej.bluetooth.listeners.impl.DefaultLocalServiceListener

ej.bluetooth.util.services.sps.SerialPortServer

All Implemented Interfaces:

LocalServiceListener

public abstract class SerialPortServer
extends DefaultLocalServiceListener

The SerialPortServer class represents a serial port server.

Constructor Summary

Constructors

Constructor and Description
SerialPortServer(BluetoothService service) Creates a serial port server, using the serial port service provided by this device.

Method Summary

Modifier and Type	Method and Description
protected abstract void	onDataReceived(BluetoothConnection connection, byte[] data) Called when data has been received from a client.
protected abstract void	onDataSent(BluetoothConnection connection, boolean success) Called when data has been sent to a client.
void	onNotificationSent(BluetoothConnection connection, BluetoothCharacteristic characteristic, boolean success) Called when a characteristic notification or indication is sent.
void	onReadRequest(BluetoothConnection connection, BluetoothAttribute attribute) Called when a read request is received.
void	onWriteRequest(BluetoothConnection connection, BluetoothAttribute attribute, byte[] value) Called when a write request is received.
void	sendData(BluetoothConnection connection, byte[] data) Sends the given data to the given client.
void	start() Starts this serial port server.
void	stop() Stops this serial port server.

Methods inherited from class ej.bluetooth.listeners.impl.DefaultLocalServiceListener

onExecuteWriteRequest, onPrepareWriteRequest, onReadBlobRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialPortServer

public SerialPortServer(BluetoothService service)

Creates a serial port server, using the serial port service provided by this device.

Parameters:

service - the serial port service provided by this device.

Throws:

IllegalArgumentException - if one of the mandatory attributes of the service is missing.

Method Detail

onDataReceived

protected abstract void onDataReceived(BluetoothConnection connection,
                                       byte[] data)

Called when data has been received from a client.

Parameters:

connection - the connection to the device from which the data has been received.

data - the data received from the client.

onDataSent

protected abstract void onDataSent(BluetoothConnection connection,
                                   boolean success)

Called when data has been sent to a client.

Parameters:

connection - the connection to the device to which the data has been sent.

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

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

Overrides:

onNotificationSent in class DefaultLocalServiceListener

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)

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

Overrides:

onReadRequest in class DefaultLocalServiceListener

Parameters:

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

attribute - the attribute to read.

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

Overrides:

onWriteRequest in class DefaultLocalServiceListener

Parameters:

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

attribute - the attribute to write.

value - the value to write.

sendData

public void sendData(BluetoothConnection connection,
                     byte[] data)

Sends the given data to the given client. The onDataSent(BluetoothConnection, boolean) methods is called once the data has been sent to the client.

Parameters:

connection - the connection to the device to which the data should be sent.

data - the data to send.

start

public void start()

Starts this serial port server.

stop

public void stop()

Stops this serial port server.