HubConnectionBuilder class
A builder for configuring HubConnection instances.
Properties
| http |
|
| logger | |
| protocol | |
| reconnect |
|
| url |
Methods
| build() | Creates a HubConnection from the configuration options specified in this builder. |
| configure |
Configures custom logging for the HubConnection. |
| configure |
Configures custom logging for the HubConnection. |
| configure |
Configures console logging for the HubConnection. |
| configure |
Configures custom logging for the HubConnection. |
| with |
Configures the HubConnection to automatically attempt to reconnect if the connection is lost. By default, the client will wait 0, 2, 10 and 30 seconds respectively before trying up to 4 reconnect attempts. |
| with |
Configures the HubConnection to automatically attempt to reconnect if the connection is lost. |
| with |
Configures the HubConnection to automatically attempt to reconnect if the connection is lost. |
| with |
Configures the HubConnection to use the specified Hub Protocol. |
| with |
Configures the HubConnection to use HTTP-based transports to connect to the specified URL. The transport will be selected automatically based on what the server and client support. |
| with |
Configures the HubConnection to use the specified HTTP-based transport to connect to the specified URL. |
| with |
Configures the HubConnection to use HTTP-based transports to connect to the specified URL. |
Property Details
httpConnectionOptions
logger
protocol
reconnectPolicy
url
public url?: stringProperty Value
string
Method Details
build()
Creates a HubConnection from the configuration options specified in this builder.
function build(): HubConnectionReturns
The configured {@link @microsoft/signalr.HubConnection}.
configureLogging(ILogger)
Configures custom logging for the HubConnection.
function configureLogging(logger: ILogger): HubConnectionBuilderParameters
- logger
- ILogger
An object implementing the ILogger interface, which will be used to write all log messages.
Returns
The {@link @microsoft/signalr.HubConnectionBuilder} instance, for chaining.
configureLogging(LogLevel | string | ILogger)
Configures custom logging for the HubConnection.
function configureLogging(logging: LogLevel | string | ILogger): HubConnectionBuilderParameters
A LogLevel, a string representing a LogLevel, or an object implementing the ILogger interface. See the documentation for client logging configuration for more details.
Returns
The {@link @microsoft/signalr.HubConnectionBuilder} instance, for chaining.
configureLogging(LogLevel)
Configures console logging for the HubConnection.
function configureLogging(logLevel: LogLevel): HubConnectionBuilderParameters
- logLevel
- LogLevel
The minimum level of messages to log. Anything at this level, or a more severe level, will be logged.
Returns
The {@link @microsoft/signalr.HubConnectionBuilder} instance, for chaining.
configureLogging(string)
Configures custom logging for the HubConnection.
function configureLogging(logLevel: string): HubConnectionBuilderParameters
- logLevel
-
string
A string representing a LogLevel setting a minimum level of messages to log. See the documentation for client logging configuration for more details.
Returns
withAutomaticReconnect()
Configures the HubConnection to automatically attempt to reconnect if the connection is lost. By default, the client will wait 0, 2, 10 and 30 seconds respectively before trying up to 4 reconnect attempts.
function withAutomaticReconnect(): HubConnectionBuilderReturns
withAutomaticReconnect(IRetryPolicy)
Configures the HubConnection to automatically attempt to reconnect if the connection is lost.
function withAutomaticReconnect(reconnectPolicy: IRetryPolicy): HubConnectionBuilderParameters
- reconnectPolicy
- IRetryPolicy
An <xref:%40microsoft%2FsignalR.IRetryPolicy> that controls the timing and number of reconnect attempts.
Returns
withAutomaticReconnect(number[])
Configures the HubConnection to automatically attempt to reconnect if the connection is lost.
function withAutomaticReconnect(retryDelays: number[]): HubConnectionBuilderParameters
- retryDelays
-
number[]
An array containing the delays in milliseconds before trying each reconnect attempt. The length of the array represents how many failed reconnect attempts it takes before the client will stop attempting to reconnect.
Returns
withHubProtocol(IHubProtocol)
Configures the HubConnection to use the specified Hub Protocol.
function withHubProtocol(protocol: IHubProtocol): HubConnectionBuilderParameters
- protocol
- IHubProtocol
The IHubProtocol implementation to use.
Returns
withUrl(string)
Configures the HubConnection to use HTTP-based transports to connect to the specified URL. The transport will be selected automatically based on what the server and client support.
function withUrl(url: string): HubConnectionBuilderParameters
- url
-
string
The URL the connection will use.
Returns
The {@link @microsoft/signalr.HubConnectionBuilder} instance, for chaining.
withUrl(string, HttpTransportType)
Configures the HubConnection to use the specified HTTP-based transport to connect to the specified URL.
function withUrl(url: string, transportType: HttpTransportType): HubConnectionBuilderParameters
- url
-
string
The URL the connection will use.
- transportType
- HttpTransportType
The specific transport to use.
Returns
The {@link @microsoft/signalr.HubConnectionBuilder} instance, for chaining.
withUrl(string, IHttpConnectionOptions)
Configures the HubConnection to use HTTP-based transports to connect to the specified URL.
function withUrl(url: string, options: IHttpConnectionOptions): HubConnectionBuilderParameters
- url
-
string
The URL the connection will use.
- options
- IHttpConnectionOptions
An options object used to configure the connection.
Returns
The {@link @microsoft/signalr.HubConnectionBuilder} instance, for chaining.