com.here.oksse

Interface ServerSentEvent.Listener

Enclosing interface:

ServerSentEvent

public static interface ServerSentEvent.Listener

Method Summary

Methods

Modifier and Type	Method and Description
void	onClosed(ServerSentEvent sse) Notify that the connection was closed.
void	onComment(ServerSentEvent sse, String comment) Called every time a comment is received.
void	onMessage(ServerSentEvent sse, String id, String event, String message) Called every time a message is received.
void	onOpen(ServerSentEvent sse, okhttp3.Response response) Notify when the connection is open an established.
okhttp3.Request	onPreRetry(ServerSentEvent sse, okhttp3.Request originalRequest) Notifies client before retrying to connect.
boolean	onRetryError(ServerSentEvent sse, Throwable throwable, okhttp3.Response response) Notify when the connection failed either because it could not be establish or the connection broke.
boolean	onRetryTime(ServerSentEvent sse, long milliseconds) The stream can define the retry time sending a message with "retry: milliseconds" If this event is received this method will be called with the sent value

Method Detail

onOpen

void onOpen(ServerSentEvent sse,
          okhttp3.Response response)

Notify when the connection is open an established. From this point on, new message could be received.

Parameters:

sse - the instance of ServerSentEvent

response - the response from the server after establishing the connection

onMessage

void onMessage(ServerSentEvent sse,
             String id,
             String event,
             String message)

Called every time a message is received.

Parameters:

sse - the instance of ServerSentEvent

id - id sent by the server to identify the message

event - event type of this message

message - message payload

onComment

void onComment(ServerSentEvent sse,
             String comment)

Called every time a comment is received.

Parameters:

sse - the instance of ServerSentEvent

comment - the content of the comment

onRetryTime

boolean onRetryTime(ServerSentEvent sse,
                  long milliseconds)

The stream can define the retry time sending a message with "retry: milliseconds" If this event is received this method will be called with the sent value

Parameters:

sse - the instance of ServerSentEvent

milliseconds - new retry time in milliseconds

Returns:

true if this retry time should be used, false otherwise

onRetryError

boolean onRetryError(ServerSentEvent sse,
                   Throwable throwable,
                   okhttp3.Response response)

Notify when the connection failed either because it could not be establish or the connection broke. The Server Sent Event protocol defines that should be able to reestablish a connection using retry mechanism. In some cases depending on the error the connection should not be retry. Implement this method to define this behavior.

Parameters:

sse - the instance of ServerSentEvent

throwable - the instance of the error that caused the failure

response - the response of the server that caused the failure, it might be null.

Returns:

true if the connection should be retried after the defined retry time, false to avoid the retry, this will close the SSE.

onClosed

void onClosed(ServerSentEvent sse)

Notify that the connection was closed.

Parameters:

sse - the instance of ServerSentEvent

onPreRetry

okhttp3.Request onPreRetry(ServerSentEvent sse,
                         okhttp3.Request originalRequest)

Notifies client before retrying to connect. At this point listener may decide to return originalRequest to repeat last request or another one to alternate

Parameters:

sse - the instance of ServerSentEvent

originalRequest - the request to be retried

Returns:

call to be executed or null to cancel retry and close the SSE channel