Netty/Transport 4.1.107.Final · io.netty.channel.socket.oio.OioServerSocketChannelConfig

Name	Associated setter method
`ChannelOption#SO_TIMEOUT`	`setSoTimeout(int)`

Modifier and Type	Method and Description
public int	getSoTimeout() Returns the maximal time a operation on the underlying socket may block.
public OioServerSocketChannelConfig	setAllocator(ByteBufAllocator allocator) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.setAllocator. Deprecated as a consequence of `OioServerSocketChannelConfig` being deprecated. Set the `ByteBufAllocator` which is used for the channel to allocate buffers.
public OioServerSocketChannelConfig	setAutoClose(boolean autoClose) Redeclares 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	setAutoRead(boolean autoRead) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.setAutoRead. Deprecated as a consequence of `OioServerSocketChannelConfig` being deprecated. Sets if `ChannelHandlerContext#read()` will be invoked automatically so that a user application doesn't need to call it at all.
public OioServerSocketChannelConfig	setBacklog(int backlog) Redeclares 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	setConnectTimeoutMillis(int the connect timeout in milliseconds. `0` to disable. connectTimeoutMillis) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.setConnectTimeoutMillis. Deprecated as a consequence of `OioServerSocketChannelConfig` being deprecated. Sets the connect timeout of the channel in milliseconds.
public OioServerSocketChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.setMaxMessagesPerRead. Deprecated
public OioServerSocketChannelConfig	setMessageSizeEstimator(MessageSizeEstimator estimator) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.setMessageSizeEstimator. Deprecated as a consequence of `OioServerSocketChannelConfig` being deprecated. Set the `MessageSizeEstimator` which is used for the channel to detect the size of a message.
public OioServerSocketChannelConfig	setPerformancePreferences(int connectionTime, int latency, int bandwidth) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.setPerformancePreferences. Deprecated as a consequence of `OioServerSocketChannelConfig` being deprecated. Sets the performance preferences as specified in `ServerSocket#setPerformancePreferences(int, int, int)`.
public OioServerSocketChannelConfig	setReceiveBufferSize(int receiveBufferSize) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.setReceiveBufferSize. Deprecated as a consequence of `OioServerSocketChannelConfig` being deprecated. Gets the `StandardSocketOptions#SO_SNDBUF` option.
public OioServerSocketChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.setRecvByteBufAllocator. Deprecated as a consequence of `OioServerSocketChannelConfig` being deprecated. Set the `RecvByteBufAllocator` which is used for the channel to allocate receive buffers.
public OioServerSocketChannelConfig	setReuseAddress(boolean reuseAddress) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.setReuseAddress. Deprecated as a consequence of `OioServerSocketChannelConfig` being deprecated. Sets the `StandardSocketOptions#SO_REUSEADDR` option.
public OioServerSocketChannelConfig	setSoTimeout(int timeout) Deprecated as a consequence of `OioServerSocketChannelConfig` being deprecated. Sets the maximal time a operation on the underlying socket may block.
public OioServerSocketChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.setWriteBufferHighWaterMark. Deprecated as a consequence of `OioServerSocketChannelConfig` being deprecated. Sets the high water mark of the write buffer.
public OioServerSocketChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.setWriteBufferLowWaterMark. Deprecated as a consequence of `OioServerSocketChannelConfig` being deprecated. Sets the low water mark of the write buffer.
public OioServerSocketChannelConfig	setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.setWriteBufferWaterMark. Deprecated as a consequence of `OioServerSocketChannelConfig` being deprecated. Set the `WriteBufferWaterMark` which is used for setting the high and low water mark of the write buffer.
public OioServerSocketChannelConfig	setWriteSpinCount(int writeSpinCount) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.setWriteSpinCount. Deprecated as a consequence of `OioServerSocketChannelConfig` being deprecated. Sets the maximum loop count for a write operation until `WritableByteChannel#write(ByteBuffer)` returns a non-zero value.

Method Detail

getSoTimeout	back to summary
public int getSoTimeout() Returns the maximal time a operation on the underlying socket may block.

setAllocator back to summary

setAllocator	back to summary
public OioServerSocketChannelConfig setAllocator(ByteBufAllocator allocator) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.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

public OioServerSocketChannelConfig setAllocator(ByteBufAllocator allocator)

Redeclares io.netty.channel.socket.ServerSocketChannelConfig.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

setAutoClose back to summary

setAutoClose	back to summary
public OioServerSocketChannelConfig setAutoClose(boolean autoClose) Redeclares 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

public OioServerSocketChannelConfig setAutoClose(boolean autoClose)

Redeclares 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

setAutoRead back to summary

setAutoRead	back to summary
public OioServerSocketChannelConfig setAutoRead(boolean autoRead) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.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

public OioServerSocketChannelConfig setAutoRead(boolean autoRead)

Redeclares io.netty.channel.socket.ServerSocketChannelConfig.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

setBacklog back to summary

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

public OioServerSocketChannelConfig setBacklog(int backlog)

Redeclares 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

setConnectTimeoutMillis back to summary

setConnectTimeoutMillis	back to summary
public OioServerSocketChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.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

public OioServerSocketChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)

Redeclares io.netty.channel.socket.ServerSocketChannelConfig.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

setMaxMessagesPerRead	back to summary
public OioServerSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.setMaxMessagesPerRead. Deprecated Annotations @Override @Deprecated

setMaxMessagesPerRead

back to summary

public OioServerSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Redeclares io.netty.channel.socket.ServerSocketChannelConfig.setMaxMessagesPerRead.

Deprecated

Annotations

@Override
@Deprecated

setMessageSizeEstimator back to summary

setMessageSizeEstimator	back to summary
public OioServerSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.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

public OioServerSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

Redeclares io.netty.channel.socket.ServerSocketChannelConfig.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

setPerformancePreferences back to summary

setPerformancePreferences	back to summary
public OioServerSocketChannelConfig setPerformancePreferences(int connectionTime, int latency, int bandwidth) Redeclares 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

public OioServerSocketChannelConfig setPerformancePreferences(int connectionTime, int latency, int bandwidth)

Redeclares 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

setReceiveBufferSize back to summary

setReceiveBufferSize	back to summary
public OioServerSocketChannelConfig setReceiveBufferSize(int receiveBufferSize) Redeclares 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

public OioServerSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)

Redeclares 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

setRecvByteBufAllocator back to summary

setRecvByteBufAllocator	back to summary
public OioServerSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.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

public OioServerSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

Redeclares io.netty.channel.socket.ServerSocketChannelConfig.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

setReuseAddress back to summary

setReuseAddress	back to summary
public OioServerSocketChannelConfig setReuseAddress(boolean reuseAddress) Redeclares 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

public OioServerSocketChannelConfig setReuseAddress(boolean reuseAddress)

Redeclares 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

setSoTimeout	back to summary
public OioServerSocketChannelConfig setSoTimeout(int timeout) 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.

setWriteBufferHighWaterMark back to summary

setWriteBufferHighWaterMark	back to summary
public OioServerSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.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

public OioServerSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

Redeclares io.netty.channel.socket.ServerSocketChannelConfig.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

setWriteBufferLowWaterMark back to summary

setWriteBufferLowWaterMark	back to summary
public OioServerSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.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

public OioServerSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

Redeclares io.netty.channel.socket.ServerSocketChannelConfig.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

setWriteBufferWaterMark back to summary

setWriteBufferWaterMark	back to summary
public OioServerSocketChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.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

public OioServerSocketChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)

Redeclares io.netty.channel.socket.ServerSocketChannelConfig.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

setWriteSpinCount back to summary

setWriteSpinCount	back to summary
public OioServerSocketChannelConfig setWriteSpinCount(int writeSpinCount) Redeclares io.netty.channel.socket.ServerSocketChannelConfig.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

public OioServerSocketChannelConfig setWriteSpinCount(int writeSpinCount)

Redeclares io.netty.channel.socket.ServerSocketChannelConfig.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

public Interface OioServerSocketChannelConfig

Available options

Method Summary

Method Detail