ServerSentEvent Delphi DLL Reference Documentation
ServerSentEvent
Current Version: 11.0.0
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;
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.
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
function CkServerSentEvent__data(objHandle: HCkServerSentEvent): PWideChar; stdcall;
The data for the server-side event. (If the "data" field was empty, then this will be empty.)
See the notes about PWideChar memory ownership and validity.
topDebugLogFilePath
procedure CkServerSentEvent_putDebugLogFilePath(objHandle: HCkServerSentEvent; newPropVal: PWideChar); stdcall;
function CkServerSentEvent__debugLogFilePath(objHandle: HCkServerSentEvent): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
EventName
function CkServerSentEvent__eventName(objHandle: HCkServerSentEvent): PWideChar; stdcall;
The name of the server-side event. (If the "event" field was not present, then this will be empty.)
See the notes about PWideChar memory ownership and validity.
topLastErrorHtml
function CkServerSentEvent__lastErrorHtml(objHandle: HCkServerSentEvent): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topLastErrorText
function CkServerSentEvent__lastErrorText(objHandle: HCkServerSentEvent): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
LastErrorXml
function CkServerSentEvent__lastErrorXml(objHandle: HCkServerSentEvent): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topLastEventId
function CkServerSentEvent__lastEventId(objHandle: HCkServerSentEvent): PWideChar; stdcall;
The content of the "id" field, if present.
See the notes about PWideChar memory ownership and validity.
topLastMethodSuccess
procedure CkServerSentEvent_putLastMethodSuccess(objHandle: HCkServerSentEvent; newPropVal: wordbool); stdcall;
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.
topVerboseLogging
procedure CkServerSentEvent_putVerboseLogging(objHandle: HCkServerSentEvent; newPropVal: wordbool); stdcall;
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
function CkServerSentEvent__version(objHandle: HCkServerSentEvent): PWideChar; stdcall;
Version of the component/library, such as "10.1.0"
See the notes about PWideChar memory ownership and validity.
Methods
LoadEvent
eventText: PWideChar): wordbool; stdcall;
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.