at.chrl.nutils.network

Class AConnection

java.lang.Object

at.chrl.nutils.network.AConnection

public abstract class AConnection
extends Object

Class that represent Connection with server socket. Connection is created by ConnectionFactory and attached to SelectionKey key. Selection key is registered to one of Dispatchers Selector to handle io read and write.

Author:

-Nemesiss-

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closed True if this connection is already closed.
protected Object	guard Object on witch some methods are synchronized
protected boolean	isForcedClosing True if OnDisconnect() method should be called immediately after this connection was closed.
protected boolean	pendingClose True if this connection should be closed after sending last server packet.
ByteBuffer	readBuffer ByteBuffer for io read.
ByteBuffer	writeBuffer ByteBuffer for io write.

Constructor Summary

Constructors

Constructor and Description
AConnection(SocketChannel sc, Dispatcher d) Constructor

Method Summary

Modifier and Type	Method and Description
void	close(boolean forced) Connection will be closed at some time [by Dispatcher Thread], after that onDisconnect() method will be called to clear all other things.
protected void	enableWriteInterest() Notify Dispatcher Selector that we want write some data here.
protected abstract long	getDisconnectionDelay() This method is called by Dispatcher when connection is ready to be closed.
String	getIP()
SocketChannel	getSocketChannel()
protected boolean	isWriteDisabled()
protected abstract void	onDisconnect() This method is called by Dispatcher to inform that this connection was closed and should be cleared.
protected abstract void	onServerClose() This method is called by NioServer to inform that NioServer is shouting down.
protected abstract boolean	processData(ByteBuffer data)
protected abstract boolean	writeData(ByteBuffer data) This method will be called by Dispatcher, and will be repeated till return false.

Methods inherited from class java.lang.Object

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

Field Detail

pendingClose

protected boolean pendingClose

True if this connection should be closed after sending last server packet.

isForcedClosing

protected boolean isForcedClosing

True if OnDisconnect() method should be called immediately after this connection was closed.

closed

protected boolean closed

True if this connection is already closed.

guard

protected final Object guard

Object on witch some methods are synchronized

writeBuffer

public final ByteBuffer writeBuffer

ByteBuffer for io write.

readBuffer

public final ByteBuffer readBuffer

ByteBuffer for io read.

Constructor Detail

AConnection

public AConnection(SocketChannel sc,
                   Dispatcher d)
            throws IOException

Constructor

Parameters:

sc -

d -

Throws:

IOException

Method Detail

enableWriteInterest

protected final void enableWriteInterest()

Notify Dispatcher Selector that we want write some data here.

getSocketChannel

public SocketChannel getSocketChannel()

Returns:

SocketChannel representing this connection.

close

public void close(boolean forced)

Connection will be closed at some time [by Dispatcher Thread], after that onDisconnect() method will be called to clear all other things.

Parameters:

forced - is just hint that getDisconnectionDelay() should return 0 so OnDisconnect() method will be called without any delay.

isWriteDisabled

protected final boolean isWriteDisabled()

Returns:

True if write to this connection is possible.

getIP

public final String getIP()

Returns:

IP address of this Connection.

processData

protected abstract boolean processData(ByteBuffer data)

Parameters:

data -

Returns:

True if data was processed correctly, False if some error occurred and connection should be closed NOW.

writeData

protected abstract boolean writeData(ByteBuffer data)

This method will be called by Dispatcher, and will be repeated till return false.

Parameters:

data -

Returns:

True if data was written to buffer, False indicating that there are not any more data to write.

getDisconnectionDelay

protected abstract long getDisconnectionDelay()

This method is called by Dispatcher when connection is ready to be closed.

Returns:

time in ms after witch onDisconnect() method will be called.

onDisconnect

protected abstract void onDisconnect()

This method is called by Dispatcher to inform that this connection was closed and should be cleared. This method is called only once.

onServerClose

protected abstract void onServerClose()

This method is called by NioServer to inform that NioServer is shouting down. This method is called only once.