ServerSentEvent ActiveX Reference Documentation
ServerSentEvent
Current Version: 10.0.0
Represents a server-sent event (SSE) received from an HTTP text/event-stream.
Object Creation
Note: For versions of Chilkat < 10.0.0, use "Chilkat_9_5_0.ServerSentEvent" instead of "Chilkat.ServerSentEvent" For a specific major version, use "Chilkat.ServerSentEvent.<major_version>", such as "Chilkat.ServerSentEvent.10" for Chilkat v10.*.* See Chilkat ActiveX Object Creation (ASP) set obj = Server.CreateObject("Chilkat.ServerSentEvent") (AutoIt) $obj = ObjCreate("Chilkat.ServerSentEvent") (Visual Basic 6.0) Dim obj As New ChilkatServerSentEvent (VBScript) set obj = CreateObject("Chilkat.ServerSentEvent") (Delphi) obj := TChilkatServerSentEvent.Create(Self); (FoxPro) loObject = CreateObject('Chilkat.ServerSentEvent') (PowerBuilder) lole_object = create oleobject li_rc = lole_object.ConnectToNewObject("Chilkat.ServerSentEvent") (SQL Server) EXEC @hr = sp_OACreate 'Chilkat.ServerSentEvent', @obj OUT (Javascript) var obj = new ActiveXObject("Chilkat.ServerSentEvent");
Properties
Data
The data for the server-side event. (If the "data" field was empty, then this will be empty.)
topEventName
The name of the server-side event. (If the "event" field was not present, then this will be empty.)
topLastBinaryResult
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).
topLastEventId
The content of the "id" field, if present.
topLastMethodSuccess
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.
topLastStringResult
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).
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topRetry
The integer value of the "retry" field, if present. Otherwise 0.
topMethods
LoadEvent
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.