Modifier and Type	Class and Description
public static interface	ServerSentEventConnection.EventCallback
private static class	ServerSentEventConnection.SSEData
private class	ServerSentEventConnection.SseWriteListener

Modifier and Type	Field and Description
private final Queue<ServerSentEventConnection.SSEData>	buffered
private final List<ChannelListener<ServerSentEventConnection>>	closeTasks
private final HttpServerExchange	exchange
private final Queue<ServerSentEventConnection.SSEData>	flushingMessages Messages that have been written to the channel but flush() has failed
private volatile long	keepAliveTime
private volatile int	open
private static final AtomicIntegerFieldUpdater<ServerSentEventConnection>	openUpdater
private Map<String, String>	parameters
private PooledByteBuffer	pooled
private Map<String, Object>	properties
private final Deque<ServerSentEventConnection.SSEData>	queue
private volatile boolean	shutdown
private final StreamSinkChannel	sink
private XnioExecutor.Key	timerKey
private final ServerSentEventConnection.SseWriteListener	writeListener

Access	Constructor and Description
public	ServerSentEventConnection(HttpServerExchange exchange, StreamSinkChannel sink)

Method Summary

Modifier and Type	Method and Description
public synchronized void	addCloseTask(ChannelListener<ServerSentEventConnection> The listener to invoke listener) Adds a listener that will be invoked when the channel is closed
public <T> void	addToAttachmentList(AttachmentKey<AttachmentList<T>> the attachment key key, T the value to add value) Implements io.undertow.util.Attachable.addToAttachmentList. Add a value to a list-typed attachment key.
public void	close() Implements java.nio.channels.Channel.close. Closes this channel.
private synchronized void	close(IOException e)
private void	fillBuffer()
public Account	Returns: The account that was associated with the SSE request getAccount()
public <T> T	getAttachment(AttachmentKey<T> the attachment key key) Implements io.undertow.util.Attachable.getAttachment. Get an attachment value.
public <T> List<T>	getAttachmentList(AttachmentKey<? extends List<T>> the attachment key key) Implements io.undertow.util.Attachable.getAttachmentList. Gets a list attachment value.
public long	Returns: The keep alive time getKeepAliveTime()
public String	getParameter(String name)
public Principal	Returns: The principal that was associated with the SSE request getPrincipal()
public Map<String, Object>	getProperties()
public Map<String, Deque<String>>	Returns: the query parameters getQueryParameters()
public String	Returns: the query string getQueryString()
public HeaderMap	Returns: The request headers from the initial request that opened this connection getRequestHeaders()
public String	Returns: The request URI from the initial request that opened this connection getRequestURI()
public HeaderMap	Returns: The response headers from the initial request that opened this connection getResponseHeaders()
private void	handleException(IOException e)
public boolean	isOpen() Implements java.nio.channels.Channel.isOpen. Tells whether or not this channel is open.
public <T> T	putAttachment(AttachmentKey<T> the attachment key key, T the new value value) Implements io.undertow.util.Attachable.putAttachment. Set an attachment value.
public <T> T	removeAttachment(AttachmentKey<T> the attachment key key) Implements io.undertow.util.Attachable.removeAttachment. Remove an attachment, returning its previous value.
public void	send(String The event data data) Sends an event to the remote client
public void	send(String The event data data, ServerSentEventConnection.EventCallback A callback that is notified on Success or failure callback) Sends an event to the remote client
public synchronized void	send(String The event data data, String The event name event, String The event ID id, ServerSentEventConnection.EventCallback A callback that is notified on Success or failure callback) Sends an event to the remote client
public void	sendRetry(long The retry time in milliseconds retry) Sends the 'retry' message to the client, instructing it how long to wait before attempting a reconnect.
public synchronized void	sendRetry(long The retry time in milliseconds retry, ServerSentEventConnection.EventCallback The callback that is notified on success or failure callback) Sends the 'retry' message to the client, instructing it how long to wait before attempting a reconnect.
public void	setKeepAliveTime(long The time in milliseconds between keep alive messaged keepAliveTime) Sets the keep alive time in milliseconds.
public void	setParameter(String name, String value)
public void	shutdown() execute a graceful shutdown once all data has been sent

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

buffered	back to summary
private final Queue<ServerSentEventConnection.SSEData> buffered

closeTasks	back to summary
private final List<ChannelListener<ServerSentEventConnection>> closeTasks

exchange	back to summary
private final HttpServerExchange exchange

flushingMessages	back to summary
private final Queue<ServerSentEventConnection.SSEData> flushingMessages Messages that have been written to the channel but flush() has failed

keepAliveTime	back to summary
private volatile long keepAliveTime

open	back to summary
private volatile int open

openUpdater	back to summary
private static final AtomicIntegerFieldUpdater<ServerSentEventConnection> openUpdater

parameters	back to summary
private Map<String, String> parameters

pooled	back to summary
private PooledByteBuffer pooled

properties	back to summary
private Map<String, Object> properties

queue	back to summary
private final Deque<ServerSentEventConnection.SSEData> queue

shutdown	back to summary
private volatile boolean shutdown

sink	back to summary
private final StreamSinkChannel sink

timerKey	back to summary
private XnioExecutor.Key timerKey

writeListener	back to summary
private final ServerSentEventConnection.SseWriteListener writeListener

Constructor Detail

ServerSentEventConnection	back to summary
public ServerSentEventConnection(HttpServerExchange exchange, StreamSinkChannel sink)

Method Detail

addCloseTask	back to summary
public synchronized void addCloseTask(ChannelListener<ServerSentEventConnection> listener) Adds a listener that will be invoked when the channel is closed Parameters listener:ChannelListener<ServerSentEventConnection> The listener to invoke

addCloseTask

back to summary

public synchronized void addCloseTask(ChannelListener<ServerSentEventConnection> listener)

Adds a listener that will be invoked when the channel is closed

Parameters

listener:ChannelListener<ServerSentEventConnection>: The listener to invoke

addToAttachmentList	back to summary
public <T> void addToAttachmentList(AttachmentKey<AttachmentList<T>> key, T value) Implements io.undertow.util.Attachable.addToAttachmentList. Doc from io.undertow.util.Attachable.addToAttachmentList. Add a value to a list-typed attachment key. If the key is not mapped, add such a mapping. Parameters <T> the list value type key:AttachmentKey<AttachmentList<T>> the attachment key value:T the value to add Annotations @Override

addToAttachmentList

back to summary

public <T> void addToAttachmentList(AttachmentKey<AttachmentList<T>> key, T value)

Implements io.undertow.util.Attachable.addToAttachmentList.

Doc from io.undertow.util.Attachable.addToAttachmentList.

Add a value to a list-typed attachment key. If the key is not mapped, add such a mapping.

Parameters

<T>: the list value type
key:AttachmentKey<AttachmentList<T>>: the attachment key
value:T: the value to add

Annotations

@Override

close back to summary

close	back to summary
public void close() throws IOException Implements java.nio.channels.Channel.close. Doc from java.nio.channels.Channel.close. Closes this channel. After a channel is closed, any further attempt to invoke I/O operations upon it will cause a `ClosedChannelException` to be thrown. If this channel is already closed then invoking this method has no effect. This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect. Annotations @Override Exceptions IOException: If an I/O error occurs

public void close() throws IOException

Implements java.nio.channels.Channel.close.

Doc from java.nio.channels.Channel.close.

Closes this channel.

After a channel is closed, any further attempt to invoke I/O operations upon it will cause a ClosedChannelException to be thrown.

If this channel is already closed then invoking this method has no effect.

This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

close	back to summary
private synchronized void close(IOException e) throws IOException

fillBuffer	back to summary
private void fillBuffer()

getAccount	back to summary
public Account getAccount() Returns:Account The account that was associated with the SSE request

getAttachment back to summary

getAttachment	back to summary
public <T> T getAttachment(AttachmentKey<T> key) Implements io.undertow.util.Attachable.getAttachment. Doc from io.undertow.util.Attachable.getAttachment. Get an attachment value. If no attachment exists for this key, `null` is returned. Parameters <T> the value type key:AttachmentKey<T> the attachment key Returns:T the value, or `null` if there is none Annotations @Override

public <T> T getAttachment(AttachmentKey<T> key)

Implements io.undertow.util.Attachable.getAttachment.

Doc from io.undertow.util.Attachable.getAttachment.

Get an attachment value. If no attachment exists for this key, null is returned.

Parameters

<T>: the value type
key:AttachmentKey<T>: the attachment key

Returns:T

the value, or null if there is none

Annotations

@Override

getAttachmentList	back to summary
public <T> List<T> getAttachmentList(AttachmentKey<? extends List<T>> key) Implements io.undertow.util.Attachable.getAttachmentList. Doc from io.undertow.util.Attachable.getAttachmentList. Gets a list attachment value. If not attachment exists for this key an empty list is returned Parameters <T> the value type key:AttachmentKey<? extends List<T>> the attachment key Returns:List<T> the value, or an empty list if there is none Annotations @Override

getAttachmentList

back to summary

public <T> List<T> getAttachmentList(AttachmentKey<? extends List<T>> key)

Implements io.undertow.util.Attachable.getAttachmentList.

Doc from io.undertow.util.Attachable.getAttachmentList.

Gets a list attachment value. If not attachment exists for this key an empty list is returned

Parameters

<T>: the value type
key:AttachmentKey<? extends List<T>>: the attachment key

Returns:List<T>

the value, or an empty list if there is none

Annotations

@Override

getKeepAliveTime	back to summary
public long getKeepAliveTime() Returns:long The keep alive time

getParameter	back to summary
public String getParameter(String name)

getPrincipal	back to summary
public Principal getPrincipal() Returns:Principal The principal that was associated with the SSE request

getProperties	back to summary
public Map<String, Object> getProperties()

getQueryParameters	back to summary
public Map<String, Deque<String>> getQueryParameters() Returns:Map<String, Deque<String>> the query parameters

getQueryString	back to summary
public String getQueryString() Returns:String the query string

getRequestHeaders	back to summary
public HeaderMap getRequestHeaders() Returns:HeaderMap The request headers from the initial request that opened this connection

getRequestURI	back to summary
public String getRequestURI() Returns:String The request URI from the initial request that opened this connection

getResponseHeaders	back to summary
public HeaderMap getResponseHeaders() Returns:HeaderMap The response headers from the initial request that opened this connection

handleException	back to summary
private void handleException(IOException e)

isOpen back to summary

isOpen	back to summary
public boolean isOpen() Implements java.nio.channels.Channel.isOpen. Doc from java.nio.channels.Channel.isOpen. Tells whether or not this channel is open. Returns:boolean `true` if, and only if, this channel is open Annotations @Override

public boolean isOpen()

Implements java.nio.channels.Channel.isOpen.

Doc from java.nio.channels.Channel.isOpen.

Tells whether or not this channel is open.

Returns:boolean

true if, and only if, this channel is open

Annotations

@Override

putAttachment back to summary

putAttachment	back to summary
public <T> T putAttachment(AttachmentKey<T> key, T value) Implements io.undertow.util.Attachable.putAttachment. Doc from io.undertow.util.Attachable.putAttachment. Set an attachment value. If an attachment for this key was already set, return the original value. If the value being set is `null`, the attachment key is removed. Parameters <T> the value type key:AttachmentKey<T> the attachment key value:T the new value Returns:T the old value, or `null` if there was none Annotations @Override

public <T> T putAttachment(AttachmentKey<T> key, T value)

Implements io.undertow.util.Attachable.putAttachment.

Doc from io.undertow.util.Attachable.putAttachment.

Set an attachment value. If an attachment for this key was already set, return the original value. If the value being set is null, the attachment key is removed.

Parameters

<T>: the value type
key:AttachmentKey<T>: the attachment key
value:T: the new value

Returns:T

the old value, or null if there was none

Annotations

@Override

removeAttachment back to summary

removeAttachment	back to summary
public <T> T removeAttachment(AttachmentKey<T> key) Implements io.undertow.util.Attachable.removeAttachment. Doc from io.undertow.util.Attachable.removeAttachment. Remove an attachment, returning its previous value. Parameters <T> the value type key:AttachmentKey<T> the attachment key Returns:T the old value, or `null` if there was none Annotations @Override

public <T> T removeAttachment(AttachmentKey<T> key)

Implements io.undertow.util.Attachable.removeAttachment.

Doc from io.undertow.util.Attachable.removeAttachment.

Remove an attachment, returning its previous value.

Parameters

<T>: the value type
key:AttachmentKey<T>: the attachment key

Returns:T

the old value, or null if there was none

Annotations

@Override

send	back to summary
public void send(String data) Sends an event to the remote client Parameters data:String The event data

send

back to summary

public void send(String data)

Sends an event to the remote client

Parameters

data:String: The event data

send	back to summary
public void send(String data, ServerSentEventConnection.EventCallback callback) Sends an event to the remote client Parameters data:String The event data callback:ServerSentEventConnection.EventCallback A callback that is notified on Success or failure

send

back to summary

public void send(String data, ServerSentEventConnection.EventCallback callback)

Sends an event to the remote client

Parameters

data:String: The event data
callback:ServerSentEventConnection.EventCallback: A callback that is notified on Success or failure

send	back to summary
public synchronized void send(String data, String event, String id, ServerSentEventConnection.EventCallback callback) Sends an event to the remote client Parameters data:String The event data event:String The event name id:String The event ID callback:ServerSentEventConnection.EventCallback A callback that is notified on Success or failure

send

back to summary

public synchronized void send(String data, String event, String id, ServerSentEventConnection.EventCallback callback)

Sends an event to the remote client

Parameters

data:String: The event data
event:String: The event name
id:String: The event ID
callback:ServerSentEventConnection.EventCallback: A callback that is notified on Success or failure

sendRetry	back to summary
public void sendRetry(long retry) Sends the 'retry' message to the client, instructing it how long to wait before attempting a reconnect. Parameters retry:long The retry time in milliseconds

sendRetry

back to summary

public void sendRetry(long retry)

Sends the 'retry' message to the client, instructing it how long to wait before attempting a reconnect.

Parameters

retry:long: The retry time in milliseconds

sendRetry	back to summary
public synchronized void sendRetry(long retry, ServerSentEventConnection.EventCallback callback) Sends the 'retry' message to the client, instructing it how long to wait before attempting a reconnect. Parameters retry:long The retry time in milliseconds callback:ServerSentEventConnection.EventCallback The callback that is notified on success or failure

sendRetry

back to summary

public synchronized void sendRetry(long retry, ServerSentEventConnection.EventCallback callback)

Sends the 'retry' message to the client, instructing it how long to wait before attempting a reconnect.

Parameters

retry:long: The retry time in milliseconds
callback:ServerSentEventConnection.EventCallback: The callback that is notified on success or failure

setKeepAliveTime	back to summary
public void setKeepAliveTime(long keepAliveTime) Sets the keep alive time in milliseconds. If this is larger than zero a ':' message will be sent this often (assuming there is no activity) to keep the connection alive. The spec recommends a value of 15000 (15 seconds). Parameters keepAliveTime:long The time in milliseconds between keep alive messaged

setKeepAliveTime

back to summary

public void setKeepAliveTime(long keepAliveTime)

Sets the keep alive time in milliseconds. If this is larger than zero a ':' message will be sent this often (assuming there is no activity) to keep the connection alive. The spec recommends a value of 15000 (15 seconds).

Parameters

keepAliveTime:long: The time in milliseconds between keep alive messaged

setParameter	back to summary
public void setParameter(String name, String value)

shutdown	back to summary
public void shutdown() execute a graceful shutdown once all data has been sent

io.undertow.server.handlers.sse back to summary

public Interface ServerSentEventConnection.EventCallback

Method Summary

Modifier and Type	Method and Description
public void	done(ServerSentEventConnection The connection connection, String The message data data, String The message event event, String The message id id) Notification that is called when a message is sucessfully sent
public void	failed(ServerSentEventConnection The connection connection, String The message data data, String The message event event, String The message id id, IOException The exception e) Notification that is called when a message send fails.

Method Detail

done

back to summary

public void done(ServerSentEventConnection connection, String data, String event, String id)

Notification that is called when a message is sucessfully sent

Parameters

connection:ServerSentEventConnection: The connection
data:String: The message data
event:String: The message event
id:String: The message id

failed

back to summary

public void failed(ServerSentEventConnection connection, String data, String event, String id, IOException e)

Notification that is called when a message send fails.

Parameters

connection:ServerSentEventConnection: The connection
data:String: The message data
event:String: The message event
id:String: The message id
e:IOException: The exception

io.undertow.server.handlers.sse back to summary

private Class ServerSentEventConnection.SSEData

Class Inheritance

extends Object

java.lang.Object
io.undertow.server.handlers.sse.ServerSentEventConnection.SSEData

Field Summary

Modifier and Type	Field and Description
pack-priv final ServerSentEventConnection.EventCallback	callback
pack-priv final String	data
private int	endBufferPosition
pack-priv final String	event
pack-priv final String	id
private byte[]	leftOverData
private int	leftOverDataOffset
pack-priv final long	retry

Constructor Summary

Access	Constructor and Description
private	SSEData(String event, String data, String id, ServerSentEventConnection.EventCallback callback)
private	SSEData(long retry, ServerSentEventConnection.EventCallback callback)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

callback	back to summary
pack-priv final ServerSentEventConnection.EventCallback callback

data	back to summary
pack-priv final String data

endBufferPosition	back to summary
private int endBufferPosition

event	back to summary
pack-priv final String event

id	back to summary
pack-priv final String id

leftOverData	back to summary
private byte[] leftOverData

leftOverDataOffset	back to summary
private int leftOverDataOffset

retry	back to summary
pack-priv final long retry

Constructor Detail

SSEData	back to summary
private SSEData(String event, String data, String id, ServerSentEventConnection.EventCallback callback)

SSEData	back to summary
private SSEData(long retry, ServerSentEventConnection.EventCallback callback)

public Class ServerSentEventConnection

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface ServerSentEventConnection.EventCallback

Method Summary

Method Detail

private Class ServerSentEventConnection.SSEData

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

private Class ServerSentEventConnection.SseWriteListener

Constructor Summary

Method Summary

Constructor Detail

Method Detail