lib/app.cash.nostrino.client/RelayClient

RelayClient

class RelayClient(url: String, client: OkHttpClient = OkHttpClient.Builder().pingInterval(20, TimeUnit.SECONDS).build()) : Relay, ConnectionStateListener

Provides comms to and from a single relay

Constructors

RelayClient

constructor(url: String, client: OkHttpClient = OkHttpClient.Builder().pingInterval(20, TimeUnit.SECONDS).build())

Types

Companion

object Companion

Properties

allEvents

open override val allEvents: Flow<Event>

The subset of RelayMessage that only contain messages of type EventMessage

connectionState

val connectionState: StateFlow<ConnectionState>

directMessages

val directMessages: Flow<Event>

The subset of allEvents that are of type EncryptedDm

notes

val notes: Flow<Event>

The subset of allEvents that are of type TextNote

reactions

val reactions: Flow<Event>

The subset of allEvents that are of type Reaction

relayMessages

open override val relayMessages: Flow<RelayMessage>

All messages transmitted by this relay for our active subscriptions

userMetaData

val userMetaData: Flow<Event>

The subset of allEvents that are of type UserMetaData

Functions

send

open override fun send(event: Event)

Queue an event to be sent (potentially immediately)

start

open override fun start()

Begin sending and receiving events with this Relay

stop

open override fun stop()

Stop sending and receiving events with this Relay

fun subscribe(filter: Filter, subscription: Subscription = Subscription(randomSubscriptionId())): Subscription

Create a new subscription with exactly one filter

open override fun subscribe(filters: Set<Filter>, subscription: Subscription): Subscription

Create a new subscription with zero to many filters

unsubscribe

open override fun unsubscribe(subscription: Subscription)

Unsubscribe from a subscription

update

open override fun update(newState: ConnectionState)