public final Class EpollServerSocketChannelConfig

Overrides io.netty.channel.epoll.EpollServerChannelConfig.getOption.

Implements io.netty.channel.ChannelConfig.getOption.

Doc from io.netty.channel.ChannelConfig.getOption.

Return the value of the given ChannelOption

Annotations

@SuppressWarnings:unchecked

@Override

Overrides io.netty.channel.epoll.EpollServerChannelConfig.getOptions.

Implements io.netty.channel.ChannelConfig.getOptions.

Doc from io.netty.channel.ChannelConfig.getOptions.

Return all set ChannelOption's.

Annotations

@Override

Returns a positive value if TCP_DEFER_ACCEPT is enabled.

Returns true if IP_FREEBIND is enabled, false otherwise.

Returns true if IP_TRANSPARENT is enabled, false otherwise.

Returns true if the SO_REUSEPORT option is set.

Overrides io.netty.channel.epoll.EpollServerChannelConfig.setAllocator.

Implements io.netty.channel.socket.ServerSocketChannelConfig.setAllocator, io.netty.channel.ChannelConfig.setAllocator.

Doc from io.netty.channel.ChannelConfig.setAllocator.

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

Annotations

@Override

Overrides io.netty.channel.epoll.EpollServerChannelConfig.setAutoRead.

Implements io.netty.channel.socket.ServerSocketChannelConfig.setAutoRead, io.netty.channel.ChannelConfig.setAutoRead.

Doc from io.netty.channel.ChannelConfig.setAutoRead.

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.

Annotations

@Override

Overrides io.netty.channel.epoll.EpollServerChannelConfig.setBacklog.

Implements io.netty.channel.socket.ServerSocketChannelConfig.setBacklog.

Doc from io.netty.channel.socket.ServerSocketChannelConfig.setBacklog.

Sets the backlog value to specify when the channel binds to a local address.

Annotations

@Override

Overrides io.netty.channel.epoll.EpollServerChannelConfig.setConnectTimeoutMillis.

Implements io.netty.channel.socket.ServerSocketChannelConfig.setConnectTimeoutMillis, io.netty.channel.ChannelConfig.setConnectTimeoutMillis.

Doc from io.netty.channel.ChannelConfig.setConnectTimeoutMillis.

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.

Parameters

connectTimeoutMillis:int

the connect timeout in milliseconds. 0 to disable.

Annotations

@Override

If true is used IP_FREEBIND is enabled, false for disable it. Default is disabled.

If true is used IP_TRANSPARENT is enabled, false for disable it. Default is disabled.

Overrides io.netty.channel.epoll.EpollServerChannelConfig.setMaxMessagesPerRead.

Implements io.netty.channel.socket.ServerSocketChannelConfig.setMaxMessagesPerRead, io.netty.channel.ChannelConfig.setMaxMessagesPerRead.

Doc from io.netty.channel.DefaultChannelConfig.setMaxMessagesPerRead.

Annotations

@Override

@Deprecated

Overrides io.netty.channel.epoll.EpollServerChannelConfig.setMessageSizeEstimator.

Implements io.netty.channel.socket.ServerSocketChannelConfig.setMessageSizeEstimator, io.netty.channel.ChannelConfig.setMessageSizeEstimator.

Doc from io.netty.channel.ChannelConfig.setMessageSizeEstimator.

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

Annotations

@Override

Overrides io.netty.channel.epoll.EpollServerChannelConfig.setOption.

Implements io.netty.channel.ChannelConfig.setOption.

Doc from io.netty.channel.ChannelConfig.setOption.

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;
}

Returns:boolean

true if and only if the property has been set

Annotations

@Override

Overrides io.netty.channel.epoll.EpollServerChannelConfig.setPerformancePreferences.

Implements io.netty.channel.socket.ServerSocketChannelConfig.setPerformancePreferences.

Doc from io.netty.channel.socket.ServerSocketChannelConfig.setPerformancePreferences.

Sets the performance preferences as specified in ServerSocket#setPerformancePreferences(int, int, int).

Annotations

@Override

Overrides io.netty.channel.epoll.EpollServerChannelConfig.setReceiveBufferSize.

Implements io.netty.channel.socket.ServerSocketChannelConfig.setReceiveBufferSize.

Doc from io.netty.channel.socket.ServerSocketChannelConfig.setReceiveBufferSize.

Gets the StandardSocketOptions#SO_SNDBUF option.

Annotations

@Override

Overrides io.netty.channel.epoll.EpollServerChannelConfig.setRecvByteBufAllocator.

Implements io.netty.channel.socket.ServerSocketChannelConfig.setRecvByteBufAllocator, io.netty.channel.ChannelConfig.setRecvByteBufAllocator.

Doc from io.netty.channel.ChannelConfig.setRecvByteBufAllocator.

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

Annotations

@Override

Overrides io.netty.channel.epoll.EpollServerChannelConfig.setReuseAddress.

Implements io.netty.channel.socket.ServerSocketChannelConfig.setReuseAddress.

Doc from io.netty.channel.socket.ServerSocketChannelConfig.setReuseAddress.

Sets the StandardSocketOptions#SO_REUSEADDR option.

Annotations

@Override

Set the SO_REUSEPORT option on the underlying Channel. This will allow to bind multiple EpollSocketChannels to the same port and so accept connections with multiple threads. Be aware this method needs be called before EpollSocketChannel#bind(java.net.SocketAddress) to have any affect.

Set the TCP_DEFER_ACCEPT option on the socket. See man 7 tcp for more details.

Set the TCP_MD5SIG option on the socket. See linux/tcp.h for more details. Keys can only be set on, not read to prevent a potential leak, as they are confidential. Allowing them being read would mean anyone with access to the channel could get them.

Overrides io.netty.channel.epoll.EpollServerChannelConfig.setWriteBufferHighWaterMark.

Implements io.netty.channel.socket.ServerSocketChannelConfig.setWriteBufferHighWaterMark, io.netty.channel.ChannelConfig.setWriteBufferHighWaterMark.

Doc from io.netty.channel.ChannelConfig.setWriteBufferHighWaterMark.

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.

Annotations

@Override

@Deprecated

Overrides io.netty.channel.epoll.EpollServerChannelConfig.setWriteBufferLowWaterMark.

Implements io.netty.channel.socket.ServerSocketChannelConfig.setWriteBufferLowWaterMark, io.netty.channel.ChannelConfig.setWriteBufferLowWaterMark.

Doc from io.netty.channel.ChannelConfig.setWriteBufferLowWaterMark.

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.

Annotations

@Override

@Deprecated

Overrides io.netty.channel.epoll.EpollServerChannelConfig.setWriteBufferWaterMark.

Implements io.netty.channel.socket.ServerSocketChannelConfig.setWriteBufferWaterMark, io.netty.channel.ChannelConfig.setWriteBufferWaterMark.

Doc from io.netty.channel.ChannelConfig.setWriteBufferWaterMark.

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

Annotations

@Override

Overrides io.netty.channel.epoll.EpollServerChannelConfig.setWriteSpinCount.

Implements io.netty.channel.socket.ServerSocketChannelConfig.setWriteSpinCount, io.netty.channel.ChannelConfig.setWriteSpinCount.

Doc from io.netty.channel.ChannelConfig.setWriteSpinCount.

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.

Annotations

@Override