icube.demo.io

Class TCPChannel

java.lang.Object

icube.demo.io.TCPChannel

All Implemented Interfaces:

IChannel

public class TCPChannel
extends java.lang.Object
implements IChannel

Implements the TCP/IP communication resource.

Constructor Summary

Constructors

Constructor and Description
TCPChannel(java.lang.String host, int port) Instantiates a new instance of TCPChannel creating a tcp client.

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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TCPChannel

public TCPChannel(java.lang.String host,
                  int port)
           throws ChannelException

Instantiates a new instance of TCPChannel creating a tcp client.

Parameters:

host - Host name.

port - Port No.

Throws:

ChannelException - Thrown for any detected error.

Method Detail

getInputStream

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

Specified by:

getInputStream in interface IChannel

Throws:

java.io.IOException

getOutputStream

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

Specified by:

getOutputStream in interface IChannel

Throws:

java.io.IOException

isOpen

public boolean isOpen()

Description copied from interface: IChannel

Returns the open status of the communication channel.

Specified by:

isOpen in interface IChannel

Returns:

true if is open.

close

public void close()
           throws ChannelException

Description copied from interface: IChannel

Closes the communication channel.

Specified by:

close in interface IChannel

Throws:

ChannelException - Thrown for any detected error.

getID

public java.lang.String getID()

Description copied from interface: IChannel

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

Specified by:

getID in interface IChannel

Returns:

Channel ID.

open

public void open(int timeout)
          throws ChannelException

Description copied from interface: IChannel

Opens the communication channel.

Specified by:

open in interface IChannel

Parameters:

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

Throws:

ChannelException - Thrown for any detected error.