Skip to content

SignalR HandshakeProtocol.SuccessHandshakeData removed and replaced with helper method #14943

Closed
@halter73

Description

@halter73

SignalR HandshakeProtocol.SuccessHandshakeData removed and replaced with helper method

The HandshakeProtocol.SuccessHandshakeData field was removed and replaced with a helper method that generates a successful handshake response given a specific IHubProtocol.

Version introduced

3.0

Old behavior

HandshakeProtocol.SuccessHandshakeData was a public static ReadOnlyMemory<byte> field.

New behavior

HandshakeProtocol.SuccessHandshakeData has been replaced by a static GetSuccessfulHandshake(IHubProtocol protocol) method that returns a ReadOnlyMemory<byte> based on the specified protocol.

Reason for change

This change was made because additional fields were added to the handshake response that are non-constant and change depending on the selected protocol.

Recommended action

None. This type is not designed for use from user code, it is public so it can be shared between the SignalR server and client. It may also be used by customer SignalR clients written in .NET. Users of SignalR should not be affected by this change.

Category

ASP.NET Core

Affected APIs

HandshakeProtocol.SuccessHandshakeData Field


Issue metadata

  • Issue type: breaking-change

Metadata

Metadata

Assignees

Labels

breaking-changeIndicates a .NET Core breaking change

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions