icube.demo.io

Interface IChannel

All Known Implementing Classes:

COMChannel, TCPChannel

public interface IChannel

This interface defines simple communication channel methods to access metering devices.

The library provides implementation for serial port and TCP/IP.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the communication channel.
java.lang.String	getID() Returns the communication channel ID.
java.io.InputStream	getInputStream()
java.io.OutputStream	getOutputStream()
boolean	isOpen() Returns the open status of the communication channel.
void	open(int timeout) Opens the communication channel.

Method Detail

getInputStream

java.io.InputStream getInputStream()
                            throws java.io.IOException

Throws:

java.io.IOException

getOutputStream

java.io.OutputStream getOutputStream()
                              throws java.io.IOException

Throws:

java.io.IOException

getID

java.lang.String getID()

Returns the communication channel ID. (i.e. COM1, ...)

Returns:

Channel ID.

isOpen

boolean isOpen()

Returns the open status of the communication channel.

Returns:

true if is open.

open

void open(int timeout)
   throws ChannelException

Opens the communication channel.

Parameters:

timeout - Default Timeout (in ms) to be used for all read actions.

Throws:

ChannelException - Thrown for any detected error.

close

void close()
    throws ChannelException

Closes the communication channel.

Throws:

ChannelException - Thrown for any detected error.