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
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
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
connect(java.lang.String host, int port)
Connects to the end device using a hostname/ip address and portorg.bidib.jbidibc.messages.helpers.Context
getContext()
Get the Bidib adapter contextjava.lang.String
getRealPortName()
Get the physical port name used with jbidibcBiDiBSystemConnectionMemo
getSystemConnectionMemo()
Get theSystemConnectionMemo
associated with this object.abstract void
registerAllListeners(org.bidib.jbidibc.messages.ConnectionListener connectionListener, java.util.Set<org.bidib.jbidibc.core.NodeListener> nodeListeners, java.util.Set<org.bidib.jbidibc.core.MessageListener> messageListeners, java.util.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
-
-
-
-
Constructor Detail
-
BiDiBNetworkPortController
public BiDiBNetworkPortController()
-
-
Method Detail
-
connect
public abstract void connect(java.lang.String host, int port) throws java.io.IOException
Description copied from interface:NetworkPortAdapter
Connects to the end device using a hostname/ip address and port- Specified by:
connect
in interfaceNetworkPortAdapter
- Overrides:
connect
in classAbstractNetworkPortController
- Parameters:
host
- hostname / ip address.port
- network port.- Throws:
java.io.IOException
- on connection error.
-
getSystemConnectionMemo
public BiDiBSystemConnectionMemo getSystemConnectionMemo()
Get theSystemConnectionMemo
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 interfacePortAdapter
- Overrides:
getSystemConnectionMemo
in classAbstractPortController
- Returns:
- the currently associated SystemConnectionMemo
-
getRealPortName
public java.lang.String getRealPortName()
Get the physical port name used with jbidibc- Specified by:
getRealPortName
in interfaceBiDiBPortController
- Returns:
- physical port name
-
registerAllListeners
public abstract void registerAllListeners(org.bidib.jbidibc.messages.ConnectionListener connectionListener, java.util.Set<org.bidib.jbidibc.core.NodeListener> nodeListeners, java.util.Set<org.bidib.jbidibc.core.MessageListener> messageListeners, java.util.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 interfaceBiDiBPortController
- Parameters:
connectionListener
- add to thisnodeListeners
- listeners to addmessageListeners
- listeners to addtransferListeners
- listeners to add
-
getContext
public org.bidib.jbidibc.messages.helpers.Context getContext()
Get the Bidib adapter context- Specified by:
getContext
in interfaceBiDiBPortController
- Returns:
- Context
-
-