ConnectionIfc

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> jempeg >> empeg >> [ protocol overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.jempeg.empeg.protocol.ConnectionIfc

SOURCE |

Download org.jempeg.empeg.protocol.ConnectionIfc

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jempeg.empeg.protocol
Interface ConnectionIfc

All Known Implementing Classes:: SerialConnection, SocketConnection, USBConnection

public interface ConnectionIfc

A ConnectionIfc is the interface that must be implemented to provide basic communication capabilities to the Empeg. Each implementation of this interface defines a different channel that can used to communicate to an Empeg This probably needs to be "cleansed" of its C heritage by getting rid of not stream-based communication (i.e. send and receive).

Version:: $Revision: 1.7 $

Method Summary

void close()
          Closes the communication channel to the Empeg

void flushReceiveBuffer()
          Flushes the receive buffer (for use after things like error conditions when lingering bytes may be hanging at the end of the stream.

EmpegInputStream getInputStream()
          Returns an input stream to read data from the Empeg

EmpegOutputStream getOutputStream()
          Returns an output stream to write data to the Empeg

int getPacketSize()
          Returns the maximum packet size of the connection.

org.jempeg.empeg.core.DynamicConfigFile getPlayerConfiguration()
          Returns the configuration that was obtained during discovery.

boolean isOpen()
          Returns whether or not this connection is open.

void open()
          Opens the communication channel to the Empeg

void pause()
          Pauses the communication channel to the Empeg.

void setPlayerConfiguration(org.jempeg.empeg.core.DynamicConfigFile _configFile)
          Sets the configuration that was obtained during discovery.

void setTimeout(long _millis)
          Sets the current timeout on the connection.

void unpause()
          Unpauses the communication channel to the Empeg.

Method Detail

setPlayerConfiguration

public void setPlayerConfiguration(org.jempeg.empeg.core.DynamicConfigFile _configFile)

Sets the configuration that was obtained during discovery.

getPlayerConfiguration

public org.jempeg.empeg.core.DynamicConfigFile getPlayerConfiguration()

Returns the configuration that was obtained during discovery.

getPacketSize

public int getPacketSize()

Returns the maximum packet size of the connection.

getInputStream

public EmpegInputStream getInputStream()
                                throws java.io.IOException

Returns an input stream to read data from the Empeg

getOutputStream

public EmpegOutputStream getOutputStream()
                                  throws java.io.IOException

Returns an output stream to write data to the Empeg

open

public void open()
          throws java.io.IOException

Opens the communication channel to the Empeg

close

public void close()
           throws java.io.IOException

Closes the communication channel to the Empeg

pause

public void pause()
           throws java.io.IOException

Pauses the communication channel to the Empeg. You got me as to why this exists -- this came from the original port. All implementations just proxy close.

unpause

public void unpause()
             throws java.io.IOException

Unpauses the communication channel to the Empeg. You got me as to why this exists -- this came from the original port. All implementations just proxy open.

flushReceiveBuffer

public void flushReceiveBuffer()
                        throws java.io.IOException

Flushes the receive buffer (for use after things like error conditions when lingering bytes may be hanging at the end of the stream.

setTimeout

public void setTimeout(long _millis)
                throws java.io.IOException

Sets the current timeout on the connection.

isOpen

public boolean isOpen()

Returns whether or not this connection is open.