CloseMessage Constructors

Definition

Namespace:

Microsoft.AspNetCore.SignalR.Protocol

Assembly:

Microsoft.AspNetCore.SignalR.Common.dll

Package:

Microsoft.AspNetCore.SignalR.Common v8.0.0

Overloads

CloseMessage(String)	Initializes a new instance of the CloseMessage class with an optional error message and AllowReconnect set to false.
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)

Source:

CloseMessage.cs

Initializes a new instance of the CloseMessage class with an optional error message and AllowReconnect set to false.

public:
 CloseMessage(System::String ^ error);

public CloseMessage (string? error);

new Microsoft.AspNetCore.SignalR.Protocol.CloseMessage : string -> Microsoft.AspNetCore.SignalR.Protocol.CloseMessage

Public Sub New (error As String)

Parameters

error

String

An optional error message.

CloseMessage(String, Boolean)

Source:

CloseMessage.cs

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.

public:
 CloseMessage(System::String ^ error, bool allowReconnect);

public CloseMessage (string? error, bool allowReconnect);

new Microsoft.AspNetCore.SignalR.Protocol.CloseMessage : string * bool -> Microsoft.AspNetCore.SignalR.Protocol.CloseMessage

Public Sub New (error As String, allowReconnect As Boolean)

Parameters

error

String

An optional error message.

allowReconnect

Boolean

true, if client with automatic reconnects enabled should attempt to reconnect after receiving the CloseMessage; false, if the client should not try to reconnect whether or not automatic reconnects are enabled.