org.vishia.inspectorTarget

Interface CmdConsumer_ifc

All Known Implementing Classes:

ClassContent

public interface CmdConsumer_ifc

Method Summary

Modifier and Type	Method and Description
int	executeMonitorCmd(InspcDataExchangeAccess.Inspcitem cmd, InspcDataExchangeAccess.InspcDatagram answer, int maxNrofAnswerBytes) Executes a command, writes the answer in the answer datagram.
void	setAnswerComm(AnswerComm_ifc answerComm) Sets the aggregation for the answer.

Method Detail

executeMonitorCmd

int executeMonitorCmd(InspcDataExchangeAccess.Inspcitem cmd,
                      InspcDataExchangeAccess.InspcDatagram answer,
                      int maxNrofAnswerBytes)
               throws java.lang.IllegalArgumentException,
                      java.io.UnsupportedEncodingException

Executes a command, writes the answer in the answer datagram.

Rules vor answer:

The answer-Datagram is given with prepared head. The only one value is the current datagram length which should be set to the head before it is send. But this action is done in the method AnswerComm_ifc.txAnswer(int, boolean). The user should add its InspcDataExchangeAccess.Inspcitem-elements for the answer there. Only if the datagram is full and a next info have to be add, the current datagram should be send. Therefore the routine AnswerComm_ifc.txAnswer(int, boolean) should be called with the current number of bytes and false as 2. parameter. A non-filled datagram is not to be sent. It will be send after the last invocation of a command consumer from the activator of this method. In this way more as one answer can be given in one ore more datagrams, while the command datagram may contain more as one command too.

Parameters:

cmd - The command. It is one information unit only, not a full datagram, because the command is containing in a information unit. A datagram may contain more as one command.

answer - answer datagram with prepared head, maybe with already content. The answer information units are to be add here. The datagram is to be send, if it is full.

maxNrofAnswerBytes - The maximum of bytes inclusive head in the datagram.

Returns:

0

Throws:

java.lang.IllegalArgumentException

java.io.UnsupportedEncodingException

setAnswerComm

void setAnswerComm(AnswerComm_ifc answerComm)

Sets the aggregation for the answer.

Parameters:

answerComm -