typedrest-reactive/net.typedrest.endpoints.reactive/PollingEndpoint

PollingEndpoint

interface PollingEndpoint<TEntity : Any> : ElementEndpoint<TEntity>

Endpoint for a resource that can be polled for state changes.

Type Parameters

TEntity

The type of entity the endpoint represents.

Inheritors

PollingEndpointImpl

Properties

abstract val errorHandler: ErrorHandler

abstract val httpClient: OkHttpClient

isDeleteAllowed

abstract val isDeleteAllowed: Boolean?

abstract val isMergeAllowed: Boolean?

abstract val isSetAllowed: Boolean?

abstract val linkExtractor: LinkExtractor

pollingInterval

abstract var pollingInterval: Duration

Interval in which requests are sent to the server. The server may update this interval via the Retry-After response header.

abstract val response: TEntity?

abstract val serializers: List<Serializer>

abstract val uri: URI

Functions

abstract fun delete()

abstract fun exists(): Boolean

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

abstract fun getObservable(): Observable<TEntity>

Returns an Observable stream of entity states. Consecutive items are emitted only when the server-supplied entity differs from the previously emitted one according to Any.equals.

abstract fun link(rel: String): URI

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

abstract fun merge(entity: TEntity): TEntity?

abstract fun read(): TEntity

abstract fun set(entity: TEntity): TEntity?

abstract fun update(updateAction: (TEntity) -> TEntity, maxRetries: Int): TEntity?