Package jmri.jmrix.tmcc

Class SerialTrafficController

java.lang.Object

jmri.jmrix.AbstractMRTrafficController

jmri.jmrix.tmcc.SerialTrafficController

All Implemented Interfaces:

SerialInterface

public class SerialTrafficController
extends AbstractMRTrafficController
implements SerialInterface

Convert Stream-based I/O to/from TMCC 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
(package private) TmccSystemConnectionMemo	mMemo	Reference to the system connection memo.

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(TmccSystemConnectionMemo adaptermemo)	Create a new TMCC SerialTrafficController instance.

Method Summary

Modifier and Type	Method	Description
protected int	addHeaderToOutput(byte[] msg, AbstractMRMessage m)	No header needed
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 void	forwardToPort(AbstractMRMessage m, AbstractMRListener reply)	Actually transmits the next message to the port
TmccSystemConnectionMemo	getSystemConnectionMemo()	Get access to the system connection memo associated with this traffic controller.
protected int	lengthOfByteStream(AbstractMRMessage m)	Determine how much 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()	Handle initialization, output and polling for TMCC from within the running thread.
protected AbstractMRListener	pollReplyHandler()
void	removeSerialListener(SerialListener l)
void	sendSerialMessage(SerialMessage m, SerialListener reply)	Forward a preformatted message to the actual interface.
void	setSystemConnectionMemo(TmccSystemConnectionMemo 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.
protected void	warnOnTimeout(AbstractMRMessage msg, AbstractMRListener l)	Skip warning message, as timeouts are routine in this protocol

Methods inherited from class jmri.jmrix.AbstractMRTrafficController

addConsoleListener, addListener, canReceive, connectionWarn, connectPort, disconnectPort, distributeReply, enterProgModeDelayTime, getLastSender, getPortName, getSynchronizeRx, handleOneIncomingReply, handleTimeout, hasTimeouts, newRcvNotifier, notifyMessage, notifyReply, portReadyToSend, portWarn, portWarnTCP, programmerIdle, readByteProtected, receiveLoop, recovery, removeListener, reportReceiveLoopException, resetTimeout, sendMessage, setAllowUnexpectedReply, setSynchronizeRx, status, terminate, terminateThreads, transmitLoop, transmitWait, unexpectedReplyStateError

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.jmrix.tmcc.SerialInterface

status

Field Details

mMemo

TmccSystemConnectionMemo mMemo

Reference to the system connection memo.

Constructor Details

SerialTrafficController

public SerialTrafficController(TmccSystemConnectionMemo adaptermemo)

Create a new TMCC SerialTrafficController instance.

Parameters:

adaptermemo - the associated SystemConnectionMemo

Method Details

addSerialListener

public void addSerialListener(SerialListener l)

Specified by:

addSerialListener in interface SerialInterface

removeSerialListener

public void removeSerialListener(SerialListener l)

Specified by:

removeSerialListener in interface SerialInterface

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()

getSystemConnectionMemo

public TmccSystemConnectionMemo getSystemConnectionMemo()

Get access to the system connection memo associated with this traffic controller.

Returns:

associated systemConnectionMemo object

setSystemConnectionMemo

public void setSystemConnectionMemo(TmccSystemConnectionMemo m)

Set the system connection memo associated with this traffic controller.

Parameters:

m - associated systemConnectionMemo object

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

pollMessage

protected AbstractMRMessage pollMessage()

Handle initialization, output and polling for TMCC from within the running thread.

Specified by:

pollMessage in class AbstractMRTrafficController

Returns:

Formatted poll message

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

protected void loadChars(AbstractMRReply msg,
 DataInputStream istream)
                  throws 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:

IOException - when presented by the input source.

waitForStartOfReply

protected void waitForStartOfReply(DataInputStream istream)
                            throws 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:

IOException - from underlying operations

addHeaderToOutput

protected int addHeaderToOutput(byte[] msg,
 AbstractMRMessage m)

No header needed

Overrides:

addHeaderToOutput in class AbstractMRTrafficController

Parameters:

msg - The output byte stream

m - Message results

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 for msg (3) plus preceeding NOP (3)

warnOnTimeout

protected void warnOnTimeout(AbstractMRMessage msg,
 AbstractMRListener l)

Skip warning message, as timeouts are routine in this protocol

Overrides:

warnOnTimeout in class AbstractMRTrafficController

forwardToPort

protected void forwardToPort(AbstractMRMessage m,
 AbstractMRListener reply)

Actually transmits the next message to the port

Overrides:

forwardToPort in class AbstractMRTrafficController

Parameters:

m - the message to send

reply - the Listener sending the message, often provided as 'this'

See Also:

• AbstractMRTrafficController.sendMessage(AbstractMRMessage, AbstractMRListener)