jmri.jmrix.mrc
Class MrcTrafficController

java.lang.Object
  jmri.jmrix.AbstractMRTrafficController
      jmri.jmrix.mrc.MrcTrafficController

All Implemented Interfaces:

MrcInterface

public class MrcTrafficController
extends AbstractMRTrafficController
implements MrcInterface

Converts Stream-based I/O to/from MRC messages. The "MrcInterface" side sends/receives message objects.

The connection to a MrcPortController 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 transistions, based on the necessary state in each message.

Author:

Bob Jacobsen Copyright (C) 2001

Nested Class Summary

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

AbstractMRTrafficController.RcvNotifier, AbstractMRTrafficController.XmtNotifier

Field Summary

protected static MrcTrafficController

self

Fields inherited from class jmri.jmrix.AbstractMRTrafficController

allowUnexpectedReply, cmdListeners, controller, flushReceiveChars, IDLESTATE, istream, mCurrentMode, mCurrentState, mLastSender, mWaitBeforePoll, NORMALMODE, NOTIFIEDSTATE, OKSENDMSGSTATE, ostream, PROGRAMINGMODE, replyInDispatch, WAITMSGREPLYSTATE, WAITREPLYINNORMMODESTATE, WAITREPLYINPROGMODESTATE, xmtRunnable

Constructor Summary

MrcTrafficController()

Method Summary

void	addMrcListener(MrcListener l)
protected boolean	endOfMessage(AbstractMRReply msg)
protected AbstractMRMessage	enterNormalMode()
protected AbstractMRMessage	enterProgMode()
protected void	forwardMessage(AbstractMRListener client, AbstractMRMessage m) Forward a MrcMessage to all registered MrcInterface listeners.
protected void	forwardReply(AbstractMRListener client, AbstractMRReply m) Forward a MrcReply to all registered MrcInterface listeners.
static MrcTrafficController	instance() static function returning the MrcTrafficController instance to use.
protected AbstractMRReply	newReply()
protected AbstractMRMessage	pollMessage() 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 TC should just sleep.
protected AbstractMRListener	pollReplyHandler()
void	removeMrcListener(MrcListener l)
void	sendMrcMessage(MrcMessage m, MrcListener reply) Forward a preformatted message to the actual interface.
protected void	setInstance()
void	setSensorManager(SensorManager m)

Methods inherited from class jmri.jmrix.AbstractMRTrafficController

addHeaderToOutput, addListener, addTrailerToOutput, canReceive, connectionWarn, connectPort, disconnectPort, enterProgModeDelayTime, finalize, forwardToPort, getPortName, handleOneIncomingReply, handleTimeout, hasTimeouts, lengthOfByteStream, loadChars, newRcvNotifier, notifyMessage, notifyReply, portReadyToSend, portWarn, programmerIdle, readByteProtected, receiveLoop, removeListener, reportReceiveLoopException, resetTimeout, sendMessage, setAllowUnexpectedReply, status, waitForStartOfReply

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.jmrix.mrc.MrcInterface

status

Field Detail

self

protected static MrcTrafficController self

Constructor Detail

MrcTrafficController

public MrcTrafficController()

Method Detail

addMrcListener

public void addMrcListener(MrcListener l)

Specified by:

addMrcListener in interface MrcInterface

removeMrcListener

public void removeMrcListener(MrcListener l)

Specified by:

removeMrcListener in interface MrcInterface

forwardMessage

protected void forwardMessage(AbstractMRListener client,
                              AbstractMRMessage m)

Forward a MrcMessage to all registered MrcInterface listeners.

Specified by:

forwardMessage in class AbstractMRTrafficController

forwardReply

protected void forwardReply(AbstractMRListener client,
                            AbstractMRReply m)

Forward a MrcReply to all registered MrcInterface listeners.

Specified by:

forwardReply in class AbstractMRTrafficController

setSensorManager

public void setSensorManager(SensorManager m)

pollMessage

protected AbstractMRMessage pollMessage()

Description copied from class: AbstractMRTrafficController

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 TC should just sleep.

Specified by:

pollMessage in class AbstractMRTrafficController

pollReplyHandler

protected AbstractMRListener pollReplyHandler()

Specified by:

pollReplyHandler in class AbstractMRTrafficController

sendMrcMessage

public void sendMrcMessage(MrcMessage m,
                           MrcListener reply)

Forward a preformatted message to the actual interface.

Specified by:

sendMrcMessage in interface MrcInterface

enterProgMode

protected AbstractMRMessage enterProgMode()

Specified by:

enterProgMode in class AbstractMRTrafficController

enterNormalMode

protected AbstractMRMessage enterNormalMode()

Specified by:

enterNormalMode in class AbstractMRTrafficController

instance

public static MrcTrafficController instance()

static function returning the MrcTrafficController instance to use.

Returns:

The registered MrcTrafficController instance for general use, if need be creating one.

setInstance

protected void setInstance()

Specified by:

setInstance in class AbstractMRTrafficController

newReply

protected AbstractMRReply newReply()

Specified by:

newReply in class AbstractMRTrafficController

endOfMessage

protected boolean endOfMessage(AbstractMRReply msg)

Specified by:

endOfMessage in class AbstractMRTrafficController