io.netty.channel.socket

类 DefaultSocketChannelConfig

java.lang.Object

io.netty.channel.DefaultChannelConfig

io.netty.channel.socket.DefaultSocketChannelConfig

所有已实现的接口:

ChannelConfig, DuplexChannelConfig, SocketChannelConfig

直接已知子类:

DefaultOioSocketChannelConfig

public class DefaultSocketChannelConfig
extends DefaultChannelConfig
implements SocketChannelConfig

The default SocketChannelConfig implementation.

字段概要

字段

限定符和类型	字段和说明
protected java.net.Socket	javaSocket

从类继承的字段 io.netty.channel.DefaultChannelConfig

channel

构造器概要

构造器

构造器和说明
DefaultSocketChannelConfig(SocketChannel channel, java.net.Socket javaSocket) Creates a new instance.

方法概要

限定符和类型	方法和说明
<T> T	getOption(ChannelOption<T> option) Return the value of the given ChannelOption
java.util.Map<ChannelOption<?>,java.lang.Object>	getOptions() Return all set ChannelOption's.
int	getReceiveBufferSize() Gets the StandardSocketOptions.SO_RCVBUF option.
int	getSendBufferSize() Gets the StandardSocketOptions.SO_SNDBUF option.
int	getSoLinger() Gets the StandardSocketOptions.SO_LINGER option.
int	getTrafficClass() Gets the StandardSocketOptions.IP_TOS option.
boolean	isAllowHalfClosure() Returns true if and only if the channel should not close itself when its remote peer shuts down output to make the connection half-closed.
boolean	isKeepAlive() Gets the StandardSocketOptions.SO_KEEPALIVE option.
boolean	isReuseAddress() Gets the StandardSocketOptions.SO_REUSEADDR option.
boolean	isTcpNoDelay() Gets the StandardSocketOptions.TCP_NODELAY option.
SocketChannelConfig	setAllocator(ByteBufAllocator allocator) Set the ByteBufAllocator which is used for the channel to allocate buffers.
SocketChannelConfig	setAllowHalfClosure(boolean allowHalfClosure) Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed.
SocketChannelConfig	setAutoClose(boolean autoClose) Sets whether the Channel should be closed automatically and immediately on write failure.
SocketChannelConfig	setAutoRead(boolean autoRead) Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
SocketChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis) Sets the connect timeout of the channel in milliseconds.
SocketChannelConfig	setKeepAlive(boolean keepAlive) Sets the StandardSocketOptions.SO_KEEPALIVE option.
SocketChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead) 已过时。
SocketChannelConfig	setMessageSizeEstimator(MessageSizeEstimator estimator) Set the MessageSizeEstimator which is used for the channel to detect the size of a message.
<T> boolean	setOption(ChannelOption<T> option, T value) Sets a configuration property with the specified name and value.
SocketChannelConfig	setPerformancePreferences(int connectionTime, int latency, int bandwidth) Sets the performance preferences as specified in Socket.setPerformancePreferences(int, int, int).
SocketChannelConfig	setReceiveBufferSize(int receiveBufferSize) Sets the StandardSocketOptions.SO_RCVBUF option.
SocketChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator) Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
SocketChannelConfig	setReuseAddress(boolean reuseAddress) Sets the StandardSocketOptions.SO_REUSEADDR option.
SocketChannelConfig	setSendBufferSize(int sendBufferSize) Sets the StandardSocketOptions.SO_SNDBUF option.
SocketChannelConfig	setSoLinger(int soLinger) Sets the StandardSocketOptions.SO_LINGER option.
SocketChannelConfig	setTcpNoDelay(boolean tcpNoDelay) Sets the StandardSocketOptions.TCP_NODELAY option.
SocketChannelConfig	setTrafficClass(int trafficClass) Sets the StandardSocketOptions.IP_TOS option.
SocketChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark) Sets the high water mark of the write buffer.
SocketChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark) Sets the low water mark of the write buffer.
SocketChannelConfig	setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark) Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
SocketChannelConfig	setWriteSpinCount(int writeSpinCount) Sets the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.

从类继承的方法 io.netty.channel.DefaultChannelConfig

autoReadCleared, getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMaxMessagesPerWrite, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setMaxMessagesPerWrite, setOptions, validate

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 io.netty.channel.ChannelConfig

getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOptions

字段详细资料

javaSocket

protected final java.net.Socket javaSocket

构造器详细资料

DefaultSocketChannelConfig

public DefaultSocketChannelConfig(SocketChannel channel,
                                  java.net.Socket javaSocket)

Creates a new instance.

方法详细资料

getOptions

public java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()

从接口复制的说明: ChannelConfig

Return all set ChannelOption's.

指定者:

getOptions 在接口中 ChannelConfig

覆盖:

getOptions 在类中 DefaultChannelConfig

getOption

public <T> T getOption(ChannelOption<T> option)

从接口复制的说明: ChannelConfig

Return the value of the given ChannelOption

指定者:

getOption 在接口中 ChannelConfig

覆盖:

getOption 在类中 DefaultChannelConfig

setOption

public <T> boolean setOption(ChannelOption<T> option,
                             T value)

从接口复制的说明: ChannelConfig

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;
 }
 

指定者:

setOption 在接口中 ChannelConfig

覆盖:

setOption 在类中 DefaultChannelConfig

返回:

true if and only if the property has been set

getReceiveBufferSize

public int getReceiveBufferSize()

从接口复制的说明: SocketChannelConfig

Gets the StandardSocketOptions.SO_RCVBUF option.

指定者:

getReceiveBufferSize 在接口中 SocketChannelConfig

getSendBufferSize

public int getSendBufferSize()

从接口复制的说明: SocketChannelConfig

Gets the StandardSocketOptions.SO_SNDBUF option.

指定者:

getSendBufferSize 在接口中 SocketChannelConfig

getSoLinger

public int getSoLinger()

从接口复制的说明: SocketChannelConfig

Gets the StandardSocketOptions.SO_LINGER option.

指定者:

getSoLinger 在接口中 SocketChannelConfig

getTrafficClass

public int getTrafficClass()

从接口复制的说明: SocketChannelConfig

Gets the StandardSocketOptions.IP_TOS option.

指定者:

getTrafficClass 在接口中 SocketChannelConfig

isKeepAlive

public boolean isKeepAlive()

从接口复制的说明: SocketChannelConfig

Gets the StandardSocketOptions.SO_KEEPALIVE option.

指定者:

isKeepAlive 在接口中 SocketChannelConfig

isReuseAddress

public boolean isReuseAddress()

从接口复制的说明: SocketChannelConfig

Gets the StandardSocketOptions.SO_REUSEADDR option.

指定者:

isReuseAddress 在接口中 SocketChannelConfig

isTcpNoDelay

public boolean isTcpNoDelay()

从接口复制的说明: SocketChannelConfig

Gets 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.

指定者:

isTcpNoDelay 在接口中 SocketChannelConfig

setKeepAlive

public SocketChannelConfig setKeepAlive(boolean keepAlive)

从接口复制的说明: SocketChannelConfig

Sets the StandardSocketOptions.SO_KEEPALIVE option.

指定者:

setKeepAlive 在接口中 SocketChannelConfig

setPerformancePreferences

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

从接口复制的说明: SocketChannelConfig

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

指定者:

setPerformancePreferences 在接口中 SocketChannelConfig

setReceiveBufferSize

public SocketChannelConfig setReceiveBufferSize(int receiveBufferSize)

从接口复制的说明: SocketChannelConfig

Sets the StandardSocketOptions.SO_RCVBUF option.

指定者:

setReceiveBufferSize 在接口中 SocketChannelConfig

setReuseAddress

public SocketChannelConfig setReuseAddress(boolean reuseAddress)

从接口复制的说明: SocketChannelConfig

Sets the StandardSocketOptions.SO_REUSEADDR option.

指定者:

setReuseAddress 在接口中 SocketChannelConfig

setSendBufferSize

public SocketChannelConfig setSendBufferSize(int sendBufferSize)

从接口复制的说明: SocketChannelConfig

Sets the StandardSocketOptions.SO_SNDBUF option.

指定者:

setSendBufferSize 在接口中 SocketChannelConfig

setSoLinger

public SocketChannelConfig setSoLinger(int soLinger)

从接口复制的说明: SocketChannelConfig

Sets the StandardSocketOptions.SO_LINGER option.

指定者:

setSoLinger 在接口中 SocketChannelConfig

setTcpNoDelay

public SocketChannelConfig setTcpNoDelay(boolean tcpNoDelay)

从接口复制的说明: SocketChannelConfig

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.

指定者:

setTcpNoDelay 在接口中 SocketChannelConfig

setTrafficClass

public SocketChannelConfig setTrafficClass(int trafficClass)

从接口复制的说明: SocketChannelConfig

Sets the StandardSocketOptions.IP_TOS option.

指定者:

setTrafficClass 在接口中 SocketChannelConfig

isAllowHalfClosure

public boolean isAllowHalfClosure()

从接口复制的说明: DuplexChannelConfig

Returns true if and only if the channel should not close itself when its remote peer shuts down output to make the connection half-closed. If false, the connection is closed automatically when the remote peer shuts down output.

指定者:

isAllowHalfClosure 在接口中 DuplexChannelConfig

setAllowHalfClosure

public SocketChannelConfig setAllowHalfClosure(boolean allowHalfClosure)

从接口复制的说明: DuplexChannelConfig

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.

指定者:

setAllowHalfClosure 在接口中 DuplexChannelConfig

指定者:

setAllowHalfClosure 在接口中 SocketChannelConfig

setConnectTimeoutMillis

public SocketChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)

从接口复制的说明: ChannelConfig

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.

指定者:

setConnectTimeoutMillis 在接口中 ChannelConfig

指定者:

setConnectTimeoutMillis 在接口中 SocketChannelConfig

覆盖:

setConnectTimeoutMillis 在类中 DefaultChannelConfig

参数:

connectTimeoutMillis - the connect timeout in milliseconds. 0 to disable.

setMaxMessagesPerRead

@Deprecated
public SocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

已过时。

从类复制的说明: DefaultChannelConfig

指定者:

setMaxMessagesPerRead 在接口中 ChannelConfig

指定者:

setMaxMessagesPerRead 在接口中 DuplexChannelConfig

指定者:

setMaxMessagesPerRead 在接口中 SocketChannelConfig

覆盖:

setMaxMessagesPerRead 在类中 DefaultChannelConfig

setWriteSpinCount

public SocketChannelConfig setWriteSpinCount(int writeSpinCount)

从接口复制的说明: ChannelConfig

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.

指定者:

setWriteSpinCount 在接口中 ChannelConfig

指定者:

setWriteSpinCount 在接口中 DuplexChannelConfig

指定者:

setWriteSpinCount 在接口中 SocketChannelConfig

覆盖:

setWriteSpinCount 在类中 DefaultChannelConfig

setAllocator

public SocketChannelConfig setAllocator(ByteBufAllocator allocator)

从接口复制的说明: ChannelConfig

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

指定者:

setAllocator 在接口中 ChannelConfig

指定者:

setAllocator 在接口中 DuplexChannelConfig

指定者:

setAllocator 在接口中 SocketChannelConfig

覆盖:

setAllocator 在类中 DefaultChannelConfig

setRecvByteBufAllocator

public SocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

从接口复制的说明: ChannelConfig

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

指定者:

setRecvByteBufAllocator 在接口中 ChannelConfig

指定者:

setRecvByteBufAllocator 在接口中 DuplexChannelConfig

指定者:

setRecvByteBufAllocator 在接口中 SocketChannelConfig

覆盖:

setRecvByteBufAllocator 在类中 DefaultChannelConfig

setAutoRead

public SocketChannelConfig setAutoRead(boolean autoRead)

从接口复制的说明: ChannelConfig

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.

指定者:

setAutoRead 在接口中 ChannelConfig

指定者:

setAutoRead 在接口中 DuplexChannelConfig

指定者:

setAutoRead 在接口中 SocketChannelConfig

覆盖:

setAutoRead 在类中 DefaultChannelConfig

setAutoClose

public SocketChannelConfig setAutoClose(boolean autoClose)

从接口复制的说明: ChannelConfig

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

指定者:

setAutoClose 在接口中 ChannelConfig

指定者:

setAutoClose 在接口中 DuplexChannelConfig

指定者:

setAutoClose 在接口中 SocketChannelConfig

覆盖:

setAutoClose 在类中 DefaultChannelConfig

setWriteBufferHighWaterMark

public SocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)

从接口复制的说明: 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 return false.

指定者:

setWriteBufferHighWaterMark 在接口中 ChannelConfig

覆盖:

setWriteBufferHighWaterMark 在类中 DefaultChannelConfig

setWriteBufferLowWaterMark

public SocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)

从接口复制的说明: 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 return true again.

指定者:

setWriteBufferLowWaterMark 在接口中 ChannelConfig

覆盖:

setWriteBufferLowWaterMark 在类中 DefaultChannelConfig

setWriteBufferWaterMark

public SocketChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)

从接口复制的说明: ChannelConfig

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

指定者:

setWriteBufferWaterMark 在接口中 ChannelConfig

指定者:

setWriteBufferWaterMark 在接口中 DuplexChannelConfig

指定者:

setWriteBufferWaterMark 在接口中 SocketChannelConfig

覆盖:

setWriteBufferWaterMark 在类中 DefaultChannelConfig

setMessageSizeEstimator

public SocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

从接口复制的说明: ChannelConfig

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

指定者:

setMessageSizeEstimator 在接口中 ChannelConfig

指定者:

setMessageSizeEstimator 在接口中 DuplexChannelConfig

指定者:

setMessageSizeEstimator 在接口中 SocketChannelConfig

覆盖:

setMessageSizeEstimator 在类中 DefaultChannelConfig