Package io.smallrye.reactive.messaging

Interface PausableChannelConfiguration

public interface PausableChannelConfiguration
A channel that can be paused and resumed.

  • Field Details

    • PAUSABLE_PROPERTY

      static final String PAUSABLE_PROPERTY
      The name of the property to configure whether the channel is pausable.
      See Also:

    • PAUSED_PROPERTY

      static final String PAUSED_PROPERTY
      Deprecated.
      use INITIALLY_PAUSED_PROPERTY instead
      The name of the property to configure whether the channel is initially paused.
      See Also:

    • INITIALLY_PAUSED_PROPERTY

      static final String INITIALLY_PAUSED_PROPERTY
      The name of the property to configure whether the channel is initially paused.
      See Also:

    • BUFFER_SIZE_PROPERTY

      static final String BUFFER_SIZE_PROPERTY
      The name of the property to configure the buffer size.
      See Also:

    • LATE_SUBSCRIPTION_PROPERTY

      static final String LATE_SUBSCRIPTION_PROPERTY
      The name of the property to configure whether late subscribers should receive buffered messages.
      See Also:

    • BUFFER_STRATEGY_PROPERTY

      static final String BUFFER_STRATEGY_PROPERTY
      The name of the property to configure the buffer strategy.
      See Also:

  • Method Details

    • name

      String name()
      The name of the channel.

    • initiallyPaused

      boolean initiallyPaused()
      Whether the channel is paused at subscribe time. Default is false.

    • bufferSize

      Integer bufferSize()
      The maximum buffer size for buffered items when the channel is paused.

    • lateSubscription

      boolean lateSubscription()
      Whether the subscription is done after the channel is paused. Default is false.

    • bufferStrategy

      PausableChannelConfiguration.PausableBufferStrategy bufferStrategy()
      The buffer strategy if previously requested items are received when the channel is paused. Default is PausableChannelConfiguration.PausableBufferStrategy.BUFFER.