ServerSentEvent DataFlex Reference Documentation

ServerSentEvent

Current Version: 9.5.0.89

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

Object Creation

// (Dataflex programs use the 32-bit Chilkat ActiveX)
Handle hoServerSentEvent
Get Create(RefClass(cComChilkatServerSentEvent)) to hoServerSentEvent

Properties

Data
Function ComData Returns String
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
Function ComEventName Returns String
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
Function ComLastBinaryResult Returns Variant
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 True. 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
Function ComLastEventId Returns String
Introduced in version 9.5.0.58

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

top
LastMethodSuccess
Function ComLastMethodSuccess Returns Boolean
Procedure Set ComLastMethodSuccess Boolean value

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False 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 = True and failure = False.
  • 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 True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LastStringResult
Function ComLastStringResult Returns String
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 True. 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
Function ComLastStringResultLen Returns Integer
Introduced in version 9.5.0.53

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

top
Retry
Function ComRetry Returns Integer
Introduced in version 9.5.0.58

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

top

Methods

LoadEvent
Function ComLoadEvent String eventText Returns Boolean
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 True for success, False for failure.

top