ServerSentEvent Perl Reference Documentation
CkServerSentEvent
Current Version: 11.0.0
Represents a server-sent event (SSE) received from an HTTP text/event-stream.
Object Creation
$obj = chilkat::CkServerSentEvent->new();
Properties
Data
# $ckStr is a CkString
$serverSentEvent->get_Data($ckStr);
$strVal = $serverSentEvent->data();
The data for the server-side event. (If the "data" field was empty, then this will be empty.)
topDebugLogFilePath
# $ckStr is a CkString
$serverSentEvent->get_DebugLogFilePath($ckStr);
$strVal = $serverSentEvent->debugLogFilePath();
$serverSentEvent->put_DebugLogFilePath($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
# $ckStr is a CkString
$serverSentEvent->get_EventName($ckStr);
$strVal = $serverSentEvent->eventName();
The name of the server-side event. (If the "event" field was not present, then this will be empty.)
topLastErrorHtml
# $ckStr is a CkString
$serverSentEvent->get_LastErrorHtml($ckStr);
$strVal = $serverSentEvent->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
# $ckStr is a CkString
$serverSentEvent->get_LastErrorText($ckStr);
$strVal = $serverSentEvent->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
# $ckStr is a CkString
$serverSentEvent->get_LastErrorXml($ckStr);
$strVal = $serverSentEvent->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
# $ckStr is a CkString
$serverSentEvent->get_LastEventId($ckStr);
$strVal = $serverSentEvent->lastEventId();
The content of the "id" field, if present.
topLastMethodSuccess
$boolVal = $serverSentEvent->get_LastMethodSuccess();
$serverSentEvent->put_LastMethodSuccess($boolVal);
Indicates the success or failure of the most recent method call: 1 means success, 0 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.
Retry
$intVal = $serverSentEvent->get_Retry();
The integer value of the "retry" field, if it exists; otherwise, 0.
topVerboseLogging
$boolVal = $serverSentEvent->get_VerboseLogging();
$serverSentEvent->put_VerboseLogging($boolVal);
If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
# $ckStr is a CkString
$serverSentEvent->get_Version($ckStr);
$strVal = $serverSentEvent->version();
Methods
LoadEvent
$status = $serverSentEvent->LoadEvent($eventText);
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.