Package org.eclipse.jetty.ee10.servlets

Interface EventSource.Emitter

All Known Implementing Classes:
EventSourceServlet.EventSourceEmitter
Enclosing interface:
EventSource
public static interface EventSource.Emitter

EventSource.Emitter is the active half of an event source connection, and allows applications to operate on the connection by sending events, data or comments, or by closing the connection.

An EventSource.Emitter instance will be created for each new event source connection.

EventSource.Emitter instances are fully thread safe and can be used from multiple threads.

  • 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.

  • Method Details

    • event

      void event(String name, String data) throws IOException

      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
      Parameters:
      name - the event name
      data - the data to be sent
      Throws:
      IOException - if an I/O failure occurred
      See Also:

    • data

      void data(String data) throws IOException

      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
      Parameters:
      data - the data to be sent
      Throws:
      IOException - if an I/O failure occurred

    • comment

      void comment(String comment) throws IOException

      Sends a comment to the client.

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

       : foo
      Parameters:
      comment - the comment to send
      Throws:
      IOException - if an I/O failure occurred

    • close

      void close()

      Closes this event source connection.