io.netty.channel.kqueue

类 KQueueDomainSocketChannelConfig

java.lang.Object

io.netty.channel.DefaultChannelConfig

io.netty.channel.kqueue.KQueueChannelConfig

io.netty.channel.kqueue.KQueueDomainSocketChannelConfig

所有已实现的接口:

ChannelConfig, DuplexChannelConfig, DomainSocketChannelConfig

@UnstableApi
public final class KQueueDomainSocketChannelConfig
extends KQueueChannelConfig
implements DomainSocketChannelConfig, DuplexChannelConfig

字段概要

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

channel

方法概要

限定符和类型	方法和说明
<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.
int	getReceiveBufferSize()
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.
KQueueDomainSocketChannelConfig	setAllocator(ByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate buffers.
KQueueDomainSocketChannelConfig	setAllowHalfClosure(boolean allowHalfClosure) Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed.
KQueueDomainSocketChannelConfig	setAutoClose(boolean autoClose) Sets whether the Channel should be closed automatically and immediately on write failure.
KQueueDomainSocketChannelConfig	setAutoRead(boolean autoRead) Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
KQueueDomainSocketChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.
KQueueDomainSocketChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead) 已过时。
KQueueDomainSocketChannelConfig	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.
KQueueDomainSocketChannelConfig	setRcvAllocTransportProvidesGuess(boolean transportProvidesGuess) If this is true then the RecvByteBufAllocator.Handle#guess() will be overridden to always attempt to read as many bytes as kqueue says are available.
KQueueDomainSocketChannelConfig	setReadMode(DomainSocketReadMode mode) Change the DomainSocketReadMode for the channel.
KQueueDomainSocketChannelConfig	setReceiveBufferSize(int receiveBufferSize)
KQueueDomainSocketChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
KQueueDomainSocketChannelConfig	setSendBufferSize(int sendBufferSize)
KQueueDomainSocketChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark) 已过时。
KQueueDomainSocketChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark) 已过时。
KQueueDomainSocketChannelConfig	setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark) Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
KQueueDomainSocketChannelConfig	setWriteSpinCount(int writeSpinCount) Sets the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.

从类继承的方法 io.netty.channel.kqueue.KQueueChannelConfig

autoReadCleared, getRcvAllocTransportProvidesGuess

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

getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMaxMessagesPerWrite, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setMaxMessagesPerWrite, 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, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOptions

方法详细资料

getOptions

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

从接口复制的说明: ChannelConfig

Return all set ChannelOption's.

指定者:

getOptions 在接口中 ChannelConfig

覆盖:

getOptions 在类中 KQueueChannelConfig

getOption

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

从接口复制的说明: ChannelConfig

Return the value of the given ChannelOption

指定者:

getOption 在接口中 ChannelConfig

覆盖:

getOption 在类中 KQueueChannelConfig

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

返回:

true if and only if the property has been set

setRcvAllocTransportProvidesGuess

public KQueueDomainSocketChannelConfig setRcvAllocTransportProvidesGuess(boolean transportProvidesGuess)

从类复制的说明: KQueueChannelConfig

If this is true then the RecvByteBufAllocator.Handle#guess() will be overridden to always attempt to read as many bytes as kqueue says are available.

覆盖:

setRcvAllocTransportProvidesGuess 在类中 KQueueChannelConfig

setMaxMessagesPerRead

@Deprecated
public KQueueDomainSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

已过时。

从类复制的说明: DefaultChannelConfig

指定者:

setMaxMessagesPerRead 在接口中 ChannelConfig

指定者:

setMaxMessagesPerRead 在接口中 DuplexChannelConfig

指定者:

setMaxMessagesPerRead 在接口中 DomainSocketChannelConfig

覆盖:

setMaxMessagesPerRead 在类中 KQueueChannelConfig

setConnectTimeoutMillis

public KQueueDomainSocketChannelConfig 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 在类中 KQueueChannelConfig

参数:

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

setWriteSpinCount

public KQueueDomainSocketChannelConfig 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 在接口中 DuplexChannelConfig

指定者:

setWriteSpinCount 在接口中 DomainSocketChannelConfig

覆盖:

setWriteSpinCount 在类中 KQueueChannelConfig

setRecvByteBufAllocator

public KQueueDomainSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

从接口复制的说明: ChannelConfig

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

指定者:

setRecvByteBufAllocator 在接口中 ChannelConfig

指定者:

setRecvByteBufAllocator 在接口中 DuplexChannelConfig

指定者:

setRecvByteBufAllocator 在接口中 DomainSocketChannelConfig

覆盖:

setRecvByteBufAllocator 在类中 KQueueChannelConfig

setAllocator

public KQueueDomainSocketChannelConfig setAllocator(ByteBufAllocator allocator)

从接口复制的说明: ChannelConfig

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

指定者:

setAllocator 在接口中 ChannelConfig

指定者:

setAllocator 在接口中 DuplexChannelConfig

指定者:

setAllocator 在接口中 DomainSocketChannelConfig

覆盖:

setAllocator 在类中 KQueueChannelConfig

setAutoClose

public KQueueDomainSocketChannelConfig setAutoClose(boolean autoClose)

从接口复制的说明: ChannelConfig

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

指定者:

setAutoClose 在接口中 ChannelConfig

指定者:

setAutoClose 在接口中 DuplexChannelConfig

指定者:

setAutoClose 在接口中 DomainSocketChannelConfig

覆盖:

setAutoClose 在类中 DefaultChannelConfig

setMessageSizeEstimator

public KQueueDomainSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

从接口复制的说明: ChannelConfig

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

指定者:

setMessageSizeEstimator 在接口中 ChannelConfig

指定者:

setMessageSizeEstimator 在接口中 DuplexChannelConfig

指定者:

setMessageSizeEstimator 在接口中 DomainSocketChannelConfig

覆盖:

setMessageSizeEstimator 在类中 KQueueChannelConfig

setWriteBufferLowWaterMark

@Deprecated
public KQueueDomainSocketChannelConfig 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 在类中 KQueueChannelConfig

setWriteBufferHighWaterMark

@Deprecated
public KQueueDomainSocketChannelConfig 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 在类中 KQueueChannelConfig

setWriteBufferWaterMark

public KQueueDomainSocketChannelConfig 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 在接口中 DuplexChannelConfig

指定者:

setWriteBufferWaterMark 在接口中 DomainSocketChannelConfig

覆盖:

setWriteBufferWaterMark 在类中 KQueueChannelConfig

setAutoRead

public KQueueDomainSocketChannelConfig 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 在接口中 DuplexChannelConfig

指定者:

setAutoRead 在接口中 DomainSocketChannelConfig

覆盖:

setAutoRead 在类中 KQueueChannelConfig

setReadMode

public KQueueDomainSocketChannelConfig 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

getSendBufferSize

public int getSendBufferSize()

setSendBufferSize

public KQueueDomainSocketChannelConfig setSendBufferSize(int sendBufferSize)

getReceiveBufferSize

public int getReceiveBufferSize()

setReceiveBufferSize

public KQueueDomainSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)

isAllowHalfClosure

public boolean isAllowHalfClosure()

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

指定者:

isAllowHalfClosure 在接口中 DuplexChannelConfig

setAllowHalfClosure

public KQueueDomainSocketChannelConfig setAllowHalfClosure(boolean allowHalfClosure)

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

指定者:

setAllowHalfClosure 在接口中 DuplexChannelConfig