Package jmri.jmrix.lenz

Class XNetNetworkPortController

java.lang.Object

jmri.jmrix.AbstractPortController

jmri.jmrix.AbstractNetworkPortController

jmri.jmrix.lenz.XNetNetworkPortController

All Implemented Interfaces:

XNetPortController, NetworkPortAdapter, PortAdapter

Direct Known Subclasses:

LIUSBEthernetAdapter, LIUSBServerAdapter, XnTcpAdapter

public abstract class XNetNetworkPortController
extends AbstractNetworkPortController
implements XNetPortController

Abstract base for classes representing an XNet 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

Constructor	Description
XNetNetworkPortController()

Method Summary

Modifier and Type	Method	Description
void	dispose()	Clean up before removal.
XNetSystemConnectionMemo	getSystemConnectionMemo()	Get the SystemConnectionMemo associated with this object.
boolean	hasTimeSlot()	Indicate whether the command station is currently providing a timeslot to this port controller.
boolean	okToSend()	Can the port accept additional characters?
protected void	resetupConnection()	Customizable method to deal with resetting a system connection after a successful recovery of a connection.
void	setOutputBufferEmpty(boolean s)	We need a way to say if the output buffer is empty or not.
void	setTimeSlot(boolean timeslot)	Set a variable indicating whether or not the command station is providing a timeslot.
abstract boolean	status()	Check that this object is ready to operate.

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, 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.NetworkPortAdapter

configure

Methods inherited from interface jmri.jmrix.PortAdapter

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

XNetNetworkPortController

public XNetNetworkPortController()

Method Detail

status

public abstract boolean status()

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

Specified by:

status in interface NetworkPortAdapter

Specified by:

status in interface PortAdapter

Specified by:

status in interface XNetPortController

Overrides:

status in class AbstractPortController

Returns:

true if OK, at least as far as known

okToSend

@OverridingMethodsMustInvokeSuper
public boolean okToSend()

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 XNetPortController

Returns:

true if OK to send, else false.

hasTimeSlot

public boolean hasTimeSlot()

Indicate whether the command station is currently providing a timeslot to this port controller.

Specified by:

hasTimeSlot in interface XNetPortController

Returns:

true if the command station is currently providing a timeslot.

setTimeSlot

public void setTimeSlot(boolean timeslot)

Set a variable indicating whether or not the command station is providing a timeslot.

This method should be called with the paramter set to false if a "Command Station No Longer Providing a timeslot for communications" (01 05 04) is received.

This method should be called with the parameter set to true if a "Command Station is providing a timeslot for communications again." (01 07 06) is received.

Specified by:

setTimeSlot in interface XNetPortController

Parameters:

timeslot - true if a timeslot is being sent, false otherwise.

setOutputBufferEmpty

public void setOutputBufferEmpty(boolean s)

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

Specified by:

setOutputBufferEmpty in interface XNetPortController

Parameters:

s - true to set buffer empty, else false.

getSystemConnectionMemo

public XNetSystemConnectionMemo 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

dispose

public void dispose()

Description copied from class: AbstractPortController

Clean up before removal. Overriding methods must call super.dispose() or document why they are not calling the overridden implementation. In most cases, failure to call the overridden implementation will cause user-visible error.

Specified by:

dispose in interface PortAdapter

Overrides:

dispose in class AbstractPortController

resetupConnection

protected void resetupConnection()

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

Overrides:

resetupConnection in class AbstractNetworkPortController