typedrest-reactive/net.typedrest.endpoints.reactive/StreamingEndpointImpl

StreamingEndpointImpl

open class StreamingEndpointImpl<TEntity : Any>(referrer: Endpoint, relativeUri: URI, entityType: Class<TEntity>, separator: String = "") : AbstractEndpoint, StreamingEndpoint<TEntity>

Endpoint for a stream of TEntitys using a persistent HTTP connection.

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.

separator

The character sequence used to detect that a new element starts in an HTTP stream.

Type Parameters

TEntity

The type of individual elements in the stream.

Constructors

StreamingEndpointImpl

constructor(referrer: Endpoint, relativeUri: URI, entityType: Class<TEntity>, separator: String = "")

constructor(referrer: Endpoint, relativeUri: String, entityType: Class<TEntity>, separator: String = "")

Creates a new streaming endpoint.

Properties

bufferSize

var bufferSize: Int

The size of the buffer used to collect data for deserialization in bytes.

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?)