ServerSentEvent PHP Extension Reference Documentation
CkServerSentEvent
Current Version: 11.5.0
Chilkat.ServerSentEvent
Use
Inspect
Use
Read
Use
Check Parse server-sent event text into event name, data, ID, and retry fields.
Chilkat.ServerSentEvent is a small helper class for parsing
Server-Sent Events formatted text. Given a multi-line event block, it
extracts the event name, data payload,
id value, and retry interval into simple
read-only properties. It is useful when an application receives event-stream
text and needs to work with the structured event fields instead of manually
parsing the raw lines.
Load event text
LoadEvent to parse a complete multi-line
Server-Sent Event block.
Read event name
EventName to determine the event type supplied by
the server, if an event: field is present.
Read event data
Data to obtain the event payload, such as JSON text from
a streaming API or real-time service.
Track event IDs
LastEventId when the event includes an
id: field that identifies the event or stream position.
Handle retry hints
Retry to read the server-provided retry interval when a
retry: field is included.
Diagnostics
LastErrorText if event text cannot be parsed or if a
parsing result is unexpected.
Chilkat.WebSocket:
ServerSentEvent does not manage a WebSocket connection or parse
WebSocket frames. Instead, it can be used after Chilkat.WebSocket
receives a text message whose payload is formatted as a Server-Sent Event.
Read the WebSocket text frame, pass the event text to
LoadEvent, then use EventName, Data,
LastEventId, and Retry to process the event.
LoadEvent, then inspect EventName to route the
event and Data to process the payload. Use
LastEventId and Retry when the stream provides
reconnection or event-position information.
Object Creation
$obj = new CkServerSentEvent();
Properties
Data
string data();
The data for the server-side event. (If the data field was empty, then this will be empty.)
DebugLogFilePath
void put_DebugLogFilePath(string strVal);
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
EventName
string eventName();
The name of the server-side event. (If the event field was not present, then this will be empty.)
LastErrorHtml
string lastErrorHtml();
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
string lastErrorText();
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
string lastErrorXml();
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastEventId
string lastEventId();
The content of the id field, if present.
LastMethodSuccess
void put_LastMethodSuccess(bool boolVal);
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
Retry
int get_Retry()
The integer value of the retry field, if it exists; otherwise, 0.
Utf8
void put_Utf8(bool boolVal);
When set to true, all string arguments and return values are interpreted as UTF-8 strings. When set to false, they are interpreted as ANSI strings.
In Chilkat v11.0.0 and later, the default value is true. Before v11.0.0, it was false.
VerboseLogging
void put_VerboseLogging(bool boolVal);
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
string version();
Methods
LoadEvent
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.