Package io.netty.channel.socket.oio
Interface OioSocketChannelConfig
-
- All Superinterfaces:
ChannelConfig
,DuplexChannelConfig
,SocketChannelConfig
- All Known Implementing Classes:
DefaultOioSocketChannelConfig
@Deprecated public interface OioSocketChannelConfig extends SocketChannelConfig
Deprecated.use NIO / EPOLL / KQUEUE transport.AChannelConfig
for aOioSocketChannel
.Available options
In addition to the options provided bySocketChannelConfig
,OioSocketChannelConfig
allows the following options in the option map:Name Associated setter method ChannelOption.SO_TIMEOUT
setSoTimeout(int)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description int
getSoTimeout()
Deprecated.Returns the maximal time a operation on the underlying socket may block.OioSocketChannelConfig
setAllocator(ByteBufAllocator allocator)
Deprecated.Set theByteBufAllocator
which is used for the channel to allocate buffers.OioSocketChannelConfig
setAllowHalfClosure(boolean allowHalfClosure)
Deprecated.Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed.OioSocketChannelConfig
setAutoClose(boolean autoClose)
Deprecated.Sets whether theChannel
should be closed automatically and immediately on write failure.OioSocketChannelConfig
setAutoRead(boolean autoRead)
Deprecated.Sets ifChannelHandlerContext.read()
will be invoked automatically so that a user application doesn't need to call it at all.OioSocketChannelConfig
setConnectTimeoutMillis(int connectTimeoutMillis)
Deprecated.Sets the connect timeout of the channel in milliseconds.OioSocketChannelConfig
setKeepAlive(boolean keepAlive)
Deprecated.Sets theStandardSocketOptions.SO_KEEPALIVE
option.OioSocketChannelConfig
setMaxMessagesPerRead(int maxMessagesPerRead)
Deprecated.OioSocketChannelConfig
setMessageSizeEstimator(MessageSizeEstimator estimator)
Deprecated.Set theMessageSizeEstimator
which is used for the channel to detect the size of a message.OioSocketChannelConfig
setPerformancePreferences(int connectionTime, int latency, int bandwidth)
Deprecated.Sets the performance preferences as specified inSocket.setPerformancePreferences(int, int, int)
.OioSocketChannelConfig
setReceiveBufferSize(int receiveBufferSize)
Deprecated.Sets theStandardSocketOptions.SO_RCVBUF
option.OioSocketChannelConfig
setRecvByteBufAllocator(RecvByteBufAllocator allocator)
Deprecated.Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.OioSocketChannelConfig
setReuseAddress(boolean reuseAddress)
Deprecated.Sets theStandardSocketOptions.SO_REUSEADDR
option.OioSocketChannelConfig
setSendBufferSize(int sendBufferSize)
Deprecated.Sets theStandardSocketOptions.SO_SNDBUF
option.OioSocketChannelConfig
setSoLinger(int soLinger)
Deprecated.Sets theStandardSocketOptions.SO_LINGER
option.OioSocketChannelConfig
setSoTimeout(int timeout)
Deprecated.Sets the maximal time a operation on the underlying socket may block.OioSocketChannelConfig
setTcpNoDelay(boolean tcpNoDelay)
Deprecated.Sets theStandardSocketOptions.TCP_NODELAY
option.OioSocketChannelConfig
setTrafficClass(int trafficClass)
Deprecated.Sets theStandardSocketOptions.IP_TOS
option.OioSocketChannelConfig
setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
Deprecated.Sets the high water mark of the write buffer.OioSocketChannelConfig
setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
Deprecated.Sets the low water mark of the write buffer.OioSocketChannelConfig
setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
Deprecated.Set theWriteBufferWaterMark
which is used for setting the high and low water mark of the write buffer.OioSocketChannelConfig
setWriteSpinCount(int writeSpinCount)
Deprecated.Sets the maximum loop count for a write operation untilWritableByteChannel.write(ByteBuffer)
returns a non-zero value.-
Methods inherited from interface io.netty.channel.ChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getOption, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOption, setOptions
-
Methods inherited from interface io.netty.channel.socket.DuplexChannelConfig
isAllowHalfClosure
-
Methods inherited from interface io.netty.channel.socket.SocketChannelConfig
getReceiveBufferSize, getSendBufferSize, getSoLinger, getTrafficClass, isKeepAlive, isReuseAddress, isTcpNoDelay
-
-
-
-
Method Detail
-
setSoTimeout
OioSocketChannelConfig setSoTimeout(int timeout)
Deprecated.Sets the maximal time a operation on the underlying socket may block.
-
getSoTimeout
int getSoTimeout()
Deprecated.Returns the maximal time a operation on the underlying socket may block.
-
setTcpNoDelay
OioSocketChannelConfig setTcpNoDelay(boolean tcpNoDelay)
Deprecated.Description copied from interface:SocketChannelConfig
Sets theStandardSocketOptions.TCP_NODELAY
option. Please note that the default value of this option istrue
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 befalse
.- Specified by:
setTcpNoDelay
in interfaceSocketChannelConfig
-
setSoLinger
OioSocketChannelConfig setSoLinger(int soLinger)
Deprecated.Description copied from interface:SocketChannelConfig
Sets theStandardSocketOptions.SO_LINGER
option.- Specified by:
setSoLinger
in interfaceSocketChannelConfig
-
setSendBufferSize
OioSocketChannelConfig setSendBufferSize(int sendBufferSize)
Deprecated.Description copied from interface:SocketChannelConfig
Sets theStandardSocketOptions.SO_SNDBUF
option.- Specified by:
setSendBufferSize
in interfaceSocketChannelConfig
-
setReceiveBufferSize
OioSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)
Deprecated.Description copied from interface:SocketChannelConfig
Sets theStandardSocketOptions.SO_RCVBUF
option.- Specified by:
setReceiveBufferSize
in interfaceSocketChannelConfig
-
setKeepAlive
OioSocketChannelConfig setKeepAlive(boolean keepAlive)
Deprecated.Description copied from interface:SocketChannelConfig
Sets theStandardSocketOptions.SO_KEEPALIVE
option.- Specified by:
setKeepAlive
in interfaceSocketChannelConfig
-
setTrafficClass
OioSocketChannelConfig setTrafficClass(int trafficClass)
Deprecated.Description copied from interface:SocketChannelConfig
Sets theStandardSocketOptions.IP_TOS
option.- Specified by:
setTrafficClass
in interfaceSocketChannelConfig
-
setReuseAddress
OioSocketChannelConfig setReuseAddress(boolean reuseAddress)
Deprecated.Description copied from interface:SocketChannelConfig
Sets theStandardSocketOptions.SO_REUSEADDR
option.- Specified by:
setReuseAddress
in interfaceSocketChannelConfig
-
setPerformancePreferences
OioSocketChannelConfig setPerformancePreferences(int connectionTime, int latency, int bandwidth)
Deprecated.Description copied from interface:SocketChannelConfig
Sets the performance preferences as specified inSocket.setPerformancePreferences(int, int, int)
.- Specified by:
setPerformancePreferences
in interfaceSocketChannelConfig
-
setAllowHalfClosure
OioSocketChannelConfig setAllowHalfClosure(boolean allowHalfClosure)
Deprecated.Description copied from interface:DuplexChannelConfig
Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed. Iftrue
the connection is not closed when the remote peer shuts down output. Instead,ChannelInboundHandler.userEventTriggered(ChannelHandlerContext, Object)
is invoked with aChannelInputShutdownEvent
object. Iffalse
, the connection is closed automatically.- Specified by:
setAllowHalfClosure
in interfaceDuplexChannelConfig
- Specified by:
setAllowHalfClosure
in interfaceSocketChannelConfig
-
setConnectTimeoutMillis
OioSocketChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
Deprecated.Description copied from interface:ChannelConfig
Sets the connect timeout of the channel in milliseconds. If theChannel
does not support connect operation, this property is not used at all, and therefore will be ignored.- Specified by:
setConnectTimeoutMillis
in interfaceChannelConfig
- Specified by:
setConnectTimeoutMillis
in interfaceSocketChannelConfig
- Parameters:
connectTimeoutMillis
- the connect timeout in milliseconds.0
to disable.
-
setMaxMessagesPerRead
@Deprecated OioSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
Deprecated.- Specified by:
setMaxMessagesPerRead
in interfaceChannelConfig
- Specified by:
setMaxMessagesPerRead
in interfaceDuplexChannelConfig
- Specified by:
setMaxMessagesPerRead
in interfaceSocketChannelConfig
-
setWriteSpinCount
OioSocketChannelConfig setWriteSpinCount(int writeSpinCount)
Deprecated.Description copied from interface:ChannelConfig
Sets the maximum loop count for a write operation untilWritableByteChannel.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 is16
.- Specified by:
setWriteSpinCount
in interfaceChannelConfig
- Specified by:
setWriteSpinCount
in interfaceDuplexChannelConfig
- Specified by:
setWriteSpinCount
in interfaceSocketChannelConfig
-
setAllocator
OioSocketChannelConfig setAllocator(ByteBufAllocator allocator)
Deprecated.Description copied from interface:ChannelConfig
Set theByteBufAllocator
which is used for the channel to allocate buffers.- Specified by:
setAllocator
in interfaceChannelConfig
- Specified by:
setAllocator
in interfaceDuplexChannelConfig
- Specified by:
setAllocator
in interfaceSocketChannelConfig
-
setRecvByteBufAllocator
OioSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)
Deprecated.Description copied from interface:ChannelConfig
Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.- Specified by:
setRecvByteBufAllocator
in interfaceChannelConfig
- Specified by:
setRecvByteBufAllocator
in interfaceDuplexChannelConfig
- Specified by:
setRecvByteBufAllocator
in interfaceSocketChannelConfig
-
setAutoRead
OioSocketChannelConfig setAutoRead(boolean autoRead)
Deprecated.Description copied from interface:ChannelConfig
Sets ifChannelHandlerContext.read()
will be invoked automatically so that a user application doesn't need to call it at all. The default value istrue
.- Specified by:
setAutoRead
in interfaceChannelConfig
- Specified by:
setAutoRead
in interfaceDuplexChannelConfig
- Specified by:
setAutoRead
in interfaceSocketChannelConfig
-
setAutoClose
OioSocketChannelConfig setAutoClose(boolean autoClose)
Deprecated.Description copied from interface:ChannelConfig
Sets whether theChannel
should be closed automatically and immediately on write failure. The default istrue
.- Specified by:
setAutoClose
in interfaceChannelConfig
- Specified by:
setAutoClose
in interfaceDuplexChannelConfig
- Specified by:
setAutoClose
in interfaceSocketChannelConfig
-
setWriteBufferHighWaterMark
OioSocketChannelConfig 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 returnfalse
.- Specified by:
setWriteBufferHighWaterMark
in interfaceChannelConfig
-
setWriteBufferLowWaterMark
OioSocketChannelConfig 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 returntrue
again.- Specified by:
setWriteBufferLowWaterMark
in interfaceChannelConfig
-
setWriteBufferWaterMark
OioSocketChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)
Deprecated.Description copied from interface:ChannelConfig
Set theWriteBufferWaterMark
which is used for setting the high and low water mark of the write buffer.- Specified by:
setWriteBufferWaterMark
in interfaceChannelConfig
- Specified by:
setWriteBufferWaterMark
in interfaceDuplexChannelConfig
- Specified by:
setWriteBufferWaterMark
in interfaceSocketChannelConfig
-
setMessageSizeEstimator
OioSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)
Deprecated.Description copied from interface:ChannelConfig
Set theMessageSizeEstimator
which is used for the channel to detect the size of a message.- Specified by:
setMessageSizeEstimator
in interfaceChannelConfig
- Specified by:
setMessageSizeEstimator
in interfaceDuplexChannelConfig
- Specified by:
setMessageSizeEstimator
in interfaceSocketChannelConfig
-
-