com.qualcomm.hardware.lynx.commands

Class LynxRespondable<RESPONSE extends LynxMessage>

java.lang.Object

com.qualcomm.hardware.lynx.commands.LynxMessage

com.qualcomm.hardware.lynx.commands.LynxRespondable<RESPONSE>

Direct Known Subclasses:

LynxCommand, LynxResponse

public abstract class LynxRespondable<RESPONSE extends LynxMessage>
extends LynxMessage

A LynxRespondable is a message that will generate a response from the module to which it is transmitted. A positive response is either a full-fledged response message (if the message expects a response) or a LynxAck if not; a negative response is in the form of a LynxNack.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.CountDownLatch	ackOrNackReceived
protected boolean	isAckOrResponseReceived
protected LynxNack	nackReceived
protected RESPONSE	response
protected java.util.concurrent.CountDownLatch	responseOrNackReceived
protected int	retransmissionsRemaining

Fields inherited from class com.qualcomm.hardware.lynx.commands.LynxMessage

hasBeenTransmitted, messageNumber, module, nanotimeLastTransmit, payloadTimeWindow, referenceNumber, serialization

Constructor Summary

Constructors

Constructor and Description
LynxRespondable(LynxModuleIntf module)

Method Summary

Modifier and Type	Method and Description
protected void	awaitAckResponseOrNack()
protected void	awaitAndRetransmit(java.util.concurrent.CountDownLatch latch, LynxNack.ReasonCode nackCode, java.lang.String message)
protected int	getMsAwaitInterval()
protected int	getMsRetransmissionInterval()
LynxNack	getNackReceived()
boolean	hasBeenAcknowledged()
boolean	isAckable()
boolean	isAckOrResponseReceived()
boolean	isNackReceived()
boolean	isRetransmittable()
protected void	noteAttentionRequired()
void	noteRetransmission()
void	onAckReceived(LynxAck ack)
void	onNackReceived(LynxNack nack)
void	onPretendTransmit()
void	onResponseReceived(LynxMessage response)
void	pretendFinish()
protected RESPONSE	responseOrThrow()
void	send()
RESPONSE	sendReceive()
void	setUnretransmittable()
protected void	throwIfNack()
protected void	throwNackForUnsupportedCommand(LynxUnsupportedCommandException e)
protected boolean	usePretendResponseIfRealModuleDoesntSupport() Command normally pre-create responses that get used when the usb device is in pretend mode.

Methods inherited from class com.qualcomm.hardware.lynx.commands.LynxMessage

acquireNetworkLock, forgetSerialization, fromPayloadByteArray, getCommandNumber, getDestModuleAddress, getMessageNumber, getModule, getModuleAddress, getNanotimeLastTransmit, getPayloadTimeWindow, getReferenceNumber, getSerialization, hasBeenTransmitted, invokeStaticNullaryMethod, isAck, isNack, isResponse, isResponseExpected, loadFromSerialization, noteHasBeenTransmitted, releaseNetworkLock, resetModulePingTimer, setMessageNumber, setModule, setNanotimeLastTransmit, setPayloadTimeWindow, setReferenceNumber, setSerialization, toPayloadByteArray

Methods inherited from class java.lang.Object

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

Field Detail

isAckOrResponseReceived

protected boolean isAckOrResponseReceived

nackReceived

protected LynxNack nackReceived

ackOrNackReceived

protected java.util.concurrent.CountDownLatch ackOrNackReceived

retransmissionsRemaining

protected int retransmissionsRemaining

responseOrNackReceived

protected java.util.concurrent.CountDownLatch responseOrNackReceived

response

protected RESPONSE extends LynxMessage response

Constructor Detail

LynxRespondable

public LynxRespondable(LynxModuleIntf module)

Method Detail

onPretendTransmit

public void onPretendTransmit()
                       throws java.lang.InterruptedException

Overrides:

onPretendTransmit in class LynxMessage

Throws:

java.lang.InterruptedException

isRetransmittable

public boolean isRetransmittable()

setUnretransmittable

public void setUnretransmittable()

noteRetransmission

public void noteRetransmission()

Overrides:

noteRetransmission in class LynxMessage

hasBeenAcknowledged

public boolean hasBeenAcknowledged()

isAckOrResponseReceived

public boolean isAckOrResponseReceived()

isNackReceived

public boolean isNackReceived()

getNackReceived

public LynxNack getNackReceived()

isAckable

public boolean isAckable()

Overrides:

isAckable in class LynxMessage

pretendFinish

public void pretendFinish()
                   throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

onAckReceived

public void onAckReceived(LynxAck ack)

noteAttentionRequired

protected void noteAttentionRequired()

onResponseReceived

public void onResponseReceived(LynxMessage response)

onNackReceived

public void onNackReceived(LynxNack nack)

send

public void send()
          throws java.lang.InterruptedException,
                 LynxNackException

Throws:

java.lang.InterruptedException

LynxNackException

sendReceive

public RESPONSE sendReceive()
                     throws java.lang.InterruptedException,
                            LynxNackException

Throws:

java.lang.InterruptedException

LynxNackException

usePretendResponseIfRealModuleDoesntSupport

protected boolean usePretendResponseIfRealModuleDoesntSupport()

Command normally pre-create responses that get used when the usb device is in pretend mode. Normally, those responses are *only* used in pretend mode. However, on a case-by-case basis those pretend responses can *also* be used when armed in the situation where the module in question doesn't in fact support the command (perhaps it has an older, shorter notion of a particular interface, for example).

throwNackForUnsupportedCommand

protected void throwNackForUnsupportedCommand(LynxUnsupportedCommandException e)
                                       throws LynxNackException

Throws:

LynxNackException

responseOrThrow

protected RESPONSE responseOrThrow()
                            throws LynxNackException

Throws:

LynxNackException

throwIfNack

protected void throwIfNack()
                    throws LynxNackException

Throws:

LynxNackException

getMsAwaitInterval

protected int getMsAwaitInterval()

getMsRetransmissionInterval

protected int getMsRetransmissionInterval()

awaitAndRetransmit

protected void awaitAndRetransmit(java.util.concurrent.CountDownLatch latch,
                                  LynxNack.ReasonCode nackCode,
                                  java.lang.String message)
                           throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

awaitAckResponseOrNack

protected void awaitAckResponseOrNack()
                               throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException