org.avineas.io.tcp

Class SocketChannel

java.lang.Object

org.avineas.io.tcp.SocketChannel

All Implemented Interfaces:

java.io.Closeable, Channel, ReadChannel, WriteChannel

public class SocketChannel
extends java.lang.Object

Base channel for outgoing TCP connections. This class automatically reconnects to the remote port if somehow the connection is lost. As such it is a kind of permanent virtual circuit to an other party.

Author:

Arie van Wijngaarden

Constructor Summary

Constructors

Constructor and Description
SocketChannel(java.lang.String host, int port) Create a socket to a specific remote TCP port.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
int	read(byte[] data, int offset, long timeout) Read a packet or byte array from the channel, filling up either the data buffer or the information as present in the packet.
java.lang.String	toString()
int	write(byte[] data, int length) Write a packet or number of bytes via the channel.

Methods inherited from class java.lang.Object

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

Constructor Detail

SocketChannel

public SocketChannel(java.lang.String host,
             int port)

Create a socket to a specific remote TCP port.

Parameters:

host - The host name to connect to

port - The port at the remote host to connect to

Method Detail

read

public int read(byte[] data,
       int offset,
       long timeout)

Description copied from interface: ReadChannel

Read a packet or byte array from the channel, filling up either the data buffer or the information as present in the packet.

Specified by:

read in interface ReadChannel

Parameters:

data - The byte buffer to read into

offset - The offset in the buffer to start reading

timeout - The timeout to wait for the first byte of data to become available, in ms. If a value <= 0 is passed, no waiting is done at all

Returns:

The number of bytes read. -1 on error, 0 if no data available within the timeout. The returned number of bytes may be less than would be expected given the size of the data buffer

write

public int write(byte[] data,
        int length)

Description copied from interface: WriteChannel

Write a packet or number of bytes via the channel.

Specified by:

write in interface WriteChannel

Parameters:

data - The data to write

length - The length to write

Returns:

The number of bytes written, normally the value of the parameter 'length'. -1 is returned if the channel is somehow closed or another error occurred

close

@PreDestroy
public void close()

Specified by:

close in interface java.io.Closeable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object