Package jmri.jmrix.mqtt
Class MqttThrottleManager
java.lang.Object
jmri.jmrix.AbstractThrottleManager
jmri.jmrix.mqtt.MqttThrottleManager
- All Implemented Interfaces:
ThrottleManager
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
FieldsFields inherited from class jmri.jmrix.AbstractThrottleManager
adapterMemo, userName -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanThere are no ambiguous addresses on this system.booleancanBeLongAddress(int address) Address 128 and above is a long addressbooleancanBeShortAddress(int address) Address between 1 and 127 is a short addressvoidThe throttle listener has finished with the specific Throttle and is is available for reuse/reallocation by somebody else.booleanNot for general use, seereleaseThrottleanddispatchThrottle.booleanMQTT based systems DO use the Dispatch Functionprotected static booleanisLongAddress(int num) voidThe specified Throttle Listener has finished using a given throttle and no longer requires access to it.voidrequestThrottleSetup(LocoAddress address, boolean control) Request a new throttle object be created for the address, and let the throttle listeners know about it.voidsetRcvDirectionTopic(String rcvDirectionTopic) voidsetRcvFunctionTopic(String rcvFunctionTopic) voidsetRcvThrottleTopic(String rcvThrottleTopic) voidsetSendDirectionTopic(String sendDirectionTopic) voidsetSendFunctionTopic(String sendFunctionTopic) voidsetSendThrottleTopic(String sendThrottleTopic) protected booleanMQTT based systems can have multiple throttles for the same deviceWhat 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
-
Field Details
-
throttles
-
sendThrottleTopic
-
rcvThrottleTopic
-
sendDirectionTopic
-
rcvDirectionTopic
-
sendFunctionTopic
-
rcvFunctionTopic
-
-
Constructor Details
-
MqttThrottleManager
Constructor.- Parameters:
memo- the memo for the connection this tm will use
-
-
Method Details
-
setSendThrottleTopic
-
setRcvThrottleTopic
-
setSendDirectionTopic
-
setRcvDirectionTopic
-
setSendFunctionTopic
-
setRcvFunctionTopic
-
requestThrottleSetup
Request a new throttle object be created for the address, and let the throttle listeners know about it.- Specified by:
requestThrottleSetupin classAbstractThrottleManager- Parameters:
address- addresscontrol- false - read only.
-
hasDispatchFunction
MQTT based systems DO use the Dispatch Function- Specified by:
hasDispatchFunctionin interfaceThrottleManager- Overrides:
hasDispatchFunctionin classAbstractThrottleManager- Returns:
- true if dispatch is possible; false otherwise
-
singleUse
MQTT based systems can have multiple throttles for the same deviceDoes this DCC system allow a Throttle (e.g. an address) to be used by only one user at a time?
- Overrides:
singleUsein classAbstractThrottleManager- Returns:
- true or false
-
canBeLongAddress
Address 128 and above is a long address- Parameters:
address- address number to test- Returns:
- true if address can be long; false otherwise
-
canBeShortAddress
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
There are no ambiguous addresses on this system.- Returns:
- true if ambiguous addresses are not allowed; false otherwise
-
isLongAddress
-
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:
supportedSpeedModesin interfaceThrottleManager- Overrides:
supportedSpeedModesin classAbstractThrottleManager- Returns:
- an XOR of the possible modes specified in the throttle interface
-
disposeThrottle
Not for general use, seereleaseThrottleanddispatchThrottle.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:
disposeThrottlein interfaceThrottleManager- Overrides:
disposeThrottlein classAbstractThrottleManager- Parameters:
t- Throttle being releasedl- Throttle Listener releasing the throttle- Returns:
- true if the throttle has been disposed of.
-
dispatchThrottle
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:
dispatchThrottlein interfaceThrottleManager- Overrides:
dispatchThrottlein classAbstractThrottleManager- Parameters:
t- Throttle being releasedl- Throttle Listener releasing the throttle
-
releaseThrottle
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:
releaseThrottlein interfaceThrottleManager- Overrides:
releaseThrottlein classAbstractThrottleManager- Parameters:
t- Throttle being releasedl- Throttle Listener releasing the throttle
-