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
FieldsModifier and TypeFieldDescriptionprotected org.bidib.jbidibc.core.BidibInterfaceprotected org.bidib.jbidibc.messages.helpers.ContextFields inherited from class jmri.jmrix.AbstractNetworkPortController
connTimeout, m_HostName, m_port, socketConnFields inherited from class jmri.jmrix.AbstractPortController
allowConnectionRecovery, manufacturerName, opened, option1Name, option2Name, option3Name, option4Name, options, reconnectinterval, reconnectMaxAttempts, reconnectMaxInterval -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract voidConnects to the end device using a hostname/ip address and portorg.bidib.jbidibc.messages.helpers.ContextGet the Bidib adapter contextGet the physical port name used with jbidibcGet theSystemConnectionMemoassociated with this object.abstract voidregisterAllListeners(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, setServiceTypeMethods 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, statusMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface jmri.jmrix.NetworkPortAdapter
configure, statusMethods 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
-
context
-
-
Constructor Details
-
BiDiBNetworkPortController
public BiDiBNetworkPortController()
-
-
Method Details
-
connect
Description copied from interface:NetworkPortAdapterConnects to the end device using a hostname/ip address and port- Specified by:
connectin interfaceNetworkPortAdapter- Overrides:
connectin classAbstractNetworkPortController- Parameters:
host- hostname / ip address.port- network port.- Throws:
IOException- on connection error.
-
getSystemConnectionMemo
Get theSystemConnectionMemoassociated 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:
getSystemConnectionMemoin interfacePortAdapter- Overrides:
getSystemConnectionMemoin classAbstractPortController- Returns:
- the currently associated SystemConnectionMemo
-
getRealPortName
Get the physical port name used with jbidibc- Specified by:
getRealPortNamein interfaceBiDiBPortController- 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:
registerAllListenersin interfaceBiDiBPortController- Parameters:
connectionListener- add to thisnodeListeners- listeners to addmessageListeners- listeners to addtransferListeners- listeners to add
-
getContext
Get the Bidib adapter context- Specified by:
getContextin interfaceBiDiBPortController- Returns:
- Context
-