ch.ralscha.extdirectspring.controller

Class SSEWriter

java.lang.Object

ch.ralscha.extdirectspring.controller.SSEWriter

public class SSEWriter
extends Object

This class allows you to send server sent events in a streaming fashion. Add this class as a parameter to the method and send SSEvent with write(SSEvent) to the client.

Example:

  @ExtDirectMethod(ExtDirectMethodType.SSE)
  public void sse(SSEWriter sseWriter) {
    SSEvent event = new SSEvent();
    event.set....           
    sseWriter.write(event);
    //do something else or wait for something or ...
    sseWriter.write(event);
    //...
  }
 

Constructor Summary

Constructors

Constructor and Description
SSEWriter(javax.servlet.http.HttpServletResponse response)

Method Summary

Methods

Modifier and Type	Method and Description
void	write(Object data) Creates a SSEvent object and sets the data property to the provided parameter.
void	write(SSEvent sseEvent) Writes the event into the servlet output stream and flushes the response.

Methods inherited from class java.lang.Object

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

Constructor Detail

SSEWriter

public SSEWriter(javax.servlet.http.HttpServletResponse response)

Method Detail

write

public void write(Object data)
           throws IOException

Creates a SSEvent object and sets the data property to the provided parameter. Then it writes the event into the servlet output stream and flushes the response.

Parameters:

data - the value that becomes the data part of the SSEvent. If null nothing is written.

Throws:

IOException

write

public void write(SSEvent sseEvent)
           throws IOException

Writes the event into the servlet output stream and flushes the response. The method does not close the output stream.

Parameters:

sseEvent - the event object

Throws:

IOException