Package org.omegazero.net.socket.impl

Class PlainConnection

java.lang.Object

org.omegazero.net.socket.SocketConnection

org.omegazero.net.socket.ChannelConnection

org.omegazero.net.socket.impl.PlainConnection

All Implemented Interfaces:

AutoCloseable

public class PlainConnection
extends ChannelConnection

Field Summary

Fields inherited from class org.omegazero.net.socket.ChannelConnection

readBuf, writeBuf

Fields inherited from class org.omegazero.net.socket.SocketConnection

readLock, writeLock

Constructor Summary

Constructors

Constructor	Description
PlainConnection(SelectionKey selectionKey, ChannelProvider provider)
PlainConnection(SelectionKey selectionKey, ChannelProvider provider, SocketAddress remote)

Method Summary

Modifier and Type	Method	Description
protected void	createBuffers()	Must be called by subclass constructors.
boolean	flush()	Attempts to flush any queued data after a call to SocketConnection.writeQueue(byte[]) or data that could not be written previously because the socket was busy.
byte[]	read()	Reads data received from the peer host on this connection.
void	write(byte[] data, int offset, int length)	Writes data to this connection for delivery to the peer host.
void	writeQueue(byte[] data, int offset, int length)	Similar to SocketConnection.write(byte[], int, int), except that no attempt will be made to immediately flush the data to the socket, if supported by the implementation.

Methods inherited from class org.omegazero.net.socket.ChannelConnection

close, close0, connect, destroy, flushWriteBacklog, getLastIOTime, getLocalAddress, getProvider, getRemoteAddress, isConnected, isWritable, readFromSocket, setReadBlock, writeBuffered, writeToSocket

Methods inherited from class org.omegazero.net.socket.SocketConnection

getApparentRemoteAddress, getAttachment, getReadLock, getWriteLock, handleClose, handleConnect, handleData, handleError, handleTimeout, handleWritable, hasConnected, hasDisconnected, localClose, localConnect, queueWrite, setApparentRemoteAddress, setAttachment, setOnClose, setOnConnect, setOnData, setOnError, setOnLocalClose, setOnLocalConnect, setOnTimeout, setOnWritable, write, write, writeQueue

Methods inherited from class java.lang.Object

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

Constructor Details

PlainConnection

public PlainConnection(SelectionKey selectionKey,
 ChannelProvider provider)
                throws IOException

Throws:

IOException

PlainConnection

public PlainConnection(SelectionKey selectionKey,
 ChannelProvider provider,
 SocketAddress remote)
                throws IOException

Throws:

IOException

Method Details

createBuffers

protected void createBuffers()

Description copied from class: ChannelConnection

Must be called by subclass constructors. This method creates the ChannelConnection.readBuf and ChannelConnection.writeBuf buffers and any additional buffers required.

Specified by:

createBuffers in class ChannelConnection

read

public byte[] read()

Description copied from class: SocketConnection

Reads data received from the peer host on this connection.

This function is non-blocking. If no data was available, null is returned.

Specified by:

read in class SocketConnection

Returns:

The read data or null if no data is available.

write

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

Description copied from class: SocketConnection

Writes data to this connection for delivery to the peer host.

This function is non-blocking and may store data in a temporary write buffer if the underlying socket is busy. An application should try to respect the value of SocketConnection.isWritable() to reduce memory consumption by such write buffer if a lot of data is being written.

If this method is called before the onConnect event, the data is queued in a temporary buffer and written out when the socket connects.

Specified by:

write in class SocketConnection

Parameters:

data - The data to write

offset - The start index of the data to write in the data byte array

length - The total number of bytes to write from the data byte array, starting at offset

See Also:

• SocketConnection.write(byte[])
• SocketConnection.writeQueue(byte[], int, int)

writeQueue

public void writeQueue(byte[] data,
 int offset,
 int length)

Description copied from class: SocketConnection

Similar to SocketConnection.write(byte[], int, int), except that no attempt will be made to immediately flush the data to the socket, if supported by the implementation.

Overrides:

writeQueue in class SocketConnection

Parameters:

data - The data to write

offset - The start index of the data to write in the data byte array

length - The total number of bytes to write from the data byte array, starting at offset

See Also:

• SocketConnection.writeQueue(byte[])
• SocketConnection.write(byte[], int, int)

flush

public boolean flush()

Description copied from class: ChannelConnection

Attempts to flush any queued data after a call to SocketConnection.writeQueue(byte[]) or data that could not be written previously because the socket was busy.

Overrides:

flush in class ChannelConnection

Returns:

true if all data could be written to the socket

See Also:

• SocketConnection.write(byte[])
• SocketConnection.writeQueue(byte[])