|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.ka2ddo.ax25.AX25Message
org.ka2ddo.aprs.Message
org.ka2ddo.aprs.MessageMessage
public class MessageMessage
This class encodes an addressed Message APRS message (APRS protocol specification chapter 14). Note that one form of Message can be a directed query (APRS protocol specification chapter 15).
Query
,
Serialized FormNested Class Summary |
---|
Nested classes/interfaces inherited from class org.ka2ddo.ax25.AX25Message |
---|
AX25Message.Precedence |
Nested classes/interfaces inherited from interface org.ka2ddo.ax25.SignableMessage |
---|
SignableMessage.SignatureState |
Field Summary | |
---|---|
boolean |
acked
Flag indicating if a locally-originated message has been acknowledged. |
java.lang.String |
addressee
Addressee of the message. |
int |
numTransmissions
Number of times the message should be transmitted before giving up. |
java.lang.String |
serialNumber
Sequence number of this message used for acknowledgment. |
SignableMessage.SignatureState |
signatureState
Quality of the signature (if any) associated with this message. |
Fields inherited from class org.ka2ddo.aprs.Message |
---|
comment, extensions, msgType, S_PERMANENT, S_PERMANENT_UC, symbolCode, symTableId, USASCII |
Fields inherited from class org.ka2ddo.ax25.AX25Message |
---|
ax25Frame, invalid, ISO_8859_1, originatingCallsign, PERMANENT, rcptTime, thirdParty, timestamp, UTC, UTF8 |
Constructor Summary | |
---|---|
MessageMessage(byte[] body,
int offset,
java.lang.String tp,
long rcvTimestamp)
Decode a MessageMessage from a byte array. |
|
MessageMessage(java.lang.String addressee,
java.lang.String body)
Create a new partially-initialized MessageMessage, suitable for transmission. |
|
MessageMessage(java.lang.String addressee,
java.lang.String body,
java.lang.String serialNum)
Create a new partially-initialized MessageMessage, suitable for transmission. |
Method Summary | |
---|---|
java.lang.String |
getAddressee()
Report the addressee of this message. |
byte[] |
getBody(boolean countTransmission,
byte protocolId,
AX25Frame frame)
Get an instance of this message, suitable for transmitting. |
java.lang.String |
getKeyAlias()
Get the alias for the key that should be used to sign this message at transmission time. |
java.lang.String |
getQuery()
Test whether this MessageMessage contains a directed query (APRS protocol specification chapter 15). |
java.lang.String |
getSignature()
Get the ASCII-encoded signature of this message. |
SignableMessage.SignatureState |
getSignatureState()
Report the status of the signature of this message. |
boolean |
isEnabled()
Test if message should still be transmitted. |
java.lang.String |
paramString()
Descriptive text about this message, to be included in the toString() method's response. |
void |
setKeyAlias(java.lang.String alias)
Set the alias for the key that should be used to sign this message at transmission time. |
void |
setSignature(java.lang.String signature)
Set the ASCII-encoded signature of this message. |
void |
writeToSigningBuf(java.io.DataOutput dos,
java.io.PrintStream ps)
Write the appropriate part of the body of this message to the signing buffer. |
Methods inherited from class org.ka2ddo.aprs.Message |
---|
bodyEquals, compareTo, decodeDatestamp, decodeHurricaneParams, decodeTimestamp, decodeWeatherParams, decodeWeatherParams, dup, encodeTimestamp, extractComment, extractComment, extractSymbol, formatBody, getComment, getExtension, getExtensionString, getMsgType, getReadOnlyExtensionMap, getSymbolCode, getSymTableId, hasWeather, inferSymbol, isSymbolInferred, looksLikeLongFormatLatitude, setComment, setSymbolCode, setSymTableId, storeExtension, toString |
Methods inherited from class org.ka2ddo.ax25.AX25Message |
---|
equals, extractSource, getAx25Frame, getFirstDigipeat, getLastDigipeat, getOriginalDestination, getOriginalSource, getOriginatingCallsign, getPrecedence, getRcptTime, getTimestamp, hashCode, hasPosition, hasThisFirstDigi, indexOf, indexOf, isInvalid, onlyDigits, onlyDigits, onlyDigitsOrPeriod, onlyDigitsOrSpace, onlyDigitsPlus, onlyPeriods, setAx25Frame, setInvalid, setOriginatingCallsign, setRcptTime, setTimestamp, split |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.ka2ddo.ax25.SignableMessage |
---|
getOriginatingCallsign, getTimestamp |
Methods inherited from interface org.ka2ddo.ax25.SendableMessage |
---|
dup |
Field Detail |
---|
public java.lang.String addressee
public java.lang.String serialNumber
public boolean acked
public int numTransmissions
public SignableMessage.SignatureState signatureState
Constructor Detail |
---|
public MessageMessage(byte[] body, int offset, java.lang.String tp, long rcvTimestamp)
body
- byte array containing the messageoffset
- index into the array where the message startstp
- third-party routing String, or null if not routed from another networkrcvTimestamp
- time in Java milliseconds since 1 Jan 1970 UTC when the message was receivedpublic MessageMessage(java.lang.String addressee, java.lang.String body)
addressee
- String addressee for the messagebody
- String body text of the messagepublic MessageMessage(java.lang.String addressee, java.lang.String body, java.lang.String serialNum)
addressee
- String addressee for the messagebody
- String body text of the messageserialNum
- String serial number for the message (indicates it should be acknowledged)Method Detail |
---|
public java.lang.String paramString()
paramString
in class Message
Message.toString()
public java.lang.String getAddressee()
public java.lang.String getQuery()
public byte[] getBody(boolean countTransmission, byte protocolId, AX25Frame frame)
getBody
in interface SendableMessage
countTransmission
- number of times the message has been transmittedprotocolId
- AX.25 protocol type for this messageframe
- AX25Frame into which the message will be placed, so any alternate AX25Message can be linked to it
AX25Frame.parsedAX25Msg
public boolean isEnabled()
isEnabled
in interface SendableMessage
public SignableMessage.SignatureState getSignatureState()
getSignatureState
in interface SignableMessage
public void setKeyAlias(java.lang.String alias)
setKeyAlias
in interface SignableMessage
alias
- String name that should match a secret key in the key managerpublic java.lang.String getKeyAlias()
getKeyAlias
in interface SignableMessage
public java.lang.String getSignature()
getSignature
in interface AprsSignableMessage
public void setSignature(java.lang.String signature)
setSignature
in interface AprsSignableMessage
signature
- String of the signature, or null to remove any pre-existing signaturepublic void writeToSigningBuf(java.io.DataOutput dos, java.io.PrintStream ps)
writeToSigningBuf
in interface SignableMessage
dos
- DataOutput that will accept binary writes of the message dataps
- PrintStream that will accept character writes of the message data
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |