org.openlcb

Class OlcbInterface.QueuedOutputConnection

java.lang.Object

org.openlcb.OlcbInterface.QueuedOutputConnection

All Implemented Interfaces:

Connection

Enclosing class:

OlcbInterface

private class OlcbInterface.QueuedOutputConnection
extends Object
implements Connection

This class keeps an output connection operating using an internal queue. It keeps messages in an internal thread-safe queue and sends them on a separate thread.

The caller must donate a thread to this connection by calling the run() method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	OlcbInterface.QueuedOutputConnection.QEntry

Nested classes/interfaces inherited from interface org.openlcb.Connection

Connection.ConnectionListener

Field Summary

Fields

Modifier and Type	Field and Description
private BlockingQueue<OlcbInterface.QueuedOutputConnection.QEntry>	outputQueue
private int	pendingCount
private Connection	realOutput

Constructor Summary

Constructors

Constructor and Description
QueuedOutputConnection(Connection realOutput)

Method Summary

Modifier and Type	Method and Description
void	put(Message msg, Connection sender) Put a message to this connection.
void	registerStartNotification(Connection.ConnectionListener c) Register to be informed when this connection is ready to accept messages.
private void	run() Never returns.
void	waitForSendQueue()

Methods inherited from class java.lang.Object

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

Field Detail

realOutput

private final Connection realOutput

outputQueue

private final BlockingQueue<OlcbInterface.QueuedOutputConnection.QEntry> outputQueue

pendingCount

private int pendingCount

Constructor Detail

QueuedOutputConnection

QueuedOutputConnection(Connection realOutput)

Method Detail

put

public void put(Message msg,
                Connection sender)

Description copied from interface: Connection

Put a message to this connection.

Specified by:

put in interface Connection

Parameters:

msg - message to send

sender - Node that is sending the message, used for tracking, logging, etc. (This models a two-ended connection to whatever communications link is used)

registerStartNotification

public void registerStartNotification(Connection.ConnectionListener c)

Description copied from interface: Connection

Register to be informed when this connection is ready to accept messages. Unless you know via some other mechanism that the connection is ready to go, you must register a listener and get the call-back before sending messages through the connection.

Specified by:

registerStartNotification in interface Connection

Parameters:

c - callback object to invoke

waitForSendQueue

public void waitForSendQueue()

run

private void run()

Never returns.