Package io.netty.channel.socket.nio

Class NioDomainSocketChannel.NioDomainSocketChannelConfig

java.lang.Object

io.netty.channel.DefaultChannelConfig

io.netty.channel.socket.nio.NioDomainSocketChannel.NioDomainSocketChannelConfig

All Implemented Interfaces:

ChannelConfig, DuplexChannelConfig

Enclosing class:

NioDomainSocketChannel

private final class NioDomainSocketChannel.NioDomainSocketChannelConfig
extends DefaultChannelConfig
implements DuplexChannelConfig

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	allowHalfClosure
private java.nio.channels.SocketChannel	javaChannel
private int	maxBytesPerGatheringWrite

Fields inherited from class io.netty.channel.DefaultChannelConfig

channel

Constructor Summary

Constructors

Modifier	Constructor	Description
private	NioDomainSocketChannelConfig(NioDomainSocketChannel channel, java.nio.channels.SocketChannel javaChannel)

Method Summary

Modifier and Type	Method	Description
protected void	autoReadCleared()	Is called once DefaultChannelConfig.setAutoRead(boolean) is called with false and DefaultChannelConfig.isAutoRead() was true before.
private void	calculateMaxBytesPerGatheringWrite()
(package private) int	getMaxBytesPerGatheringWrite()
<T> T	getOption(ChannelOption<T> option)	Return the value of the given ChannelOption
java.util.Map<ChannelOption<?>,java.lang.Object>	getOptions()	Return all set ChannelOption's.
private int	getReceiveBufferSize()
private int	getSendBufferSize()
boolean	isAllowHalfClosure()	Returns true if and only if the channel should not close itself when its remote peer shuts down output to make the connection half-closed.
private java.nio.channels.SocketChannel	jdkChannel()
NioDomainSocketChannel.NioDomainSocketChannelConfig	setAllocator(ByteBufAllocator allocator)	Set the ByteBufAllocator which is used for the channel to allocate buffers.
NioDomainSocketChannel.NioDomainSocketChannelConfig	setAllowHalfClosure(boolean allowHalfClosure)	Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed.
NioDomainSocketChannel.NioDomainSocketChannelConfig	setAutoClose(boolean autoClose)	Sets whether the Channel should be closed automatically and immediately on write failure.
NioDomainSocketChannel.NioDomainSocketChannelConfig	setAutoRead(boolean autoRead)	Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
NioDomainSocketChannel.NioDomainSocketChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis)	Sets the connect timeout of the channel in milliseconds.
(package private) void	setMaxBytesPerGatheringWrite(int maxBytesPerGatheringWrite)
NioDomainSocketChannel.NioDomainSocketChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead)	Deprecated.
NioDomainSocketChannel.NioDomainSocketChannelConfig	setMessageSizeEstimator(MessageSizeEstimator estimator)	Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
<T> boolean	setOption(ChannelOption<T> option, T value)	Sets a configuration property with the specified name and value.
private NioDomainSocketChannel.NioDomainSocketChannelConfig	setReceiveBufferSize(int receiveBufferSize)
NioDomainSocketChannel.NioDomainSocketChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator)	Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
private NioDomainSocketChannel.NioDomainSocketChannelConfig	setSendBufferSize(int sendBufferSize)
NioDomainSocketChannel.NioDomainSocketChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark)	Sets the high water mark of the write buffer.
NioDomainSocketChannel.NioDomainSocketChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark)	Sets the low water mark of the write buffer.
NioDomainSocketChannel.NioDomainSocketChannelConfig	setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)	Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
NioDomainSocketChannel.NioDomainSocketChannelConfig	setWriteSpinCount(int writeSpinCount)	Sets the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.

Methods inherited from class io.netty.channel.DefaultChannelConfig

getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMaxMessagesPerWrite, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setMaxMessagesPerWrite, setOptions, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelConfig

getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOptions

Field Detail

allowHalfClosure

private volatile boolean allowHalfClosure

maxBytesPerGatheringWrite

private volatile int maxBytesPerGatheringWrite

javaChannel

private final java.nio.channels.SocketChannel javaChannel

Constructor Detail

NioDomainSocketChannelConfig

private NioDomainSocketChannelConfig(NioDomainSocketChannel channel,
                                     java.nio.channels.SocketChannel javaChannel)

Method Detail

isAllowHalfClosure

public boolean isAllowHalfClosure()

Description copied from interface: DuplexChannelConfig

Returns true if and only if the channel should not close itself when its remote peer shuts down output to make the connection half-closed. If false, the connection is closed automatically when the remote peer shuts down output.

Specified by:

isAllowHalfClosure in interface DuplexChannelConfig

setAllowHalfClosure

public NioDomainSocketChannel.NioDomainSocketChannelConfig setAllowHalfClosure(boolean allowHalfClosure)

Description copied from interface: DuplexChannelConfig

Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed. If true the connection is not closed when the remote peer shuts down output. Instead, ChannelInboundHandler.userEventTriggered(ChannelHandlerContext, Object) is invoked with a ChannelInputShutdownEvent object. If false, the connection is closed automatically.

Specified by:

setAllowHalfClosure in interface DuplexChannelConfig

getOptions

public java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()

Description copied from interface: ChannelConfig

Return all set ChannelOption's.

Specified by:

getOptions in interface ChannelConfig

Overrides:

getOptions in class DefaultChannelConfig

getOption

public <T> T getOption(ChannelOption<T> option)

Description copied from interface: ChannelConfig

Return the value of the given ChannelOption

Specified by:

getOption in interface ChannelConfig

Overrides:

getOption in class DefaultChannelConfig

setOption

public <T> boolean setOption(ChannelOption<T> option,
                             T value)

Description copied from interface: ChannelConfig

Sets a configuration property with the specified name and value. To override this method properly, you must call the super class:

 public boolean setOption(ChannelOption<T> option, T value) {
     if (super.setOption(option, value)) {
         return true;
     }

     if (option.equals(additionalOption)) {
         ....
         return true;
     }

     return false;
 }
 

Specified by:

setOption in interface ChannelConfig

Overrides:

setOption in class DefaultChannelConfig

Returns:

true if and only if the property has been set

getReceiveBufferSize

private int getReceiveBufferSize()

setReceiveBufferSize

private NioDomainSocketChannel.NioDomainSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)

getSendBufferSize

private int getSendBufferSize()

setSendBufferSize

private NioDomainSocketChannel.NioDomainSocketChannelConfig setSendBufferSize(int sendBufferSize)

setConnectTimeoutMillis

public NioDomainSocketChannel.NioDomainSocketChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)

Description copied from interface: ChannelConfig

Sets the connect timeout of the channel in milliseconds. If the Channel does not support connect operation, this property is not used at all, and therefore will be ignored.

Specified by:

setConnectTimeoutMillis in interface ChannelConfig

Overrides:

setConnectTimeoutMillis in class DefaultChannelConfig

Parameters:

connectTimeoutMillis - the connect timeout in milliseconds. 0 to disable.

setMaxMessagesPerRead

@Deprecated
public NioDomainSocketChannel.NioDomainSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Deprecated.

Description copied from class: DefaultChannelConfig

Specified by:

setMaxMessagesPerRead in interface ChannelConfig

Specified by:

setMaxMessagesPerRead in interface DuplexChannelConfig

Overrides:

setMaxMessagesPerRead in class DefaultChannelConfig

setWriteSpinCount

public NioDomainSocketChannel.NioDomainSocketChannelConfig setWriteSpinCount(int writeSpinCount)

Description copied from interface: ChannelConfig

Sets the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value. It is similar to what a spin lock is used for in concurrency programming. It improves memory utilization and write throughput depending on the platform that JVM runs on. The default value is 16.

Specified by:

setWriteSpinCount in interface ChannelConfig

Specified by:

setWriteSpinCount in interface DuplexChannelConfig

Overrides:

setWriteSpinCount in class DefaultChannelConfig

setAllocator

public NioDomainSocketChannel.NioDomainSocketChannelConfig setAllocator(ByteBufAllocator allocator)

Description copied from interface: ChannelConfig

Set the ByteBufAllocator which is used for the channel to allocate buffers.

Specified by:

setAllocator in interface ChannelConfig

Specified by:

setAllocator in interface DuplexChannelConfig

Overrides:

setAllocator in class DefaultChannelConfig

setRecvByteBufAllocator

public NioDomainSocketChannel.NioDomainSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

Description copied from interface: ChannelConfig

Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.

Specified by:

setRecvByteBufAllocator in interface ChannelConfig

Specified by:

setRecvByteBufAllocator in interface DuplexChannelConfig

Overrides:

setRecvByteBufAllocator in class DefaultChannelConfig

setAutoRead

public NioDomainSocketChannel.NioDomainSocketChannelConfig setAutoRead(boolean autoRead)

Description copied from interface: ChannelConfig

Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all. The default value is true.

Specified by:

setAutoRead in interface ChannelConfig

Specified by:

setAutoRead in interface DuplexChannelConfig

Overrides:

setAutoRead in class DefaultChannelConfig

setAutoClose

public NioDomainSocketChannel.NioDomainSocketChannelConfig setAutoClose(boolean autoClose)

Description copied from interface: ChannelConfig

Sets whether the Channel should be closed automatically and immediately on write failure. The default is true.

Specified by:

setAutoClose in interface ChannelConfig

Specified by:

setAutoClose in interface DuplexChannelConfig

Overrides:

setAutoClose in class DefaultChannelConfig

setWriteBufferHighWaterMark

public NioDomainSocketChannel.NioDomainSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

Description copied from interface: ChannelConfig

Sets the high water mark of the write buffer. If the number of bytes queued in the write buffer exceeds this value, Channel.isWritable() will start to return false.

Specified by:

setWriteBufferHighWaterMark in interface ChannelConfig

Overrides:

setWriteBufferHighWaterMark in class DefaultChannelConfig

setWriteBufferLowWaterMark

public NioDomainSocketChannel.NioDomainSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

Description copied from interface: ChannelConfig

Sets the low water mark of the write buffer. Once the number of bytes queued in the write buffer exceeded the high water mark and then dropped down below this value, Channel.isWritable() will start to return true again.

Specified by:

setWriteBufferLowWaterMark in interface ChannelConfig

Overrides:

setWriteBufferLowWaterMark in class DefaultChannelConfig

setWriteBufferWaterMark

public NioDomainSocketChannel.NioDomainSocketChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)

Description copied from interface: ChannelConfig

Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.

Specified by:

setWriteBufferWaterMark in interface ChannelConfig

Specified by:

setWriteBufferWaterMark in interface DuplexChannelConfig

Overrides:

setWriteBufferWaterMark in class DefaultChannelConfig

setMessageSizeEstimator

public NioDomainSocketChannel.NioDomainSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

Description copied from interface: ChannelConfig

Set the MessageSizeEstimator which is used for the channel to detect the size of a message.

Specified by:

setMessageSizeEstimator in interface ChannelConfig

Specified by:

setMessageSizeEstimator in interface DuplexChannelConfig

Overrides:

setMessageSizeEstimator in class DefaultChannelConfig

autoReadCleared

protected void autoReadCleared()

Description copied from class: DefaultChannelConfig

Is called once DefaultChannelConfig.setAutoRead(boolean) is called with false and DefaultChannelConfig.isAutoRead() was true before.

Overrides:

autoReadCleared in class DefaultChannelConfig

setMaxBytesPerGatheringWrite

void setMaxBytesPerGatheringWrite(int maxBytesPerGatheringWrite)

getMaxBytesPerGatheringWrite

int getMaxBytesPerGatheringWrite()

calculateMaxBytesPerGatheringWrite

private void calculateMaxBytesPerGatheringWrite()

jdkChannel

private java.nio.channels.SocketChannel jdkChannel()