org.ka2ddo.aprs

Class StatusMessage

java.lang.Object

org.ka2ddo.ax25.AX25Message

org.ka2ddo.aprs.Message

org.ka2ddo.aprs.StatusMessage

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<AX25Message>, CommentedMessage, SendableMessage

public class StatusMessage
extends Message
implements SendableMessage

This class decodes a Status message (APRS protocol specification chapter 16). Note that Status messages with Maidenhead locator prefixes are decoded as MaidenheadLocatorBeacon class objects instead,

Author:

Andrew Pavlin, KA2DDO

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.ka2ddo.ax25.AX25Message

AX25Message.Precedence

Field Summary

Fields inherited from class org.ka2ddo.aprs.Message

appendCR, APRS_AND_OPENTRAC_AND_RAW, APRS_AND_RAW, comment, msgType, S_PERMANENT, S_PERMANENT_UC, symbolCode, symTableId

Fields inherited from class org.ka2ddo.ax25.AX25Message

APRS_AND_OPENTRAC, ax25Frame, extensions, invalid, originatingCallsign, originatingDest, PERMANENT, rcptTime, thirdParty, timestamp, UTC

Constructor Summary

Constructors

Constructor and Description
StatusMessage(byte[] body, int offset, java.lang.String tp, long rcvTimestamp) Constructor for Status message when decoding a binary AX.25 frame.
StatusMessage(long now, java.lang.String comment) Alternate constructor for creating transmittable StatusMessage.

Method Summary

Modifier and Type	Method and Description
void	disableForTransmit() Specify that message should no longer be transmitted.
byte[]	getBody(boolean countTransmission, ProtocolFamily protocolId, AX25Frame frame) Get an instance of this message, suitable for transmitting.
java.util.Set<ProtocolFamily>	getProtocols() Get the protocol family or families that this message corresponds to, so ports that don't support all protocols will not forward inappropriate packets.
boolean	isEnabled() Test if message should still be transmitted.

Methods inherited from class org.ka2ddo.aprs.Message

bodyEquals, compareTo, decodeDatestamp, decodeHurricaneParams, decodeTimestamp, decodeWeatherParams, decodeWeatherParams, dup, encodeTimestamp, extractComment, extractComment, extractSymbol, formatBody, getComment, getExtensionString, getMsgType, getPrecedence, getSymbolCode, getSymTableId, hasWeather, inferSymbol, isAppendCR, isSymbolInferred, looksLikeLongFormatLatitude, paramString, setAppendCR, setComment, setSymbolCode, setSymTableId, toString

Methods inherited from class org.ka2ddo.ax25.AX25Message

equals, extractSource, getAx25Frame, getExtension, getFirstDigipeat, getLastDigipeat, getNthDigipeat, getOriginalDestination, getOriginalSource, getOriginatingCallsign, getOriginatingDest, getRcptTime, getReadOnlyExtensionMap, getTimestamp, hashCode, hasPosition, hasThisFirstDigi, indexOf, indexOf, isDirect, isInvalid, isRf, onlyDigits, onlyDigits, onlyDigitsOrMinus, onlyDigitsOrPeriod, onlyDigitsOrSpace, onlyDigitsPlus, onlyPeriods, setAx25Frame, setInvalid, setOriginatingCallsign, setRcptTime, setTimestamp, split, storeExtension

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ka2ddo.ax25.SendableMessage

dup

Constructor Detail

StatusMessage

public StatusMessage(byte[] body,
                     int offset,
                     java.lang.String tp,
                     long rcvTimestamp)

Constructor for Status message when decoding a binary AX.25 frame.

Parameters:

body - byte array of frame body

offset - int array index offset for start of message (non-zero for encapsulated messages)

tp - third-party relay String for encapsulated messages, or null for no third-party wrapper

rcvTimestamp - Unix time when message was actually received by YAAC

StatusMessage

public StatusMessage(long now,
                     java.lang.String comment)

Alternate constructor for creating transmittable StatusMessage.

Parameters:

now - current time in Java milliseconds since midnight Jan 1 1970 UTC

comment - status String

Method Detail

getBody

public byte[] getBody(boolean countTransmission,
                      ProtocolFamily protocolId,
                      AX25Frame frame)

Get an instance of this message, suitable for transmitting.

Specified by:

getBody in interface SendableMessage

Parameters:

countTransmission - number of times the message has been transmitted.

protocolId - ProtocolFamily to generate the message in

frame - AX25Frame into which the message will be placed; the decoded message (as opposed to the byte array encoding) should be stored into the field frame.parsedAX25Msg

Returns:

byte array of message, or null if message body cannot be generated in specified protocol, or retransmission count has been exceeded.

See Also:

AX25Frame.parsedAX25Msg

isEnabled

public boolean isEnabled()

Test if message should still be transmitted.

Specified by:

isEnabled in interface SendableMessage

Returns:

boolean true if message should still be transmitted

disableForTransmit

public void disableForTransmit()

Specify that message should no longer be transmitted.

Specified by:

disableForTransmit in interface SendableMessage

getProtocols

public java.util.Set<ProtocolFamily> getProtocols()

Get the protocol family or families that this message corresponds to, so ports that don't support all protocols will not forward inappropriate packets.

Overrides:

getProtocols in class Message

Returns:

array of supported ProtocolFamily enums