org.bidib.jbidibc.serial

Class AbstractSerialBidib

java.lang.Object

org.bidib.jbidibc.core.AbstractBidib

org.bidib.jbidibc.serial.AbstractSerialBidib

All Implemented Interfaces:

BidibInterface

public abstract class AbstractSerialBidib
extends AbstractBidib

This is the abstract serial bidib implementation. It creates and initializes the MessageReceiver and the NodeFactory that is used in the system.

Field Summary

Fields

Modifier and Type	Field and Description
protected Semaphore	portSemaphore
protected String	requestedPortName

Fields inherited from interface org.bidib.jbidibc.core.BidibInterface

DEFAULT_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
AbstractSerialBidib()

Method Summary

Modifier and Type	Method and Description
protected void	cleanupAfterClose(SerialMessageReceiver serialMessageReceiver)
protected BidibMessageProcessor	createMessageReceiver(NodeFactory nodeFactory)
protected SerialMessageReceiver	getSerialMessageReceiver()
protected abstract void	internalOpen(String portName, int baudRate, Context context)
protected boolean	isConnected()
protected abstract boolean	isImplAvaiable()
static boolean	isInstanceAvailable() Returns if an instance of ScmSerialBidib is available.
abstract boolean	isOpened()
void	open(String portName, ConnectionListener connectionListener, Set<NodeListener> nodeListeners, Set<MessageListener> messageListeners, Set<TransferListener> transferListeners, Context context)
protected void	receive(byte[] data)
protected void	receive(byte[] data, int len)
void	send(byte[] bytes) Send the bytes to the send queue.
protected abstract void	sendData(byte[] data)
protected void	setConnected(boolean connected)
protected void	startReceiverAndQueues(SerialMessageReceiver serialMessageReceiver, Context context)
protected void	stopReceiverAndQueues(SerialMessageReceiver serialMessageReceiver)

Methods inherited from class org.bidib.jbidibc.core.AbstractBidib

getAccessoryNode, getBoosterNode, getCommandStationNode, getConnectionListener, getFirmwarePacketTimeout, getMessageReceiver, getNode, getNodeFactory, getResponseTimeout, getRootNode, getTransferListeners, initialize, registerListeners, releaseRootNode, setConnectionListener, setFirmwarePacketTimeout, setIgnoreWaitTimeout, setResponseTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bidib.jbidibc.core.BidibInterface

close, getPortIdentifiers

Field Detail

portSemaphore

protected Semaphore portSemaphore

requestedPortName

protected String requestedPortName

Constructor Detail

AbstractSerialBidib

public AbstractSerialBidib()

Method Detail

createMessageReceiver

protected BidibMessageProcessor createMessageReceiver(NodeFactory nodeFactory)

Specified by:

createMessageReceiver in class AbstractBidib

getSerialMessageReceiver

protected SerialMessageReceiver getSerialMessageReceiver()

isInstanceAvailable

public static boolean isInstanceAvailable()

Returns if an instance of ScmSerialBidib is available. The instance will not be created if not available.

Returns:

an instance of ScmSerialBidib is available

stopReceiverAndQueues

protected void stopReceiverAndQueues(SerialMessageReceiver serialMessageReceiver)

cleanupAfterClose

protected void cleanupAfterClose(SerialMessageReceiver serialMessageReceiver)

startReceiverAndQueues

protected void startReceiverAndQueues(SerialMessageReceiver serialMessageReceiver,
                                      Context context)

isImplAvaiable

protected abstract boolean isImplAvaiable()

internalOpen

protected abstract void internalOpen(String portName,
                                     int baudRate,
                                     Context context)
                              throws Exception

Throws:

Exception

open

public void open(String portName,
                 ConnectionListener connectionListener,
                 Set<NodeListener> nodeListeners,
                 Set<MessageListener> messageListeners,
                 Set<TransferListener> transferListeners,
                 Context context)
          throws PortNotFoundException,
                 PortNotOpenedException

Throws:

PortNotFoundException

PortNotOpenedException

isConnected

protected boolean isConnected()

setConnected

protected void setConnected(boolean connected)

isOpened

public abstract boolean isOpened()

send

public void send(byte[] bytes)

Send the bytes to the send queue.

Parameters:

bytes - the bytes to send

sendData

protected abstract void sendData(byte[] data)

receive

protected void receive(byte[] data)

receive

protected void receive(byte[] data,
                       int len)