IHubConnectionBuilder Interface
Definition
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 builder abstraction for configuring HubConnection instances.
public interface class IHubConnectionBuilder : Microsoft::AspNetCore::SignalR::ISignalRBuilder
public interface IHubConnectionBuilder : Microsoft.AspNetCore.SignalR.ISignalRBuilder
type IHubConnectionBuilder = interface
interface ISignalRBuilder
Public Interface IHubConnectionBuilder
Implements ISignalRBuilder
- Derived
- Implements
Properties
Services |
Gets the builder service collection. (Inherited from ISignalRBuilder) |
Methods
Build() |
Creates a HubConnection. |
Extension Methods
ConfigureLogging(IHubConnectionBuilder, Action<ILoggingBuilder>) |
Adds a delegate for configuring the provided ILoggingBuilder. This may be called multiple times. |
WithAutomaticReconnect(IHubConnectionBuilder, IRetryPolicy) |
Configures the HubConnection to automatically attempt to reconnect if the connection is lost. |
WithAutomaticReconnect(IHubConnectionBuilder, TimeSpan[]) |
Configures the HubConnection to automatically attempt to reconnect if the connection is lost. |
WithAutomaticReconnect(IHubConnectionBuilder) |
Configures the HubConnection to automatically attempt to reconnect if the connection is lost. The client will wait the default 0, 2, 10 and 30 seconds respectively before trying up to four reconnect attempts. |
WithKeepAliveInterval(IHubConnectionBuilder, TimeSpan) |
Configures KeepAliveInterval for the HubConnection. |
WithServerTimeout(IHubConnectionBuilder, TimeSpan) |
Configures ServerTimeout for the HubConnection. |
WithStatefulReconnect(IHubConnectionBuilder) |
Configures the HttpConnectionOptions to negotiate stateful reconnect with the server. |
WithUrl(IHubConnectionBuilder, String, HttpTransportType, Action<HttpConnectionOptions>) |
Configures the HubConnection to use HTTP-based transports to connect to the specified URL and transports. |
WithUrl(IHubConnectionBuilder, String, HttpTransportType) |
Configures the HubConnection to use HTTP-based transports to connect to the specified URL and transports. |
WithUrl(IHubConnectionBuilder, String, Action<HttpConnectionOptions>) |
Configures the HubConnection to use HTTP-based transports to connect to the specified URL. |
WithUrl(IHubConnectionBuilder, String) |
Configures the HubConnection to use HTTP-based transports to connect to the specified URL. |
WithUrl(IHubConnectionBuilder, Uri, HttpTransportType, Action<HttpConnectionOptions>) |
Configures the HubConnection to use HTTP-based transports to connect to the specified URL and transports. |
WithUrl(IHubConnectionBuilder, Uri, HttpTransportType) |
Configures the HubConnection to use HTTP-based transports to connect to the specified URL and transports. |
WithUrl(IHubConnectionBuilder, Uri, Action<HttpConnectionOptions>) |
Configures the HubConnection to use HTTP-based transports to connect to the specified URL. |
WithUrl(IHubConnectionBuilder, Uri) |
Configures the HubConnection to use HTTP-based transports to connect to the specified URL. |
WithMessagePackProtocol(IHubConnectionBuilder, MessagePackHubProtocolOptions) | |
WithMessagePackProtocol(IHubConnectionBuilder) | |
AddMessagePackProtocol(ISignalRBuilder, Action<MessagePackHubProtocolOptions>) |
Enables the MsgPack protocol for SignalR and allows options for the MsgPack protocol to be configured. |
AddMessagePackProtocol(ISignalRBuilder) |
Enables the MsgPack protocol for SignalR. |