Boeing Simulation 3.1 API Specification

connect
Interface ConsumerChannel

All Known Implementing Classes:
FacetConsumerChannel, SocketConsumerChannel

public interface ConsumerChannel

A class that abstracts the connection by which one component can read objects from another component.

Version:
$Revision: 1.6 $
Author:
Dave Jurgens

Method Summary
 void close()
          Closes this channel.
 boolean isAvailable()
          Returns true if it is possible at the time of the call to consume additional data from the channel.
 Object readObject()
          Reads in an Object from the channel.
 

Method Detail

close

public void close()
           throws IOException
Closes this channel.

IOException

isAvailable

public boolean isAvailable()
                    throws IOException
Returns true if it is possible at the time of the call to consume additional data from the channel.

IOException

readObject

public Object readObject()
                  throws IOException,
                         ClassNotFoundException
Reads in an Object from the channel. This method blocks until an Object is available.

IOException
ClassNotFoundException

Boeing Simulation 3.1 API Specification

To submit a bug or feature email the author of that class. Funding for this research was provided by Boeing and DARPA.