@aspnet/signalr package

Classes

HttpError

Error thrown when an HTTP request fails.

TimeoutError

Error thrown when a timeout elapses.

DefaultHttpClient

Default implementation of HttpClient.

HttpClient

Abstraction over an HTTP client. This class provides an abstraction over an HTTP client so that a different implementation can be provided on different platforms.

HttpResponse

Represents an HTTP response.

HubConnection

Represents a connection to a SignalR Hub.

HubConnectionBuilder

A builder for configuring HubConnection instances.

HubMessage

Union type of all known Hub messages. "HubMessage" is a type alias. It refers to InvocationMessage, StreamInvocationMessage, StreamItemMessage, CompletionMessage, CancelInvocationMessage, PingMessage and CloseMessage.

JsonHubProtocol

Implements the JSON Hub Protocol.

NullLogger

A logger that does nothing when log messages are sent to it.

Interfaces

AbortSignal

Represents a signal that can be monitored to determine if a request has been aborted.

HttpRequest

Represents an HTTP request.

IHttpConnectionOptions

Options provided to the 'withUrl' method on HubConnectionBuilder to configure options for the HTTP-based transports.

CancelInvocationMessage

A hub message sent to request that a streaming invocation be canceled.

CloseMessage

A hub message indicating that the sender is closing the connection. If error is defined, the sender is closing the connection due to an error.

CompletionMessage

A hub message representing the result of an invocation.

HubInvocationMessage

Defines properties common to all Hub messages relating to a specific invocation.

HubMessageBase

Defines properties common to all Hub messages.

IHubProtocol

A protocol abstraction for communicating with SignalR Hubs.

InvocationMessage

A hub message representing a non-streaming invocation.

MessageHeaders

Defines a dictionary of string keys and string values representing headers attached to a Hub message.

PingMessage

A hub message indicating that the sender is still active.

StreamInvocationMessage

A hub message representing a streaming invocation.

StreamItemMessage

A hub message representing a single item produced as part of a result stream.

ILogger

An abstraction that provides a sink for diagnostic messages.

ITransport

An abstraction over the behavior of transports. This is designed to support the framework and not intended for use by applications.

IStreamResult

Defines the result of a streaming hub method.

IStreamSubscriber

Defines the expected type for a receiver of results streamed by the server.

ISubscription

An interface that allows an IStreamSubscriber to be disconnected from a stream.

Enums

MessageType

Defines the type of a Hub Message.

LogLevel

Indicates the severity of a log message. Log Levels are ordered in increasing severity. So Debug is more severe than Trace, etc.

HttpTransportType

Specifies a specific HTTP transport type.

TransferFormat

Specifies the transfer format for a connection.