Module org.eclipse.jetty.ee10.servlets

Package org.eclipse.jetty.ee10.servlets

Class EventSourceServlet.EventSourceEmitter

java.lang.Object

org.eclipse.jetty.ee10.servlets.EventSourceServlet.EventSourceEmitter

All Implemented Interfaces:

Runnable, EventSource.Emitter

Enclosing class:

EventSourceServlet

protected class EventSourceServlet.EventSourceEmitter
extends Object
implements EventSource.Emitter, Runnable

Constructor Summary

Constructors

Constructor	Description
EventSourceEmitter(EventSource eventSource, jakarta.servlet.AsyncContext async)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this event source connection.
void	comment(String comment)	Sends a comment to the client.
void	data(String data)	Sends a default event with data to the client.
void	event(String name, String data)	Sends a named event with data to the client.
protected void	flush()
void	run()

Methods inherited from class java.lang.Object

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

Constructor Details

EventSourceEmitter

public EventSourceEmitter(EventSource eventSource,
 jakarta.servlet.AsyncContext async)
                   throws IOException

Throws:

IOException

Method Details

event

public void event(String name,
 String data)
           throws IOException

Description copied from interface: EventSource.Emitter

Sends a named event with data to the client.

When invoked as: event("foo", "bar"), the client will receive the lines:

 event: foo
 data: bar
 

Specified by:

event in interface EventSource.Emitter

Parameters:

name - the event name

data - the data to be sent

Throws:

IOException - if an I/O failure occurred

See Also:

• EventSource.Emitter.data(String)

data

public void data(String data)
          throws IOException

Description copied from interface: EventSource.Emitter

Sends a default event with data to the client.

When invoked as: data("baz"), the client will receive the line:

 data: baz
 

When invoked as: data("foo\r\nbar\rbaz\nbax"), the client will receive the lines:

 data: foo
 data: bar
 data: baz
 data: bax
 

Specified by:

data in interface EventSource.Emitter

Parameters:

data - the data to be sent

Throws:

IOException - if an I/O failure occurred

comment

public void comment(String comment)
             throws IOException

Description copied from interface: EventSource.Emitter

Sends a comment to the client.

When invoked as: comment("foo"), the client will receive the line:

 : foo
 

Specified by:

comment in interface EventSource.Emitter

Parameters:

comment - the comment to send

Throws:

IOException - if an I/O failure occurred

run

public void run()

Specified by:

run in interface Runnable

flush

protected void flush()
              throws IOException

Throws:

IOException

close

public void close()

Description copied from interface: EventSource.Emitter

Closes this event source connection.

Specified by:

close in interface EventSource.Emitter