Share via

CloseMessage Class

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.SignalR.Protocol
Assembly:
Microsoft.AspNetCore.SignalR.Common.dll
Package:
Microsoft.AspNetCore.SignalR.Common v1.0.0
Package:
Microsoft.AspNetCore.SignalR.Common v1.1.0
Package:
Microsoft.AspNetCore.SignalR.Common v3.0.3
Package:
Microsoft.AspNetCore.SignalR.Common v3.1.18
Package:
Microsoft.AspNetCore.SignalR.Common v5.0.9
Package:
Microsoft.AspNetCore.SignalR.Common v6.0.6
Package:
Microsoft.AspNetCore.SignalR.Common v7.0.5
Package:
Microsoft.AspNetCore.SignalR.Common v8.0.0
Package:
Microsoft.AspNetCore.SignalR.Common v9.0.0
Source:
CloseMessage.cs
Source:
CloseMessage.cs
Source:
CloseMessage.cs
Source:
CloseMessage.cs
Source:
CloseMessage.cs
Source:
CloseMessage.cs
Source:
CloseMessage.cs
Source:
CloseMessage.cs
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.

Applies to