com.iotize.android.device.api.protocol

Interface ComProtocol

All Known Implementing Classes:

AbstractComProtocol, BluetoothProtocol

public interface ComProtocol

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ComProtocol.Configuration Protocol configuration class
static interface	ComProtocol.IOnEvent<T>
static interface	ComProtocol.OnConnectionStatusChangeListener Event when the protocol connection status change
static interface	ComProtocol.OnErrorListener Event when an error occur

Method Summary

Modifier and Type	Method and Description
void	addOnConnectionStatusChangeListener(ComProtocol.OnConnectionStatusChangeListener listener) Set the message listener
void	addOnErrorListener(ComProtocol.OnErrorListener listener) Set the message listener
void	addOnMessageListener(ComProtocol.IOnEvent<byte[]> listener) Set the message listener
void	connect() Connect to the protocol
void	disconnect() Disconnect from the protocol
ComProtocol.Configuration	getConfiguration()
ConnectionState	getConnectionStatus() Get the current connection status
java.lang.Throwable	getLastError()
HostProtocol	getType() Get com protocol type
boolean	isConnected()
void	notifyNewMessage(byte[] message)
byte[]	read() Read input data
boolean	removeOnConnectionStatusChangeListener(ComProtocol.OnConnectionStatusChangeListener listener)
boolean	removeOnErrorListener(ComProtocol.OnErrorListener listener)
byte[]	send(byte[] message) Write request and wait for response
void	sendAsync(byte[] message, ComProtocol.IOnEvent<byte[]> event) Send data asynchronously
void	write(byte[] data) Write without waiting for a response

Method Detail

getConnectionStatus

ConnectionState getConnectionStatus()

Get the current connection status

Returns:

the connection state

getType

HostProtocol getType()

Get com protocol type

Returns:

the protocol type

getLastError

@Nullable
java.lang.Throwable getLastError()

Returns:

the last error

isConnected

boolean isConnected()

Returns:

True if connected

connect

void connect()
      throws java.lang.Exception

Connect to the protocol

Throws:

java.lang.Exception - when connection fails

disconnect

void disconnect()
         throws java.lang.Exception

Disconnect from the protocol

Throws:

java.lang.Exception - when disconnection fails

write

void write(byte[] data)
    throws java.lang.Exception

Write without waiting for a response

Parameters:

data - data to send

Throws:

java.lang.Exception - when send fails

read

byte[] read()
     throws java.lang.Exception

Read input data

Returns:

the response

Throws:

java.lang.Exception - when read fails

send

byte[] send(byte[] message)
     throws java.lang.Exception

Write request and wait for response

Parameters:

message - the data to send

Returns:

the response

Throws:

java.lang.Exception - when send fails

sendAsync

void sendAsync(byte[] message,
               ComProtocol.IOnEvent<byte[]> event)

Send data asynchronously

Parameters:

message - the data to send

event - callback event

notifyNewMessage

void notifyNewMessage(byte[] message)

Parameters:

message - the input message received

addOnMessageListener

void addOnMessageListener(ComProtocol.IOnEvent<byte[]> listener)

Set the message listener

Parameters:

listener - the listner

addOnConnectionStatusChangeListener

void addOnConnectionStatusChangeListener(ComProtocol.OnConnectionStatusChangeListener listener)

Set the message listener

Parameters:

listener - the listener

removeOnConnectionStatusChangeListener

boolean removeOnConnectionStatusChangeListener(ComProtocol.OnConnectionStatusChangeListener listener)

Parameters:

listener - the listener

Returns:

true if listener has been removed. False if it was not removed (meaning it was not present in the list)

getConfiguration

ComProtocol.Configuration getConfiguration()

addOnErrorListener

void addOnErrorListener(ComProtocol.OnErrorListener listener)

Set the message listener

Parameters:

listener - the listener

removeOnErrorListener

boolean removeOnErrorListener(ComProtocol.OnErrorListener listener)

Parameters:

listener - the listener

Returns:

true if listener has been removed. False if it was not removed (meaning it was not present in the list)