Package org.apache.cxf.jaxrs.sse

Class SseEventSinkImpl

java.lang.Object
org.apache.cxf.jaxrs.sse.SseEventSinkImpl
All Implemented Interfaces:
jakarta.ws.rs.sse.SseEventSink, AutoCloseable
public class SseEventSinkImpl extends Object implements jakarta.ws.rs.sse.SseEventSink

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    BUFFER_SIZE_PROPERTY
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    SseEventSinkImpl(jakarta.ws.rs.ext.MessageBodyWriter<jakarta.ws.rs.sse.OutboundSseEvent> writer, jakarta.ws.rs.container.AsyncResponse async, jakarta.servlet.AsyncContext ctx)
    Create new SseEventSink implementation with the default buffer size of 10000 SSE events.
    SseEventSinkImpl(jakarta.ws.rs.ext.MessageBodyWriter<jakarta.ws.rs.sse.OutboundSseEvent> writer, jakarta.ws.rs.container.AsyncResponse async, jakarta.servlet.AsyncContext ctx, int bufferSize)
    Create new SseEventSink implementation with the configurable SSE events buffer size.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
     
    jakarta.servlet.AsyncContext
    getAsyncContext()
     
    boolean
    isClosed()
     
    CompletionStage<?>
    send(jakarta.ws.rs.sse.OutboundSseEvent event)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

    • SseEventSinkImpl

      public SseEventSinkImpl(jakarta.ws.rs.ext.MessageBodyWriter<jakarta.ws.rs.sse.OutboundSseEvent> writer, jakarta.ws.rs.container.AsyncResponse async, jakarta.servlet.AsyncContext ctx)
      Create new SseEventSink implementation with the default buffer size of 10000 SSE events.
      Parameters:
      writer - message body writer
      async - asynchronous response
      ctx - asynchronous context

    • SseEventSinkImpl

      public SseEventSinkImpl(jakarta.ws.rs.ext.MessageBodyWriter<jakarta.ws.rs.sse.OutboundSseEvent> writer, jakarta.ws.rs.container.AsyncResponse async, jakarta.servlet.AsyncContext ctx, int bufferSize)
      Create new SseEventSink implementation with the configurable SSE events buffer size.
      Parameters:
      writer - message body writer
      async - asynchronous response
      ctx - asynchronous context
      bufferSize - SSE events buffer size

  • Method Details

    • getAsyncContext

      public jakarta.servlet.AsyncContext getAsyncContext()

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface jakarta.ws.rs.sse.SseEventSink

    • isClosed

      public boolean isClosed()
      Specified by:
      isClosed in interface jakarta.ws.rs.sse.SseEventSink

    • send

      public CompletionStage<?> send(jakarta.ws.rs.sse.OutboundSseEvent event)
      Specified by:
      send in interface jakarta.ws.rs.sse.SseEventSink