ServerSentEvent C Reference Documentation
ServerSentEvent
Current Version: 10.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.)
topEventName
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.)
topLastEventId
const char *CkServerSentEvent_lastEventId(HCkServerSentEvent cHandle);
The content of the "id" field, if present.
topLastMethodSuccess
void CkServerSentEvent_putLastMethodSuccess(HCkServerSentEvent cHandle, BOOL newVal);
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.
topRetry
The integer value of the "retry" field, if present. Otherwise 0.
topUtf8
void CkServerSentEvent_putUtf8(HCkServerSentEvent cHandle, BOOL newVal);
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.
topMethods
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.