com.sleepycat.je.rep.utilint.net

Class AbstractDataChannel

java.lang.Object

com.sleepycat.je.rep.utilint.net.AbstractDataChannel

All Implemented Interfaces:

DataChannel, Closeable, AutoCloseable, ByteChannel, Channel, GatheringByteChannel, ReadableByteChannel, ScatteringByteChannel, WritableByteChannel

Direct Known Subclasses:

SimpleDataChannel, SSLDataChannel

public abstract class AbstractDataChannel
extends Object
implements DataChannel

An abstract class that utilizes a delegate socketChannel for network I/O, but which provides an abstract ByteChannel interface for callers. This allows more interesting communication mechanisms to be introduced.

Nested Class Summary

Nested classes/interfaces inherited from interface com.sleepycat.je.rep.net.DataChannel

DataChannel.CloseAsyncStatus, DataChannel.FlushStatus

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	configuredBlocking The cached value of whether the channel is blocking.
protected SocketChannel	socketChannel The underlying socket channel

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDataChannel(SocketChannel socketChannel) Constructor for sub-classes.

Method Summary

Modifier and Type	Method and Description
void	configureBlocking(boolean block) Configures the channel to be blocking.
protected void	ensureCloseAsyncForNonBlocking() Ensures this channel is in non-blocking mode when calling closeAsync.
protected void	ensureCloseForBlocking() Ensures this channel is in blocking mode when calling close.
SocketAddress	getRemoteAddress() Returns the remote address to which this channel's socket is connected.
SocketChannel	getSocketChannel() Accessor for the underlying SocketChannel.
boolean	isBlocking() Tells whether or not every I/O operation on this channel will block until it completes.
boolean	isConnected() Checks whether the channel is connected.
Socket	socket() Retrieves a socket associated with this channel.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sleepycat.je.rep.net.DataChannel

close, closeAsync, closeForcefully, flush, isSecure, isTrustCapable, isTrusted, read, write

Methods inherited from interface java.nio.channels.GatheringByteChannel

write

Methods inherited from interface java.nio.channels.WritableByteChannel

write

Methods inherited from interface java.nio.channels.ScatteringByteChannel

read

Methods inherited from interface java.nio.channels.ReadableByteChannel

read

Methods inherited from interface java.nio.channels.Channel

isOpen

Field Detail

configuredBlocking

protected boolean configuredBlocking

The cached value of whether the channel is blocking. The method AbstractSelectableChannel.isBlocking() acquires the AbstractSelectableChannel.blockingLock(). Some socket read operations also acquires such lock, e.g., sun.nio.ch.ChannelInputStream#read. Thus a non-blocking implementation calling isBlocking() might be blocked by concurrent operations. Use a cached value to avoid such blocking behavior. Accessors to this field must synchronize on the object.

socketChannel

protected final SocketChannel socketChannel

The underlying socket channel

Constructor Detail

AbstractDataChannel

protected AbstractDataChannel(SocketChannel socketChannel)

Constructor for sub-classes.

Parameters:

socketChannel - The underlying SocketChannel over which data will be sent. This should be the lowest-level socket so that select operations can be performed on it.

Method Detail

isConnected

public boolean isConnected()

Checks whether the channel is connected.

Specified by:

isConnected in interface DataChannel

Returns:

true if the channel is connected

socket

public Socket socket()

Retrieves a socket associated with this channel.

Specified by:

socket in interface DataChannel

Returns:

a socket associated with this channel.

getRemoteAddress

public SocketAddress getRemoteAddress()
                               throws IOException

Returns the remote address to which this channel's socket is connected.

Specified by:

getRemoteAddress in interface DataChannel

Throws:

IOException

configureBlocking

public void configureBlocking(boolean block)
                       throws IOException

Configures the channel to be blocking.

Specified by:

configureBlocking in interface DataChannel

Throws:

IOException

isBlocking

public boolean isBlocking()

Tells whether or not every I/O operation on this channel will block until it completes.

Specified by:

isBlocking in interface DataChannel

getSocketChannel

public SocketChannel getSocketChannel()

Accessor for the underlying SocketChannel. Use of this accessor is discouraged -- see DataChannel.

Specified by:

getSocketChannel in interface DataChannel

Returns:

the socket channel underlying this data channel instance

ensureCloseForBlocking

protected void ensureCloseForBlocking()

Ensures this channel is in blocking mode when calling close.

ensureCloseAsyncForNonBlocking

protected void ensureCloseAsyncForNonBlocking()

Ensures this channel is in non-blocking mode when calling closeAsync.