ServerSentEvent Tcl Reference Documentation

ServerSentEvent

Current Version: 9.5.0.73

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

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

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

top
LastMethodSuccess
boolean 1/0
set boolVal [CkServerSentEvent_get_LastMethodSuccess $myServerSentEvent]
CkServerSentEvent_put_LastMethodSuccess $myServerSentEvent $boolVal

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

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

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

top

Methods

LoadEvent
# 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.

top