RealtimeSystemPayload

@Serializable
data class RealtimeSystemPayload(val extension: String, val status: String, val message: String, val channel: String)(source)

Payload of a system event emitted by the server.

Most notably, when a channel is created with BroadcastJoinConfig.replicationReady: true, the server sends one of these once the Postgres replication connection is ready (status: 'ok') or fails to become ready in time (status: 'error').

Parameters

extension

The extension that produced the message, e.g. 'system' or 'postgres_changes'.

status

'ok' on success, 'error' on failure.

message

Human-readable description, e.g. 'Replication connection established'.

channel

The channel (sub)topic the message refers to.

Constructors

Link copied to clipboard
constructor(extension: String, status: String, message: String, channel: String)

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard