ServerSentEvent C Reference Documentation
ServerSentEvent
Current Version: 11.0.0
Represents a server-sent event (SSE) received from an HTTP text/event-stream.
Create/Dispose
HCkServerSentEvent instance = CkServerSentEvent_Create(); // ... CkServerSentEvent_Dispose(instance);
Creates an instance of the HCkServerSentEvent object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.
Objects created by calling CkServerSentEvent_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkServerSentEvent_Dispose.
Properties
Data
const char *CkServerSentEvent_data(HCkServerSentEvent cHandle);
The data for the server-side event. (If the "data" field was empty, then this will be empty.)
topDebugLogFilePath
void CkServerSentEvent_putDebugLogFilePath(HCkServerSentEvent cHandle, const char *newVal);
const char *CkServerSentEvent_debugLogFilePath(HCkServerSentEvent cHandle);
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
const char *CkServerSentEvent_eventName(HCkServerSentEvent cHandle);
The name of the server-side event. (If the "event" field was not present, then this will be empty.)
topLastErrorHtml
const char *CkServerSentEvent_lastErrorHtml(HCkServerSentEvent cHandle);
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
const char *CkServerSentEvent_lastErrorText(HCkServerSentEvent cHandle);
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
const char *CkServerSentEvent_lastErrorXml(HCkServerSentEvent cHandle);
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
const char *CkServerSentEvent_lastEventId(HCkServerSentEvent cHandle);
The content of the "id" field, if present.
topLastMethodSuccess
void CkServerSentEvent_putLastMethodSuccess(HCkServerSentEvent cHandle, BOOL newVal);
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.
Retry
The integer value of the "retry" field, if it exists; otherwise, 0.
topUtf8
void CkServerSentEvent_putUtf8(HCkServerSentEvent cHandle, BOOL newVal);
When set to TRUE, all const char * 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 CkServerSentEvent_putVerboseLogging(HCkServerSentEvent cHandle, BOOL newVal);
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
const char *CkServerSentEvent_version(HCkServerSentEvent cHandle);
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.