client/org.inthewaves.kotlinsignald.subscription/Subscription

Subscription

expect class Subscription : IncomingMessageSubscription

actual class Subscription : IncomingMessageSubscription

Contains information about an active incoming message subscription with signald.

Functions

expect open override fun close()

actual open override fun close()

nextMessage

abstract fun nextMessage(): ClientMessageWrapper?

open override fun nextMessage(): ClientMessageWrapper?

Parses an incoming message from the socket. If this returns null, then the socket is closed / reached EOF. This will block the current thread if it has to wait for messages.

nextMessageSuspend

abstract suspend fun nextMessageSuspend(): ClientMessageWrapper?

open suspend override fun nextMessageSuspend(): ClientMessageWrapper?

Parses an incoming message from the socket. If this returns null, then the socket is closed / reached EOF. This will suspend if it has to wait for messages.

open suspend override fun nextMessageSuspend(): ClientMessageWrapper?

unsubscribe

suspend fun unsubscribe(): SubscriptionResponse

fun unsubscribe(): SubscriptionResponse

Properties

accountId

expect val accountId: String

actual val accountId: String

initialMessagesCount

abstract val initialMessagesCount: Int

The number of messages sent while we were waiting for signald's response to the subscribe request. This is currently used for detecting such a situation.

initialMessagesCount

open override val initialMessagesCount: Int

The number of messages sent while we were waiting for signald's response to the subscribe.

initialMessagesCount

open override val initialMessagesCount: Int

The number of messages sent while we were waiting for signald's response to the subscribe.