io.netty.channel.unix

接口 DomainSocketChannelConfig

所有超级接口:

ChannelConfig

所有已知实现类:

EpollDomainSocketChannelConfig, KQueueDomainSocketChannelConfig

public interface DomainSocketChannelConfig
extends ChannelConfig

Special ChannelConfig for DomainSocketChannels.

方法概要

限定符和类型	方法和说明
DomainSocketReadMode	getReadMode() Return the DomainSocketReadMode for the channel.
DomainSocketChannelConfig	setAllocator(ByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate buffers.
DomainSocketChannelConfig	setAutoClose(boolean autoClose) Sets whether the Channel should be closed automatically and immediately on write failure.
DomainSocketChannelConfig	setAutoRead(boolean autoRead) Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
DomainSocketChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.
DomainSocketChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead) 已过时。
DomainSocketChannelConfig	setMessageSizeEstimator(MessageSizeEstimator estimator) Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
DomainSocketChannelConfig	setReadMode(DomainSocketReadMode mode) Change the DomainSocketReadMode for the channel.
DomainSocketChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
DomainSocketChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark) 已过时。
DomainSocketChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark) 已过时。
DomainSocketChannelConfig	setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark) Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
DomainSocketChannelConfig	setWriteSpinCount(int writeSpinCount) Sets the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.

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

getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOption, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOption, setOptions

方法详细资料

setMaxMessagesPerRead

@Deprecated
DomainSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

已过时。

指定者:

setMaxMessagesPerRead 在接口中 ChannelConfig

setConnectTimeoutMillis

DomainSocketChannelConfig 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

参数:

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

setWriteSpinCount

DomainSocketChannelConfig 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

setAllocator

DomainSocketChannelConfig setAllocator(ByteBufAllocator allocator)

从接口复制的说明: ChannelConfig

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

指定者:

setAllocator 在接口中 ChannelConfig

setRecvByteBufAllocator

DomainSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

从接口复制的说明: ChannelConfig

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

指定者:

setRecvByteBufAllocator 在接口中 ChannelConfig

setAutoRead

DomainSocketChannelConfig 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

setAutoClose

DomainSocketChannelConfig setAutoClose(boolean autoClose)

从接口复制的说明: ChannelConfig

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

指定者:

setAutoClose 在接口中 ChannelConfig

setWriteBufferHighWaterMark

@Deprecated
DomainSocketChannelConfig 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

setWriteBufferLowWaterMark

@Deprecated
DomainSocketChannelConfig 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

setWriteBufferWaterMark

DomainSocketChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)

从接口复制的说明: ChannelConfig

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

指定者:

setWriteBufferWaterMark 在接口中 ChannelConfig

setMessageSizeEstimator

DomainSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

从接口复制的说明: ChannelConfig

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

指定者:

setMessageSizeEstimator 在接口中 ChannelConfig

setReadMode

DomainSocketChannelConfig setReadMode(DomainSocketReadMode mode)

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.

getReadMode

DomainSocketReadMode getReadMode()

Return the DomainSocketReadMode for the channel.