Microsoft.AspNetCore.SignalR.Protocol Namespace
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.
Contains types that implement the SignalR Hub Protocol.
Classes
| AckMessage |
Represents the ID being acknowledged so older messages do not need to be buffered anymore. |
| CancelInvocationMessage |
The CancelInvocationMessage represents a cancellation of a streaming method. |
| CloseMessage |
The message sent when closing a connection. |
| CompletionMessage |
Represents an invocation that has completed. If there is an error then the invocation didn't complete successfully. |
| HandshakeProtocol |
A helper class for working with SignalR handshakes. |
| HandshakeRequestMessage |
A handshake request message. |
| HandshakeResponseMessage |
A handshake response message. |
| HubInvocationMessage |
A base class for hub messages related to a specific invocation. |
| HubMessage |
A base class for hub messages. |
| HubMethodInvocationMessage |
A base class for hub messages representing an invocation. |
| HubProtocolConstants |
Constants related to the SignalR hub protocol. |
| HubProtocolExtensions |
Extension methods for IHubProtocol. |
| InvocationBindingFailureMessage |
Represents a failure to bind arguments for an invocation. This does not represent an actual message that is sent on the wire, it is returned by TryParseMessage(ReadOnlySequence<Byte>, IInvocationBinder, HubMessage) to indicate that a binding failure occurred when parsing an invocation. The invocation ID is associated so that the error can be sent back to the client, associated with the appropriate invocation ID. |
| InvocationMessage |
A hub message representing a non-streaming invocation. |
| JsonHubProtocol |
Implements the SignalR Hub Protocol using System.Text.Json. |
| MessagePackHubProtocol |
Implements the SignalR Hub Protocol using MessagePack. |
| NewtonsoftJsonHubProtocol |
Implements the SignalR Hub Protocol using Newtonsoft.Json. |
| PingMessage |
A keep-alive message to let the other side of the connection know that the connection is still alive. |
| RawResult |
Type returned to IHubProtocol implementations to let them know the object being deserialized should be stored as raw serialized bytes in the format of the protocol being used. |
| SequenceMessage |
Represents the restart of the sequence of messages being sent. SequenceId is the starting ID of messages being sent, which might be duplicate messages. |
| StreamBindingFailureMessage |
Represents a failure to bind arguments for a StreamDataMessage. This does not represent an actual message that is sent on the wire, it is returned by TryParseMessage(ReadOnlySequence<Byte>, IInvocationBinder, HubMessage) to indicate that a binding failure occurred when parsing a StreamDataMessage. The stream ID is associated so that the error can be sent to the relevant hub method. |
| StreamInvocationMessage |
A hub message representing a streaming invocation. |
| StreamItemMessage |
Represents a single item of an active stream. |
Interfaces
| IHubProtocol |
A protocol abstraction for communicating with SignalR hubs. |
Remarks
For more information about SignalR Hub Protocol, see Hub Protocol.