Push

class Push(channel: Channel, event: String, payloadClosure: PayloadClosure, timeout: Long)

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

Constructors

Push

fun Push(channel: Channel, event: String, payload: Payload = mapOf(), timeout: Long = Defaults.TIMEOUT)

Push

fun Push(channel: Channel, event: String, payloadClosure: PayloadClosure, timeout: Long = Defaults.TIMEOUT)

Functions

receive

fun receive(status: String, callback: (Message) -> Unit): Push

Receive a specific event when sending an Outbound messageExample: channel .send("event", myPayload) .

resend

fun resend(timeout: Long = Defaults.TIMEOUT)

Resets and sends the Push

send

fun send()

Sends the Push.

Properties

channel

val channel: Channel

The channel the Push is being sent through

event

val event: String

The event the Push is targeting

payload

var payload: Payload

payloadClosure

var payloadClosure: PayloadClosure

Closure that allows changing parameters sent during push

receivedMessage

var receivedMessage: Message? = null

The server's response to the Push

receiveHooks

var receiveHooks: MutableMap<String, List<(message: Message) -> Unit>>

Hooks into a Push.

ref

var ref: String? = null

The reference ID of the Push

refEvent

var refEvent: String? = null

The event that is associated with the reference ID of the Push

sent

var sent: Boolean = false

True if the Push has been sent

timeout

var timeout: Long

Duration before the message is considered timed out and failed to send

timeoutTask

var timeoutTask: DispatchWorkItem? = null

The task to be triggered if the Push times out