CkServerSentEvent Ruby Reference Documentation

CkServerSentEvent

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

Object Creation

obj = Chilkat::CkServerSentEvent.new()

Properties

# strVal is a string
# ckStr is a CkString
serverSentEvent.get_Data(ckStr);
strVal = serverSentEvent.data();

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

# strVal is a string
# ckStr is a CkString
serverSentEvent.get_EventName(ckStr);
strVal = serverSentEvent.eventName();

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

# strVal is a string
# ckStr is a CkString
serverSentEvent.get_LastEventId(ckStr);
strVal = serverSentEvent.lastEventId();

Introduced in version 9.5.0.58

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

# intVal is an integer
intVal = serverSentEvent.get_Retry();

Introduced in version 9.5.0.58

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

# boolVal is a boolean
boolVal = serverSentEvent.get_Utf8();
serverSentEvent.put_Utf8(boolVal);

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

Methods

# eventText is a string
status = serverSentEvent.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 true for success, false for failure.

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