Package io.netty.channel.kqueue

Class KQueueDomainSocketChannelConfig

java.lang.Object

io.netty.channel.DefaultChannelConfig

io.netty.channel.kqueue.KQueueChannelConfig

io.netty.channel.kqueue.KQueueDomainSocketChannelConfig

All Implemented Interfaces:

ChannelConfig, DuplexChannelConfig, DomainSocketChannelConfig

public final class KQueueDomainSocketChannelConfig
extends KQueueChannelConfig
implements DomainSocketChannelConfig, DuplexChannelConfig

Field Summary

Fields inherited from class io.netty.channel.DefaultChannelConfig

channel

Method Summary

Modifier and Type	Method	Description
<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.
DomainSocketReadMode	getReadMode()	Return the DomainSocketReadMode for the channel.
int	getReceiveBufferSize()
int	getSendBufferSize()
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.
KQueueDomainSocketChannelConfig	setAllocator(ByteBufAllocator allocator)	Set the ByteBufAllocator which is used for the channel to allocate buffers.
KQueueDomainSocketChannelConfig	setAllowHalfClosure(boolean allowHalfClosure)	Sets whether the channel should not close itself when its remote peer shuts down output to make the connection half-closed.
KQueueDomainSocketChannelConfig	setAutoClose(boolean autoClose)	Sets whether the Channel should be closed automatically and immediately on write failure.
KQueueDomainSocketChannelConfig	setAutoRead(boolean autoRead)	Sets if ChannelHandlerContext.read() will be invoked automatically so that a user application doesn't need to call it at all.
KQueueDomainSocketChannelConfig	setConnectTimeoutMillis(int connectTimeoutMillis)	Sets the connect timeout of the channel in milliseconds.
KQueueDomainSocketChannelConfig	setMaxMessagesPerRead(int maxMessagesPerRead)	Deprecated.
KQueueDomainSocketChannelConfig	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.
KQueueDomainSocketChannelConfig	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.
KQueueDomainSocketChannelConfig	setReadMode(DomainSocketReadMode mode)	Change the DomainSocketReadMode for the channel.
KQueueDomainSocketChannelConfig	setReceiveBufferSize(int receiveBufferSize)
KQueueDomainSocketChannelConfig	setRecvByteBufAllocator(RecvByteBufAllocator allocator)	Set the RecvByteBufAllocator which is used for the channel to allocate receive buffers.
KQueueDomainSocketChannelConfig	setSendBufferSize(int sendBufferSize)
KQueueDomainSocketChannelConfig	setWriteBufferHighWaterMark(int writeBufferHighWaterMark)	Deprecated.
KQueueDomainSocketChannelConfig	setWriteBufferLowWaterMark(int writeBufferLowWaterMark)	Deprecated.
KQueueDomainSocketChannelConfig	setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)	Set the WriteBufferWaterMark which is used for setting the high and low water mark of the write buffer.
KQueueDomainSocketChannelConfig	setWriteSpinCount(int writeSpinCount)	Sets the maximum loop count for a write operation until WritableByteChannel.write(ByteBuffer) returns a non-zero value.

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 java.util.Map<ChannelOption<?>,java.lang.Object> getOptions()

Description copied from interface: ChannelConfig

Return all set ChannelOption's.

Specified by:

getOptions in interface ChannelConfig

Overrides:

getOptions in class KQueueChannelConfig

getOption

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

Description copied from interface: ChannelConfig

Return the value of the given ChannelOption

Specified by:

getOption in interface ChannelConfig

Overrides:

getOption in class KQueueChannelConfig

setOption

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

Description copied from interface: 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;
 }
 

Specified by:

setOption in interface ChannelConfig

Overrides:

setOption in class KQueueChannelConfig

Returns:

true if and only if the property has been set

setRcvAllocTransportProvidesGuess

public KQueueDomainSocketChannelConfig 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

setMaxMessagesPerRead

@Deprecated
public KQueueDomainSocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead)

Deprecated.

Description copied from class: DefaultChannelConfig

Specified by:

setMaxMessagesPerRead in interface ChannelConfig

Specified by:

setMaxMessagesPerRead in interface DomainSocketChannelConfig

Specified by:

setMaxMessagesPerRead in interface DuplexChannelConfig

Overrides:

setMaxMessagesPerRead in class KQueueChannelConfig

setConnectTimeoutMillis

public KQueueDomainSocketChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis)

Description copied from interface: 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.

Specified by:

setConnectTimeoutMillis in interface ChannelConfig

Specified by:

setConnectTimeoutMillis in interface DomainSocketChannelConfig

Overrides:

setConnectTimeoutMillis in class KQueueChannelConfig

Parameters:

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

setWriteSpinCount

public KQueueDomainSocketChannelConfig setWriteSpinCount(int writeSpinCount)

Description copied from interface: 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.

Specified by:

setWriteSpinCount in interface ChannelConfig

Specified by:

setWriteSpinCount in interface DomainSocketChannelConfig

Specified by:

setWriteSpinCount in interface DuplexChannelConfig

Overrides:

setWriteSpinCount in class KQueueChannelConfig

setRecvByteBufAllocator

public KQueueDomainSocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator)

Description copied from interface: ChannelConfig

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

Specified by:

setRecvByteBufAllocator in interface ChannelConfig

Specified by:

setRecvByteBufAllocator in interface DomainSocketChannelConfig

Specified by:

setRecvByteBufAllocator in interface DuplexChannelConfig

Overrides:

setRecvByteBufAllocator in class KQueueChannelConfig

setAllocator

public KQueueDomainSocketChannelConfig setAllocator(ByteBufAllocator allocator)

Description copied from interface: ChannelConfig

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

Specified by:

setAllocator in interface ChannelConfig

Specified by:

setAllocator in interface DomainSocketChannelConfig

Specified by:

setAllocator in interface DuplexChannelConfig

Overrides:

setAllocator in class KQueueChannelConfig

setAutoClose

public KQueueDomainSocketChannelConfig setAutoClose(boolean autoClose)

Description copied from interface: ChannelConfig

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

Specified by:

setAutoClose in interface ChannelConfig

Specified by:

setAutoClose in interface DomainSocketChannelConfig

Specified by:

setAutoClose in interface DuplexChannelConfig

Overrides:

setAutoClose in class DefaultChannelConfig

setMessageSizeEstimator

public KQueueDomainSocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator)

Description copied from interface: ChannelConfig

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

Specified by:

setMessageSizeEstimator in interface ChannelConfig

Specified by:

setMessageSizeEstimator in interface DomainSocketChannelConfig

Specified by:

setMessageSizeEstimator in interface DuplexChannelConfig

Overrides:

setMessageSizeEstimator in class KQueueChannelConfig

setWriteBufferLowWaterMark

@Deprecated
public KQueueDomainSocketChannelConfig 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 return true again.

Specified by:

setWriteBufferLowWaterMark in interface ChannelConfig

Specified by:

setWriteBufferLowWaterMark in interface DomainSocketChannelConfig

Overrides:

setWriteBufferLowWaterMark in class KQueueChannelConfig

setWriteBufferHighWaterMark

@Deprecated
public KQueueDomainSocketChannelConfig 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 return false.

Specified by:

setWriteBufferHighWaterMark in interface ChannelConfig

Specified by:

setWriteBufferHighWaterMark in interface DomainSocketChannelConfig

Overrides:

setWriteBufferHighWaterMark in class KQueueChannelConfig

setWriteBufferWaterMark

public KQueueDomainSocketChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark)

Description copied from interface: ChannelConfig

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

Specified by:

setWriteBufferWaterMark in interface ChannelConfig

Specified by:

setWriteBufferWaterMark in interface DomainSocketChannelConfig

Specified by:

setWriteBufferWaterMark in interface DuplexChannelConfig

Overrides:

setWriteBufferWaterMark in class KQueueChannelConfig

setAutoRead

public KQueueDomainSocketChannelConfig setAutoRead(boolean autoRead)

Description copied from interface: 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.

Specified by:

setAutoRead in interface ChannelConfig

Specified by:

setAutoRead in interface DomainSocketChannelConfig

Specified by:

setAutoRead in interface DuplexChannelConfig

Overrides:

setAutoRead in class KQueueChannelConfig

setReadMode

public KQueueDomainSocketChannelConfig setReadMode(DomainSocketReadMode mode)

Description copied from interface: DomainSocketChannelConfig

Change the DomainSocketReadMode for the channel. The default is DomainSocketReadMode.BYTES which means bytes will be read from the Channel and passed through the pipeline. If DomainSocketReadMode.FILE_DESCRIPTORS is used FileDescriptors will be passed through the ChannelPipeline. This setting can be modified on the fly if needed.

Specified by:

setReadMode in interface DomainSocketChannelConfig

getReadMode

public DomainSocketReadMode getReadMode()

Description copied from interface: DomainSocketChannelConfig

Return the DomainSocketReadMode for the channel.

Specified by:

getReadMode in interface DomainSocketChannelConfig

getSendBufferSize

public int getSendBufferSize()

setSendBufferSize

public KQueueDomainSocketChannelConfig setSendBufferSize(int sendBufferSize)

getReceiveBufferSize

public int getReceiveBufferSize()

setReceiveBufferSize

public KQueueDomainSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)

isAllowHalfClosure

public boolean isAllowHalfClosure()

Description copied from interface: 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.

Specified by:

isAllowHalfClosure in interface DuplexChannelConfig

setAllowHalfClosure

public KQueueDomainSocketChannelConfig setAllowHalfClosure(boolean allowHalfClosure)

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

Specified by:

setAllowHalfClosure in interface DuplexChannelConfig