JsonHubProtocol Class

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Implements the SignalR Hub Protocol using System.Text.Json.

public ref class JsonHubProtocol : Microsoft::AspNetCore::SignalR::Protocol::IHubProtocol

public ref class JsonHubProtocol sealed : Microsoft::AspNetCore::SignalR::Protocol::IHubProtocol

public class JsonHubProtocol : Microsoft.AspNetCore.SignalR.Protocol.IHubProtocol

public sealed class JsonHubProtocol : Microsoft.AspNetCore.SignalR.Protocol.IHubProtocol

type JsonHubProtocol = class
    interface IHubProtocol

Public Class JsonHubProtocol
Implements IHubProtocol

Public NotInheritable Class JsonHubProtocol
Implements IHubProtocol

Inheritance: Object
JsonHubProtocol

Implements: IHubProtocol

Constructors

JsonHubProtocol()	Initializes a new instance of the JsonHubProtocol class.
JsonHubProtocol(IOptions<JsonHubProtocolOptions>)	Initializes a new instance of the JsonHubProtocol class.

Properties

Name	Gets the name of the protocol. The name is used by SignalR to resolve the protocol between the client and server.
PayloadSerializer	Gets the serializer used to serialize invocation arguments and return values.
TransferFormat	Gets the transfer format of the protocol.
Version	Gets the major version of the protocol.

Methods

GetMessageBytes(HubMessage)	Converts the specified HubMessage to its serialized representation.
IsVersionSupported(Int32)	Gets a value indicating whether the protocol supports the specified version.
TryParseMessage(ReadOnlySequence<Byte>, IInvocationBinder, HubMessage)	Creates a new HubMessage from the specified serialized representation, and using the specified binder.
WriteMessage(HubMessage, IBufferWriter<Byte>)	Writes the specified HubMessage to a writer.

Extension Methods

GetMessageBytes(IHubProtocol, HubMessage)

Converts the specified HubMessage to its serialized representation.

Applies to