Class ServerSentEventsResult<T>

Namespace

Olve.TypeSpec

Assembly

Olve.TypeSpec.dll

Writes a handler's events as text/event-stream: each event's name is its EventType, its id the item's, and its data the JSON of the event serialized as the union (so the type discriminator is always written). The stream ends quietly when the client disconnects or the app stops, so open streams never hold up shutdown.

public sealed class ServerSentEventsResult<T> : IResult where T : IServerSentEvent

Type Parameters

T

Inheritance

object

ServerSentEventsResult<T>

Implements

IResult

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ServerSentEventsResult(IAsyncEnumerable<ServerSentEvent<T>>)

Writes a handler's events as text/event-stream: each event's name is its EventType, its id the item's, and its data the JSON of the event serialized as the union (so the type discriminator is always written). The stream ends quietly when the client disconnects or the app stops, so open streams never hold up shutdown.

public ServerSentEventsResult(IAsyncEnumerable<ServerSentEvent<T>> events)

Parameters

events IAsyncEnumerable<ServerSentEvent<T>>

Methods

ExecuteAsync(HttpContext)

Write an HTTP response reflecting the result.

public Task ExecuteAsync(HttpContext httpContext)

Parameters

httpContext HttpContext

The HttpContext for the current request.

Returns

Task

A task that represents the asynchronous execute operation.