LnStreamPortPacketizer (JMRI API)

java.lang.Object
- jmri.jmrix.loconet.LnTrafficController
- - jmri.jmrix.loconet.LnPacketizer
  - - jmri.jmrix.loconet.streamport.LnStreamPortPacketizer

All Implemented Interfaces:

LocoNetInterface

Direct Known Subclasses:

Z21LnStreamPortPacketizer
```
public class LnStreamPortPacketizer
extends LnPacketizer
```
Converts Stream-based I/O to/from LocoNet messages. The "LocoNetInterface" side sends/receives LocoNetMessage objects. The connection to a LnPortController is via a pair of *Streams, which then carry sequences of characters for transmission.
Messages come to this via the main GUI thread, and are forwarded back to listeners in that same thread. Reception and transmission are handled in dedicated threads by RcvHandler and XmtHandler objects. Those are internal classes defined here. The thread priorities are:
- RcvHandler - at highest available priority
- XmtHandler - down one, which is assumed to be above the GUI
- (everything else)
Some of the message formats used in this class are Copyright Digitrax, Inc. and used with permission as part of the JMRI project. That permission does not extend to uses in other software products. If you wish to use this code, algorithm or these message formats outside of JMRI, please contact Digitrax Inc for separate permission.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

(package private) class LnStreamPortPacketizer.XmtHandler
Captive class to handle transmission
- Nested classes/interfaces inherited from class jmri.jmrix.loconet.LnPacketizer
  LnPacketizer.RcvHandler

Field Summary

Fields
Modifier and Type Field Description

LnStreamPortController streamController
- Fields inherited from class jmri.jmrix.loconet.LnPacketizer
  controller, echo, istream, ostream, rcvHandler, rcvThread, threadStopRequest, xmtHandler, xmtList, xmtThread
- Fields inherited from class jmri.jmrix.loconet.LnTrafficController
  listeners, receivedByteCount, receivedMsgCount, transmittedMsgCount
- Fields inherited from interface jmri.jmrix.loconet.LocoNetInterface
  ALL, POWER, PROGRAMMING, SENSORS, SLOTINFO, TURNOUTS

Constructor Summary

Constructors
Constructor Description

LnStreamPortPacketizer(LocoNetSystemConnectionMemo m)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`connectPort(LnStreamPortController p)`	Make connection to existing LnPortController object.
`void`	`disconnectPort(LnStreamPortController p)`	Break connection to existing LnPortController object.
`boolean`	`isXmtBusy()`	Implement abstract method to signal if there's a backlog of information waiting to be sent.
`void`	`startThreads()`	Invoked at startup to start the threads needed here.

Methods inherited from class jmri.jmrix.loconet.LnPacketizer
connectPort, disconnectPort, dispose, messageTransmitted, readByteProtected, sendLocoNetMessage, status, terminateThreads

Methods inherited from class jmri.jmrix.loconet.LnTrafficController
addLocoNetListener, getReceivedByteCount, getReceivedMsgCount, getSystemConnectionMemo, getTransmittedMsgCount, notify, removeLocoNetListener, resetStatistics, setSystemConnectionMemo

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - streamController
```
public LnStreamPortController streamController
```
- Constructor Detail
  - LnStreamPortPacketizer
```
public LnStreamPortPacketizer(LocoNetSystemConnectionMemo m)
```
- Method Detail
  - isXmtBusy
```
public boolean isXmtBusy()
```
    Description copied from class: LnPacketizer
    
    Implement abstract method to signal if there's a backlog of information waiting to be sent.
    
    Overrides:
    
    isXmtBusy in class LnPacketizer
    
    Returns:
    
    true if busy, false if nothing waiting to send
  - connectPort
```
public void connectPort(LnStreamPortController p)
```
    Make connection to existing LnPortController object.
    
    Parameters:
    
    p - Port controller to connect to. Save this for a later disconnect call
  - disconnectPort
```
public void disconnectPort(LnStreamPortController p)
```
    Break connection to existing LnPortController object. Once broken, attempts to send via "message" member will fail.
    
    Parameters:
    
    p - previously connected port
  - startThreads
```
public void startThreads()
```
    Invoked at startup to start the threads needed here.
    
    Overrides:
    
    startThreads in class LnPacketizer