ServerSentEvent PureBasic Reference Documentation

ServerSentEvent

Represents a server-sent event (SSE) received from an HTTP text/event-stream.

Object Creation

obj.i = CkServerSentEvent::ckCreate()

; Make sure to dispose of the object when finished like this:
CkServerSentEvent::ckDispose(obj);

Properties

Declare.s ckData(obj.i) ; (read-only)

Introduced in version 9.5.0.58

The data for the server-side event. (If the "data" field was empty, then this will be empty.)

Declare.s ckEventName(obj.i) ; (read-only)

Introduced in version 9.5.0.58

The name of the server-side event. (If the "event" field was not present, then this will be empty.)

Declare.s ckLastEventId(obj.i) ; (read-only)

Introduced in version 9.5.0.58

The content of the "id" field, if present.

Declare.i ckRetry(obj.i) ; (read-only)

Introduced in version 9.5.0.58

The integer value of the "retry" field, if present. Otherwise 0.

Methods

Declare.i ckLoadEvent(obj.i, eventText.s)

Introduced in version 9.5.0.58

Loads the multi-line event text into this object. For example, the eventText for a Firebase event might look like this:

event: put
data: {"path": "/c", "data": {"foo": true, "bar": false}}

Returns 1 for success, 0 for failure.

Firebase Receive Server-Sent Events (text/event-stream)