typedrest-reactive/net.typedrest.endpoints.reactive/SseStreamingEndpointImpl

SseStreamingEndpointImpl

open class SseStreamingEndpointImpl<TEntity : Any>(referrer: Endpoint, relativeUri: URI, entityType: Class<TEntity>, eventType: String? = null) : AbstractEndpoint, StreamingEndpoint<TEntity>

Endpoint for a stream of TEntitys using Server-Sent Events (SSE).

Sends Accept: text/event-stream. By default, transparently reconnects on connection drops or transient errors, honoring the server-supplied retry: interval and resuming via the Last-Event-ID header.

Parameters

referrer

The endpoint used to navigate to this one.

relativeUri

The URI of this endpoint relative to the referrer's.

entityType

The type of individual elements in the stream.

eventType

If set, only events with this event: type are emitted; others are ignored. null emits all events.

Type Parameters

TEntity

The type of individual elements in the stream.

Constructors

SseStreamingEndpointImpl

constructor(referrer: Endpoint, relativeUri: URI, entityType: Class<TEntity>, eventType: String? = null)

constructor(referrer: Endpoint, relativeUri: String, entityType: Class<TEntity>, eventType: String? = null)

Creates a new SSE streaming endpoint.

Properties

autoReconnect

var autoReconnect: Boolean

Whether to transparently reconnect on connection drops, transient transport errors and 5xx responses.

defaultReconnectionInterval

var defaultReconnectionInterval: Duration

The reconnection interval used when the server has not (yet) supplied one via the SSE retry: field.

errorHandler

open override val errorHandler: ErrorHandler

httpClient

open override val httpClient: OkHttpClient

linkExtractor

open override val linkExtractor: LinkExtractor

serializers

open override val serializers: List<Serializer>

uri

open override val uri: URI

Functions

deserialize

fun <T> deserialize(body: ResponseBody, type: Class<T>): T?

deserializeList

fun <T> deserializeList(body: ResponseBody, type: Class<T>): List<T>?

getLinks

open override fun getLinks(rel: String): List<Pair<URI, String?>>

getLinkTemplate

fun getLinkTemplate(rel: String): com/damnhandy/uri/template/UriTemplate

getObservable

open override fun getObservable(): Observable<TEntity>

Provides an Observable stream of entities.

link

open override fun link(rel: String): URI

linkTemplate

open override fun linkTemplate(rel: String, variables: Map<String, Any>): URI

serialize

fun <T> serialize(entity: T, type: Class<T>): RequestBody

serializeList

fun <T> serializeList(entities: Iterable<T>, type: Class<T>): RequestBody

setDefaultLink

fun setDefaultLink(rel: String, href: String?)

setDefaultLinkTemplate

fun setDefaultLinkTemplate(rel: String, href: String?)