org.openlcb

Interface Connection

All Known Implementing Classes:

AbstractConnection, AbstractNodeCache, BitProducerConsumer, BlueGoldEngine, BlueGoldExtendedEngine, CanInterface.FrameRenderer, DatagramMeteringBuffer, DatagramMeteringBuffer.MessageMemo, DatagramMeteringBuffer.ReplyHandler, DatagramReceiver, DatagramService, DatagramTransmitter, DccProxyCache, EventFilterGateway, EventFilterGateway.EastConnection, EventFilterGateway.WestConnection, Gateway, LoaderClient, MessageBuilder.FrameBuilder, MessageDecoder, MimicNodeStore, MimicNodeStore.NodeMemo, MonPane.InputLink, Node, OlcbInterface.MessageDispatcher, OlcbInterface.OutputConnectionSniffer, OlcbInterface.QueuedOutputConnection, ProducerPane.InputLink, ScatterGather.SingleConnection, SingleConsumer, SingleConsumerNode, SingleLinkNode, SingleProducer, SingleProducerNode, StreamReceiver, StreamTransmitter, TractionThrottle, TrainNodeCache, VerifyNodeIdHandler

public interface Connection

Interface for receiving OpenLCB messages.

Generally, nodes send messages by delivering them to Connections.

Version:

$Revision$

Author:

Bob Jacobsen Copyright 2009

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Connection.ConnectionListener Internal listener class definition

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.

Method Detail

put

void put(Message msg,
         Connection sender)

Put a message to this 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

void registerStartNotification(Connection.ConnectionListener c)

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.

Parameters:

c - callback object to invoke