ServerSentEvent ActiveX Reference Documentation
ServerSentEvent
Current Version: 11.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") (VBA, such as Excel) Dim obj As New ChilkatServerSentEvent See How to Use ActiveX in Excel (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.)
topDebugLogFilePath
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.
EventName
The name of the server-side event. (If the "event" field was not present, then this will be empty.)
topLastBinaryResult
This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.
LastErrorHtml
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.
topLastErrorText
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.
LastErrorXml
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.
topLastEventId
The content of the "id" field, if present.
topLastMethodSuccess
Indicates the success or failure of the most recent method call: 1 means success, 0 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.
LastStringResult
In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topRetry
The integer value of the "retry" field, if it exists; otherwise, 0.
topVerboseLogging
If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
Version of the component/library, such as "10.1.0"
Methods
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.