ServerSentEvent Tcl Reference Documentation

ServerSentEvent

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

Object Creation

set myServerSentEvent [new CkServerSentEvent]

Properties

Data (string)

# ckStr is a CkString
CkServerSentEvent_get_Data $myServerSentEvent $ckStr
set strVal [CkServerSentEvent_get_data $myServerSentEvent]

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.)

EventName (string)

# ckStr is a CkString
CkServerSentEvent_get_EventName $myServerSentEvent $ckStr
set strVal [CkServerSentEvent_get_eventName $myServerSentEvent]

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.)

LastEventId (string)

# ckStr is a CkString
CkServerSentEvent_get_LastEventId $myServerSentEvent $ckStr
set strVal [CkServerSentEvent_get_lastEventId $myServerSentEvent]

Introduced in version 9.5.0.58

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

Retry (integer)

set intVal [CkServerSentEvent_get_Retry $myServerSentEvent]

Introduced in version 9.5.0.58

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

Utf8 (boolean 1/0)

set boolVal [CkServerSentEvent_get_Utf8 $myServerSentEvent]
CkServerSentEvent_put_Utf8 $myServerSentEvent $boolVal

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

Methods

# eventText is a string
set status [CkServerSentEvent_LoadEvent $eventText]

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)