yarp/api/Microsoft.AspNetCore.Builder.AppBuilderDelegationExtensions.html at 87f8788327d1d0ee8b33f41230f974c87b22924a · dotnet/yarp · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class AppBuilderDelegationExtensions
   </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class AppBuilderDelegationExtensions
   ">
    <meta name="generator" content="docfx 2.59.4.0">

    <link rel="shortcut icon" href="../favicon.ico">
    <link rel="stylesheet" href="../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../styles/docfx.css">
    <link rel="stylesheet" href="../styles/main.css">
    <meta property="docfx:navrel" content="../toc.html">
    <meta property="docfx:tocrel" content="toc.html">


  </head>
  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>

        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>

              <a class="navbar-brand" href="../index.html">
                <img id="logo" class="svg" src="../logo.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>

        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">

        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="Microsoft.AspNetCore.Builder.AppBuilderDelegationExtensions">


  <h1 id="Microsoft_AspNetCore_Builder_AppBuilderDelegationExtensions" data-uid="Microsoft.AspNetCore.Builder.AppBuilderDelegationExtensions" class="text-break">Class AppBuilderDelegationExtensions
  </h1>
  <div class="markdown level0 summary"><p>Extensions for adding delegation middleware to the pipeline.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><span class="xref">System.Object</span></div>
    <div class="level1"><span class="xref">AppBuilderDelegationExtensions</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="Microsoft.AspNetCore.Builder.html">Microsoft.AspNetCore.Builder</a></h6>
  <h6><strong>Assembly</strong>: Yarp.ReverseProxy.dll</h6>
  <h5 id="Microsoft_AspNetCore_Builder_AppBuilderDelegationExtensions_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public static class AppBuilderDelegationExtensions : object</code></pre>
  </div>
  <h3 id="methods">Methods
  </h3>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/microsoft/reverse-proxy/new/release/latest/apiSpec/new?filename=Microsoft_AspNetCore_Builder_AppBuilderDelegationExtensions_UseHttpSysDelegation_Microsoft_AspNetCore_Builder_IReverseProxyApplicationBuilder_.md&amp;value=---%0Auid%3A%20Microsoft.AspNetCore.Builder.AppBuilderDelegationExtensions.UseHttpSysDelegation(Microsoft.AspNetCore.Builder.IReverseProxyApplicationBuilder)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/microsoft/reverse-proxy/blob/release/latest/src/ReverseProxy/Delegation/AppBuilderDelegationExtensions.cs/#L25">View Source</a>
  </span>
  <a id="Microsoft_AspNetCore_Builder_AppBuilderDelegationExtensions_UseHttpSysDelegation_" data-uid="Microsoft.AspNetCore.Builder.AppBuilderDelegationExtensions.UseHttpSysDelegation*"></a>
  <h4 id="Microsoft_AspNetCore_Builder_AppBuilderDelegationExtensions_UseHttpSysDelegation_Microsoft_AspNetCore_Builder_IReverseProxyApplicationBuilder_" data-uid="Microsoft.AspNetCore.Builder.AppBuilderDelegationExtensions.UseHttpSysDelegation(Microsoft.AspNetCore.Builder.IReverseProxyApplicationBuilder)">UseHttpSysDelegation(IReverseProxyApplicationBuilder)</h4>
  <div class="markdown level1 summary"><p>Adds middleware to check if the selected destination should use Http.sys delegation.
If so, the request is delegated to the destination queue instead of being proxied over HTTP.
This should be placed after load balancing and passive health checks.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public static IReverseProxyApplicationBuilder UseHttpSysDelegation(this IReverseProxyApplicationBuilder builder)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="Microsoft.AspNetCore.Builder.IReverseProxyApplicationBuilder.html">IReverseProxyApplicationBuilder</a></td>
        <td><span class="parametername">builder</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="Microsoft.AspNetCore.Builder.IReverseProxyApplicationBuilder.html">IReverseProxyApplicationBuilder</a></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 id="Microsoft_AspNetCore_Builder_AppBuilderDelegationExtensions_UseHttpSysDelegation_Microsoft_AspNetCore_Builder_IReverseProxyApplicationBuilder__remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>This middleware only works with the ASP.NET Core Http.sys server implementation.</p>
</div>
</article>
          </div>

          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                  <li>
                    <a href="https://github.com/microsoft/reverse-proxy/new/release/latest/apiSpec/new?filename=Microsoft_AspNetCore_Builder_AppBuilderDelegationExtensions.md&amp;value=---%0Auid%3A%20Microsoft.AspNetCore.Builder.AppBuilderDelegationExtensions%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
                  </li>
                  <li>
                    <a href="https://github.com/microsoft/reverse-proxy/blob/release/latest/src/ReverseProxy/Delegation/AppBuilderDelegationExtensions.cs/#L15" class="contribution-link">View Source</a>
                  </li>
                </ul>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
                <h5>In This Article</h5>
                <div></div>
              </nav>
            </div>
          </div>
        </div>
      </div>

      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>

            <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>

    <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../styles/docfx.js"></script>
    <script type="text/javascript" src="../styles/main.js"></script>
  </body>
</html>