Package org.eclipse.microprofile.reactive.messaging

Annotation Interface OnOverflow

@Retention(RUNTIME) @Target({METHOD,CONSTRUCTOR,FIELD,PARAMETER}) public @interface OnOverflow
Configures the back pressure policy on an injected Emitter: 
 {
     @code
     @Channel("channel")
     @OnOverflow(value = OnOverflow.Strategy.BUFFER, bufferSize = 256)
     Emitter<String> emitter;
 }

When not used, a OnOverflow.Strategy.BUFFER strategy is used with a buffer limited to 128 elements.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    OnOverflow.Strategy
    The back pressure strategy.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    OnOverflow.Strategy
    value
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    long
    bufferSize
     

  • Element Details

    • bufferSize

      long bufferSize
      Returns:
      the size of the buffer when OnOverflow.Strategy.BUFFER is used. If not set and if the OnOverflow.Strategy.BUFFER strategy is used, the buffer size will be defaulted to the value of the config property mp.messaging.emitter.defult-buffer-size.
      Default:
      0L