Package io.netty.channel.socket
Interface ServerSocketChannelConfig
- All Superinterfaces:
ChannelConfig
- All Known Subinterfaces:
OioServerSocketChannelConfig
- All Known Implementing Classes:
DefaultOioServerSocketChannelConfig
,DefaultServerSocketChannelConfig
,EpollServerChannelConfig
,EpollServerSocketChannelConfig
,KQueueServerChannelConfig
,KQueueServerSocketChannelConfig
,NioServerSocketChannel.NioServerSocketChannelConfig
A
ChannelConfig
for a ServerSocketChannel
.
Available options
In addition to the options provided byChannelConfig
,
ServerSocketChannelConfig
allows the following options in the
option map:
Name | Associated setter method |
---|---|
"backlog" | setBacklog(int) |
"reuseAddress" | setReuseAddress(boolean) |
"receiveBufferSize" | setReceiveBufferSize(int) |
-
Method Summary
Modifier and TypeMethodDescriptionint
Gets the backlog value to specify when the channel binds to a local address.int
Gets theStandardSocketOptions.SO_RCVBUF
option.boolean
Gets theStandardSocketOptions.SO_REUSEADDR
option.setAllocator
(ByteBufAllocator allocator) Set theByteBufAllocator
which is used for the channel to allocate buffers.setAutoRead
(boolean autoRead) Sets ifChannelHandlerContext.read()
will be invoked automatically so that a user application doesn't need to call it at all.setBacklog
(int backlog) Sets the backlog value to specify when the channel binds to a local address.setConnectTimeoutMillis
(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.setMaxMessagesPerRead
(int maxMessagesPerRead) Deprecated.setMessageSizeEstimator
(MessageSizeEstimator estimator) Set theMessageSizeEstimator
which is used for the channel to detect the size of a message.setPerformancePreferences
(int connectionTime, int latency, int bandwidth) Sets the performance preferences as specified inServerSocket.setPerformancePreferences(int, int, int)
.setReceiveBufferSize
(int receiveBufferSize) Gets theStandardSocketOptions.SO_SNDBUF
option.setRecvByteBufAllocator
(RecvByteBufAllocator allocator) Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.setReuseAddress
(boolean reuseAddress) Sets theStandardSocketOptions.SO_REUSEADDR
option.setWriteBufferHighWaterMark
(int writeBufferHighWaterMark) Sets the high water mark of the write buffer.setWriteBufferLowWaterMark
(int writeBufferLowWaterMark) Sets the low water mark of the write buffer.setWriteBufferWaterMark
(WriteBufferWaterMark writeBufferWaterMark) Set theWriteBufferWaterMark
which is used for setting the high and low water mark of the write buffer.setWriteSpinCount
(int writeSpinCount) 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, setAutoClose, setOption, setOptions
-
Method Details
-
getBacklog
int getBacklog()Gets the backlog value to specify when the channel binds to a local address. -
setBacklog
Sets the backlog value to specify when the channel binds to a local address. -
isReuseAddress
boolean isReuseAddress()Gets theStandardSocketOptions.SO_REUSEADDR
option. -
setReuseAddress
Sets theStandardSocketOptions.SO_REUSEADDR
option. -
getReceiveBufferSize
int getReceiveBufferSize()Gets theStandardSocketOptions.SO_RCVBUF
option. -
setReceiveBufferSize
Gets theStandardSocketOptions.SO_SNDBUF
option. -
setPerformancePreferences
Sets the performance preferences as specified inServerSocket.setPerformancePreferences(int, int, int)
. -
setConnectTimeoutMillis
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
- Parameters:
connectTimeoutMillis
- the connect timeout in milliseconds.0
to disable.
-
setMaxMessagesPerRead
Deprecated.- Specified by:
setMaxMessagesPerRead
in interfaceChannelConfig
-
setWriteSpinCount
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
-
setAllocator
Description copied from interface:ChannelConfig
Set theByteBufAllocator
which is used for the channel to allocate buffers.- Specified by:
setAllocator
in interfaceChannelConfig
-
setRecvByteBufAllocator
Description copied from interface:ChannelConfig
Set theRecvByteBufAllocator
which is used for the channel to allocate receive buffers.- Specified by:
setRecvByteBufAllocator
in interfaceChannelConfig
-
setAutoRead
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
-
setMessageSizeEstimator
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
-
setWriteBufferHighWaterMark
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
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
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
-