CkServerSentEvent PHP Extension Reference Documentation

CkServerSentEvent

Current Version: 9.5.0.73

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

Object Creation

$obj = new CkServerSentEvent();

Properties

Data
(read-only)
string 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.)

top
EventName
(read-only)
string 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.)

top
LastEventId
(read-only)
string lastEventId();
Introduced in version 9.5.0.58

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

top
LastMethodSuccess
bool get_LastMethodSuccess()
void put_LastMethodSuccess(bool boolVal);

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false 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 = true and failure = false.
  • 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 true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Retry
(read-only)
int get_Retry()
Introduced in version 9.5.0.58

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

top
Utf8
bool get_Utf8()
void put_Utf8(bool 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.

top

Methods

LoadEvent
bool LoadEvent(string 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.

top