TChilkatServerSentEvent Delphi ActiveX Reference Documentation

TChilkatServerSentEvent

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

Importing the Chilkat ActiveX into Delphi

Important: Whenever upgrading to a new version of Chilkat, make sure to re-imported ActiveX DLL into Delphi to regenerate the files described below.

Two things are required to use an ActiveX in Delphi:

  1. The ActiveX DLL needs to be registered via regsvr32 on the system where the Delphi application runs. See How To Register ActiveX DLLs for detailed information.
  2. The ActiveX component needs to be "imported". Use the Delphi Import Component Wizard to import the Chilkat type library. This creates the following files: Chilkat_v9_5_0_TLB.pas and Chilkat_v9_5_0_TLB.dcr. The Chilkat_v9_5_0_TLB.pas should be added to your project.

To import the Chilkat type library, do the following:

  1. In the Delphi RAD Studio, select the menu item "Component" --> "Import a Type Library".
  2. Find "Chilkat ActiveX v9.5.0" in the list and select it. This will only appear in the list if the ChilkatAx-9.5.0-win32.dll (or ChilkatAx-9.5.0-x64.dll) has been registered w/ regsvr32.
  3. Check the "Generate Component Wrappers" checkbox.
  4. Select a directory where the unit files (.pas and .dcr) will be generated.
  5. Select "Create Unit" and then "Finish".
  6. Add the .pas to your Delphi project.

To use a Chilkat ActiveX object in your Delphi code, add "Chilkat_v9_5_0_TLB" to the "uses" statement. For example:

uses
  Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
  Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_v9_5_0_TLB;

Object Creation

var
obj: TChilkatServerSentEvent;
...
begin
obj := TChilkatServerSentEvent.Create(Self);
...
// When finished, free the object instance.
obj.Free();

Properties

property Data: WideString readonly

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

property EventName: WideString readonly

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

property LastEventId: WideString readonly

Introduced in version 9.5.0.58

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

property Retry: Integer readonly

Introduced in version 9.5.0.58

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

Methods

function LoadEvent(eventText: WideString): Integer;

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 1 for success, 0 for failure.

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