Package io.netty.channel.epoll
Class EpollDomainSocketChannelConfig
- java.lang.Object
-
- io.netty.channel.DefaultChannelConfig
-
- io.netty.channel.epoll.EpollChannelConfig
-
- io.netty.channel.epoll.EpollDomainSocketChannelConfig
-
- All Implemented Interfaces:
ChannelConfig
,DuplexChannelConfig
,DomainSocketChannelConfig
public final class EpollDomainSocketChannelConfig extends EpollChannelConfig implements DomainSocketChannelConfig, DuplexChannelConfig
-
-
Field Summary
-
Fields inherited from class io.netty.channel.DefaultChannelConfig
channel
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description <T> T
getOption(ChannelOption<T> option)
Return the value of the givenChannelOption
java.util.Map<ChannelOption<?>,java.lang.Object>
getOptions()
Return all setChannelOption
's.DomainSocketReadMode
getReadMode()
Return theDomainSocketReadMode
for the channel.int
getReceiveBufferSize()
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.EpollDomainSocketChannelConfig
setAllocator(ByteBufAllocator allocator)
Set theByteBufAllocator
which is used for the channel to allocate buffers.EpollDomainSocketChannelConfig
setAllowHalfClosure(boolean allowHalfClosure)
Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed.EpollDomainSocketChannelConfig
setAutoClose(boolean autoClose)
Sets whether theChannel
should be closed automatically and immediately on write failure.EpollDomainSocketChannelConfig
setAutoRead(boolean autoRead)
Sets ifChannelHandlerContext.read()
will be invoked automatically so that a user application doesn't need to call it at all.EpollDomainSocketChannelConfig
setConnectTimeoutMillis(int connectTimeoutMillis)
Sets the connect timeout of the channel in milliseconds.EpollDomainSocketChannelConfig
setEpollMode(EpollMode mode)
Set theEpollMode
used.EpollDomainSocketChannelConfig
setMaxMessagesPerRead(int maxMessagesPerRead)
Deprecated.EpollDomainSocketChannelConfig
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.EpollDomainSocketChannelConfig
setReadMode(DomainSocketReadMode mode)
Change theDomainSocketReadMode
for the channel.EpollDomainSocketChannelConfig
setReceiveBufferSize(int receiveBufferSize)
EpollDomainSocketChannelConfig
setRecvByteBufAllocator(RecvByteBufAllocator allocator)
Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.EpollDomainSocketChannelConfig
setSendBufferSize(int sendBufferSize)
EpollDomainSocketChannelConfig
setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
Deprecated.EpollDomainSocketChannelConfig
setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
Deprecated.EpollDomainSocketChannelConfig
setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
Set theWriteBufferWaterMark
which is used for setting the high and low water mark of the write buffer.EpollDomainSocketChannelConfig
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.epoll.EpollChannelConfig
autoReadCleared, getEpollMode, getMaxBytesPerGatheringWrite, setMaxBytesPerGatheringWrite, socket
-
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
-
-
-
-
Method Detail
-
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 classEpollChannelConfig
-
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 classEpollChannelConfig
-
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 classEpollChannelConfig
- Returns:
true
if and only if the property has been set
-
setMaxMessagesPerRead
@Deprecated public EpollDomainSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
Deprecated.Description copied from class:DefaultChannelConfig
- Specified by:
setMaxMessagesPerRead
in interfaceChannelConfig
- Specified by:
setMaxMessagesPerRead
in interfaceDomainSocketChannelConfig
- Specified by:
setMaxMessagesPerRead
in interfaceDuplexChannelConfig
- Overrides:
setMaxMessagesPerRead
in classEpollChannelConfig
-
setConnectTimeoutMillis
public EpollDomainSocketChannelConfig 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
- Specified by:
setConnectTimeoutMillis
in interfaceDomainSocketChannelConfig
- Overrides:
setConnectTimeoutMillis
in classEpollChannelConfig
- Parameters:
connectTimeoutMillis
- the connect timeout in milliseconds.0
to disable.
-
setWriteSpinCount
public EpollDomainSocketChannelConfig 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 interfaceDomainSocketChannelConfig
- Specified by:
setWriteSpinCount
in interfaceDuplexChannelConfig
- Overrides:
setWriteSpinCount
in classEpollChannelConfig
-
setRecvByteBufAllocator
public EpollDomainSocketChannelConfig 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 interfaceDomainSocketChannelConfig
- Specified by:
setRecvByteBufAllocator
in interfaceDuplexChannelConfig
- Overrides:
setRecvByteBufAllocator
in classEpollChannelConfig
-
setAllocator
public EpollDomainSocketChannelConfig 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 interfaceDomainSocketChannelConfig
- Specified by:
setAllocator
in interfaceDuplexChannelConfig
- Overrides:
setAllocator
in classEpollChannelConfig
-
setAutoClose
public EpollDomainSocketChannelConfig 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 interfaceDomainSocketChannelConfig
- Specified by:
setAutoClose
in interfaceDuplexChannelConfig
- Overrides:
setAutoClose
in classDefaultChannelConfig
-
setMessageSizeEstimator
public EpollDomainSocketChannelConfig 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 interfaceDomainSocketChannelConfig
- Specified by:
setMessageSizeEstimator
in interfaceDuplexChannelConfig
- Overrides:
setMessageSizeEstimator
in classEpollChannelConfig
-
setWriteBufferLowWaterMark
@Deprecated public EpollDomainSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
Deprecated.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
- Specified by:
setWriteBufferLowWaterMark
in interfaceDomainSocketChannelConfig
- Overrides:
setWriteBufferLowWaterMark
in classEpollChannelConfig
-
setWriteBufferHighWaterMark
@Deprecated public EpollDomainSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
Deprecated.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
- Specified by:
setWriteBufferHighWaterMark
in interfaceDomainSocketChannelConfig
- Overrides:
setWriteBufferHighWaterMark
in classEpollChannelConfig
-
setWriteBufferWaterMark
public EpollDomainSocketChannelConfig 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 interfaceDomainSocketChannelConfig
- Specified by:
setWriteBufferWaterMark
in interfaceDuplexChannelConfig
- Overrides:
setWriteBufferWaterMark
in classEpollChannelConfig
-
setAutoRead
public EpollDomainSocketChannelConfig 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 interfaceDomainSocketChannelConfig
- Specified by:
setAutoRead
in interfaceDuplexChannelConfig
- Overrides:
setAutoRead
in classEpollChannelConfig
-
setEpollMode
public EpollDomainSocketChannelConfig setEpollMode(EpollMode mode)
Description copied from class:EpollChannelConfig
Set theEpollMode
used. Default isEpollMode.EDGE_TRIGGERED
. If you want to useDefaultChannelConfig.isAutoRead()
false
orDefaultChannelConfig.getMaxMessagesPerRead()
and have an accurate behaviour you should useEpollMode.LEVEL_TRIGGERED
. Be aware this config setting can only be adjusted before the channel was registered.- Overrides:
setEpollMode
in classEpollChannelConfig
-
setReadMode
public EpollDomainSocketChannelConfig setReadMode(DomainSocketReadMode mode)
Description copied from interface:DomainSocketChannelConfig
Change theDomainSocketReadMode
for the channel. The default isDomainSocketReadMode.BYTES
which means bytes will be read from theChannel
and passed through the pipeline. IfDomainSocketReadMode.FILE_DESCRIPTORS
is usedFileDescriptor
s will be passed through theChannelPipeline
. This setting can be modified on the fly if needed.- Specified by:
setReadMode
in interfaceDomainSocketChannelConfig
-
getReadMode
public DomainSocketReadMode getReadMode()
Description copied from interface:DomainSocketChannelConfig
Return theDomainSocketReadMode
for the channel.- Specified by:
getReadMode
in interfaceDomainSocketChannelConfig
-
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 EpollDomainSocketChannelConfig 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
-
getSendBufferSize
public int getSendBufferSize()
-
setSendBufferSize
public EpollDomainSocketChannelConfig setSendBufferSize(int sendBufferSize)
-
getReceiveBufferSize
public int getReceiveBufferSize()
-
setReceiveBufferSize
public EpollDomainSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)
-
-