Package jmri.jmrix.maple

Class SerialTrafficController

java.lang.Object

jmri.jmrix.AbstractMRTrafficController

jmri.jmrix.AbstractMRNodeTrafficController

jmri.jmrix.maple.SerialTrafficController

All Implemented Interfaces:

SerialInterface

public class SerialTrafficController
extends AbstractMRNodeTrafficController
implements SerialInterface

Converts Stream-based I/O to/from Maple 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.

Since:

2.3.7

Nested Class Summary

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

AbstractMRTrafficController.RcvNotifier, AbstractMRTrafficController.XmtNotifier

Field Summary

Fields

Modifier and Type	Field	Description
(package private) SerialSensorManager	mSensorManager
protected int	wrTimeoutCount

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()	Create a new Maple 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)	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 SerialMessage to all registered SerialInterface listeners.
protected void	forwardReply(AbstractMRListener client, AbstractMRReply m)	Forward a SerialReply to all registered SerialInterface listeners.
protected boolean	getMustInit(int i)	Does a given node need to have initialization data sent?
int	getSavedPollAddress()
int	getWrTimeoutCount()
protected void	handleTimeout(AbstractMRMessage m, AbstractMRListener l)
void	initializeSerialNode(SerialNode node)	Public method to set up for initialization of a Serial node.
InputBits	inputBits()
protected int	lengthOfByteStream(AbstractMRMessage m)	Determine how much many bytes the entire message will take, including space for header and trailer.
void	loadChars(AbstractMRReply msg, java.io.DataInputStream istream)	Get characters from the input source, and file a message.
protected AbstractMRReply	newReply()
OutputBits	outputBits()
protected AbstractMRMessage	pollMessage()	Handle output and polling for Maple Serial Nodes from within the running thread.
protected AbstractMRListener	pollReplyHandler()
void	removeSerialListener(SerialListener l)
protected void	resetTimeout(AbstractMRMessage m)
void	resetWrTimeoutCount()
void	sendSerialMessage(SerialMessage m, SerialListener reply)	Forward a preformatted message to the actual interface.
void	setSensorManager(SerialSensorManager m)
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, 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, unexpectedReplyStateError, 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.maple.SerialInterface

status

Field Detail

mSensorManager

SerialSensorManager mSensorManager

wrTimeoutCount

protected int wrTimeoutCount

Constructor Detail

SerialTrafficController

public SerialTrafficController()

Create a new Maple SerialTrafficController instance.

Method Detail

inputBits

public InputBits inputBits()

outputBits

public OutputBits outputBits()

addSerialListener

public void addSerialListener(SerialListener l)

Specified by:

addSerialListener in interface SerialInterface

removeSerialListener

public void removeSerialListener(SerialListener l)

Specified by:

removeSerialListener in interface SerialInterface

initializeSerialNode

public void initializeSerialNode(SerialNode node)

Public method to set up for initialization of a Serial node.

Parameters:

node - unused.

enterProgMode

protected AbstractMRMessage enterProgMode()

Description copied from class: AbstractMRTrafficController

Set the system to programming mode.

Specified by:

enterProgMode in class AbstractMRTrafficController

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

protected AbstractMRMessage enterNormalMode()

Description copied from class: AbstractMRTrafficController

Sets the system to normal mode during programming while in IDLESTATE. If AbstractMRTrafficController.programmerIdle() returns true, enterNormalMode() is called after a timeout.

Specified by:

enterNormalMode in class AbstractMRTrafficController

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 SerialMessage to all registered SerialInterface listeners.

Specified by:

forwardMessage in class AbstractMRTrafficController

Parameters:

client - abstract listener.

m - message to forward.

forwardReply

protected void forwardReply(AbstractMRListener client,
                            AbstractMRReply m)

Forward a SerialReply to all registered SerialInterface listeners.

Specified by:

forwardReply in class AbstractMRTrafficController

setSensorManager

public void setSensorManager(SerialSensorManager m)

getMustInit

protected boolean getMustInit(int i)

Description copied from class: AbstractMRNodeTrafficController

Does a given node need to have initialization data sent?

Overrides:

getMustInit in class AbstractMRNodeTrafficController

Parameters:

i - the node address (number)

Returns:

true if initialization data is required

getSavedPollAddress

public int getSavedPollAddress()

pollMessage

protected AbstractMRMessage pollMessage()

Handle output and polling for Maple Serial Nodes from within the running thread.

Specified by:

pollMessage in class AbstractMRTrafficController

Returns:

Formatted poll message

getWrTimeoutCount

public int getWrTimeoutCount()

resetWrTimeoutCount

public void resetWrTimeoutCount()

handleTimeout

protected void handleTimeout(AbstractMRMessage m,
                             AbstractMRListener l)

Overrides:

handleTimeout in class AbstractMRTrafficController

resetTimeout

protected void resetTimeout(AbstractMRMessage m)

Overrides:

resetTimeout in class AbstractMRTrafficController

pollReplyHandler

protected AbstractMRListener pollReplyHandler()

Specified by:

pollReplyHandler in class AbstractMRTrafficController

sendSerialMessage

public void sendSerialMessage(SerialMessage m,
                              SerialListener reply)

Forward a preformatted message to the actual interface.

Specified by:

sendSerialMessage in interface SerialInterface

newReply

protected AbstractMRReply newReply()

Specified by:

newReply in class AbstractMRTrafficController

endOfMessage

protected boolean endOfMessage(AbstractMRReply msg)

Specified by:

endOfMessage in class AbstractMRTrafficController

loadChars

public 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 class AbstractMRTrafficController

Parameters:

msg - message to fill

istream - 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 class AbstractMRTrafficController

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 class AbstractMRTrafficController

Parameters:

msg - the output byte stream

m - the message to add the header to

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 class AbstractMRTrafficController

Parameters:

msg - The output byte stream

offset - the first byte not yet used

m - output message to extend

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 class AbstractMRTrafficController

Parameters:

m - the message to be sent

Returns:

Number of bytes