Package jmri.jmrix.jmriclient

Class JMRIClientPortController

java.lang.Object

jmri.jmrix.AbstractPortController

jmri.jmrix.AbstractNetworkPortController

jmri.jmrix.jmriclient.JMRIClientPortController

All Implemented Interfaces:

NetworkPortAdapter, PortAdapter

Direct Known Subclasses:

NetworkDriverAdapter

public abstract class JMRIClientPortController
extends AbstractNetworkPortController

Abstract base for classes representing a JMRIClient communications port

Nested Class Summary

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

AbstractPortController.Option

Field Summary

Fields inherited from class jmri.jmrix.AbstractNetworkPortController

connTimeout, m_HostName, m_port, socketConn

Fields inherited from class jmri.jmrix.AbstractPortController

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JMRIClientPortController(JMRIClientSystemConnectionMemo connectionMemo)

Method Summary

Modifier and Type	Method	Description
JMRIClientSystemConnectionMemo	getSystemConnectionMemo()	Get the SystemConnectionMemo associated with this object.
protected void	resetupConnection()	Customizable method to deal with resetting a system connection after a successful recovery of a connection.

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

configureOption1, configureOption2, configureOption3, 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, status

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.jmrix.NetworkPortAdapter

configure, status

Methods inherited from interface jmri.jmrix.PortAdapter

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

Constructor Details

JMRIClientPortController

protected JMRIClientPortController(JMRIClientSystemConnectionMemo connectionMemo)

Method Details

getSystemConnectionMemo

public JMRIClientSystemConnectionMemo getSystemConnectionMemo()

Description copied from class: AbstractPortController

Get the SystemConnectionMemo associated with this object.

This method should only be overridden to ensure that a specific subclass of SystemConnectionMemo is returned. The recommended pattern is: public MySystemConnectionMemo getSystemConnectionMemo() { return (MySystemConnectionMemo) super.getSystemConnectionMemo(); }

Specified by:

getSystemConnectionMemo in interface PortAdapter

Overrides:

getSystemConnectionMemo in class AbstractPortController

Returns:

the currently associated SystemConnectionMemo

resetupConnection

protected void resetupConnection()

Description copied from class: AbstractNetworkPortController

Customizable method to deal with resetting a system connection after a successful recovery of a connection.

Overrides:

resetupConnection in class AbstractNetworkPortController