io.netty.channel.epoll

类 EpollDomainSocketChannelConfig

java.lang.Object

io.netty.channel.DefaultChannelConfig

io.netty.channel.epoll.EpollChannelConfig

io.netty.channel.epoll.EpollDomainSocketChannelConfig

所有已实现的接口:

ChannelConfig, DomainSocketChannelConfig

public final class EpollDomainSocketChannelConfig
extends EpollChannelConfig
implements DomainSocketChannelConfig

方法概要

方法

限定符和类型	方法和说明
<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.
DomainSocketReadMode	getReadMode() Return the DomainSocketReadMode for the channel.
EpollDomainSocketChannelConfig	setAllocator(ByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate buffers.
EpollDomainSocketChannelConfig	setAutoClose(boolean autoClose)
EpollDomainSocketChannelConfig	setAutoRead(boolean autoRead) Sets if ChannelHandlerContext.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 the EpollMode used.
EpollDomainSocketChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead) Sets the maximum number of messages to read per read loop.
EpollDomainSocketChannelConfig	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.
EpollDomainSocketChannelConfig	setReadMode(DomainSocketReadMode mode) Change the DomainSocketReadMode for the channel.
EpollDomainSocketChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate receive buffers.
EpollDomainSocketChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Sets the high water mark of the write buffer.
EpollDomainSocketChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Sets the low water mark of the write buffer.
EpollDomainSocketChannelConfig	setWriteSpinCount(int writeSpinCount) Sets the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.

从类继承的方法 io.netty.channel.epoll.EpollChannelConfig

autoReadCleared, getEpollMode

从类继承的方法 io.netty.channel.DefaultChannelConfig

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

从类继承的方法 java.lang.Object

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

从接口继承的方法 io.netty.channel.ChannelConfig

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

方法详细资料

getOptions

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

从接口复制的说明: ChannelConfig

Return all set ChannelOption's.

指定者:

getOptions 在接口中 ChannelConfig

覆盖:

getOptions 在类中 EpollChannelConfig

getOption

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

从接口复制的说明: ChannelConfig

Return the value of the given ChannelOption

指定者:

getOption 在接口中 ChannelConfig

覆盖:

getOption 在类中 EpollChannelConfig

setOption

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

从接口复制的说明: 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;
 }
 

指定者:

setOption 在接口中 ChannelConfig

覆盖:

setOption 在类中 EpollChannelConfig

返回:

true if and only if the property has been set

setMaxMessagesPerRead

public EpollDomainSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

从接口复制的说明: ChannelConfig

Sets the maximum number of messages to read per read loop. If this value is greater than 1, an event loop might attempt to read multiple times to procure multiple messages.

指定者:

setMaxMessagesPerRead 在接口中 ChannelConfig

指定者:

setMaxMessagesPerRead 在接口中 DomainSocketChannelConfig

覆盖:

setMaxMessagesPerRead 在类中 EpollChannelConfig

setConnectTimeoutMillis

public EpollDomainSocketChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)

从接口复制的说明: 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.

指定者:

setConnectTimeoutMillis 在接口中 ChannelConfig

指定者:

setConnectTimeoutMillis 在接口中 DomainSocketChannelConfig

覆盖:

setConnectTimeoutMillis 在类中 EpollChannelConfig

参数:

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

setWriteSpinCount

public EpollDomainSocketChannelConfig setWriteSpinCount(int writeSpinCount)

从接口复制的说明: 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.

指定者:

setWriteSpinCount 在接口中 ChannelConfig

指定者:

setWriteSpinCount 在接口中 DomainSocketChannelConfig

覆盖:

setWriteSpinCount 在类中 EpollChannelConfig

setRecvByteBufAllocator

public EpollDomainSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

从接口复制的说明: ChannelConfig

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

指定者:

setRecvByteBufAllocator 在接口中 ChannelConfig

指定者:

setRecvByteBufAllocator 在接口中 DomainSocketChannelConfig

覆盖:

setRecvByteBufAllocator 在类中 EpollChannelConfig

setAllocator

public EpollDomainSocketChannelConfig setAllocator(ByteBufAllocator allocator)

从接口复制的说明: ChannelConfig

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

指定者:

setAllocator 在接口中 ChannelConfig

指定者:

setAllocator 在接口中 DomainSocketChannelConfig

覆盖:

setAllocator 在类中 EpollChannelConfig

setAutoClose

public EpollDomainSocketChannelConfig setAutoClose(boolean autoClose)

指定者:

setAutoClose 在接口中 ChannelConfig

指定者:

setAutoClose 在接口中 DomainSocketChannelConfig

覆盖:

setAutoClose 在类中 DefaultChannelConfig

setMessageSizeEstimator

public EpollDomainSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

从接口复制的说明: ChannelConfig

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

指定者:

setMessageSizeEstimator 在接口中 ChannelConfig

指定者:

setMessageSizeEstimator 在接口中 DomainSocketChannelConfig

覆盖:

setMessageSizeEstimator 在类中 EpollChannelConfig

setWriteBufferLowWaterMark

public EpollDomainSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

从接口复制的说明: 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.

指定者:

setWriteBufferLowWaterMark 在接口中 ChannelConfig

指定者:

setWriteBufferLowWaterMark 在接口中 DomainSocketChannelConfig

覆盖:

setWriteBufferLowWaterMark 在类中 EpollChannelConfig

setWriteBufferHighWaterMark

public EpollDomainSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

从接口复制的说明: 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.

指定者:

setWriteBufferHighWaterMark 在接口中 ChannelConfig

指定者:

setWriteBufferHighWaterMark 在接口中 DomainSocketChannelConfig

覆盖:

setWriteBufferHighWaterMark 在类中 EpollChannelConfig

setAutoRead

public EpollDomainSocketChannelConfig setAutoRead(boolean autoRead)

从接口复制的说明: 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.

指定者:

setAutoRead 在接口中 ChannelConfig

指定者:

setAutoRead 在接口中 DomainSocketChannelConfig

覆盖:

setAutoRead 在类中 EpollChannelConfig

setEpollMode

public EpollDomainSocketChannelConfig setEpollMode(EpollMode mode)

从类复制的说明: EpollChannelConfig

Set the EpollMode used. Default is EpollMode.EDGE_TRIGGERED. If you want to use DefaultChannelConfig.isAutoRead() false or DefaultChannelConfig.getMaxMessagesPerRead() and have an accurate behaviour you should use EpollMode.LEVEL_TRIGGERED. Be aware this config setting can only be adjusted before the channel was registered.

覆盖:

setEpollMode 在类中 EpollChannelConfig

setReadMode

public EpollDomainSocketChannelConfig setReadMode(DomainSocketReadMode mode)

从接口复制的说明: DomainSocketChannelConfig

Change the DomainSocketReadMode for the channel. The default is DomainSocketReadMode.BYTES which means bytes will be read from the Channel and passed through the pipeline. If DomainSocketReadMode.FILE_DESCRIPTORS is used FileDescriptors will be passed through the ChannelPipeline. This setting can be modified on the fly if needed.

指定者:

setReadMode 在接口中 DomainSocketChannelConfig

getReadMode

public DomainSocketReadMode getReadMode()

从接口复制的说明: DomainSocketChannelConfig

Return the DomainSocketReadMode for the channel.

指定者:

getReadMode 在接口中 DomainSocketChannelConfig