ServerSentEvent PureBasic Reference Documentation
ServerSentEvent
Current Version: 10.0.0
Represents a server-sent event (SSE) received from an HTTP text/event-stream.
Object Creation
obj.i = CkServerSentEvent::ckCreate()
; Make sure to dispose of the object when finished like this:
CkServerSentEvent::ckDispose(obj);
Properties
Data
The data for the server-side event. (If the "data" field was empty, then this will be empty.)
topEventName
The name of the server-side event. (If the "event" field was not present, then this will be empty.)
topLastEventId
The content of the "id" field, if present.
topLastMethodSuccess
Declare setCkLastMethodSuccess(obj.i, value.i)
Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
- 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 1. 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.
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 1 for success, 0 for failure.