Package jmri.jmrix.cmri.serial
Class SerialTrafficController
- java.lang.Object
-
- jmri.jmrix.AbstractMRTrafficController
-
- jmri.jmrix.AbstractMRNodeTrafficController
-
- jmri.jmrix.cmri.serial.SerialTrafficController
-
- All Implemented Interfaces:
SerialInterface
public class SerialTrafficController extends AbstractMRNodeTrafficController implements SerialInterface
Converts Stream-based I/O to/from C/MRI serial messages.The "SerialInterface" side sends/receives message objects.
The connection to a SerialPortController is via a pair of *Streams, which then carry sequences of characters for transmission. Note that this processing is handled in an independent thread.
This handles the state transitions, based on the necessary state in each message.
Handles initialization, polling, output, and input for multiple Serial Nodes.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class jmri.jmrix.AbstractMRTrafficController
AbstractMRTrafficController.RcvNotifier, AbstractMRTrafficController.XmtNotifier
-
-
Field Summary
Fields Modifier and Type Field Description java.util.ArrayList<java.lang.Integer>
cmriNetPollList
(package private) CMRInetMetricsCollector
metricsCollector
Create a new C/MRI SerialTrafficController instance.(package private) SerialSensorManager
mSensorManager
boolean
pollNetwork
-
Fields inherited from class jmri.jmrix.AbstractMRNodeTrafficController
curSerialNodeIndex, maxNode, minNode, nodeArray, numNodes
-
Fields inherited from class jmri.jmrix.AbstractMRTrafficController
allowUnexpectedReply, AUTORETRYSTATE, cmdListeners, connectionError, controller, flushReceiveChars, IDLESTATE, istream, listenerQueue, maxRcvExceptionCount, mCurrentMode, mCurrentState, mLastSender, msgQueue, mWaitBeforePoll, NORMALMODE, NOTIFIEDSTATE, OKSENDMSGSTATE, ostream, POLLSTATE, PROGRAMINGMODE, rcvException, rcvThread, replyInDispatch, threadStopRequest, timeoutFlag, timeouts, WAITMSGREPLYSTATE, WAITREPLYINNORMMODESTATE, WAITREPLYINPROGMODESTATE, waitTimePoll, xmtException, xmtRunnable, xmtThread
-
-
Constructor Summary
Constructors Constructor Description SerialTrafficController()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected int
addHeaderToOutput(byte[] msg, AbstractMRMessage m)
Add header to the outgoing byte stream.void
addSerialListener(SerialListener l)
protected void
addTrailerToOutput(byte[] msg, int offset, AbstractMRMessage m)
Add trailer to the outgoing byte stream.protected boolean
endOfMessage(AbstractMRReply msg)
protected AbstractMRMessage
enterNormalMode()
Sets the system to normal mode during programming while in IDLESTATE.protected AbstractMRMessage
enterProgMode()
Set the system to programming mode.protected void
forwardMessage(AbstractMRListener client, AbstractMRMessage m)
Forward a message to all registered listeners.protected void
forwardReply(AbstractMRListener client, AbstractMRReply m)
Forward a reply to all registered listeners.int
getInitTimeout()
CMRInetMetricsData
getMetricsData()
Expose metrics databoolean
getPollNetwork()
int
getXmitTimeout()
protected void
handleTimeout(AbstractMRMessage m, AbstractMRListener l)
void
initializeSerialNode(SerialNode node)
Initialize a CMRI node.protected int
lengthOfByteStream(AbstractMRMessage m)
Determine how much many bytes the entire message will take, including space for header and trailerprotected void
loadChars(AbstractMRReply msg, java.io.DataInputStream istream)
Get characters from the input source, and file a message.protected AbstractMRReply
newReply()
protected AbstractMRMessage
pollMessage()
Handles initialization, output and polling for C/MRI Serial Nodes from within the running thread.protected AbstractMRListener
pollReplyHandler()
void
removeSerialListener(SerialListener l)
protected void
resetTimeout(AbstractMRMessage m)
void
sendSerialMessage(SerialMessage m, SerialListener reply)
Forward a pre-formatted message to the actual interface.void
setInitTimeout(int init_Timeout)
void
setPollNetwork(boolean OnOff)
void
setSensorManager(SerialSensorManager m)
void
setXmitTimeout(int init_XmitTimeout)
protected void
unexpectedReplyStateError(int State, java.lang.String msgString)
Log an error message for a message received in an unexpected state.protected void
waitForStartOfReply(java.io.DataInputStream istream)
Dummy routine, to be filled by protocols that have to skip some start-of-message characters.-
Methods inherited from class jmri.jmrix.AbstractMRNodeTrafficController
deleteNode, getMustInit, getNode, getNodeFromAddress, getNumNodes, init, registerNode, setMustInit, setMustInit
-
Methods inherited from class jmri.jmrix.AbstractMRTrafficController
addConsoleListener, addListener, canReceive, connectionWarn, connectPort, disconnectPort, distributeReply, enterProgModeDelayTime, forwardToPort, getLastSender, getPortName, getSynchronizeRx, handleOneIncomingReply, hasTimeouts, newRcvNotifier, notifyMessage, notifyReply, portReadyToSend, portWarn, portWarnTCP, programmerIdle, readByteProtected, receiveLoop, recovery, removeListener, reportReceiveLoopException, sendMessage, setAllowUnexpectedReply, setSynchronizeRx, status, terminate, terminateThreads, transmitLoop, transmitWait, warnOnTimeout
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface jmri.jmrix.cmri.serial.SerialInterface
status
-
-
-
-
Field Detail
-
metricsCollector
CMRInetMetricsCollector metricsCollector
Create a new C/MRI SerialTrafficController instance.
-
mSensorManager
SerialSensorManager mSensorManager
-
pollNetwork
public boolean pollNetwork
-
cmriNetPollList
public java.util.ArrayList<java.lang.Integer> cmriNetPollList
-
-
Constructor Detail
-
SerialTrafficController
public SerialTrafficController()
-
-
Method Detail
-
addSerialListener
public void addSerialListener(SerialListener l)
- Specified by:
addSerialListener
in interfaceSerialInterface
-
removeSerialListener
public void removeSerialListener(SerialListener l)
- Specified by:
removeSerialListener
in interfaceSerialInterface
-
initializeSerialNode
public void initializeSerialNode(SerialNode node)
Initialize a CMRI node.- Parameters:
node
- the node to initialize
-
enterProgMode
protected AbstractMRMessage enterProgMode()
Description copied from class:AbstractMRTrafficController
Set the system to programming mode.- Specified by:
enterProgMode
in classAbstractMRTrafficController
- Returns:
- any message that needs to be returned to the Command Station to change modes. If no message is needed, returns null.
- See Also:
AbstractMRTrafficController.enterNormalMode()
-
getMetricsData
public CMRInetMetricsData getMetricsData()
Expose metrics data- Returns:
- metrics data
-
enterNormalMode
protected AbstractMRMessage enterNormalMode()
Description copied from class:AbstractMRTrafficController
Sets the system to normal mode during programming while in IDLESTATE. IfAbstractMRTrafficController.programmerIdle()
returns true, enterNormalMode() is called after a timeout.- Specified by:
enterNormalMode
in classAbstractMRTrafficController
- Returns:
- any message that needs to be returned to the Command Station to change modes. If no message is needed, returns null.
- See Also:
AbstractMRTrafficController.enterProgMode()
-
forwardMessage
protected void forwardMessage(AbstractMRListener client, AbstractMRMessage m)
Forward a message to all registered listeners.- Specified by:
forwardMessage
in classAbstractMRTrafficController
- Parameters:
client
- the listener to receive the message; may throw an uncaught exception if not aSerialListener
m
- the message to forward; may throw an uncaught exception if not aSerialMessage
-
forwardReply
protected void forwardReply(AbstractMRListener client, AbstractMRReply m)
Forward a reply to all registered listeners.- Specified by:
forwardReply
in classAbstractMRTrafficController
- Parameters:
client
- the listener to receive the reply; may throw an uncaught exception if not aSerialListener
m
- the reply to forward; may throw an uncaught exception if not aSerialMessage
-
setSensorManager
public void setSensorManager(SerialSensorManager m)
-
setPollNetwork
public void setPollNetwork(boolean OnOff)
-
getPollNetwork
public boolean getPollNetwork()
-
setInitTimeout
public void setInitTimeout(int init_Timeout)
-
getInitTimeout
public int getInitTimeout()
-
setXmitTimeout
public void setXmitTimeout(int init_XmitTimeout)
-
getXmitTimeout
public int getXmitTimeout()
-
pollMessage
protected AbstractMRMessage pollMessage()
Handles initialization, output and polling for C/MRI Serial Nodes from within the running thread.Invoked if it's appropriate to do low-priority polling of the command station, this should return the next message to send, or null if the TrafficController should just sleep.
- Specified by:
pollMessage
in classAbstractMRTrafficController
- Returns:
- Formatted poll message
-
unexpectedReplyStateError
protected void unexpectedReplyStateError(int State, java.lang.String msgString)
Description copied from class:AbstractMRTrafficController
Log an error message for a message received in an unexpected state.- Overrides:
unexpectedReplyStateError
in classAbstractMRTrafficController
- Parameters:
State
- message state.msgString
- message string.
-
handleTimeout
protected void handleTimeout(AbstractMRMessage m, AbstractMRListener l)
- Overrides:
handleTimeout
in classAbstractMRTrafficController
-
resetTimeout
protected void resetTimeout(AbstractMRMessage m)
- Overrides:
resetTimeout
in classAbstractMRTrafficController
-
pollReplyHandler
protected AbstractMRListener pollReplyHandler()
- Specified by:
pollReplyHandler
in classAbstractMRTrafficController
-
sendSerialMessage
public void sendSerialMessage(SerialMessage m, SerialListener reply)
Forward a pre-formatted message to the actual interface.- Specified by:
sendSerialMessage
in interfaceSerialInterface
- Parameters:
m
- the message to forwardreply
- the listener for the response to m
-
newReply
protected AbstractMRReply newReply()
- Specified by:
newReply
in classAbstractMRTrafficController
-
endOfMessage
protected boolean endOfMessage(AbstractMRReply msg)
- Specified by:
endOfMessage
in classAbstractMRTrafficController
-
loadChars
protected void loadChars(AbstractMRReply msg, java.io.DataInputStream istream) throws java.io.IOException
Description copied from class:AbstractMRTrafficController
Get characters from the input source, and file a message.Returns only when the message is complete.
Only used in the Receive thread.
Handles timeouts on read by ignoring zero-length reads.
- Overrides:
loadChars
in classAbstractMRTrafficController
- Parameters:
msg
- message to fillistream
- character source.- Throws:
java.io.IOException
- when presented by the input source.
-
waitForStartOfReply
protected void waitForStartOfReply(java.io.DataInputStream istream) throws java.io.IOException
Description copied from class:AbstractMRTrafficController
Dummy routine, to be filled by protocols that have to skip some start-of-message characters.- Overrides:
waitForStartOfReply
in classAbstractMRTrafficController
- Parameters:
istream
- input source- Throws:
java.io.IOException
- from underlying operations
-
addHeaderToOutput
protected int addHeaderToOutput(byte[] msg, AbstractMRMessage m)
Add header to the outgoing byte stream.- Overrides:
addHeaderToOutput
in classAbstractMRTrafficController
- Parameters:
msg
- the output byte streamm
- the message in msg- Returns:
- next location in the stream to fill
-
addTrailerToOutput
protected void addTrailerToOutput(byte[] msg, int offset, AbstractMRMessage m)
Add trailer to the outgoing byte stream.- Overrides:
addTrailerToOutput
in classAbstractMRTrafficController
- Parameters:
msg
- the output byte streamoffset
- the first byte not yet usedm
- the message in msg
-
lengthOfByteStream
protected int lengthOfByteStream(AbstractMRMessage m)
Determine how much many bytes the entire message will take, including space for header and trailer- Overrides:
lengthOfByteStream
in classAbstractMRTrafficController
- Parameters:
m
- The message to be sent- Returns:
- Number of bytes
-
-