com.here.oksse

Class OkSse

java.lang.Object

com.here.oksse.OkSse

public class OkSse
extends Object

OkSse is a plugin for OkHttp library that extends its functionality to create a Server Sent Event client.

The usage of this class follows the same logic as any OkHttp request.

Use new OkSse() to create a new instance with a new instance of OkHttpClient with default settings

   // The singleton HTTP client.
   public final OkSse okSseClient = new OkSse();
 

Use new OkSse(okHttpClient) to create a new instance that shares the instance of OkHttpClient. This would be the prefered way, since the resources of the OkHttpClient will be reused for the SSE

   // The singleton HTTP client.
   public final OkSse okSseClient = new OkSse(okHttpClient);
 

To create a new ServerSentEvent call newServerSentEvent(Request, ServerSentEvent.Listener) giving the desired Request. Note that must be a GET request.

OkSse will make sure to build the proper parameters needed for SSE conneciton and return the instance.

Constructor Summary

Constructors

Constructor and Description
OkSse() Create a OkSse using a new instance of OkHttpClient with the default settings.
OkSse(okhttp3.OkHttpClient client) Creates a new OkSse using the shared OkHttpClient

Method Summary

Methods

Modifier and Type	Method and Description
okhttp3.OkHttpClient	getClient() Get the OkHttpClient used to create this instance.
ServerSentEvent	newServerSentEvent(okhttp3.Request request, ServerSentEvent.Listener listener) Create a new instance of ServerSentEvent that will handle the connection and communication with the SSE Server.

Methods inherited from class java.lang.Object

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

Constructor Detail

OkSse

public OkSse()

Create a OkSse using a new instance of OkHttpClient with the default settings.

OkSse

public OkSse(okhttp3.OkHttpClient client)

Creates a new OkSse using the shared OkHttpClient

Parameters:

client -

Method Detail

getClient

public okhttp3.OkHttpClient getClient()

Get the OkHttpClient used to create this instance.

Returns:

the instance of the OkHttpClient

newServerSentEvent

public ServerSentEvent newServerSentEvent(okhttp3.Request request,
                                 ServerSentEvent.Listener listener)

Create a new instance of ServerSentEvent that will handle the connection and communication with the SSE Server.

Parameters:

request - the OkHttp Request with the valid information to create the connection with the server.

listener - the ServerSentEvent.Listener to attach to this SSE.

Returns:

a new instance of ServerSentEvent that will automatically start the connection.