Show / Hide Table of Contents

Class ServerSentEventsServiceOptions<TServerSentEventsService>

Options for ServerSentEventsService. The type of ServerSentEventsService for which the options will be used.

Inheritance
object
ServerSentEventsServiceOptions<TServerSentEventsService>
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Lib.AspNetCore.ServerSentEvents
Assembly: Lib.AspNetCore.ServerSentEvents.dll
Syntax
public class ServerSentEventsServiceOptions<TServerSentEventsService> where TServerSentEventsService : ServerSentEventsService
Type Parameters
Name Description
TServerSentEventsService

Properties

KeepaliveContent

Gets or sets the content for keepalive. If the KeepaliveKind is Comment it will be the content of the comment. If the KeepaliveKind is Event it will be the type of the event.

Declaration
public string KeepaliveContent { get; set; }
Property Value
Type Description
string

KeepaliveInterval

Gets or sets the keepalive interval (in seconds).

Declaration
public int KeepaliveInterval { get; set; }
Property Value
Type Description
int

KeepaliveKind

Gets or sets the kind of content for keepalive.

Declaration
public ServerSentEventsKeepaliveKind KeepaliveKind { get; set; }
Property Value
Type Description
ServerSentEventsKeepaliveKind

KeepaliveMode

Gets or sets the keepalive sending mode.

Declaration
public ServerSentEventsKeepaliveMode KeepaliveMode { get; set; }
Property Value
Type Description
ServerSentEventsKeepaliveMode

OnClientConnected

Called when client has connected. This can be used to add client to groups.

Declaration
public Action<IServerSentEventsService, ServerSentEventsClientConnectedArgs> OnClientConnected { get; set; }
Property Value
Type Description
Action<IServerSentEventsService, ServerSentEventsClientConnectedArgs>

OnClientDisconnected

Called when client has disconnected.

Declaration
public Action<IServerSentEventsService, ServerSentEventsClientDisconnectedArgs> OnClientDisconnected { get; set; }
Property Value
Type Description
Action<IServerSentEventsService, ServerSentEventsClientDisconnectedArgs>

ReconnectInterval

Gets or sets the interval after which clients will attempt to reestablish failed connections.

Declaration
public uint? ReconnectInterval { get; set; }
Property Value
Type Description
uint?
Back to top Copyright © 2017 - 2025 Tomasz Pęczek