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
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
autoReadCleared()
Is called onceDefaultChannelConfig.setAutoRead(boolean)
is called withfalse
andDefaultChannelConfig.isAutoRead()
wastrue
before.private void
calculateMaxBytesPerGatheringWrite()
(package private) int
getMaxBytesPerGatheringWrite()
<T> T
getOption(ChannelOption<T> option)
Return the value of the givenChannelOption
java.util.Map<ChannelOption<?>,java.lang.Object>
getOptions()
Return all setChannelOption
's.private int
getReceiveBufferSize()
private int
getSendBufferSize()
boolean
isAllowHalfClosure()
Returnstrue
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 theByteBufAllocator
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 theChannel
should be closed automatically and immediately on write failure.NioDomainSocketChannel.NioDomainSocketChannelConfig
setAutoRead(boolean autoRead)
Sets ifChannelHandlerContext.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 theMessageSizeEstimator
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 theRecvByteBufAllocator
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 theWriteBufferWaterMark
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 untilWritableByteChannel.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
-
-
-
-
Constructor Detail
-
NioDomainSocketChannelConfig
private NioDomainSocketChannelConfig(NioDomainSocketChannel channel, java.nio.channels.SocketChannel javaChannel)
-
-
Method Detail
-
isAllowHalfClosure
public boolean isAllowHalfClosure()
Description copied from interface:DuplexChannelConfig
Returnstrue
if and only if the channel should not close itself when its remote peer shuts down output to make the connection half-closed. Iffalse
, the connection is closed automatically when the remote peer shuts down output.- Specified by:
isAllowHalfClosure
in interfaceDuplexChannelConfig
-
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. Iftrue
the connection is not closed when the remote peer shuts down output. Instead,ChannelInboundHandler.userEventTriggered(ChannelHandlerContext, Object)
is invoked with aChannelInputShutdownEvent
object. Iffalse
, the connection is closed automatically.- Specified by:
setAllowHalfClosure
in interfaceDuplexChannelConfig
-
getOptions
public java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()
Description copied from interface:ChannelConfig
Return all setChannelOption
's.- Specified by:
getOptions
in interfaceChannelConfig
- Overrides:
getOptions
in classDefaultChannelConfig
-
getOption
public <T> T getOption(ChannelOption<T> option)
Description copied from interface:ChannelConfig
Return the value of the givenChannelOption
- Specified by:
getOption
in interfaceChannelConfig
- Overrides:
getOption
in classDefaultChannelConfig
-
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 interfaceChannelConfig
- Overrides:
setOption
in classDefaultChannelConfig
- 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 theChannel
does not support connect operation, this property is not used at all, and therefore will be ignored.- Specified by:
setConnectTimeoutMillis
in interfaceChannelConfig
- Overrides:
setConnectTimeoutMillis
in classDefaultChannelConfig
- 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 interfaceChannelConfig
- Specified by:
setMaxMessagesPerRead
in interfaceDuplexChannelConfig
- Overrides:
setMaxMessagesPerRead
in classDefaultChannelConfig
-
setWriteSpinCount
public NioDomainSocketChannel.NioDomainSocketChannelConfig setWriteSpinCount(int writeSpinCount)
Description copied from interface:ChannelConfig
Sets the maximum loop count for a write operation untilWritableByteChannel.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 is16
.- Specified by:
setWriteSpinCount
in interfaceChannelConfig
- Specified by:
setWriteSpinCount
in interfaceDuplexChannelConfig
- Overrides:
setWriteSpinCount
in classDefaultChannelConfig
-
setAllocator
public NioDomainSocketChannel.NioDomainSocketChannelConfig setAllocator(ByteBufAllocator allocator)
Description copied from interface:ChannelConfig
Set theByteBufAllocator
which is used for the channel to allocate buffers.- Specified by:
setAllocator
in interfaceChannelConfig
- Specified by:
setAllocator
in interfaceDuplexChannelConfig
- Overrides:
setAllocator
in classDefaultChannelConfig
-
setRecvByteBufAllocator
public NioDomainSocketChannel.NioDomainSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
Description copied from interface:ChannelConfig
Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.- Specified by:
setRecvByteBufAllocator
in interfaceChannelConfig
- Specified by:
setRecvByteBufAllocator
in interfaceDuplexChannelConfig
- Overrides:
setRecvByteBufAllocator
in classDefaultChannelConfig
-
setAutoRead
public NioDomainSocketChannel.NioDomainSocketChannelConfig setAutoRead(boolean autoRead)
Description copied from interface:ChannelConfig
Sets ifChannelHandlerContext.read()
will be invoked automatically so that a user application doesn't need to call it at all. The default value istrue
.- Specified by:
setAutoRead
in interfaceChannelConfig
- Specified by:
setAutoRead
in interfaceDuplexChannelConfig
- Overrides:
setAutoRead
in classDefaultChannelConfig
-
setAutoClose
public NioDomainSocketChannel.NioDomainSocketChannelConfig setAutoClose(boolean autoClose)
Description copied from interface:ChannelConfig
Sets whether theChannel
should be closed automatically and immediately on write failure. The default istrue
.- Specified by:
setAutoClose
in interfaceChannelConfig
- Specified by:
setAutoClose
in interfaceDuplexChannelConfig
- Overrides:
setAutoClose
in classDefaultChannelConfig
-
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 returnfalse
.- Specified by:
setWriteBufferHighWaterMark
in interfaceChannelConfig
- Overrides:
setWriteBufferHighWaterMark
in classDefaultChannelConfig
-
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 returntrue
again.- Specified by:
setWriteBufferLowWaterMark
in interfaceChannelConfig
- Overrides:
setWriteBufferLowWaterMark
in classDefaultChannelConfig
-
setWriteBufferWaterMark
public NioDomainSocketChannel.NioDomainSocketChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
Description copied from interface:ChannelConfig
Set theWriteBufferWaterMark
which is used for setting the high and low water mark of the write buffer.- Specified by:
setWriteBufferWaterMark
in interfaceChannelConfig
- Specified by:
setWriteBufferWaterMark
in interfaceDuplexChannelConfig
- Overrides:
setWriteBufferWaterMark
in classDefaultChannelConfig
-
setMessageSizeEstimator
public NioDomainSocketChannel.NioDomainSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
Description copied from interface:ChannelConfig
Set theMessageSizeEstimator
which is used for the channel to detect the size of a message.- Specified by:
setMessageSizeEstimator
in interfaceChannelConfig
- Specified by:
setMessageSizeEstimator
in interfaceDuplexChannelConfig
- Overrides:
setMessageSizeEstimator
in classDefaultChannelConfig
-
autoReadCleared
protected void autoReadCleared()
Description copied from class:DefaultChannelConfig
Is called onceDefaultChannelConfig.setAutoRead(boolean)
is called withfalse
andDefaultChannelConfig.isAutoRead()
wastrue
before.- Overrides:
autoReadCleared
in classDefaultChannelConfig
-
setMaxBytesPerGatheringWrite
void setMaxBytesPerGatheringWrite(int maxBytesPerGatheringWrite)
-
getMaxBytesPerGatheringWrite
int getMaxBytesPerGatheringWrite()
-
calculateMaxBytesPerGatheringWrite
private void calculateMaxBytesPerGatheringWrite()
-
jdkChannel
private java.nio.channels.SocketChannel jdkChannel()
-
-