org.glassfish.sse.api

Class ServerSentEventConnection

java.lang.Object

org.glassfish.sse.api.ServerSentEventConnection

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class ServerSentEventConnection
extends Object
implements Closeable

Represents a Server-Sent Event connection for sending push notifications

Author:

Jitendra Kotamraju

Constructor Summary

Constructors

Constructor and Description
ServerSentEventConnection()

Method Summary

Modifier and Type	Method and Description
abstract void	close() Closes the connection
String	getLastEventID() Event source's last event ID.
abstract javax.servlet.http.HttpServletRequest	getRequest() Servlet request for Server-Sent Event connection
abstract void	sendMessage(ServerSentEventData eventData) Sends the Server-Sent event to client
abstract void	sendMessage(String eventData) Sends the Server-Sent event to client

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerSentEventConnection

public ServerSentEventConnection()

Method Detail

getRequest

public abstract javax.servlet.http.HttpServletRequest getRequest()

Servlet request for Server-Sent Event connection

Returns:

servlet request

getLastEventID

public String getLastEventID()

Event source's last event ID.

Returns:

null if there is no HTTP header in the request otherwise, last event ID

sendMessage

public abstract void sendMessage(String eventData)
                          throws IOException

Sends the Server-Sent event to client

Parameters:

eventData - Server-Sent event data

Throws:

IOException - when there is an error in sending

IllegalStateException - when called after calling close method

See Also:

ServerSentEventData

sendMessage

public abstract void sendMessage(ServerSentEventData eventData)
                          throws IOException

Sends the Server-Sent event to client

Parameters:

eventData - Server-Sent event data

Throws:

IOException - when there is an error in sending

IllegalStateException - when called after calling close method

See Also:

ServerSentEventData

close

public abstract void close()

Closes the connection

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable