Package jmri.jmrix.bidib

Class BiDiBNetworkPortController

java.lang.Object

jmri.jmrix.AbstractPortController

jmri.jmrix.AbstractNetworkPortController

jmri.jmrix.bidib.BiDiBNetworkPortController

All Implemented Interfaces:

BiDiBPortController, NetworkPortAdapter, PortAdapter

Direct Known Subclasses:

BiDiBOverTcpAdapter, NetBiDiBAdapter

public abstract class BiDiBNetworkPortController
extends AbstractNetworkPortController
implements BiDiBPortController

Abstract base for classes representing a BiDiB communications port

Nested Class Summary

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

AbstractPortController.Option

Field Summary

Fields

Modifier and Type	Field	Description
protected org.bidib.jbidibc.core.BidibInterface	bidib
protected org.bidib.jbidibc.messages.helpers.Context	context

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

Constructor	Description
BiDiBNetworkPortController()

Method Summary

Modifier and Type	Method	Description
abstract void	connect(String host, int port)	Connects to the end device using a hostname/ip address and port
org.bidib.jbidibc.messages.helpers.Context	getContext()	Get the Bidib adapter context
String	getRealPortName()	Get the physical port name used with jbidibc
BiDiBSystemConnectionMemo	getSystemConnectionMemo()	Get the SystemConnectionMemo associated with this object.
abstract void	registerAllListeners(org.bidib.jbidibc.messages.ConnectionListener connectionListener, Set<org.bidib.jbidibc.core.NodeListener> nodeListeners, Set<org.bidib.jbidibc.core.MessageListener> messageListeners, Set<org.bidib.jbidibc.core.node.listener.TransferListener> transferListeners)	Register all Listeners to the specific BiDiB Object.

Methods inherited from class jmri.jmrix.AbstractNetworkPortController

autoConfigure, closeConnection, connect, getAdvertisementName, getConnectionTimeout, getCurrentPortName, getHostAddress, getHostName, getInputStream, getMdnsConfigure, getOutputStream, getPort, getServiceType, reconnectFromLoop, resetupConnection, 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, 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

Field Details

bidib

protected org.bidib.jbidibc.core.BidibInterface bidib

context

protected org.bidib.jbidibc.messages.helpers.Context context

Constructor Details

BiDiBNetworkPortController

public BiDiBNetworkPortController()

Method Details

connect

public abstract void connect(String host,
 int port)
                      throws IOException

Description copied from interface: NetworkPortAdapter

Connects to the end device using a hostname/ip address and port

Specified by:

connect in interface NetworkPortAdapter

Overrides:

connect in class AbstractNetworkPortController

Parameters:

host - hostname / ip address.

port - network port.

Throws:

IOException - on connection error.

getSystemConnectionMemo

public BiDiBSystemConnectionMemo getSystemConnectionMemo()

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

getRealPortName

public String getRealPortName()

Get the physical port name used with jbidibc

Specified by:

getRealPortName in interface BiDiBPortController

Returns:

physical port name

registerAllListeners

public abstract void registerAllListeners(org.bidib.jbidibc.messages.ConnectionListener connectionListener,
 Set<org.bidib.jbidibc.core.NodeListener> nodeListeners,
 Set<org.bidib.jbidibc.core.MessageListener> messageListeners,
 Set<org.bidib.jbidibc.core.node.listener.TransferListener> transferListeners)

Register all Listeners to the specific BiDiB Object. We need this here since the BidibInterface does not provide this method.

Specified by:

registerAllListeners in interface BiDiBPortController

Parameters:

connectionListener - add to this

nodeListeners - listeners to add

messageListeners - listeners to add

transferListeners - listeners to add

getContext

public org.bidib.jbidibc.messages.helpers.Context getContext()

Get the Bidib adapter context

Specified by:

getContext in interface BiDiBPortController

Returns:

Context