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

public Class DefaultOioSocketChannelConfig

extends DefaultSocketChannelConfig
implements OioSocketChannelConfig
Class Inheritance
All Implemented Interfaces
io.netty.channel.socket.oio.OioSocketChannelConfig, io.netty.channel.socket.SocketChannelConfig, io.netty.channel.socket.DuplexChannelConfig, io.netty.channel.ChannelConfig
Annotations
@Deprecated
Imports
io.netty.buffer.ByteBufAllocator, io.netty.channel.ChannelException, .ChannelOption, .MessageSizeEstimator, .PreferHeapByteBufAllocator, .RecvByteBufAllocator, .WriteBufferWaterMark, io.netty.channel.socket.DefaultSocketChannelConfig, .SocketChannel, java.io.IOException, java.net.Socket, java.util.Map

Deprecated

use NIO / EPOLL / KQUEUE transport.

Default OioSocketChannelConfig implementation

Field Summary

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

Constructor Summary

AccessConstructor and Description
public
DefaultOioSocketChannelConfig(SocketChannel channel, Socket javaSocket)

Deprecated
pack-priv
DefaultOioSocketChannelConfig(OioSocketChannel channel, Socket javaSocket)

Deprecated as a consequence of OioSocketChannel 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.OioSocketChannelConfig.getSoTimeout.

Returns the maximal time a operation on the underlying socket may block.
public OioSocketChannelConfig
public OioSocketChannelConfig
setAllowHalfClosure(boolean allowHalfClosure)

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setAllowHalfClosure.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setAllowHalfClosure, io.netty.channel.socket.SocketChannelConfig.setAllowHalfClosure.

Deprecated as a consequence of OioSocketChannelConfig being deprecated.
Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed.
public OioSocketChannelConfig
setAutoClose(boolean autoClose)

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setAutoClose.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setAutoClose, io.netty.channel.socket.SocketChannelConfig.setAutoClose, io.netty.channel.ChannelConfig.setAutoClose.

Deprecated as a consequence of OioSocketChannelConfig being deprecated.
Sets whether the Channel should be closed automatically and immediately on write failure.
public OioSocketChannelConfig
setAutoRead(boolean autoRead)

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setAutoRead.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setAutoRead, io.netty.channel.socket.SocketChannelConfig.setAutoRead, io.netty.channel.ChannelConfig.setAutoRead.

Deprecated as a consequence of OioSocketChannelConfig being deprecated.
Sets if ChannelHandlerContext#read() will be invoked automatically so that a user application doesn't need to call it at all.
public OioSocketChannelConfig
setConnectTimeoutMillis(int
the connect timeout in milliseconds. 0 to disable.
connectTimeoutMillis
)

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setConnectTimeoutMillis.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setConnectTimeoutMillis, io.netty.channel.socket.SocketChannelConfig.setConnectTimeoutMillis, io.netty.channel.ChannelConfig.setConnectTimeoutMillis.

Deprecated as a consequence of OioSocketChannelConfig being deprecated.
Sets the connect timeout of the channel in milliseconds.
public OioSocketChannelConfig
public OioSocketChannelConfig
public OioSocketChannelConfig
public <T> boolean
setOption(ChannelOption<T> option, T value)

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setOption.

Implements io.netty.channel.ChannelConfig.setOption.

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

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

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

Constructor Detail

DefaultOioSocketChannelConfigback to summary
public DefaultOioSocketChannelConfig(SocketChannel channel, Socket javaSocket)

Deprecated

Annotations
@Deprecated
DefaultOioSocketChannelConfigback to summary
pack-priv DefaultOioSocketChannelConfig(OioSocketChannel channel, Socket javaSocket)

Deprecated

as a consequence of OioSocketChannel 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.DefaultSocketChannelConfig.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.DefaultSocketChannelConfig.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.OioSocketChannelConfig.getSoTimeout.

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

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

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

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setAllocator.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setAllocator, io.netty.channel.socket.SocketChannelConfig.setAllocator, io.netty.channel.ChannelConfig.setAllocator.

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

Deprecated

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

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

Annotations
@Override
setAllowHalfClosureback to summary
public OioSocketChannelConfig setAllowHalfClosure(boolean allowHalfClosure)

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setAllowHalfClosure.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setAllowHalfClosure, io.netty.channel.socket.SocketChannelConfig.setAllowHalfClosure.

Doc from io.netty.channel.socket.DuplexChannelConfig.setAllowHalfClosure.

Deprecated

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

Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed. If true the connection is not closed when the remote peer shuts down output. Instead, ChannelInboundHandler#userEventTriggered(ChannelHandlerContext, Object) is invoked with a ChannelInputShutdownEvent object. If false, the connection is closed automatically.

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

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setAutoClose.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setAutoClose, io.netty.channel.socket.SocketChannelConfig.setAutoClose, io.netty.channel.ChannelConfig.setAutoClose.

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

Deprecated

as a consequence of OioSocketChannelConfig 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 OioSocketChannelConfig setAutoRead(boolean autoRead)

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setAutoRead.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setAutoRead, io.netty.channel.socket.SocketChannelConfig.setAutoRead, io.netty.channel.ChannelConfig.setAutoRead.

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

Deprecated

as a consequence of OioSocketChannelConfig 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
setConnectTimeoutMillisback to summary
public OioSocketChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setConnectTimeoutMillis.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setConnectTimeoutMillis, io.netty.channel.socket.SocketChannelConfig.setConnectTimeoutMillis, io.netty.channel.ChannelConfig.setConnectTimeoutMillis.

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

Deprecated

as a consequence of OioSocketChannelConfig 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
setKeepAliveback to summary
public OioSocketChannelConfig setKeepAlive(boolean keepAlive)

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setKeepAlive.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setKeepAlive, io.netty.channel.socket.SocketChannelConfig.setKeepAlive.

Doc from io.netty.channel.socket.SocketChannelConfig.setKeepAlive.

Deprecated

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

Sets the StandardSocketOptions#SO_KEEPALIVE option.

Annotations
@Override
setMaxMessagesPerReadback to summary
public OioSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setMaxMessagesPerRead.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setMaxMessagesPerRead, io.netty.channel.socket.SocketChannelConfig.setMaxMessagesPerRead, io.netty.channel.ChannelConfig.setMaxMessagesPerRead.

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

Deprecated

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

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setMessageSizeEstimator.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setMessageSizeEstimator, io.netty.channel.socket.SocketChannelConfig.setMessageSizeEstimator, io.netty.channel.ChannelConfig.setMessageSizeEstimator.

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

Deprecated

as a consequence of OioSocketChannelConfig 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.DefaultSocketChannelConfig.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 OioSocketChannelConfig setPerformancePreferences(int connectionTime, int latency, int bandwidth)

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setPerformancePreferences.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setPerformancePreferences, io.netty.channel.socket.SocketChannelConfig.setPerformancePreferences.

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

Deprecated

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

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

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

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setReceiveBufferSize.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setReceiveBufferSize, io.netty.channel.socket.SocketChannelConfig.setReceiveBufferSize.

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

Deprecated

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

Sets the StandardSocketOptions#SO_RCVBUF option.

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

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setRecvByteBufAllocator.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setRecvByteBufAllocator, io.netty.channel.socket.SocketChannelConfig.setRecvByteBufAllocator, io.netty.channel.ChannelConfig.setRecvByteBufAllocator.

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

Deprecated

as a consequence of OioSocketChannelConfig 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 OioSocketChannelConfig setReuseAddress(boolean reuseAddress)

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setReuseAddress.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setReuseAddress, io.netty.channel.socket.SocketChannelConfig.setReuseAddress.

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

Deprecated

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

Sets the StandardSocketOptions#SO_REUSEADDR option.

Annotations
@Override
setSendBufferSizeback to summary
public OioSocketChannelConfig setSendBufferSize(int sendBufferSize)

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setSendBufferSize.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setSendBufferSize, io.netty.channel.socket.SocketChannelConfig.setSendBufferSize.

Doc from io.netty.channel.socket.SocketChannelConfig.setSendBufferSize.

Deprecated

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

Sets the StandardSocketOptions#SO_SNDBUF option.

Annotations
@Override
setSoLingerback to summary
public OioSocketChannelConfig setSoLinger(int soLinger)

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setSoLinger.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setSoLinger, io.netty.channel.socket.SocketChannelConfig.setSoLinger.

Doc from io.netty.channel.socket.SocketChannelConfig.setSoLinger.

Deprecated

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

Sets the StandardSocketOptions#SO_LINGER option.

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

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

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

Deprecated

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

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

Annotations
@Override
setTcpNoDelayback to summary
public OioSocketChannelConfig setTcpNoDelay(boolean tcpNoDelay)

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setTcpNoDelay.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setTcpNoDelay, io.netty.channel.socket.SocketChannelConfig.setTcpNoDelay.

Doc from io.netty.channel.socket.SocketChannelConfig.setTcpNoDelay.

Deprecated

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

Sets the StandardSocketOptions#TCP_NODELAY option. Please note that the default value of this option is true unlike the operating system default (false). However, for some buggy platforms, such as Android, that shows erratic behavior with Nagle's algorithm disabled, the default value remains to be false.

Annotations
@Override
setTrafficClassback to summary
public OioSocketChannelConfig setTrafficClass(int trafficClass)

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setTrafficClass.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setTrafficClass, io.netty.channel.socket.SocketChannelConfig.setTrafficClass.

Doc from io.netty.channel.socket.SocketChannelConfig.setTrafficClass.

Deprecated

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

Sets the StandardSocketOptions#IP_TOS option.

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

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setWriteBufferHighWaterMark.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setWriteBufferHighWaterMark, io.netty.channel.ChannelConfig.setWriteBufferHighWaterMark.

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

Deprecated

as a consequence of OioSocketChannelConfig 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 OioSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setWriteBufferLowWaterMark.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setWriteBufferLowWaterMark, io.netty.channel.ChannelConfig.setWriteBufferLowWaterMark.

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

Deprecated

as a consequence of OioSocketChannelConfig 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 OioSocketChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setWriteBufferWaterMark.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setWriteBufferWaterMark, io.netty.channel.socket.SocketChannelConfig.setWriteBufferWaterMark, io.netty.channel.ChannelConfig.setWriteBufferWaterMark.

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

Deprecated

as a consequence of OioSocketChannelConfig 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 OioSocketChannelConfig setWriteSpinCount(int writeSpinCount)

Overrides io.netty.channel.socket.DefaultSocketChannelConfig.setWriteSpinCount.

Implements io.netty.channel.socket.oio.OioSocketChannelConfig.setWriteSpinCount, io.netty.channel.socket.SocketChannelConfig.setWriteSpinCount, io.netty.channel.ChannelConfig.setWriteSpinCount.

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

Deprecated

as a consequence of OioSocketChannelConfig 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