core/dev.fritz2.remote

Package-level declarations

Types

abstract class Authentication<P> : Middleware

Special Middleware to use in at http API to provide an authentication for every request. The type-parameter P represents the principal information, which contains all login-information needed to authenticate against the external HTTP API. The principal information is held inside and available as flow by calling data. To use this Middleware you need to implement the addAuthentication method, where you get the principal information, when available, to add it to your requests. To implement the client side of authentication process you also need to implement the authenticate method in which you specify what is needed to authenticate the user (e.g. open up a login modal). When your authentication process is done you have to call the complete function and set your principal. Then all requests, that have been initialized while the authentication was running, will be re-executed with the additional authentication information provided by the addAuthentication method. When the user logs out you have to call the clear function to clear all authentication information.

CloseException

class CloseException(message: String, throwable: Throwable) : Exception

Exception for handling errors with closing

ConnectionException

class ConnectionException(message: String, throwable: Throwable) : Exception

Exception for handling errors with connecting

Middleware

interface Middleware

interface to do interceptions at http calls. It can modify each request and handles all responses in a specified way.

Request

open class Request(val url: String = "", val method: String = "", val headers: Map<String, String> = emptyMap(), val body: dynamic = undefined, val referrer: String? = undefined, val referrerPolicy: dynamic = undefined, val mode: RequestMode? = undefined, val credentials: RequestCredentials? = undefined, val cache: RequestCache? = undefined, val redirect: RequestRedirect? = undefined, val integrity: String? = undefined, val keepalive: Boolean? = undefined, val reqWindow: Any? = undefined, val middlewares: List<Middleware> = emptyList())

Represents the common fields and attributes of an HTTP request.

Response

open class Response(response: Response, val request: Request, val propagate: Boolean = true)

Represents the common fields and attributes of an HTTP response. It contains also the original Request which was made to get this Response.

SendException

class SendException(message: String) : Exception

Exception for handling errors with sending

Session

open class Session(webSocket: WebSocket)

Session represents a session via websocket after connection was successful. Within a Session you can exchange data with the remote endpoint bi-directionaly.

SessionState

sealed class SessionState

SessionState represents the actual state of the websocket connection. After connection is established it changes from SessionState.Connecting to SessionState.Open and when connection is closed it is SessionState.Closed.

Socket

open class Socket(baseUrl: String = "", protocols: Array<out String> = emptyArray())

Socket defines how to connect via websocket. Therefore, it needs an baseUrl and an optional list of protocols. The Session will be established after calling the connect method.