ServerSentEvent ActiveX Reference Documentation

ServerSentEvent

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

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatServerSentEvent

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.ServerSentEvent")

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.ServerSentEvent")

(Delphi)
obj := TChilkatServerSentEvent.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.ServerSentEvent')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.ServerSentEvent")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.ServerSentEvent', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.ServerSentEvent");

Properties

Data As String (read-only)

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

EventName As String (read-only)

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

LastEventId As String (read-only)

Introduced in version 9.5.0.58

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

LastMethodSuccess As Long

Introduced in version 9.5.0.52

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.

Retry As Long (read-only)

Introduced in version 9.5.0.58

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

Methods

LoadEvent(eventText As String) As Long

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.

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

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

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

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

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

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