Class EpollChannelConfig

java.lang.Object

io.netty.channel.DefaultChannelConfig

io.netty.channel.epoll.EpollChannelConfig

All Implemented Interfaces:

ChannelConfig

Direct Known Subclasses:

EpollDatagramChannelConfig, EpollDomainDatagramChannelConfig, EpollDomainSocketChannelConfig, EpollServerChannelConfig, EpollSocketChannelConfig

public class EpollChannelConfig
extends DefaultChannelConfig

Field Summary

Fields inherited from class DefaultChannelConfig

channel

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EpollChannelConfig(Channel channel)
protected	EpollChannelConfig(Channel channel, RecvByteBufAllocator recvByteBufAllocator)

Method Summary

Modifier and Type	Method	Description
protected final void	autoReadCleared()	Is called once DefaultChannelConfig.setAutoRead(boolean) is called with false and DefaultChannelConfig.isAutoRead() was true before.
EpollMode	getEpollMode()	Deprecated. Netty always uses level-triggered mode and so this method is just a no-op.
protected final long	getMaxBytesPerGatheringWrite()
<T> T	getOption(ChannelOption<T> option)	Return the value of the given ChannelOption
Map<ChannelOption<?>, 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)	Deprecated. Netty always uses level-triggered mode and so this method is just a no-op.
protected final void	setMaxBytesPerGatheringWrite(long maxBytesPerGatheringWrite)
EpollChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead)	Deprecated.
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)	Deprecated.
EpollChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark)	Deprecated.
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()

Methods inherited from class DefaultChannelConfig

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

Methods inherited from class Object

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

Constructor Details

EpollChannelConfig

protected EpollChannelConfig(Channel channel)

EpollChannelConfig

protected EpollChannelConfig(Channel channel,
 RecvByteBufAllocator recvByteBufAllocator)

Method Details

socket

protected LinuxSocket socket()

getOptions

public Map<ChannelOption<?>, Object> getOptions()

Description copied from interface: ChannelConfig

Return all set ChannelOption's.

Specified by:

getOptions in interface ChannelConfig

Overrides:

getOptions in class DefaultChannelConfig

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 DefaultChannelConfig

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 DefaultChannelConfig

Returns:

true if and only if the property has been set

setConnectTimeoutMillis

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

Overrides:

setConnectTimeoutMillis in class DefaultChannelConfig

Parameters:

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

setMaxMessagesPerRead

@Deprecated
public EpollChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Deprecated.

Description copied from class: DefaultChannelConfig

Specified by:

setMaxMessagesPerRead in interface ChannelConfig

Overrides:

setMaxMessagesPerRead in class DefaultChannelConfig

setWriteSpinCount

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

Overrides:

setWriteSpinCount in class DefaultChannelConfig

setAllocator

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

Overrides:

setAllocator in class DefaultChannelConfig

setRecvByteBufAllocator

public EpollChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

Description copied from interface: ChannelConfig

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

Specified by:

setRecvByteBufAllocator in interface ChannelConfig

Overrides:

setRecvByteBufAllocator in class DefaultChannelConfig

setAutoRead

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

Overrides:

setAutoRead in class DefaultChannelConfig

setWriteBufferHighWaterMark

@Deprecated
public EpollChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

Deprecated.

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

Overrides:

setWriteBufferHighWaterMark in class DefaultChannelConfig

setWriteBufferLowWaterMark

@Deprecated
public EpollChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

Deprecated.

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

Overrides:

setWriteBufferLowWaterMark in class DefaultChannelConfig

setWriteBufferWaterMark

public EpollChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)

Description copied from interface: ChannelConfig

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

Specified by:

setWriteBufferWaterMark in interface ChannelConfig

Overrides:

setWriteBufferWaterMark in class DefaultChannelConfig

setMessageSizeEstimator

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

Overrides:

setMessageSizeEstimator in class DefaultChannelConfig

getEpollMode

@Deprecated
public EpollMode getEpollMode()

Deprecated.

Netty always uses level-triggered mode and so this method is just a no-op.

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

@Deprecated
public EpollChannelConfig setEpollMode(EpollMode mode)

Deprecated.

Netty always uses level-triggered mode and so this method is just a no-op.

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()

Description copied from class: DefaultChannelConfig

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

Overrides:

autoReadCleared in class DefaultChannelConfig

setMaxBytesPerGatheringWrite

protected final void setMaxBytesPerGatheringWrite(long maxBytesPerGatheringWrite)

getMaxBytesPerGatheringWrite

protected final long getMaxBytesPerGatheringWrite()