io.netty.channel.epoll

类 EpollChannelConfig

java.lang.Object

io.netty.channel.DefaultChannelConfig

io.netty.channel.epoll.EpollChannelConfig

所有已实现的接口:

ChannelConfig

直接已知子类:

EpollDatagramChannelConfig, EpollDomainDatagramChannelConfig, EpollDomainSocketChannelConfig, EpollServerChannelConfig, EpollSocketChannelConfig

public class EpollChannelConfig
extends DefaultChannelConfig

字段概要

从类继承的字段 io.netty.channel.DefaultChannelConfig

channel

构造器概要

构造器

限定符	构造器和说明
protected	EpollChannelConfig(Channel channel)
protected	EpollChannelConfig(Channel channel, RecvByteBufAllocator recvByteBufAllocator)

方法概要

限定符和类型	方法和说明
protected void	autoReadCleared() Is called once DefaultChannelConfig.setAutoRead(boolean) is called with false and DefaultChannelConfig.isAutoRead() was true before.
EpollMode	getEpollMode() Return the EpollMode used.
protected long	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.
EpollChannelConfig	setAllocator(ByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate buffers.
EpollChannelConfig	setAutoRead(boolean autoRead) Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
EpollChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.
EpollChannelConfig	setEpollMode(EpollMode mode) Set the EpollMode used.
protected void	setMaxBytesPerGatheringWrite(long maxBytesPerGatheringWrite)
EpollChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead) 已过时。
EpollChannelConfig	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.
EpollChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
EpollChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark) 已过时。
EpollChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark) 已过时。
EpollChannelConfig	setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark) Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
EpollChannelConfig	setWriteSpinCount(int writeSpinCount) Sets the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.
protected LinuxSocket	socket()

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

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

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

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

构造器详细资料

EpollChannelConfig

protected EpollChannelConfig(Channel channel)

EpollChannelConfig

protected EpollChannelConfig(Channel channel,
                             RecvByteBufAllocator recvByteBufAllocator)

方法详细资料

socket

protected LinuxSocket socket()

getOptions

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

从接口复制的说明: ChannelConfig

Return all set ChannelOption's.

指定者:

getOptions 在接口中 ChannelConfig

覆盖:

getOptions 在类中 DefaultChannelConfig

getOption

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

从接口复制的说明: ChannelConfig

Return the value of the given ChannelOption

指定者:

getOption 在接口中 ChannelConfig

覆盖:

getOption 在类中 DefaultChannelConfig

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 在类中 DefaultChannelConfig

返回:

true if and only if the property has been set

setConnectTimeoutMillis

public EpollChannelConfig 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 在类中 DefaultChannelConfig

参数:

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

setMaxMessagesPerRead

@Deprecated
public EpollChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

已过时。

从类复制的说明: DefaultChannelConfig

指定者:

setMaxMessagesPerRead 在接口中 ChannelConfig

覆盖:

setMaxMessagesPerRead 在类中 DefaultChannelConfig

setWriteSpinCount

public EpollChannelConfig 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 在类中 DefaultChannelConfig

setAllocator

public EpollChannelConfig setAllocator(ByteBufAllocator allocator)

从接口复制的说明: ChannelConfig

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

指定者:

setAllocator 在接口中 ChannelConfig

覆盖:

setAllocator 在类中 DefaultChannelConfig

setRecvByteBufAllocator

public EpollChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

从接口复制的说明: ChannelConfig

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

指定者:

setRecvByteBufAllocator 在接口中 ChannelConfig

覆盖:

setRecvByteBufAllocator 在类中 DefaultChannelConfig

setAutoRead

public EpollChannelConfig 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 在类中 DefaultChannelConfig

setWriteBufferHighWaterMark

@Deprecated
public EpollChannelConfig 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 在类中 DefaultChannelConfig

setWriteBufferLowWaterMark

@Deprecated
public EpollChannelConfig 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 在类中 DefaultChannelConfig

setWriteBufferWaterMark

public EpollChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)

从接口复制的说明: ChannelConfig

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

指定者:

setWriteBufferWaterMark 在接口中 ChannelConfig

覆盖:

setWriteBufferWaterMark 在类中 DefaultChannelConfig

setMessageSizeEstimator

public EpollChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

从接口复制的说明: ChannelConfig

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

指定者:

setMessageSizeEstimator 在接口中 ChannelConfig

覆盖:

setMessageSizeEstimator 在类中 DefaultChannelConfig

getEpollMode

public EpollMode getEpollMode()

Return 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.

setEpollMode

public EpollChannelConfig setEpollMode(EpollMode mode)

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.

autoReadCleared

protected final void autoReadCleared()

从类复制的说明: DefaultChannelConfig

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

覆盖:

autoReadCleared 在类中 DefaultChannelConfig

setMaxBytesPerGatheringWrite

protected final void setMaxBytesPerGatheringWrite(long maxBytesPerGatheringWrite)

getMaxBytesPerGatheringWrite

protected final long getMaxBytesPerGatheringWrite()