org.ka2ddo.ax25

Enum ProtocolFamily

java.lang.Object

java.lang.Enum<ProtocolFamily>

org.ka2ddo.ax25.ProtocolFamily

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ProtocolFamily>

public enum ProtocolFamily
extends java.lang.Enum<ProtocolFamily>

This enumeration categorizes AX.25 messages by what protocol they are carrying, to make it easier for YAAC I/O ports to determine if a particular AX25Frame should be sent out a particular port.

Author:

Andrew Pavlin, KA2DDO

Enum Constant Summary

Enum Constants

Enum Constant and Description
APRS APRS packets over AX.25 UI frames, PID=0xF0 (NOLVL3)n.
OPENTRAC OpenTRAC packets over AX.25 UI frames, PID=0x77 (OPENTRAC).
OTHER Some other transport provided by a plugin's PortConnector subclass, where the PortConnector is entirely responsible for any packet reformatting.
RAW_AX25 Other level 2 AX.25 frames, including connected-mode frames, PID=0xF0 (NOLVL3).

Method Summary

Modifier and Type	Method and Description
byte	getPid() Get the AX.25 protocol ID value associated with this ProtocolFamily.
static ProtocolFamily	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ProtocolFamily[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

APRS

public static final ProtocolFamily APRS

APRS packets over AX.25 UI frames, PID=0xF0 (NOLVL3)n.

See Also:

PortConfig.PROTOCOL_APRS

OPENTRAC

public static final ProtocolFamily OPENTRAC

OpenTRAC packets over AX.25 UI frames, PID=0x77 (OPENTRAC).

See Also:

PortConfig.PROTOCOL_OPENTRAC

RAW_AX25

public static final ProtocolFamily RAW_AX25

Other level 2 AX.25 frames, including connected-mode frames, PID=0xF0 (NOLVL3).

See Also:

PortConfig.PROTOCOL_AX25

OTHER

public static final ProtocolFamily OTHER

Some other transport provided by a plugin's PortConnector subclass, where the PortConnector is entirely responsible for any packet reformatting.

Since:

PROVIDER_API_VERSION == 47

See Also:

PortConfig.PROTOCOL_OTHER_TRANSPORT

Method Detail

values

public static ProtocolFamily[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ProtocolFamily c : ProtocolFamily.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ProtocolFamily valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getPid

public byte getPid()

Get the AX.25 protocol ID value associated with this ProtocolFamily.

Returns:

PID value