com.sleepycat.je.rep.utilint

Class NamedChannelWithTimeout

java.lang.Object

com.sleepycat.je.rep.utilint.NamedChannel

com.sleepycat.je.rep.utilint.NamedChannelWithTimeout

All Implemented Interfaces:

Closeable, AutoCloseable, ByteChannel, Channel, ReadableByteChannel, WritableByteChannel

public class NamedChannelWithTimeout
extends NamedChannel

NamedChannelWithTimeout permits association of timeouts with a DataChannel. This mechanism is necessary, since the standard mechanism for associating timeouts with sockets using Socket.setSoTimeout is not supported by nio SocketChannels.

Field Summary

Fields inherited from class com.sleepycat.je.rep.utilint.NamedChannel

channel

Constructor Summary

Constructors

Constructor and Description
NamedChannelWithTimeout(RepImpl repImpl, Logger logger, ChannelTimeoutTask channelTimeoutTask, DataChannel channel, int timeoutMs)
NamedChannelWithTimeout(RepNode repNode, DataChannel channel, int timeoutMs)

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	isActive(long timeMs) Method invoked by the time thread to check on the channel on a periodic basis.
int	read(ByteBuffer dst)
void	setTimeoutMs(int timeoutMs) Used to modify the timeout associated with the channel.

Methods inherited from class com.sleepycat.je.rep.utilint.NamedChannel

getChannel, getNameIdPair, isOpen, setNameIdPair, toString, write

Methods inherited from class java.lang.Object

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

Constructor Detail

NamedChannelWithTimeout

public NamedChannelWithTimeout(RepNode repNode,
                               DataChannel channel,
                               int timeoutMs)

NamedChannelWithTimeout

public NamedChannelWithTimeout(RepImpl repImpl,
                               Logger logger,
                               ChannelTimeoutTask channelTimeoutTask,
                               DataChannel channel,
                               int timeoutMs)

Method Detail

setTimeoutMs

public void setTimeoutMs(int timeoutMs)

Used to modify the timeout associated with the channel.

Parameters:

timeoutMs - the new timeout value

read

public int read(ByteBuffer dst)
         throws IOException

Specified by:

read in interface ReadableByteChannel

Overrides:

read in class NamedChannel

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Overrides:

close in class NamedChannel

Throws:

IOException

isActive

public boolean isActive(long timeMs)

Method invoked by the time thread to check on the channel on a periodic basis. Note that the time that is passed in is a "pseudo" time that is only meaningful for calculating time differences.

Parameters:

timeMs - the pseudo time

Returns:

true if the channel is active, false if it isn't and has been closed