com.here.oksse

Interface ServerSentEvent

public interface ServerSentEvent

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ServerSentEvent.Listener

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Force the Server Sent event channel to close.
okhttp3.Request	request()
void	setTimeout(long timeout, TimeUnit unit) Defines a timeout to close the connection when now events are received.

Method Detail

request

okhttp3.Request request()

Returns:

the original request that initiated the Server Sent Event.

setTimeout

void setTimeout(long timeout,
              TimeUnit unit)

Defines a timeout to close the connection when now events are received. This is useful to avoid hanging connections. Note if this is set a heartbeat mechanism should be implemented in server side to avoid closing connections when no events.

Parameters:

timeout - timeout to set

unit - the TimeUnit of the timeout to set

close

void close()

Force the Server Sent event channel to close. This will cancel any pending request or close the established channel.