kotlin-web/web.sse/EventSource

EventSource

open class EventSource(val url: String, init: EventSourceInit = definedExternally) : EventTarget(source)

The EventSource interface is web content's interface to server-sent events.

Constructors

constructor(url: String, init: EventSourceInit = definedExternally)

constructor(url: URL, init: EventSourceInit = definedExternally)

Types

object Companion

sealed interface ReadyState

Properties

val CLOSED: EventSource.ReadyState

val CONNECTING: EventSource.ReadyState

var onerror: EventHandler<Event, EventSource, EventSource>?

var onmessage: EventHandler<MessageEvent<*>, EventSource, EventSource>?

var onopen: EventHandler<Event, EventSource, EventSource>?

val OPEN: EventSource.ReadyState

val readyState: EventSource.ReadyState

The readyState read-only property of the EventSource interface returns a number representing the state of the connection.

val url: String

The url read-only property of the EventSource interface returns a string representing the URL of the source.

withCredentials

val withCredentials: Boolean

The withCredentials read-only property of the EventSource interface returns a boolean value indicating whether the EventSource object was instantiated with CORS credentials set.

Functions

fun close()

The close() method of the EventSource interface closes the connection, if one is made, and sets the EventSource.readyState attribute to 2 (closed).

fun dispatchEvent(event: Event): Boolean

The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions? = definedExternally): Observable<T>