ServerSentEvent ActiveX Reference Documentation

ServerSentEvent

Current Version: 9.5.0.88

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

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

top
LastBinaryResult
LastBinaryResult As Variant (read-only)
Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastEventId
LastEventId As String (read-only)
Introduced in version 9.5.0.58

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

top
LastMethodSuccess
LastMethodSuccess As Long

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.

top
LastStringResult
LastStringResult As String (read-only)
Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

top
LastStringResultLen
LastStringResultLen As Long (read-only)
Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

top
Retry
Retry As Long (read-only)
Introduced in version 9.5.0.58

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

top

Methods

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

top