KQueueSocketChannelConfig (Netty/Transport/Classes/KQueue 4.1.112.Final API)

java.lang.Object
- io.netty.channel.DefaultChannelConfig
- - io.netty.channel.kqueue.KQueueChannelConfig
  - - io.netty.channel.kqueue.KQueueSocketChannelConfig

All Implemented Interfaces:

io.netty.channel.ChannelConfig, io.netty.channel.socket.DuplexChannelConfig, io.netty.channel.socket.SocketChannelConfig
```
public final class KQueueSocketChannelConfig
extends KQueueChannelConfig
implements io.netty.channel.socket.SocketChannelConfig
```

Field Summary
- Fields inherited from class io.netty.channel.DefaultChannelConfig
  channel

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`<T> T`	`getOption(io.netty.channel.ChannelOption<T> option)`
`Map<io.netty.channel.ChannelOption<?>,Object>`	`getOptions()`
`int`	`getReceiveBufferSize()`
`int`	`getSendBufferSize()`
`int`	`getSndLowAt()`
`int`	`getSoLinger()`
`int`	`getTrafficClass()`
`boolean`	`isAllowHalfClosure()`
`boolean`	`isKeepAlive()`
`boolean`	`isReuseAddress()`
`boolean`	`isTcpFastOpenConnect()` Returns `true` if TCP fast open is enabled, `false` otherwise.
`boolean`	`isTcpNoDelay()`
`boolean`	`isTcpNoPush()`
`KQueueSocketChannelConfig`	`setAllocator(io.netty.buffer.ByteBufAllocator allocator)`
`KQueueSocketChannelConfig`	`setAllowHalfClosure(boolean allowHalfClosure)`
`KQueueSocketChannelConfig`	`setAutoClose(boolean autoClose)`
`KQueueSocketChannelConfig`	`setAutoRead(boolean autoRead)`
`KQueueSocketChannelConfig`	`setConnectTimeoutMillis(int connectTimeoutMillis)`
`KQueueSocketChannelConfig`	`setKeepAlive(boolean keepAlive)`
`KQueueSocketChannelConfig`	`setMaxMessagesPerRead(int maxMessagesPerRead)` Deprecated.
`KQueueSocketChannelConfig`	`setMessageSizeEstimator(io.netty.channel.MessageSizeEstimator estimator)`
`<T> boolean`	`setOption(io.netty.channel.ChannelOption<T> option, T value)`
`KQueueSocketChannelConfig`	`setPerformancePreferences(int connectionTime, int latency, int bandwidth)`
`KQueueSocketChannelConfig`	`setRcvAllocTransportProvidesGuess(boolean transportProvidesGuess)` If this is `true` then the `RecvByteBufAllocator.Handle#guess()` will be overridden to always attempt to read as many bytes as kqueue says are available.
`KQueueSocketChannelConfig`	`setReceiveBufferSize(int receiveBufferSize)`
`KQueueSocketChannelConfig`	`setRecvByteBufAllocator(io.netty.channel.RecvByteBufAllocator allocator)`
`KQueueSocketChannelConfig`	`setReuseAddress(boolean reuseAddress)`
`KQueueSocketChannelConfig`	`setSendBufferSize(int sendBufferSize)`
`void`	`setSndLowAt(int sndLowAt)`
`KQueueSocketChannelConfig`	`setSoLinger(int soLinger)`
`KQueueSocketChannelConfig`	`setTcpFastOpenConnect(boolean fastOpenConnect)` Enables client TCP fast open, if available.
`KQueueSocketChannelConfig`	`setTcpNoDelay(boolean tcpNoDelay)`
`void`	`setTcpNoPush(boolean tcpNoPush)`
`KQueueSocketChannelConfig`	`setTrafficClass(int trafficClass)`
`KQueueSocketChannelConfig`	`setWriteBufferHighWaterMark(int writeBufferHighWaterMark)` Deprecated.
`KQueueSocketChannelConfig`	`setWriteBufferLowWaterMark(int writeBufferLowWaterMark)` Deprecated.
`KQueueSocketChannelConfig`	`setWriteBufferWaterMark(io.netty.channel.WriteBufferWaterMark writeBufferWaterMark)`
`KQueueSocketChannelConfig`	`setWriteSpinCount(int writeSpinCount)`

Methods inherited from class io.netty.channel.kqueue.KQueueChannelConfig
autoReadCleared, getRcvAllocTransportProvidesGuess

Methods inherited from class io.netty.channel.DefaultChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMaxMessagesPerWrite, getMessageSizeEstimator, getOptions, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setMaxMessagesPerWrite, setOptions, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty.channel.ChannelConfig
getAllocator, getConnectTimeoutMillis, getMaxMessagesPerRead, getMessageSizeEstimator, getRecvByteBufAllocator, getWriteBufferHighWaterMark, getWriteBufferLowWaterMark, getWriteBufferWaterMark, getWriteSpinCount, isAutoClose, isAutoRead, setOptions

- Method Detail
  - getOptions
```
public Map<io.netty.channel.ChannelOption<?>,Object> getOptions()
```
    Specified by:
    
    getOptions in interface io.netty.channel.ChannelConfig
    
    Overrides:
    
    getOptions in class KQueueChannelConfig
  - getOption
```
public <T> T getOption(io.netty.channel.ChannelOption<T> option)
```
    Specified by:
    
    getOption in interface io.netty.channel.ChannelConfig
    
    Overrides:
    
    getOption in class KQueueChannelConfig
  - setOption
```
public <T> boolean setOption(io.netty.channel.ChannelOption<T> option,
                             T value)
```
    Specified by:
    
    setOption in interface io.netty.channel.ChannelConfig
    
    Overrides:
    
    setOption in class KQueueChannelConfig
  - getReceiveBufferSize
```
public int getReceiveBufferSize()
```
    Specified by:
    
    getReceiveBufferSize in interface io.netty.channel.socket.SocketChannelConfig
  - getSendBufferSize
```
public int getSendBufferSize()
```
    Specified by:
    
    getSendBufferSize in interface io.netty.channel.socket.SocketChannelConfig
  - getSoLinger
```
public int getSoLinger()
```
    Specified by:
    
    getSoLinger in interface io.netty.channel.socket.SocketChannelConfig
  - getTrafficClass
```
public int getTrafficClass()
```
    Specified by:
    
    getTrafficClass in interface io.netty.channel.socket.SocketChannelConfig
  - isKeepAlive
```
public boolean isKeepAlive()
```
    Specified by:
    
    isKeepAlive in interface io.netty.channel.socket.SocketChannelConfig
  - isReuseAddress
```
public boolean isReuseAddress()
```
    Specified by:
    
    isReuseAddress in interface io.netty.channel.socket.SocketChannelConfig
  - isTcpNoDelay
```
public boolean isTcpNoDelay()
```
    Specified by:
    
    isTcpNoDelay in interface io.netty.channel.socket.SocketChannelConfig
  - getSndLowAt
```
public int getSndLowAt()
```
  - setSndLowAt
```
public void setSndLowAt(int sndLowAt)
```
  - isTcpNoPush
```
public boolean isTcpNoPush()
```
  - setTcpNoPush
```
public void setTcpNoPush(boolean tcpNoPush)
```
  - setKeepAlive
```
public KQueueSocketChannelConfig setKeepAlive(boolean keepAlive)
```
    Specified by:
    
    setKeepAlive in interface io.netty.channel.socket.SocketChannelConfig
  - setReceiveBufferSize
```
public KQueueSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)
```
    Specified by:
    
    setReceiveBufferSize in interface io.netty.channel.socket.SocketChannelConfig
  - setReuseAddress
```
public KQueueSocketChannelConfig setReuseAddress(boolean reuseAddress)
```
    Specified by:
    
    setReuseAddress in interface io.netty.channel.socket.SocketChannelConfig
  - setSendBufferSize
```
public KQueueSocketChannelConfig setSendBufferSize(int sendBufferSize)
```
    Specified by:
    
    setSendBufferSize in interface io.netty.channel.socket.SocketChannelConfig
  - setSoLinger
```
public KQueueSocketChannelConfig setSoLinger(int soLinger)
```
    Specified by:
    
    setSoLinger in interface io.netty.channel.socket.SocketChannelConfig
  - setTcpNoDelay
```
public KQueueSocketChannelConfig setTcpNoDelay(boolean tcpNoDelay)
```
    Specified by:
    
    setTcpNoDelay in interface io.netty.channel.socket.SocketChannelConfig
  - setTrafficClass
```
public KQueueSocketChannelConfig setTrafficClass(int trafficClass)
```
    Specified by:
    
    setTrafficClass in interface io.netty.channel.socket.SocketChannelConfig
  - isAllowHalfClosure
```
public boolean isAllowHalfClosure()
```
    Specified by:
    
    isAllowHalfClosure in interface io.netty.channel.socket.DuplexChannelConfig
  - setTcpFastOpenConnect
```
public KQueueSocketChannelConfig setTcpFastOpenConnect(boolean fastOpenConnect)
```
    Enables client TCP fast open, if available.
  - isTcpFastOpenConnect
```
public boolean isTcpFastOpenConnect()
```
    Returns true if TCP fast open is enabled, false otherwise.
  - setRcvAllocTransportProvidesGuess
```
public KQueueSocketChannelConfig setRcvAllocTransportProvidesGuess(boolean transportProvidesGuess)
```
    Description copied from class: KQueueChannelConfig
    
    If this is true then the RecvByteBufAllocator.Handle#guess() will be overridden to always attempt to read as many bytes as kqueue says are available.
    
    Overrides:
    
    setRcvAllocTransportProvidesGuess in class KQueueChannelConfig
  - setPerformancePreferences
```
public KQueueSocketChannelConfig setPerformancePreferences(int connectionTime,
                                                           int latency,
                                                           int bandwidth)
```
    Specified by:
    
    setPerformancePreferences in interface io.netty.channel.socket.SocketChannelConfig
  - setAllowHalfClosure
```
public KQueueSocketChannelConfig setAllowHalfClosure(boolean allowHalfClosure)
```
    Specified by:
    
    setAllowHalfClosure in interface io.netty.channel.socket.DuplexChannelConfig
    
    Specified by:
    
    setAllowHalfClosure in interface io.netty.channel.socket.SocketChannelConfig
  - setConnectTimeoutMillis
```
public KQueueSocketChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)
```
    Specified by:
    
    setConnectTimeoutMillis in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setConnectTimeoutMillis in interface io.netty.channel.socket.SocketChannelConfig
    
    Overrides:
    
    setConnectTimeoutMillis in class KQueueChannelConfig
  - setMaxMessagesPerRead
```
@Deprecated
public KQueueSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)
```
    Deprecated.
    
    Specified by:
    
    setMaxMessagesPerRead in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setMaxMessagesPerRead in interface io.netty.channel.socket.DuplexChannelConfig
    
    Specified by:
    
    setMaxMessagesPerRead in interface io.netty.channel.socket.SocketChannelConfig
    
    Overrides:
    
    setMaxMessagesPerRead in class KQueueChannelConfig
  - setWriteSpinCount
```
public KQueueSocketChannelConfig setWriteSpinCount(int writeSpinCount)
```
    Specified by:
    
    setWriteSpinCount in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setWriteSpinCount in interface io.netty.channel.socket.DuplexChannelConfig
    
    Specified by:
    
    setWriteSpinCount in interface io.netty.channel.socket.SocketChannelConfig
    
    Overrides:
    
    setWriteSpinCount in class KQueueChannelConfig
  - setAllocator
```
public KQueueSocketChannelConfig setAllocator(io.netty.buffer.ByteBufAllocator allocator)
```
    Specified by:
    
    setAllocator in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setAllocator in interface io.netty.channel.socket.DuplexChannelConfig
    
    Specified by:
    
    setAllocator in interface io.netty.channel.socket.SocketChannelConfig
    
    Overrides:
    
    setAllocator in class KQueueChannelConfig
  - setRecvByteBufAllocator
```
public KQueueSocketChannelConfig setRecvByteBufAllocator(io.netty.channel.RecvByteBufAllocator allocator)
```
    Specified by:
    
    setRecvByteBufAllocator in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setRecvByteBufAllocator in interface io.netty.channel.socket.DuplexChannelConfig
    
    Specified by:
    
    setRecvByteBufAllocator in interface io.netty.channel.socket.SocketChannelConfig
    
    Overrides:
    
    setRecvByteBufAllocator in class KQueueChannelConfig
  - setAutoRead
```
public KQueueSocketChannelConfig setAutoRead(boolean autoRead)
```
    Specified by:
    
    setAutoRead in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setAutoRead in interface io.netty.channel.socket.DuplexChannelConfig
    
    Specified by:
    
    setAutoRead in interface io.netty.channel.socket.SocketChannelConfig
    
    Overrides:
    
    setAutoRead in class KQueueChannelConfig
  - setAutoClose
```
public KQueueSocketChannelConfig setAutoClose(boolean autoClose)
```
    Specified by:
    
    setAutoClose in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setAutoClose in interface io.netty.channel.socket.DuplexChannelConfig
    
    Specified by:
    
    setAutoClose in interface io.netty.channel.socket.SocketChannelConfig
    
    Overrides:
    
    setAutoClose in class io.netty.channel.DefaultChannelConfig
  - setWriteBufferHighWaterMark
```
@Deprecated
public KQueueSocketChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark)
```
    Deprecated.
    
    Specified by:
    
    setWriteBufferHighWaterMark in interface io.netty.channel.ChannelConfig
    
    Overrides:
    
    setWriteBufferHighWaterMark in class KQueueChannelConfig
  - setWriteBufferLowWaterMark
```
@Deprecated
public KQueueSocketChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark)
```
    Deprecated.
    
    Specified by:
    
    setWriteBufferLowWaterMark in interface io.netty.channel.ChannelConfig
    
    Overrides:
    
    setWriteBufferLowWaterMark in class KQueueChannelConfig
  - setWriteBufferWaterMark
```
public KQueueSocketChannelConfig setWriteBufferWaterMark(io.netty.channel.WriteBufferWaterMark writeBufferWaterMark)
```
    Specified by:
    
    setWriteBufferWaterMark in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setWriteBufferWaterMark in interface io.netty.channel.socket.DuplexChannelConfig
    
    Specified by:
    
    setWriteBufferWaterMark in interface io.netty.channel.socket.SocketChannelConfig
    
    Overrides:
    
    setWriteBufferWaterMark in class KQueueChannelConfig
  - setMessageSizeEstimator
```
public KQueueSocketChannelConfig setMessageSizeEstimator(io.netty.channel.MessageSizeEstimator estimator)
```
    Specified by:
    
    setMessageSizeEstimator in interface io.netty.channel.ChannelConfig
    
    Specified by:
    
    setMessageSizeEstimator in interface io.netty.channel.socket.DuplexChannelConfig
    
    Specified by:
    
    setMessageSizeEstimator in interface io.netty.channel.socket.SocketChannelConfig
    
    Overrides:
    
    setMessageSizeEstimator in class KQueueChannelConfig

Class KQueueSocketChannelConfig

Field Summary

Fields inherited from class io.netty.channel.DefaultChannelConfig

Method Summary

Methods inherited from class io.netty.channel.kqueue.KQueueChannelConfig

Methods inherited from class io.netty.channel.DefaultChannelConfig

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.ChannelConfig

Method Detail

getOptions

getOption

setOption

getReceiveBufferSize

getSendBufferSize

getSoLinger

getTrafficClass

isKeepAlive

isReuseAddress

isTcpNoDelay

getSndLowAt

setSndLowAt

isTcpNoPush

setTcpNoPush

setKeepAlive

setReceiveBufferSize

setReuseAddress

setSendBufferSize

setSoLinger

setTcpNoDelay

setTrafficClass

isAllowHalfClosure

setTcpFastOpenConnect

isTcpFastOpenConnect

setRcvAllocTransportProvidesGuess

setPerformancePreferences

setAllowHalfClosure

setConnectTimeoutMillis

setMaxMessagesPerRead

setWriteSpinCount

setAllocator

setRecvByteBufAllocator

setAutoRead

setAutoClose

setWriteBufferHighWaterMark

setWriteBufferLowWaterMark

setWriteBufferWaterMark

setMessageSizeEstimator