CloseMessage Class

Definition

Namespace:

Microsoft.AspNetCore.SignalR.Protocol

Assembly:

Microsoft.AspNetCore.SignalR.Common.dll

Package:

Microsoft.AspNetCore.SignalR.Common v9.0.0

Source:

CloseMessage.cs

The message sent when closing a connection.

public ref class CloseMessage : Microsoft::AspNetCore::SignalR::Protocol::HubMessage

public class CloseMessage : Microsoft.AspNetCore.SignalR.Protocol.HubMessage

type CloseMessage = class
    inherit HubMessage

Public Class CloseMessage
Inherits HubMessage

Inheritance

Object

HubMessage

CloseMessage

Constructors

CloseMessage(String, Boolean)	Initializes a new instance of the CloseMessage class with an optional error message and a Boolean indicating whether or not a client with automatic reconnects enabled should attempt to reconnect upon receiving the message.
CloseMessage(String)	Initializes a new instance of the CloseMessage class with an optional error message and AllowReconnect set to false.

Fields

Empty

An empty close message with no error and AllowReconnect set to false.

Properties

AllowReconnect	If false, clients with automatic reconnects enabled should not attempt to automatically reconnect after receiving the CloseMessage.
Error	Gets the optional error message.