Package org.omegazero.net.nio.socket.provider

Class SocketChannelProvider

java.lang.Object

org.omegazero.net.nio.socket.provider.SocketChannelProvider

All Implemented Interfaces:

ChannelProvider

public class SocketChannelProvider
extends Object
implements ChannelProvider

A ChannelProvider for SocketChannels.

API Note:

Before version 2.1.0, this class was in package org.omegazero.net.socket.provider.

Constructor Summary

Constructors

Constructor	Description
SocketChannelProvider()

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the underlying java.nio channel.
boolean	connect(SocketAddress remote, int timeout)	Connects the underlying java.nio channel to the given remote address.
SelectionKey	getSelectionKey()	Returns the SelectionKey of this ChannelProvider.
void	init(ChannelConnection connection, SelectionKey key)	Initializes this ChannelProvider.
boolean	isAvailable()	Returns true if the underlying java.nio channel is connected.
int	read(ByteBuffer buf)	Reads data from the underlying java.nio channel into the given buffer.
void	setReadBlock(boolean block)	If given true, the underlying selection key should stop listening for read ops.
int	write(ByteBuffer buf)	Writes data from the given buffer to the underlying java.nio channel.
void	writeBacklogEnded()	Called by the ChannelConnection to indicate write backlog has ended.
void	writeBacklogStarted()	Called by the ChannelConnection to indicate write backlog has started because the outgoing socket buffer is full.

Methods inherited from class java.lang.Object

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

Constructor Details

SocketChannelProvider

public SocketChannelProvider()

Method Details

init

public void init(ChannelConnection connection,
 SelectionKey key)

Description copied from interface: ChannelProvider

Initializes this ChannelProvider.

Specified by:

init in interface ChannelProvider

Parameters:

connection - The ChannelConnection this ChannelProvider is for

key - The selection key of the connection

connect

public boolean connect(SocketAddress remote,
 int timeout)
                throws IOException

Description copied from interface: ChannelProvider

Connects the underlying java.nio channel to the given remote address.

Specified by:

connect in interface ChannelProvider

Parameters:

remote - The remote address

timeout - If applicable, the connection attempt will cancel after this time in milliseconds

Returns:

true if the channel connected immediately

Throws:

IOException - If an IO error occurs

close

public void close()
           throws IOException

Description copied from interface: ChannelProvider

Closes the underlying java.nio channel.

Specified by:

close in interface ChannelProvider

Throws:

IOException - If an IO error occurs

read

public int read(ByteBuffer buf)
         throws IOException

Description copied from interface: ChannelProvider

Reads data from the underlying java.nio channel into the given buffer.

Specified by:

read in interface ChannelProvider

Parameters:

buf - The buffer to write data to

Returns:

The number of bytes read

Throws:

IOException - If an IO error occurs

write

public int write(ByteBuffer buf)
          throws IOException

Description copied from interface: ChannelProvider

Writes data from the given buffer to the underlying java.nio channel.

Specified by:

write in interface ChannelProvider

Parameters:

buf - The buffer to read from

Returns:

The number of bytes written

Throws:

IOException - If an IO error occurs

writeBacklogStarted

public void writeBacklogStarted()

Description copied from interface: ChannelProvider

Called by the ChannelConnection to indicate write backlog has started because the outgoing socket buffer is full.

Specified by:

writeBacklogStarted in interface ChannelProvider

writeBacklogEnded

public void writeBacklogEnded()

Description copied from interface: ChannelProvider

Called by the ChannelConnection to indicate write backlog has ended.

Specified by:

writeBacklogEnded in interface ChannelProvider

setReadBlock

public void setReadBlock(boolean block)

Description copied from interface: ChannelProvider

If given true, the underlying selection key should stop listening for read ops.

Specified by:

setReadBlock in interface ChannelProvider

Parameters:

block - Whether to block read events

isAvailable

public boolean isAvailable()

Description copied from interface: ChannelProvider

Returns true if the underlying java.nio channel is connected.

Specified by:

isAvailable in interface ChannelProvider

Returns:

true if the channel is connected

getSelectionKey

public SelectionKey getSelectionKey()

Description copied from interface: ChannelProvider

Returns the SelectionKey of this ChannelProvider.

Specified by:

getSelectionKey in interface ChannelProvider

Returns:

The SelectionKey