Class EpollDomainSocketChannelConfig

Field Summary

Method Summary

Method Details

• getOptions

  public Map<ChannelOption<?>, Object> getOptions()

  Description copied from interface: ChannelConfig

  Return all set ChannelOption's.

  Specified by:

  getOptions in interface ChannelConfig

  Overrides:

  getOptions in class EpollChannelConfig

• 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 EpollChannelConfig

• 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 EpollChannelConfig

  Returns:

  true if and only if the property has been set

• setMaxMessagesPerRead

  @Deprecated public EpollDomainSocketChannelConfig 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 EpollChannelConfig

• setConnectTimeoutMillis

  public EpollDomainSocketChannelConfig 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 EpollChannelConfig

  Parameters:

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

• setWriteSpinCount

  public EpollDomainSocketChannelConfig 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 EpollChannelConfig

• setRecvByteBufAllocator

  public EpollDomainSocketChannelConfig 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 EpollChannelConfig

• setAllocator

  public EpollDomainSocketChannelConfig 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 EpollChannelConfig

• setAutoClose

  public EpollDomainSocketChannelConfig 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 EpollDomainSocketChannelConfig 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 EpollChannelConfig

• setWriteBufferLowWaterMark

  @Deprecated public EpollDomainSocketChannelConfig 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 EpollChannelConfig

• setWriteBufferHighWaterMark

  @Deprecated public EpollDomainSocketChannelConfig 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 EpollChannelConfig

• setWriteBufferWaterMark

  public EpollDomainSocketChannelConfig 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 EpollChannelConfig

• setAutoRead

  public EpollDomainSocketChannelConfig 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 EpollChannelConfig

• setEpollMode

  public EpollDomainSocketChannelConfig setEpollMode(EpollMode mode)

  Description copied from class: EpollChannelConfig

  Set the EpollMode used. Default is EpollMode.EDGE_TRIGGERED. If you want to use DefaultChannelConfig.isAutoRead() false or DefaultChannelConfig.getMaxMessagesPerRead() and have an accurate behaviour you should use EpollMode.LEVEL_TRIGGERED. Be aware this config setting can only be adjusted before the channel was registered.

  Overrides:

  setEpollMode in class EpollChannelConfig

• setReadMode

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

• 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 EpollDomainSocketChannelConfig 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

• getSendBufferSize

  public int getSendBufferSize()

• setSendBufferSize

  public EpollDomainSocketChannelConfig setSendBufferSize(int sendBufferSize)

• getReceiveBufferSize

  public int getReceiveBufferSize()

• setReceiveBufferSize

  public EpollDomainSocketChannelConfig setReceiveBufferSize(int receiveBufferSize)