org.ka2ddo.ax25

Interface SendableMessage

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

AprsSignableMessage, LimitedSendableMessage, ScopeableMessage

All Known Implementing Classes:

BeaconData, DefaultMessage, MaidenheadLocatorBeacon, MessageMessage, MicE, ObjectReport, OpenTracMessage, PositionlessWeatherReport, PositionReport, Query, StationCapabilities, StatusData, StatusMessage, TelemetryMessage

public interface SendableMessage
extends java.io.Serializable

This interface tags a decoded AX25Message that can be converted back to transmittable form.

Author:

Andrew Pavlin, KA2DDO

Method Summary

Modifier and Type	Method and Description
void	disableForTransmit() Specify that message should no longer be transmitted.
AX25Message	dup() Creates and returns a copy of this Message.
byte[]	getBody(boolean countTransmission, ProtocolFamily protocolId, AX25Frame frame) Get an instance of this message, suitable for transmitting.
boolean	isEnabled() Test if message should still be transmitted.

Method Detail

getBody

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

Get an instance of this message, suitable for transmitting.

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

boolean isEnabled()

Test if message should still be transmitted.

Returns:

boolean true if message should still be transmitted

disableForTransmit

void disableForTransmit()

Specify that message should no longer be transmitted.

dup

AX25Message dup()

Creates and returns a copy of this Message.

Returns:

a clone of this instance.