Package jmri.jmrix.dccpp.dccppovertcp

Class DCCppTcpDriverAdapter

java.lang.Object

jmri.jmrix.AbstractPortController

jmri.jmrix.AbstractNetworkPortController

jmri.jmrix.dccpp.DCCppNetworkPortController

jmri.jmrix.dccpp.dccppovertcp.DCCppTcpDriverAdapter

All Implemented Interfaces:

DCCppPortController, NetworkPortAdapter, PortAdapter

public class DCCppTcpDriverAdapter
extends DCCppNetworkPortController

Implements DCCppPortController for the DCCppOverTcp system network connection.

This connects a DCC++ via a telnet connection. Normally controlled by the DCCppTcpDriverFrame class. Based on LnTcpDriverAdapter.

Nested Class Summary

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

AbstractPortController.Option

Field Summary

Fields inherited from class jmri.jmrix.dccpp.DCCppNetworkPortController

commandStationNames, commandStationType, commandStationTypes, mTurnoutExtraSpace, mTurnoutNoRetry

Fields inherited from class jmri.jmrix.AbstractNetworkPortController

connTimeout, m_HostName, m_port, socketConn

Fields inherited from class jmri.jmrix.AbstractPortController

allowConnectionRecovery, manufacturerName, option1Name, option2Name, option3Name, option4Name, options, reconnectinterval, reconnectMaxAttempts, reconnectMaxInterval

Constructor Summary

Constructors

Constructor	Description
DCCppTcpDriverAdapter()

Method Summary

Modifier and Type	Method	Description
void	configure()	Set up all of the other objects to operate with a DCC++ connected via this class.
void	configureOption1(String value)	Set the first port option.
boolean	okToSend()	Can the port accept additional characters?
void	setOutputBufferEmpty(boolean s)	We need a way to say if the output buffer is empty or not
boolean	status()	Check that this object is ready to operate.

Methods inherited from class jmri.jmrix.dccpp.DCCppNetworkPortController

configureOption3, getSystemConnectionMemo, resetupConnection, setCommandStationType, setCommandStationType, setTurnoutHandling

Methods inherited from class jmri.jmrix.AbstractNetworkPortController

autoConfigure, closeConnection, connect, connect, getAdvertisementName, getConnectionTimeout, getCurrentPortName, getHostAddress, getHostName, getInputStream, getMdnsConfigure, getOutputStream, getPort, getServiceType, reconnectFromLoop, setAdvertisementName, setConnectionTimeout, setHostAddress, setHostName, setMdnsConfigure, setPort, setPort, setServiceType

Methods inherited from class jmri.jmrix.AbstractPortController

configureOption2, configureOption4, dispose, getDisabled, getManufacturer, getOption1Name, getOption2Name, getOption3Name, getOption4Name, getOptionChoices, getOptionDisplayName, getOptions, getOptionState, getReconnectMaxAttempts, getReconnectMaxInterval, getSystemPrefix, getUserName, isDirty, isOptionAdvanced, isOptionTypePassword, isOptionTypeText, isRestartRequired, purgeStream, reconnect, recover, safeSleep, setClosed, setDisabled, setManufacturer, setOpened, setOptionState, setReconnectMaxAttempts, setReconnectMaxInterval, setSystemConnectionMemo, setSystemPrefix, setUserName

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.jmrix.PortAdapter

configureOption2, configureOption4, connect, dispose, getDisabled, getInputStream, getManufacturer, getOption1Name, getOption2Name, getOption3Name, getOption4Name, getOptionChoices, getOptionDisplayName, getOptions, getOptionState, getOutputStream, getReconnectMaxAttempts, getReconnectMaxInterval, getSystemPrefix, getUserName, isDirty, isOptionAdvanced, isOptionTypePassword, isOptionTypeText, isRestartRequired, recover, setDisabled, setManufacturer, setOptionState, setReconnectMaxAttempts, setReconnectMaxInterval, setSystemConnectionMemo, setSystemPrefix, setUserName

Constructor Details

DCCppTcpDriverAdapter

public DCCppTcpDriverAdapter()

Method Details

configure

public void configure()

Set up all of the other objects to operate with a DCC++ connected via this class.

status

public boolean status()

Description copied from class: DCCppNetworkPortController

Check that this object is ready to operate. This is a question of configuration, not transient hardware status.

Specified by:

status in interface DCCppPortController

Specified by:

status in interface NetworkPortAdapter

Specified by:

status in interface PortAdapter

Specified by:

status in class DCCppNetworkPortController

Returns:

true if OK, at least as far as known

configureOption1

public void configureOption1(String value)

Description copied from interface: PortAdapter

Set the first port option. Only to be used after construction, but before the openPort call.

Specified by:

configureOption1 in interface PortAdapter

Overrides:

configureOption1 in class AbstractPortController

Parameters:

value - to set the option to

setOutputBufferEmpty

public void setOutputBufferEmpty(boolean s)

Description copied from interface: DCCppPortController

We need a way to say if the output buffer is empty or not

Specified by:

setOutputBufferEmpty in interface DCCppPortController

Overrides:

setOutputBufferEmpty in class DCCppNetworkPortController

Parameters:

s - true to set buffer empty, else false.

okToSend

public boolean okToSend()

Description copied from class: DCCppNetworkPortController

Can the port accept additional characters? This might go false for short intervals, but it might also stick off if something goes wrong.

Specified by:

okToSend in interface DCCppPortController

Specified by:

okToSend in class DCCppNetworkPortController

Returns:

true if OK to send, else false.