ServerSentEvent Delphi DLL Reference Documentation

ServerSentEvent

Current Version: 9.5.0.75

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

Create/Dispose

var
myObject: HCkServerSentEvent;

begin
myObject := CkServerSentEvent_Create();

// ...

CkServerSentEvent_Dispose(myObject);
end;
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

Data
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.)

top
EventName
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.)

top
LastEventId
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.

top
LastMethodSuccess
function CkServerSentEvent_getLastMethodSuccess(objHandle: HCkServerSentEvent): wordbool; stdcall;
procedure CkServerSentEvent_putLastMethodSuccess(objHandle: HCkServerSentEvent; newPropVal: wordbool); stdcall;

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.

top
Retry
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.

top

Methods

LoadEvent
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.

top