Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
halter73 opened this issue Oct 4, 2019 · 0 comments · Fixed by #15044
Closed
Assignees
Labels
breaking-change Indicates a .NET Core breaking change

Comments

@halter73
Copy link
Member

halter73 commented Oct 4, 2019

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change Indicates a .NET Core breaking change
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants