Top Description Fields Constructors Methods
io.netty.channel.socket.oio

public Class DefaultOioServerSocketChannelConfig

extends DefaultServerSocketChannelConfig
implements OioServerSocketChannelConfig
Class Inheritance
All Implemented Interfaces
io.netty.channel.socket.oio.OioServerSocketChannelConfig, io.netty.channel.socket.ServerSocketChannelConfig, io.netty.channel.ChannelConfig
Annotations
@Deprecated
Imports
io.netty.buffer.ByteBufAllocator, io.netty.channel.ChannelException, .ChannelOption, .MessageSizeEstimator, .PreferHeapByteBufAllocator, .RecvByteBufAllocator, .WriteBufferWaterMark, io.netty.channel.socket.DefaultServerSocketChannelConfig, .ServerSocketChannel, java.io.IOException, java.net.ServerSocket, java.util.Map

Deprecated

use NIO / EPOLL / KQUEUE transport.

Default OioServerSocketChannelConfig implementation

Field Summary

Inherited from io.netty.channel.socket.DefaultServerSocketChannelConfig:
javaSocket

Constructor Summary

AccessConstructor and Description
public
pack-priv
DefaultOioServerSocketChannelConfig(OioServerSocketChannel channel, ServerSocket javaSocket)

Deprecated as a consequence of OioServerSocketChannel being deprecated.

Method Summary

Modifier and TypeMethod and Description
protected void
autoReadCleared()

Overrides io.netty.channel.DefaultChannelConfig.autoReadCleared.

Is called once setAutoRead(boolean) is called with false and isAutoRead() was true before.
public <T> T
public Map<ChannelOption<?>, Object>
public int
getSoTimeout()

Implements io.netty.channel.socket.oio.OioServerSocketChannelConfig.getSoTimeout.

Returns the maximal time a operation on the underlying socket may block.
public OioServerSocketChannelConfig
public OioServerSocketChannelConfig
setAutoClose(boolean autoClose)

Overrides io.netty.channel.DefaultChannelConfig.setAutoClose.

Implements io.netty.channel.socket.oio.OioServerSocketChannelConfig.setAutoClose, io.netty.channel.ChannelConfig.setAutoClose.

Deprecated as a consequence of OioServerSocketChannelConfig being deprecated.
Sets whether the Channel should be closed automatically and immediately on write failure.
public OioServerSocketChannelConfig
public OioServerSocketChannelConfig
setBacklog(int backlog)

Overrides io.netty.channel.socket.DefaultServerSocketChannelConfig.setBacklog.

Implements io.netty.channel.socket.oio.OioServerSocketChannelConfig.setBacklog, io.netty.channel.socket.ServerSocketChannelConfig.setBacklog.

Deprecated as a consequence of OioServerSocketChannelConfig being deprecated.
Sets the backlog value to specify when the channel binds to a local address.
public OioServerSocketChannelConfig
public OioServerSocketChannelConfig
public OioServerSocketChannelConfig
public <T> boolean
setOption(ChannelOption<T> option, T value)

Overrides io.netty.channel.socket.DefaultServerSocketChannelConfig.setOption.

Implements io.netty.channel.ChannelConfig.setOption.

Sets a configuration property with the specified name and value.
public OioServerSocketChannelConfig
public OioServerSocketChannelConfig
public OioServerSocketChannelConfig
public OioServerSocketChannelConfig
public OioServerSocketChannelConfig
setSoTimeout(int timeout)

Implements io.netty.channel.socket.oio.OioServerSocketChannelConfig.setSoTimeout.

Deprecated as a consequence of OioServerSocketChannelConfig being deprecated.
Sets the maximal time a operation on the underlying socket may block.
public OioServerSocketChannelConfig
public OioServerSocketChannelConfig
public OioServerSocketChannelConfig
public OioServerSocketChannelConfig
Inherited from io.netty.channel.socket.DefaultServerSocketChannelConfig:
getBackloggetReceiveBufferSizeisReuseAddress

Constructor Detail

DefaultOioServerSocketChannelConfigback to summary
public DefaultOioServerSocketChannelConfig(ServerSocketChannel channel, ServerSocket javaSocket)

Deprecated

Annotations
@Deprecated
DefaultOioServerSocketChannelConfigback to summary
pack-priv DefaultOioServerSocketChannelConfig(OioServerSocketChannel channel, ServerSocket javaSocket)

Deprecated

as a consequence of OioServerSocketChannel being deprecated. See corresponding docs for further information.

Method Detail

autoReadClearedback to summary
protected void autoReadCleared()

Overrides io.netty.channel.DefaultChannelConfig.autoReadCleared.

Doc from io.netty.channel.DefaultChannelConfig.autoReadCleared.

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

Annotations
@Override
getOptionback to summary
public <T> T getOption(ChannelOption<T> option)

Overrides io.netty.channel.socket.DefaultServerSocketChannelConfig.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
getOptionsback to summary
public Map<ChannelOption<?>, Object> getOptions()

Overrides io.netty.channel.socket.DefaultServerSocketChannelConfig.getOptions.

Implements io.netty.channel.ChannelConfig.getOptions.

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

Return all set ChannelOption's.

Annotations
@Override
getSoTimeoutback to summary
public int getSoTimeout()

Implements io.netty.channel.socket.oio.OioServerSocketChannelConfig.getSoTimeout.

Doc from io.netty.channel.socket.oio.OioServerSocketChannelConfig.getSoTimeout.

Returns the maximal time a operation on the underlying socket may block.

Annotations
@Override
setAllocatorback to summary
public OioServerSocketChannelConfig setAllocator(ByteBufAllocator allocator)

Overrides io.netty.channel.socket.DefaultServerSocketChannelConfig.setAllocator.

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

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

Deprecated

as a consequence of OioServerSocketChannelConfig being deprecated. See corresponding docs for further information.

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

Annotations
@Override
setAutoCloseback to summary
public OioServerSocketChannelConfig setAutoClose(boolean autoClose)

Overrides io.netty.channel.DefaultChannelConfig.setAutoClose.

Implements io.netty.channel.socket.oio.OioServerSocketChannelConfig.setAutoClose, io.netty.channel.ChannelConfig.setAutoClose.

Doc from io.netty.channel.ChannelConfig.setAutoClose.

Deprecated

as a consequence of OioServerSocketChannelConfig being deprecated. See corresponding docs for further information.

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

Annotations
@Override
setAutoReadback to summary
public OioServerSocketChannelConfig setAutoRead(boolean autoRead)

Overrides io.netty.channel.socket.DefaultServerSocketChannelConfig.setAutoRead.

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

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

Deprecated

as a consequence of OioServerSocketChannelConfig being deprecated. See corresponding docs for further information.

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
setBacklogback to summary
public OioServerSocketChannelConfig setBacklog(int backlog)

Overrides io.netty.channel.socket.DefaultServerSocketChannelConfig.setBacklog.

Implements io.netty.channel.socket.oio.OioServerSocketChannelConfig.setBacklog, io.netty.channel.socket.ServerSocketChannelConfig.setBacklog.

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

Deprecated

as a consequence of OioServerSocketChannelConfig being deprecated. See corresponding docs for further information.

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

Annotations
@Override
setConnectTimeoutMillisback to summary
public OioServerSocketChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)

Overrides io.netty.channel.socket.DefaultServerSocketChannelConfig.setConnectTimeoutMillis.

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

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

Deprecated

as a consequence of OioServerSocketChannelConfig being deprecated. See corresponding docs for further information.

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
setMaxMessagesPerReadback to summary
public OioServerSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Overrides io.netty.channel.socket.DefaultServerSocketChannelConfig.setMaxMessagesPerRead.

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

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

Deprecated

Annotations
@Override
@Deprecated
setMessageSizeEstimatorback to summary
public OioServerSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

Overrides io.netty.channel.socket.DefaultServerSocketChannelConfig.setMessageSizeEstimator.

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

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

Deprecated

as a consequence of OioServerSocketChannelConfig being deprecated. See corresponding docs for further information.

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

Annotations
@Override
setOptionback to summary
public <T> boolean setOption(ChannelOption<T> option, T value)

Overrides io.netty.channel.socket.DefaultServerSocketChannelConfig.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
setPerformancePreferencesback to summary
public OioServerSocketChannelConfig setPerformancePreferences(int connectionTime, int latency, int bandwidth)

Overrides io.netty.channel.socket.DefaultServerSocketChannelConfig.setPerformancePreferences.

Implements io.netty.channel.socket.oio.OioServerSocketChannelConfig.setPerformancePreferences, io.netty.channel.socket.ServerSocketChannelConfig.setPerformancePreferences.

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

Deprecated

as a consequence of OioServerSocketChannelConfig being deprecated. See corresponding docs for further information.

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

Annotations
@Override
setReceiveBufferSizeback to summary
public OioServerSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)

Overrides io.netty.channel.socket.DefaultServerSocketChannelConfig.setReceiveBufferSize.

Implements io.netty.channel.socket.oio.OioServerSocketChannelConfig.setReceiveBufferSize, io.netty.channel.socket.ServerSocketChannelConfig.setReceiveBufferSize.

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

Deprecated

as a consequence of OioServerSocketChannelConfig being deprecated. See corresponding docs for further information.

Gets the StandardSocketOptions#SO_SNDBUF option.

Annotations
@Override
setRecvByteBufAllocatorback to summary
public OioServerSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

Overrides io.netty.channel.socket.DefaultServerSocketChannelConfig.setRecvByteBufAllocator.

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

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

Deprecated

as a consequence of OioServerSocketChannelConfig being deprecated. See corresponding docs for further information.

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

Annotations
@Override
setReuseAddressback to summary
public OioServerSocketChannelConfig setReuseAddress(boolean reuseAddress)

Overrides io.netty.channel.socket.DefaultServerSocketChannelConfig.setReuseAddress.

Implements io.netty.channel.socket.oio.OioServerSocketChannelConfig.setReuseAddress, io.netty.channel.socket.ServerSocketChannelConfig.setReuseAddress.

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

Deprecated

as a consequence of OioServerSocketChannelConfig being deprecated. See corresponding docs for further information.

Sets the StandardSocketOptions#SO_REUSEADDR option.

Annotations
@Override
setSoTimeoutback to summary
public OioServerSocketChannelConfig setSoTimeout(int timeout)

Implements io.netty.channel.socket.oio.OioServerSocketChannelConfig.setSoTimeout.

Doc from io.netty.channel.socket.oio.OioServerSocketChannelConfig.setSoTimeout.

Deprecated

as a consequence of OioServerSocketChannelConfig being deprecated. See corresponding docs for further information.

Sets the maximal time a operation on the underlying socket may block.

Annotations
@Override
setWriteBufferHighWaterMarkback to summary
public OioServerSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

Overrides io.netty.channel.socket.DefaultServerSocketChannelConfig.setWriteBufferHighWaterMark.

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

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

Deprecated

as a consequence of OioServerSocketChannelConfig being deprecated. See corresponding docs for further information.

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
setWriteBufferLowWaterMarkback to summary
public OioServerSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

Overrides io.netty.channel.socket.DefaultServerSocketChannelConfig.setWriteBufferLowWaterMark.

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

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

Deprecated

as a consequence of OioServerSocketChannelConfig being deprecated. See corresponding docs for further information.

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
setWriteBufferWaterMarkback to summary
public OioServerSocketChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)

Overrides io.netty.channel.socket.DefaultServerSocketChannelConfig.setWriteBufferWaterMark.

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

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

Deprecated

as a consequence of OioServerSocketChannelConfig being deprecated. See corresponding docs for further information.

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

Annotations
@Override
setWriteSpinCountback to summary
public OioServerSocketChannelConfig setWriteSpinCount(int writeSpinCount)

Overrides io.netty.channel.socket.DefaultServerSocketChannelConfig.setWriteSpinCount.

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

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

Deprecated

as a consequence of OioServerSocketChannelConfig being deprecated. See corresponding docs for further information.

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