IHubProtocol Interface

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

Source:: IHubProtocol.cs

Source:: IHubProtocol.cs

Source:: IHubProtocol.cs

Important

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.

A protocol abstraction for communicating with SignalR hubs.

public interface class IHubProtocol

public interface IHubProtocol

type IHubProtocol = interface

Public Interface IHubProtocol

Derived: Microsoft.AspNetCore.SignalR.Protocol.JsonHubProtocol

Microsoft.AspNetCore.SignalR.Protocol.MessagePackHubProtocol

Microsoft.AspNetCore.SignalR.Protocol.NewtonsoftJsonHubProtocol

Properties

Name	Gets the name of the protocol. The name is used by SignalR to resolve the protocol between the client and server.
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