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, DomainSocketChannelConfig

public final class EpollDomainSocketChannelConfig
extends EpollChannelConfig
implements DomainSocketChannelConfig

Method Summary

Modifier and Type	Method and Description
<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.

Methods inherited from class io.netty.channel.epoll.EpollChannelConfig

autoReadCleared, getEpollMode

Methods inherited from class io.netty.channel.DefaultChannelConfig

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

Method Detail

getOptions

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

Description copied from interface: ChannelConfig

Return all set ChannelOption's.

Specified by:

getOptions in interface ChannelConfig

Overrides:

getOptions in class EpollChannelConfig

getOption

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

Description copied from interface: ChannelConfig

Return the value of the given ChannelOption

Specified by:

getOption in interface ChannelConfig

Overrides:

getOption in class EpollChannelConfig

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 interface ChannelConfig

Overrides:

setOption in class EpollChannelConfig

Returns:

true if and only if the property has been set

setMaxMessagesPerRead

public EpollDomainSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Description copied from interface: 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.

Specified by:

setMaxMessagesPerRead in interface ChannelConfig

Specified by:

setMaxMessagesPerRead in interface DomainSocketChannelConfig

Overrides:

setMaxMessagesPerRead in class EpollChannelConfig

setConnectTimeoutMillis

public EpollDomainSocketChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)

Description copied from interface: 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.

Specified by:

setConnectTimeoutMillis in interface ChannelConfig

Specified by:

setConnectTimeoutMillis in interface DomainSocketChannelConfig

Overrides:

setConnectTimeoutMillis in class EpollChannelConfig

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

Specified by:

setWriteSpinCount in interface ChannelConfig

Specified by:

setWriteSpinCount in interface DomainSocketChannelConfig

Overrides:

setWriteSpinCount in class EpollChannelConfig

setRecvByteBufAllocator

public EpollDomainSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

Description copied from interface: ChannelConfig

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

Specified by:

setRecvByteBufAllocator in interface ChannelConfig

Specified by:

setRecvByteBufAllocator in interface DomainSocketChannelConfig

Overrides:

setRecvByteBufAllocator in class EpollChannelConfig

setAllocator

public EpollDomainSocketChannelConfig setAllocator(ByteBufAllocator allocator)

Description copied from interface: ChannelConfig

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

Specified by:

setAllocator in interface ChannelConfig

Specified by:

setAllocator in interface DomainSocketChannelConfig

Overrides:

setAllocator in class EpollChannelConfig

setAutoClose

public EpollDomainSocketChannelConfig setAutoClose(boolean autoClose)

Specified by:

setAutoClose in interface ChannelConfig

Specified by:

setAutoClose in interface DomainSocketChannelConfig

Overrides:

setAutoClose in class DefaultChannelConfig

setMessageSizeEstimator

public EpollDomainSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

Description copied from interface: ChannelConfig

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

Specified by:

setMessageSizeEstimator in interface ChannelConfig

Specified by:

setMessageSizeEstimator in interface DomainSocketChannelConfig

Overrides:

setMessageSizeEstimator in class EpollChannelConfig

setWriteBufferLowWaterMark

public EpollDomainSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

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 return true again.

Specified by:

setWriteBufferLowWaterMark in interface ChannelConfig

Specified by:

setWriteBufferLowWaterMark in interface DomainSocketChannelConfig

Overrides:

setWriteBufferLowWaterMark in class EpollChannelConfig

setWriteBufferHighWaterMark

public EpollDomainSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

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 return false.

Specified by:

setWriteBufferHighWaterMark in interface ChannelConfig

Specified by:

setWriteBufferHighWaterMark in interface DomainSocketChannelConfig

Overrides:

setWriteBufferHighWaterMark in class EpollChannelConfig

setAutoRead

public EpollDomainSocketChannelConfig setAutoRead(boolean autoRead)

Description copied from interface: 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.

Specified by:

setAutoRead in interface ChannelConfig

Specified by:

setAutoRead in interface DomainSocketChannelConfig

Overrides:

setAutoRead in class EpollChannelConfig

setEpollMode

public EpollDomainSocketChannelConfig setEpollMode(EpollMode mode)

Description copied from class: 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.

Overrides:

setEpollMode in class EpollChannelConfig

setReadMode

public EpollDomainSocketChannelConfig setReadMode(DomainSocketReadMode mode)

Description copied from interface: 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.

Specified by:

setReadMode in interface DomainSocketChannelConfig

getReadMode

public DomainSocketReadMode getReadMode()

Description copied from interface: DomainSocketChannelConfig

Return the DomainSocketReadMode for the channel.

Specified by:

getReadMode in interface DomainSocketChannelConfig