Home Original page

IConnectionBuilder Interface (Microsoft.AspNetCore.Connections)

Definition

Namespace:
Microsoft.AspNetCore.Connections
Assembly:
Microsoft.AspNetCore.Connections.Abstractions.dll
Package:
Microsoft.AspNetCore.Connections.Abstractions v10.0.0
Package:
Microsoft.AspNetCore.Connections.Abstractions v2.1.0
Package:
Microsoft.AspNetCore.Connections.Abstractions v2.2.0
Package:
Microsoft.AspNetCore.Connections.Abstractions v3.0.3
Package:
Microsoft.AspNetCore.Connections.Abstractions v3.1.18
Package:
Microsoft.AspNetCore.Connections.Abstractions v5.0.9
Package:
Microsoft.AspNetCore.Connections.Abstractions v6.0.6
Package:
Microsoft.AspNetCore.Connections.Abstractions v7.0.5
Package:
Microsoft.AspNetCore.Connections.Abstractions v8.0.19
Package:
Microsoft.AspNetCore.Connections.Abstractions v9.0.8
Source:
IConnectionBuilder.cs
Source:
IConnectionBuilder.cs
Source:
IConnectionBuilder.cs
Source:
IConnectionBuilder.cs
Source:
IConnectionBuilder.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.

Defines an interface that provides the mechanisms to configure a connection pipeline.

public interface class IConnectionBuilder
public interface IConnectionBuilder
type IConnectionBuilder = interface
Public Interface IConnectionBuilder
Derived

Properties

Name Description
ApplicationServices

Gets the IServiceProvider that provides access to the application's service container.

Methods

Name Description
Build()

Builds the delegate used by this application to process connections.
Use(Func<ConnectionDelegate,ConnectionDelegate>)

Adds a middleware delegate to the application's connection pipeline.

Extension Methods

Name Description
Run(IConnectionBuilder, Func<ConnectionContext,Task>)

Add the given middleware to the connection.
Use(IConnectionBuilder, Func<ConnectionContext,ConnectionDelegate,Task>)

Add the given middleware to the connection. If you aren't calling the next function, use Run(IConnectionBuilder, Func<ConnectionContext,Task>) instead.
Use(IConnectionBuilder, Func<ConnectionContext,Func<Task>,Task>)

Add the given middleware to the connection. If you aren't calling the next function, use Run(IConnectionBuilder, Func<ConnectionContext,Task>) instead.

Prefer using Use(IConnectionBuilder, Func<ConnectionContext,ConnectionDelegate,Task>) for better performance as shown below: 

builder.Use((context, next) =>
{
    return next(context);
});
UseConnectionHandler<TConnectionHandler>(IConnectionBuilder)

Use the given TConnectionHandlerConnectionHandler.
UseHub<THub>(IConnectionBuilder)

Configure the connection to host the specified Hub type.

Applies to