Package jmri.jmrix.secsi
Class SerialTrafficController
java.lang.Object
jmri.jmrix.AbstractMRTrafficController
jmri.jmrix.AbstractMRNodeTrafficController
jmri.jmrix.secsi.SerialTrafficController
- All Implemented Interfaces:
SerialInterface
public class SerialTrafficController extends AbstractMRNodeTrafficController implements SerialInterface
Converts Stream-based I/O to/from SECSI 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 protected int
currentAddr
protected int
incomingLength
(package private) SecsiSystemConnectionMemo
memo
Reference to the system connection memo.(package private) SerialSensorManager
mSensorManager
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, WAITMSGREPLYSTATE, WAITREPLYINNORMMODESTATE, WAITREPLYINPROGMODESTATE, waitTimePoll, xmtException, xmtRunnable, xmtThread
-
Constructor Summary
Constructors Constructor Description SerialTrafficController(SecsiSystemConnectionMemo adaptermemo)
Create a new SerialTrafficController instance. -
Method Summary
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)
Although this protocol doesn't use a trailer, we implement this method to set the expected reply length and address for this message.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 SerialMessage to all registered SerialInterface listeners.protected void
forwardReply(AbstractMRListener client, AbstractMRReply m)
Forward a SerialReply to all registered SerialInterface listeners.SecsiSystemConnectionMemo
getSystemConnectionMemo()
Get access to the system connection memo associated with this traffic controller.protected void
handleTimeout(AbstractMRMessage m, AbstractMRListener l)
void
initializeSerialNode(SerialNode node)
Set up for initialization of a Serial node.protected int
lengthOfByteStream(AbstractMRMessage m)
Determine how many bytes the entire message will take, including space for header and trailer.protected void
loadChars(AbstractMRReply msg, DataInputStream istream)
Get characters from the input source, and file a message.protected AbstractMRReply
newReply()
protected AbstractMRMessage
pollMessage()
Handles initialization, output and polling from within the running threadprotected AbstractMRListener
pollReplyHandler()
void
removeSerialListener(SerialListener l)
protected void
resetTimeout(AbstractMRMessage m)
void
sendSerialMessage(SerialMessage m, SerialListener reply)
Forward a preformatted message to the actual interface.void
setSensorManager(SerialSensorManager m)
void
setSystemConnectionMemo(SecsiSystemConnectionMemo m)
Set the system connection memo associated with this traffic controller.protected void
waitForStartOfReply(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
addListener, canReceive, connectionWarn, connectPort, disconnectPort, distributeReply, enterProgModeDelayTime, finalize, 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, unexpectedReplyStateError
-
Field Details
-
mSensorManager
-
memo
Reference to the system connection memo. -
currentAddr
-
incomingLength
-
-
Constructor Details
-
SerialTrafficController
Create a new SerialTrafficController instance.- Parameters:
adaptermemo
- the associated SystemConnectionMemo
-
-
Method Details
-
addSerialListener
- Specified by:
addSerialListener
in interfaceSerialInterface
-
removeSerialListener
- Specified by:
removeSerialListener
in interfaceSerialInterface
-
initializeSerialNode
Set up for initialization of a Serial node.- Parameters:
node
- node to initialize.
-
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()
-
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
Forward a SerialMessage to all registered SerialInterface listeners.- Specified by:
forwardMessage
in classAbstractMRTrafficController
- Parameters:
client
- abstract listener.m
- message to forward.
-
forwardReply
Forward a SerialReply to all registered SerialInterface listeners.- Specified by:
forwardReply
in classAbstractMRTrafficController
-
setSensorManager
-
pollMessage
Handles initialization, output and polling from within the running thread- Specified by:
pollMessage
in classAbstractMRTrafficController
- Returns:
- Formatted poll message
-
handleTimeout
- Overrides:
handleTimeout
in classAbstractMRTrafficController
-
resetTimeout
- Overrides:
resetTimeout
in classAbstractMRTrafficController
-
pollReplyHandler
- Specified by:
pollReplyHandler
in classAbstractMRTrafficController
-
sendSerialMessage
Forward a preformatted message to the actual interface.- Specified by:
sendSerialMessage
in interfaceSerialInterface
-
getSystemConnectionMemo
Get access to the system connection memo associated with this traffic controller.- Returns:
- associated systemConnectionMemo object
-
setSystemConnectionMemo
Set the system connection memo associated with this traffic controller.- Parameters:
m
- associated systemConnectionMemo object
-
newReply
- Specified by:
newReply
in classAbstractMRTrafficController
-
endOfMessage
- Specified by:
endOfMessage
in classAbstractMRTrafficController
-
loadChars
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:
IOException
- when presented by the input source.
-
waitForStartOfReply
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:
IOException
- from underlying operations
-
addHeaderToOutput
Add header to the outgoing byte stream.- Overrides:
addHeaderToOutput
in classAbstractMRTrafficController
- Parameters:
msg
- The output byte streamm
- Message results- Returns:
- next location in the stream to fill
-
addTrailerToOutput
Although this protocol doesn't use a trailer, we implement this method to set the expected reply length and address for this message.- Overrides:
addTrailerToOutput
in classAbstractMRTrafficController
- Parameters:
msg
- The output byte streamoffset
- the first byte not yet usedm
- the original message
-
lengthOfByteStream
Determine how 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 in message
- See Also:
SerialMessage.getPoll(int)
,SerialNode.createOutPacket()
-