org.avineas.comli

Interface Slave

public interface Slave

Slave side of the COMLI protocol. To be able to interact with a COMLI master, slaves must implement this interface. As specified by the COMLI protocol, two types of interactions between master and slave are possible: a request (to request data, etc. from the slave) or a transfer (to push data to the slave). These two interactions are specified by different interface methods.

Since:

26-sep-2007

Author:

A. van Wijngaarden

Method Summary

Methods

Modifier and Type	Method and Description
byte	handleRequest(byte type, int startAddress, byte[] toFill) Handle a request from a master.
boolean	handleTransfer(byte type, int startAddress, byte[] contents) Handle a transfer from a master.

Method Detail

handleRequest

byte handleRequest(byte type,
                 int startAddress,
                 byte[] toFill)

Handle a request from a master. A master sends a request to retrieve data, etc. from a slave. The slave should perform the action and return the data.

Parameters:

type - The request type

startAddress - The start address

toFill - The byte array to fill with data. The size is determined by the size of the array

Returns:

The transfer type to return to the master. Specify 0 to indicate an error. In that case no data is replied

handleTransfer

boolean handleTransfer(byte type,
                     int startAddress,
                     byte[] contents)

Handle a transfer from a master. A master performs a transfer to change data at a slave side.

Parameters:

type - The type of tranfer

startAddress - The start address

contents - The contents

Returns:

An indication whether the transfer went correctly