ConnectionBuilder Class

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Connections
Assembly:
Microsoft.AspNetCore.Connections.Abstractions.dll
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.0
Package:
Microsoft.AspNetCore.Connections.Abstractions v9.0.0-rc.2.24474.3
Source:
ConnectionBuilder.cs
Source:
ConnectionBuilder.cs
Source:
ConnectionBuilder.cs
Source:
ConnectionBuilder.cs
Source:
ConnectionBuilder.cs
Source:
ConnectionBuilder.cs
Source:
ConnectionBuilder.cs
Source:
ConnectionBuilder.cs
Source:
ConnectionBuilder.cs

A default implementation for IConnectionBuilder.

public ref class ConnectionBuilder : Microsoft::AspNetCore::Connections::IConnectionBuilder
public class ConnectionBuilder : Microsoft.AspNetCore.Connections.IConnectionBuilder
type ConnectionBuilder = class
    interface IConnectionBuilder
Public Class ConnectionBuilder
Implements IConnectionBuilder
Inheritance
Object
ConnectionBuilder
Implements
IConnectionBuilder

Constructors

ConnectionBuilder(IServiceProvider)

Initializes a new instance of ConnectionBuilder.

Properties

ApplicationServices

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

Methods

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

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