com.qualcomm.hardware.lynx.commands

Class LynxMessage

java.lang.Object

com.qualcomm.hardware.lynx.commands.LynxMessage

Direct Known Subclasses:

LynxAck, LynxNack, LynxRespondable

public abstract class LynxMessage
extends java.lang.Object

LynxMessage is the root base class from which all lynx messaging related classes derive.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	hasBeenTransmitted
protected byte	messageNumber
protected LynxModuleIntf	module
protected long	nanotimeLastTransmit
protected TimeWindow	payloadTimeWindow
protected byte	referenceNumber
protected LynxDatagram	serialization

Constructor Summary

Constructors

Constructor and Description
LynxMessage(LynxModuleIntf module)

Method Summary

Modifier and Type	Method and Description
void	acquireNetworkLock()
void	forgetSerialization()
abstract void	fromPayloadByteArray(byte[] rgb)
abstract int	getCommandNumber()
int	getDestModuleAddress()
int	getMessageNumber()
LynxModuleIntf	getModule()
int	getModuleAddress()
long	getNanotimeLastTransmit()
TimeWindow	getPayloadTimeWindow()
int	getReferenceNumber()
LynxDatagram	getSerialization()
boolean	hasBeenTransmitted()
static java.lang.Object	invokeStaticNullaryMethod(java.lang.Class clazz, java.lang.String methodName)
boolean	isAck()
boolean	isAckable()
boolean	isNack()
boolean	isResponse()
boolean	isResponseExpected() Returns whether this message will generate a response message in return.
void	loadFromSerialization()
void	noteHasBeenTransmitted()
void	noteRetransmission()
void	onPretendTransmit()
void	releaseNetworkLock()
void	resetModulePingTimer()
void	setMessageNumber(int value)
void	setModule(LynxModule module)
void	setNanotimeLastTransmit(long value)
void	setPayloadTimeWindow(TimeWindow payloadTimeWindow)
void	setReferenceNumber(int value)
void	setSerialization(LynxDatagram datagram)
abstract byte[]	toPayloadByteArray()

Methods inherited from class java.lang.Object

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

Field Detail

module

protected LynxModuleIntf module

messageNumber

protected byte messageNumber

referenceNumber

protected byte referenceNumber

serialization

protected LynxDatagram serialization

hasBeenTransmitted

protected boolean hasBeenTransmitted

nanotimeLastTransmit

protected long nanotimeLastTransmit

payloadTimeWindow

protected TimeWindow payloadTimeWindow

Constructor Detail

LynxMessage

public LynxMessage(LynxModuleIntf module)

Method Detail

invokeStaticNullaryMethod

public static java.lang.Object invokeStaticNullaryMethod(java.lang.Class clazz,
                                                         java.lang.String methodName)
                                                  throws java.lang.NoSuchMethodException,
                                                         java.lang.IllegalAccessException,
                                                         java.lang.reflect.InvocationTargetException

Throws:

java.lang.NoSuchMethodException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

getDestModuleAddress

public int getDestModuleAddress()

noteHasBeenTransmitted

public void noteHasBeenTransmitted()

hasBeenTransmitted

public boolean hasBeenTransmitted()

getNanotimeLastTransmit

public long getNanotimeLastTransmit()

setNanotimeLastTransmit

public void setNanotimeLastTransmit(long value)

noteRetransmission

public void noteRetransmission()

acquireNetworkLock

public void acquireNetworkLock()
                        throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

releaseNetworkLock

public void releaseNetworkLock()
                        throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

onPretendTransmit

public void onPretendTransmit()
                       throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

resetModulePingTimer

public void resetModulePingTimer()

getModule

public LynxModuleIntf getModule()

setModule

public void setModule(LynxModule module)

getModuleAddress

public int getModuleAddress()

getMessageNumber

public int getMessageNumber()

setMessageNumber

public void setMessageNumber(int value)

getReferenceNumber

public int getReferenceNumber()

setReferenceNumber

public void setReferenceNumber(int value)

getPayloadTimeWindow

public TimeWindow getPayloadTimeWindow()

setPayloadTimeWindow

public void setPayloadTimeWindow(TimeWindow payloadTimeWindow)

getSerialization

public LynxDatagram getSerialization()

forgetSerialization

public void forgetSerialization()

setSerialization

public void setSerialization(LynxDatagram datagram)

loadFromSerialization

public void loadFromSerialization()

getCommandNumber

public abstract int getCommandNumber()

toPayloadByteArray

public abstract byte[] toPayloadByteArray()

fromPayloadByteArray

public abstract void fromPayloadByteArray(byte[] rgb)

isAckable

public boolean isAckable()

isAck

public boolean isAck()

isNack

public boolean isNack()

isResponseExpected

public boolean isResponseExpected()

Returns whether this message will generate a response message in return. Ackables which do *not* generate a response will generate an ack instead.

isResponse

public boolean isResponse()