Package org.ka2ddo.yaac.io
Class PortConfig.Cfg
java.lang.Object
org.ka2ddo.yaac.io.PortConfig.Cfg
- All Implemented Interfaces:
Serializable
,Comparable<PortConfig.Cfg>
- Enclosing class:
- PortConfig
public static class PortConfig.Cfg
extends Object
implements Serializable, Comparable<PortConfig.Cfg>
Port-type-specific configuration parameters for a PortConnector.
- Author:
- Andrew Pavlin, KA2DDO
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionint
Bit mask or enum number of protocols that can be transmitted through this port.int
The baud rate used for the port, if needed, or port number for TCP and UDP socket connections.String[]
Names of beacon instances to send through this port (zero-length array means only default beacon).The amateur radio station callsign associated with this port, if needed.The device name or network host name/address associated with this port.String[]
Array of digipeat alias Strings for which this port will digipeat (if transmitAllowed is true).Any filter expression associated with this port, if needed.int
A collection of flag bits indicating other attributes of the port configuration.boolean
Indicates whether flow control is enabled on this port.The authentication passcode associated with this port, if needed.int
Number of seconds in a timeslot cycle, which will be aligned to UTC and the Unix epoch time (if some weird prime number is used).int
Number of seconds in a timeslot.int
Number of seconds since the start of a cycle when this port is allowed to transmit.boolean
Indicates whether messages can be transmitted from YAAC via this port. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
Compares this object with the specified object for order.dup()
Make a deep copy of this Cfg object.boolean
Indicates whether some other object is "equal to" this one.int
hashCode()
Returns a hash code value for the object.toString()
Returns a string representation of the object.
-
Field Details
-
deviceName
The device name or network host name/address associated with this port. -
baudRate
public int baudRateThe baud rate used for the port, if needed, or port number for TCP and UDP socket connections. -
callsign
The amateur radio station callsign associated with this port, if needed. Also used for weather station model name. -
passcode
The authentication passcode associated with this port, if needed. -
filter
Any filter expression associated with this port, if needed. -
transmitAllowed
public boolean transmitAllowedIndicates whether messages can be transmitted from YAAC via this port. -
flowControlled
public boolean flowControlledIndicates whether flow control is enabled on this port. -
flags
public int flagsA collection of flag bits indicating other attributes of the port configuration.- See Also:
-
digiAliases
Array of digipeat alias Strings for which this port will digipeat (if transmitAllowed is true).- See Also:
-
acceptableProtocolsMask
public int acceptableProtocolsMaskBit mask or enum number of protocols that can be transmitted through this port. Only meaningful for ports with CAP_XMT_PACKET_DATA set (for protocol bitmask) or CAP_WAYPOINT_SENDER (for enum). -
timeslotCycleLength
public int timeslotCycleLengthNumber of seconds in a timeslot cycle, which will be aligned to UTC and the Unix epoch time (if some weird prime number is used). Negative values means timeslotting is disabled, but is preserving the last-used cycle length in case it gets re-enabled. -
timeslotOffset
public int timeslotOffsetNumber of seconds since the start of a cycle when this port is allowed to transmit. This should be an integer multiple oftimeslotLength
greater than or equal to zero, but less than thetimeslotCycleLength
. -
timeslotLength
public int timeslotLengthNumber of seconds in a timeslot. This should be a positive integer fraction of thetimeslotCycleLength
. Zero or negative means that once a station enters its timeslot, it can transmit until its queue for the port is empty, rather than having to stop because another station's timeslot has started. -
beaconNames
Names of beacon instances to send through this port (zero-length array means only default beacon).- See Also:
-
-
Constructor Details
-
Cfg
public Cfg()
-
-
Method Details
-
dup
Make a deep copy of this Cfg object.- Returns:
- duplicate Cfg
-
compareTo
Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.- Specified by:
compareTo
in interfaceComparable<PortConfig.Cfg>
- Parameters:
o
- the object to be compared.- Returns:
- a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
- Throws:
ClassCastException
- if the specified object's type prevents it from being compared to this object.
-
equals
Indicates whether some other object is "equal to" this one. -
hashCode
public int hashCode()Returns a hash code value for the object. -
toString
Returns a string representation of the object.
-