kotlinphoenix-client/io.github.ajacquierbret.kotlinphoenix.client

Package io.github.ajacquierbret.kotlinphoenix.client

Types

class Channel(topic: String, params: Payload, socket: Socket, socketFlow: SocketFlow, scope: CoroutineScope) : SharedFlow<Message>

Represents a Channel bound to a given topic

DecodeClosure

typealias DecodeClosure = (String) -> Message

A closure that will decode a JSON String into a Message

Defaults

object Defaults

DefaultsPlatform

actual object DefaultsPlatform

expect object DefaultsPlatform

actual object DefaultsPlatform

EncodeClosure

typealias EncodeClosure = (List<Any?>) -> String

A closure that will encode a Payload into a JSON String

Message

data class Message(joinRef: String?, ref: String, topic: String, event: String, rawPayload: Payload)

OnJoin

typealias OnJoin = (key: String, current: PresenceMap?, new: PresenceMap) -> Unit

Closure signature of OnJoin callbacks

OnLeave

typealias OnLeave = (key: String, current: PresenceMap, left: PresenceMap) -> Unit

Closure signature for OnLeave callbacks

OnSync

typealias OnSync = () -> Unit

Closure signature for OnSync callbacks

Payload

typealias Payload = Map<String, Any?>

Alias for a JSON mapping

PayloadClosure

typealias PayloadClosure = () -> Payload?

A closure that will return an optional Payload

Presence

class Presence(channel: Channel, scope: CoroutineScope, opts: Presence.Options)

PresenceDiff

typealias PresenceDiff = MutableMap<String, PresenceState>

Diff has keys "joins" and "leaves", pointing to a Presence.State each containing the users that joined and left.

PresenceMap

typealias PresenceMap = MutableMap<String, List<PresenceMeta>>

A mapping of a String to an array of Metas. e.g. {"metas": {id: 1}}

PresenceMeta

typealias PresenceMeta = Map<String, Any>

Meta details of a Presence. Just a dictionary of properties

PresenceState

typealias PresenceState = MutableMap<String, PresenceMap>

A mapping of a Presence state to a mapping of Metas

Push

class Push(channel: Channel, event: String, payload: Payload, timeout: Long, scope: CoroutineScope) : SharedFlow<Message>

A Push represents an attempt to send a payload through a Channel for a specific event.

Socket

actual class Socket(url: String, paramsClosure: PayloadClosure, vsn: String, encode: EncodeClosure, decode: DecodeClosure, scope: CoroutineScope) : SocketCommon

expect class Socket(url: String, paramsClosure: PayloadClosure, vsn: String, encode: EncodeClosure, decode: DecodeClosure, scope: CoroutineScope) : SocketCommon

A Socket which connects to a Phoenix Socket. Takes a closure to allow for changing parameters to be sent to the server when connecting.

actual class Socket(url: String, paramsClosure: PayloadClosure, vsn: String, encode: EncodeClosure, decode: DecodeClosure, scope: CoroutineScope) : SocketCommon

SocketCommon

abstract class SocketCommon(params: PayloadClosure, vsn: String, encode: EncodeClosure, decode: DecodeClosure, scope: CoroutineScope)

SocketEvent

sealed class SocketEvent : Throwable

SocketFlow

typealias SocketFlow = SharedFlow<SocketEvent>

Alias for a SharedFlow of SocketEvent

TimeoutTimer

class TimeoutTimer(timerCalculation: (tries: Int) -> Long, scope: CoroutineScope)

A Timer class that schedules a Job to be called in the future. Can be configured to use a custom retry pattern, such as exponential backoff.

Transport

interface Transport

Interface that defines different types of Transport layers.

URL

actual typealias URL = URL

expect class URL

actual typealias URL = <ERROR CLASS>

WebSocketTransport

actual class WebSocketTransport : WebSocketTransportCommon

expect class WebSocketTransport(url: URL, decode: DecodeClosure) : WebSocketTransportCommon

A WebSocket implementation of a Transport that uses a WebSocket to facilitate sending and receiving data.

actual class WebSocketTransport : WebSocketTransportCommon

WebSocketTransportCommon

abstract class WebSocketTransportCommon : Transport

Functions

toJsonArray

fun List<*>.toJsonArray(): JsonArray

toJsonElement

fun Any?.toJsonElement(): JsonElement

toJsonObject

fun Map<*, *>.toJsonObject(): JsonObject

toPrimitive

fun JsonElement.toPrimitive(): Any?

toPrimitiveMap

fun JsonObject.toPrimitiveMap(): Map<String, Any?>

Properties

WS_CLOSE_ABNORMAL

const val WS_CLOSE_ABNORMAL: Int = 1006

RFC 6455: indicates that the connection was closed abnormally

WS_CLOSE_NORMAL

const val WS_CLOSE_NORMAL: Int = 1000

RFC 6455: indicates a normal closure