sunday-core/io.outfoxx.sunday/EventSource

EventSource

class EventSource(requestSupplier: suspend (Headers) -> Request, retryTime: Duration = retryTimeDefault, eventTimeout: Duration? = eventTimeoutDefault, eventTimeoutCheckInterval: Duration = eventTimeoutCheckIntervalDefault, logger: Logger = LoggerFactory.getLogger(EventSource::class.java)) : Closeable

Server-Sent Events stream client.

EventSource is built on Sunday requests and allows customizing the requests for scenarios like authentication and custom headers.

Constructors

fun EventSource(requestSupplier: suspend (Headers) -> Request, retryTime: Duration = retryTimeDefault, eventTimeout: Duration? = eventTimeoutDefault, eventTimeoutCheckInterval: Duration = eventTimeoutCheckIntervalDefault, logger: Logger = LoggerFactory.getLogger(EventSource::class.java))

Types

object Companion

data class Event(val event: String?, val id: String?, val data: String?, val origin: String)

SSE Event.

enum ReadyState : Enum<EventSource.ReadyState>

Possible states of the EventSource.

Functions

addEventListener

fun addEventListener(event: String, handler: (EventSource.Event) -> Unit)

Add an event listener for a specific event type.

open override fun close()

Close and disconnect the EventSource.

Connect the EventSource.

removeEventListener

fun removeEventListener(event: String, handler: (EventSource.Event) -> Unit)

Removed a previously added event listener.

Properties

val eventListeners: Map<String, (EventSource.Event) -> Unit>

Current list of event listeners.

var onError: (error: Throwable?) -> Unit?

Error handler.

var onMessage: (event: EventSource.Event) -> Unit?

Message handler.

var onOpen: () -> Unit?

Open handler.

val readyState: EventSource.ReadyState

Current state of the EventSource.

val retryTime: Duration

Current retry time.