Package jmri.jmrix.mqtt

Class MqttThrottleManager

java.lang.Object

jmri.jmrix.AbstractThrottleManager

jmri.jmrix.mqtt.MqttThrottleManager

All Implemented Interfaces:

ThrottleManager

public class MqttThrottleManager
extends AbstractThrottleManager

MQTT implementation of a ThrottleManager based on the AbstractThrottleManager.

Nested Class Summary

Nested classes/interfaces inherited from class jmri.jmrix.AbstractThrottleManager

AbstractThrottleManager.Addresses

Field Summary

Fields

Modifier and Type	Field	Description
String	rcvDirectionTopic
String	rcvFunctionTopic
String	rcvThrottleTopic
String	sendDirectionTopic
String	sendFunctionTopic
String	sendThrottleTopic
protected HashMap<LocoAddress,MqttThrottle>	throttles

Fields inherited from class jmri.jmrix.AbstractThrottleManager

adapterMemo, userName

Constructor Summary

Constructors

Constructor	Description
MqttThrottleManager(MqttSystemConnectionMemo memo)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	addressTypeUnique()	There are no ambiguous addresses on this system.
boolean	canBeLongAddress(int address)	Address 128 and above is a long address
boolean	canBeShortAddress(int address)	Address between 1 and 127 is a short address
void	dispatchThrottle(DccThrottle t, ThrottleListener l)	The throttle listener has finished with the specific Throttle and is is available for reuse/reallocation by somebody else.
boolean	disposeThrottle(DccThrottle t, ThrottleListener l)	Not for general use, see releaseThrottle and dispatchThrottle.
boolean	hasDispatchFunction()	MQTT based systems DO use the Dispatch Function
protected static boolean	isLongAddress(int num)
void	releaseThrottle(DccThrottle t, ThrottleListener l)	The specified Throttle Listener has finished using a given throttle and no longer requires access to it.
void	requestThrottleSetup(LocoAddress address, boolean control)	Request a new throttle object be created for the address, and let the throttle listeners know about it.
void	setRcvDirectionTopic(String rcvDirectionTopic)
void	setRcvFunctionTopic(String rcvFunctionTopic)
void	setRcvThrottleTopic(String rcvThrottleTopic)
void	setSendDirectionTopic(String sendDirectionTopic)
void	setSendFunctionTopic(String sendFunctionTopic)
void	setSendThrottleTopic(String sendThrottleTopic)
protected boolean	singleUse()	MQTT based systems can have multiple throttles for the same device
EnumSet<SpeedStepMode>	supportedSpeedModes()	What speed modes are supported by this system?

Methods inherited from class jmri.jmrix.AbstractThrottleManager

addressReleased, addressStillRequired, addressStillRequired, addressStillRequired, addressStillRequired, attachListener, cancelThrottleRequest, cancelThrottleRequest, cancelThrottleRequest, cancelThrottleRequest, dispose, enablePrefSilentShareOption, enablePrefSilentStealOption, failedThrottleRequest, forceDisposeThrottle, getAddress, getAddress, getAddressProtocolTypes, getAddressTypes, getAddressTypeString, getProtocolFromString, getThrottleInfo, getThrottleUsageCount, getThrottleUsageCount, getThrottleUsageCount, getThrottleUsageCount, getUserName, hideStealNotifications, makeHardwareDecision, notifyDecisionRequest, notifyThrottleKnown, removeListener, requestThrottle, requestThrottle, requestThrottle, requestThrottle, requestThrottle, requestThrottle, requestThrottleSetup, responseThrottleDecision, responseThrottleDecision, responseThrottleDecision, showSessionCancelDialogue, updateNumUsers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

throttles

protected HashMap<LocoAddress,MqttThrottle> throttles

sendThrottleTopic

@Nonnull
public String sendThrottleTopic

rcvThrottleTopic

@Nonnull
public String rcvThrottleTopic

sendDirectionTopic

@Nonnull
public String sendDirectionTopic

rcvDirectionTopic

@Nonnull
public String rcvDirectionTopic

sendFunctionTopic

@Nonnull
public String sendFunctionTopic

rcvFunctionTopic

@Nonnull
public String rcvFunctionTopic

Constructor Details

MqttThrottleManager

public MqttThrottleManager(MqttSystemConnectionMemo memo)

Constructor.

Parameters:

memo - the memo for the connection this tm will use

Method Details

setSendThrottleTopic

public void setSendThrottleTopic(@Nonnull
 String sendThrottleTopic)

setRcvThrottleTopic

public void setRcvThrottleTopic(@Nonnull
 String rcvThrottleTopic)

setSendDirectionTopic

public void setSendDirectionTopic(@Nonnull
 String sendDirectionTopic)

setRcvDirectionTopic

public void setRcvDirectionTopic(@Nonnull
 String rcvDirectionTopic)

setSendFunctionTopic

public void setSendFunctionTopic(@Nonnull
 String sendFunctionTopic)

setRcvFunctionTopic

public void setRcvFunctionTopic(@Nonnull
 String rcvFunctionTopic)

requestThrottleSetup

public void requestThrottleSetup(LocoAddress address,
 boolean control)

Request a new throttle object be created for the address, and let the throttle listeners know about it.

Specified by:

requestThrottleSetup in class AbstractThrottleManager

Parameters:

address - address

control - false - read only.

hasDispatchFunction

public boolean hasDispatchFunction()

MQTT based systems DO use the Dispatch Function

Specified by:

hasDispatchFunction in interface ThrottleManager

Overrides:

hasDispatchFunction in class AbstractThrottleManager

Returns:

true if dispatch is possible; false otherwise

singleUse

protected boolean singleUse()

MQTT based systems can have multiple throttles for the same device

Does this DCC system allow a Throttle (e.g. an address) to be used by only one user at a time?

Overrides:

singleUse in class AbstractThrottleManager

Returns:

true or false

canBeLongAddress

public boolean canBeLongAddress(int address)

Address 128 and above is a long address

Parameters:

address - address number to test

Returns:

true if address can be long; false otherwise

canBeShortAddress

public boolean canBeShortAddress(int address)

Address between 1 and 127 is a short address

Parameters:

address - address number to test

Returns:

true if address can be short; false otherwise

addressTypeUnique

public boolean addressTypeUnique()

There are no ambiguous addresses on this system.

Returns:

true if ambiguous addresses are not allowed; false otherwise

isLongAddress

protected static boolean isLongAddress(int num)

supportedSpeedModes

public EnumSet<SpeedStepMode> supportedSpeedModes()

What speed modes are supported by this system? value should be xor of possible modes specifed by the DccThrottle interface DCC++ supports 14,27,28 and 128 speed step modes

Specified by:

supportedSpeedModes in interface ThrottleManager

Overrides:

supportedSpeedModes in class AbstractThrottleManager

Returns:

an XOR of the possible modes specified in the throttle interface

disposeThrottle

public boolean disposeThrottle(DccThrottle t,
 ThrottleListener l)

Not for general use, see releaseThrottle and dispatchThrottle.

Dispose of object when finished it. This will free up hardware resource

Used for handling certain internal error conditions, where the object still exists but hardware is not associated with it.

After this, further usage of this Throttle object will result in a JmriException.

Specified by:

disposeThrottle in interface ThrottleManager

Overrides:

disposeThrottle in class AbstractThrottleManager

Parameters:

t - Throttle being released

l - Throttle Listener releasing the throttle

Returns:

true if the throttle has been disposed of.

dispatchThrottle

public void dispatchThrottle(DccThrottle t,
 ThrottleListener l)

The throttle listener has finished with the specific Throttle and is is available for reuse/reallocation by somebody else. If possible, tell the layout that this locomotive has been dispatched to another user. Not all layouts will implement this, in which case it is synomous with release();

Normally, dispatch ends with a call to dispose.

Specified by:

dispatchThrottle in interface ThrottleManager

Overrides:

dispatchThrottle in class AbstractThrottleManager

Parameters:

t - Throttle being released

l - Throttle Listener releasing the throttle

releaseThrottle

public void releaseThrottle(DccThrottle t,
 ThrottleListener l)

The specified Throttle Listener has finished using a given throttle and no longer requires access to it.

After releasing the throttle, the manager will perform further checks to see if it is in use by any other listeners or if there are any PropertyChangeListeners attached. If there are no other uses of the throttle then it is disposed of.

Normally, release ends with a call to dispose.

Specified by:

releaseThrottle in interface ThrottleManager

Overrides:

releaseThrottle in class AbstractThrottleManager

Parameters:

t - Throttle being released

l - Throttle Listener releasing the throttle