ServerSentEvent Delphi DLL Reference Documentation

ServerSentEvent

Represents a server-sent event (SSE) received from an HTTP text/event-stream.

Create/Dispose

function CkServerSentEvent_Create: HCkServerSentEvent; stdcall;

Creates an instance of the HCkServerSentEvent object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkServerSentEvent_Dispose(handle: HCkServerSentEvent); stdcall;

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.

Properties

procedure CkServerSentEvent_getData(objHandle: HCkServerSentEvent; outPropVal: HCkString); stdcall;

function CkServerSentEvent__data(objHandle: HCkServerSentEvent): PWideChar; stdcall;

Introduced in version 9.5.0.58

The data for the server-side event. (If the "data" field was empty, then this will be empty.)

procedure CkServerSentEvent_getEventName(objHandle: HCkServerSentEvent; outPropVal: HCkString); stdcall;

function CkServerSentEvent__eventName(objHandle: HCkServerSentEvent): PWideChar; stdcall;

Introduced in version 9.5.0.58

The name of the server-side event. (If the "event" field was not present, then this will be empty.)

procedure CkServerSentEvent_getLastEventId(objHandle: HCkServerSentEvent; outPropVal: HCkString); stdcall;

function CkServerSentEvent__lastEventId(objHandle: HCkServerSentEvent): PWideChar; stdcall;

Introduced in version 9.5.0.58

The content of the "id" field, if present.

function CkServerSentEvent_getRetry(objHandle: HCkServerSentEvent): Integer; stdcall;

Introduced in version 9.5.0.58

The integer value of the "retry" field, if present. Otherwise 0.

Methods

function CkServerSentEvent_LoadEvent(objHandle: HCkServerSentEvent;
    eventText: PWideChar): wordbool; stdcall;

Introduced in version 9.5.0.58

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.

Firebase Receive Server-Sent Events (text/event-stream)