one.nio.http

Class EventSourceResponse

java.lang.Object

one.nio.http.Response

one.nio.http.EventSourceResponse

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, EventSource<java.lang.String>

public class EventSourceResponse
extends Response
implements EventSource<java.lang.String>

A Response, which can poll for server emitted events. Unlike regular Response this object must be close'd to prevent resource leak.

The usage flow is as follows:

1. Call HttpClient.openEvents(Request, int)
2. Inspect the result code, if it is not OK process the error
3. Inspect the content-type, it must be text/event-stream; if it is not - process the response body - there will be no events
4. while ( ( event = poll() ) != null ) process( event )
5. call close()
6. call HttpClient.reopenEvents(Request, String, int) with last processed Event#id() and go to p.2

See Also:

HTML Standard: 9.2 Server-sent events, HttpClient.openEvents(Request, int)

Nested Class Summary

Nested classes/interfaces inherited from interface one.nio.http.EventSource

EventSource.Event<D>

Field Summary

Fields inherited from class one.nio.http.Response

ACCEPTED, BAD_GATEWAY, BAD_REQUEST, CONFLICT, CONTINUE, CREATED, EMPTY, EXPECTATION_FAILED, FORBIDDEN, FOUND, GATEWAY_TIMEOUT, GONE, HTTP_VERSION_NOT_SUPPORTED, INTERNAL_ERROR, LENGTH_REQUIRED, METHOD_NOT_ALLOWED, MOVED_PERMANENTLY, MULTIPLE_CHOICES, NO_CONTENT, NON_AUTHORITATIVE_INFORMATION, NOT_ACCEPTABLE, NOT_FOUND, NOT_IMPLEMENTED, NOT_MODIFIED, OK, PARTIAL_CONTENT, PAYMENT_REQUIRED, PRECONDITION_FAILED, PROXY_AUTHENTICATION_REQUIRED, REQUEST_ENTITY_TOO_LARGE, REQUEST_TIMEOUT, REQUEST_URI_TOO_LONG, REQUESTED_RANGE_NOT_SATISFIABLE, RESET_CONTENT, SEE_OTHER, SERVICE_UNAVAILABLE, SWITCHING_PROTOCOLS, TEMPORARY_REDIRECT, UNAUTHORIZED, UNSUPPORTED_MEDIA_TYPE, UPGRADE_REQUIRED, USE_PROXY

Constructor Summary

Constructors

Constructor and Description
EventSourceResponse(java.lang.String resultCode)

Method Summary

Modifier and Type	Method and Description
void	close()
EventSource.Event<java.lang.String>	poll() Waits for the next SSE and returns an event.

Methods inherited from class one.nio.http.Response

addHeader, getBody, getBodyUtf8, getHeader, getHeaderCount, getHeaders, getStatus, json, ok, ok, redirect, setBody, toBytes, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

EventSourceResponse

public EventSourceResponse(java.lang.String resultCode)

Method Detail

poll

public EventSource.Event<java.lang.String> poll()
                                         throws java.io.IOException,
                                                HttpException

Description copied from interface: EventSource

Waits for the next SSE and returns an event. The method can block for a long time ( determined by server ). It is essential to check for null and EventSource.Event.isEmpty() before processing

Specified by:

poll in interface EventSource<java.lang.String>

Returns:

the next event from the stream or null, if stream was closed by either party

Throws:

java.io.IOException - an I/O exception occurred

HttpException - an incorrect HTTP request received

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException