ServerSentEventsModule

The ServerSentEventsModule is used to set up Server-Sent Events. This module sets up a middleware.

Definition

/// <summary>
/// Use Server Sent Events Module
/// It setups a Middleware
/// </summary>
public static SimpleWServer UseServerSentEventsModule(this SimpleWServer server, Action<ServerSentEventsOptions>? configure = null)

Example

See examples of use.

Authorization

Use ServerSentEventsOptions.Authorize to reject an SSE connection before the handshake:

server.ConfigureChallenge(session => session.Response.Unauthorized().SendAsync());

server.UseServerSentEventsModule(options => {
    options.Prefix = "/events";
    options.Authorize = session => session.Principal.IsAuthenticated
                                        ? AuthorizeResult.Allowed
                                        : AuthorizeResult.Challenge;
});

When Authorize returns AuthorizeResult.Challenge, the server-wide Challenge is invoked when configured and must send the response. Without it, the module responds with 403 Forbidden. Forbidden and unknown enum values always return 403 without invoking the challenge. Allowed continues processing; an absent callback also allows access. For any rejected decision, the HTTP session is not switched to SSE streaming.