diva.pod
Interface Channel

All Superinterfaces:
PropertyContainer

public interface Channel
extends PropertyContainer

A Channel is the object that transmits data between a Transmitter and a Receiver. Implementations of this interface will provide, at a minimum, a means by which the transmitter of the same protocol can pass data into the channel, and a means to pass data to the receiver. In general, a channel can perform other functions -- for example, filtering, transforming, or aggregating data.

Channels can have string-named properties attached to them. These properties are defined to have meaning only within a given protocol, and can be used by clients to specify the behavior of a channel.

Version:
$Revision: 1.2 $
Author:
John Reekie

Method Summary
 void connect(Transmitter t, Receiver r)
          Connect this channel between a transmitter and receiver.
 void disconnect()
          Disconnect this channel from its transmitter and receiver.
 Protocol getProtocol()
          Get the protocol that this channel implements.
 Receiver getReceiver()
          Get the Receiver that this channel is attached to, or null if it is not attached.
 Transmitter getTransmitter()
          Get the Transmitter that this channel is attached to, or null if it is not attached.
 
Methods inherited from interface diva.util.PropertyContainer
getProperty, propertyNames, setProperty
 

Method Detail

getProtocol

Protocol getProtocol()
Get the protocol that this channel implements.


connect

void connect(Transmitter t,
             Receiver r)
Connect this channel between a transmitter and receiver.


disconnect

void disconnect()
Disconnect this channel from its transmitter and receiver. The channel is allowed to assume that both the transmitter and receiver still exist and can be reconnected to if needed.


getReceiver

Receiver getReceiver()
Get the Receiver that this channel is attached to, or null if it is not attached.


getTransmitter

Transmitter getTransmitter()
Get the Transmitter that this channel is attached to, or null if it is not attached.



Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.