summaryrefslogtreecommitdiff
path: root/.packages/microsoft.aspnetcore.app.ref/3.0.1/ref/netcoreapp3.0/Microsoft.AspNetCore.Server.IIS.xml
diff options
context:
space:
mode:
Diffstat (limited to '.packages/microsoft.aspnetcore.app.ref/3.0.1/ref/netcoreapp3.0/Microsoft.AspNetCore.Server.IIS.xml')
-rwxr-xr-x.packages/microsoft.aspnetcore.app.ref/3.0.1/ref/netcoreapp3.0/Microsoft.AspNetCore.Server.IIS.xml586
1 files changed, 586 insertions, 0 deletions
diff --git a/.packages/microsoft.aspnetcore.app.ref/3.0.1/ref/netcoreapp3.0/Microsoft.AspNetCore.Server.IIS.xml b/.packages/microsoft.aspnetcore.app.ref/3.0.1/ref/netcoreapp3.0/Microsoft.AspNetCore.Server.IIS.xml
new file mode 100755
index 0000000000..28c816ec66
--- /dev/null
+++ b/.packages/microsoft.aspnetcore.app.ref/3.0.1/ref/netcoreapp3.0/Microsoft.AspNetCore.Server.IIS.xml
@@ -0,0 +1,586 @@
+<?xml version="1.0"?>
+<doc>
+ <assembly>
+ <name>Microsoft.AspNetCore.Server.IIS</name>
+ </assembly>
+ <members>
+ <member name="M:Microsoft.Extensions.Internal.TypeNameHelper.GetTypeDisplayName(System.Type,System.Boolean,System.Boolean,System.Boolean,System.Char)">
+ <summary>
+ Pretty print a type name.
+ </summary>
+ <param name="type">The <see cref="T:System.Type"/>.</param>
+ <param name="fullName"><c>true</c> to print a fully qualified name.</param>
+ <param name="includeGenericParameterNames"><c>true</c> to include generic parameter names.</param>
+ <param name="includeGenericParameters"><c>true</c> to include generic parameters.</param>
+ <param name="nestedTypeDelimiter">Character to use as a delimiter in nested type names</param>
+ <returns>The pretty printed type name.</returns>
+ </member>
+ <member name="T:Microsoft.Extensions.StackTrace.Sources.ExceptionDetails">
+ <summary>
+ Contains details for individual exception messages.
+ </summary>
+ </member>
+ <member name="P:Microsoft.Extensions.StackTrace.Sources.ExceptionDetails.Error">
+ <summary>
+ An individual exception
+ </summary>
+ </member>
+ <member name="P:Microsoft.Extensions.StackTrace.Sources.ExceptionDetails.StackFrames">
+ <summary>
+ The generated stack frames
+ </summary>
+ </member>
+ <member name="P:Microsoft.Extensions.StackTrace.Sources.ExceptionDetails.ErrorMessage">
+ <summary>
+ Gets or sets the summary message.
+ </summary>
+ </member>
+ <member name="T:Microsoft.Extensions.StackTrace.Sources.StackFrameSourceCodeInfo">
+ <summary>
+ Contains the source code where the exception occurred.
+ </summary>
+ </member>
+ <member name="P:Microsoft.Extensions.StackTrace.Sources.StackFrameSourceCodeInfo.Function">
+ <summary>
+ Function containing instruction
+ </summary>
+ </member>
+ <member name="P:Microsoft.Extensions.StackTrace.Sources.StackFrameSourceCodeInfo.File">
+ <summary>
+ File containing the instruction
+ </summary>
+ </member>
+ <member name="P:Microsoft.Extensions.StackTrace.Sources.StackFrameSourceCodeInfo.Line">
+ <summary>
+ The line number of the instruction
+ </summary>
+ </member>
+ <member name="P:Microsoft.Extensions.StackTrace.Sources.StackFrameSourceCodeInfo.PreContextLine">
+ <summary>
+ The line preceding the frame line
+ </summary>
+ </member>
+ <member name="P:Microsoft.Extensions.StackTrace.Sources.StackFrameSourceCodeInfo.PreContextCode">
+ <summary>
+ Lines of code before the actual error line(s).
+ </summary>
+ </member>
+ <member name="P:Microsoft.Extensions.StackTrace.Sources.StackFrameSourceCodeInfo.ContextCode">
+ <summary>
+ Line(s) of code responsible for the error.
+ </summary>
+ </member>
+ <member name="P:Microsoft.Extensions.StackTrace.Sources.StackFrameSourceCodeInfo.PostContextCode">
+ <summary>
+ Lines of code after the actual error line(s).
+ </summary>
+ </member>
+ <member name="P:Microsoft.Extensions.StackTrace.Sources.StackFrameSourceCodeInfo.ErrorDetails">
+ <summary>
+ Specific error details for this stack frame.
+ </summary>
+ </member>
+ <member name="T:Microsoft.Extensions.RazorViews.BaseView">
+ <summary>
+ Infrastructure
+ </summary>
+ </member>
+ <member name="P:Microsoft.Extensions.RazorViews.BaseView.Context">
+ <summary>
+ The request context
+ </summary>
+ </member>
+ <member name="P:Microsoft.Extensions.RazorViews.BaseView.Request">
+ <summary>
+ The request
+ </summary>
+ </member>
+ <member name="P:Microsoft.Extensions.RazorViews.BaseView.Response">
+ <summary>
+ The response
+ </summary>
+ </member>
+ <member name="P:Microsoft.Extensions.RazorViews.BaseView.Output">
+ <summary>
+ The output stream
+ </summary>
+ </member>
+ <member name="P:Microsoft.Extensions.RazorViews.BaseView.HtmlEncoder">
+ <summary>
+ Html encoder used to encode content.
+ </summary>
+ </member>
+ <member name="P:Microsoft.Extensions.RazorViews.BaseView.UrlEncoder">
+ <summary>
+ Url encoder used to encode content.
+ </summary>
+ </member>
+ <member name="P:Microsoft.Extensions.RazorViews.BaseView.JavaScriptEncoder">
+ <summary>
+ JavaScript encoder used to encode content.
+ </summary>
+ </member>
+ <member name="M:Microsoft.Extensions.RazorViews.BaseView.ExecuteAsync(System.IO.Stream)">
+ <summary>
+ Execute an individual request
+ </summary>
+ <param name="stream">The stream to write to</param>
+ </member>
+ <member name="M:Microsoft.Extensions.RazorViews.BaseView.ExecuteAsync(Microsoft.AspNetCore.Http.HttpContext)">
+ <summary>
+ Execute an individual request
+ </summary>
+ <param name="context"></param>
+ </member>
+ <member name="M:Microsoft.Extensions.RazorViews.BaseView.ExecuteAsync">
+ <summary>
+ Execute an individual request
+ </summary>
+ </member>
+ <member name="M:Microsoft.Extensions.RazorViews.BaseView.WriteLiteral(System.Object)">
+ <summary>
+ Write the given value without HTML encoding directly to <see cref="P:Microsoft.Extensions.RazorViews.BaseView.Output"/>.
+ </summary>
+ <param name="value">The <see cref="T:System.Object"/> to write.</param>
+ </member>
+ <member name="M:Microsoft.Extensions.RazorViews.BaseView.WriteLiteral(System.String)">
+ <summary>
+ Write the given value without HTML encoding directly to <see cref="P:Microsoft.Extensions.RazorViews.BaseView.Output"/>.
+ </summary>
+ <param name="value">The <see cref="T:System.String"/> to write.</param>
+ </member>
+ <member name="M:Microsoft.Extensions.RazorViews.BaseView.WriteAttribute(System.String,System.String,System.String,Microsoft.Extensions.RazorViews.AttributeValue[])">
+ <summary>
+ Writes the given attribute to the given writer
+ </summary>
+ <param name="name">The name of the attribute to write</param>
+ <param name="leader">The value of the prefix</param>
+ <param name="trailer">The value of the suffix</param>
+ <param name="values">The <see cref="T:Microsoft.Extensions.RazorViews.AttributeValue"/>s to write.</param>
+ </member>
+ <member name="M:Microsoft.Extensions.RazorViews.BaseView.Write(Microsoft.Extensions.RazorViews.HelperResult)">
+ <summary>
+ <see cref="M:Microsoft.Extensions.RazorViews.HelperResult.WriteTo(System.IO.TextWriter)"/> is invoked
+ </summary>
+ <param name="result">The <see cref="T:Microsoft.Extensions.RazorViews.HelperResult"/> to invoke</param>
+ </member>
+ <member name="M:Microsoft.Extensions.RazorViews.BaseView.Write(System.Object)">
+ <summary>
+ Writes the specified <paramref name="value"/> to <see cref="P:Microsoft.Extensions.RazorViews.BaseView.Output"/>.
+ </summary>
+ <param name="value">The <see cref="T:System.Object"/> to write.</param>
+ <remarks>
+ <see cref="M:Microsoft.Extensions.RazorViews.HelperResult.WriteTo(System.IO.TextWriter)"/> is invoked for <see cref="T:Microsoft.Extensions.RazorViews.HelperResult"/> types.
+ For all other types, the encoded result of <see cref="M:System.Object.ToString"/> is written to
+ <see cref="P:Microsoft.Extensions.RazorViews.BaseView.Output"/>.
+ </remarks>
+ </member>
+ <member name="M:Microsoft.Extensions.RazorViews.BaseView.Write(System.String)">
+ <summary>
+ Writes the specified <paramref name="value"/> with HTML encoding to <see cref="P:Microsoft.Extensions.RazorViews.BaseView.Output"/>.
+ </summary>
+ <param name="value">The <see cref="T:System.String"/> to write.</param>
+ </member>
+ <member name="T:Microsoft.Extensions.RazorViews.HelperResult">
+ <summary>
+ Represents a deferred write operation in a <see cref="T:Microsoft.Extensions.RazorViews.BaseView"/>.
+ </summary>
+ </member>
+ <member name="M:Microsoft.Extensions.RazorViews.HelperResult.#ctor(System.Action{System.IO.TextWriter})">
+ <summary>
+ Creates a new instance of <see cref="T:Microsoft.Extensions.RazorViews.HelperResult"/>.
+ </summary>
+ <param name="action">The delegate to invoke when <see cref="M:Microsoft.Extensions.RazorViews.HelperResult.WriteTo(System.IO.TextWriter)"/> is called.</param>
+ </member>
+ <member name="M:Microsoft.Extensions.RazorViews.HelperResult.WriteTo(System.IO.TextWriter)">
+ <summary>
+ Method invoked to produce content from the <see cref="T:Microsoft.Extensions.RazorViews.HelperResult"/>.
+ </summary>
+ <param name="writer">The <see cref="T:System.IO.TextWriter"/> instance to write to.</param>
+ </member>
+ <member name="M:Microsoft.AspNetCore.Server.IIS.Core.IISHttpContext.ReadAsync(System.Memory{System.Byte},System.Threading.CancellationToken)">
+ <summary>
+ Reads data from the Input pipe to the user.
+ </summary>
+ <param name="memory"></param>
+ <param name="cancellationToken"></param>
+ <returns></returns>
+ </member>
+ <member name="M:Microsoft.AspNetCore.Server.IIS.Core.IISHttpContext.WriteAsync(System.ReadOnlyMemory{System.Byte},System.Threading.CancellationToken)">
+ <summary>
+ Writes data to the output pipe.
+ </summary>
+ <param name="memory"></param>
+ <param name="cancellationToken"></param>
+ <returns></returns>
+ </member>
+ <member name="M:Microsoft.AspNetCore.Server.IIS.Core.IISHttpContext.FlushAsync(System.Threading.CancellationToken)">
+ <summary>
+ Flushes the data in the output pipe
+ </summary>
+ <param name="cancellationToken"></param>
+ <returns></returns>
+ </member>
+ <member name="T:Microsoft.AspNetCore.Server.IIS.HttpContextExtensions">
+ <summary>
+ Extensions to <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> that enable access to IIS features.
+ </summary>
+ </member>
+ <member name="M:Microsoft.AspNetCore.Server.IIS.HttpContextExtensions.GetIISServerVariable(Microsoft.AspNetCore.Http.HttpContext,System.String)">
+ <summary>
+ Gets the value of a server variable for the current request.
+ </summary>
+ <param name="context">The http context for the request.</param>
+ <param name="variableName">The name of the variable.</param>
+ <returns>
+ <c>null</c> if the server does not support the <see cref="T:Microsoft.AspNetCore.Http.Features.IServerVariablesFeature"/> feature.
+ May return null or empty if the variable does not exist or is not set.
+ </returns>
+ </member>
+ <member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.ResponseStreamWasUpgraded">
+ <summary>Cannot write to response body after connection has been upgraded.</summary>
+ </member>
+ <member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.UnhandledApplicationException">
+ <summary>The response has been aborted due to an unhandled application exception.</summary>
+ </member>
+ <member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.CannotUpgradeNonUpgradableRequest">
+ <summary>Cannot upgrade a non-upgradable request. Check IHttpUpgradeFeature.IsUpgradableRequest to determine if a request can be upgraded.</summary>
+ </member>
+ <member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.UpgradeCannotBeCalledMultipleTimes">
+ <summary>IHttpUpgradeFeature.UpgradeAsync was already called and can only be called once per connection.</summary>
+ </member>
+ <member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.SynchronousReadsDisallowed">
+ <summary>Synchronous operations are disallowed. Call ReadAsync or set AllowSynchronousIO to true instead.</summary>
+ </member>
+ <member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.SynchronousWritesDisallowed">
+ <summary>Synchronous operations are disallowed. Call WriteAsync or set AllowSynchronousIO to true instead.</summary>
+ </member>
+ <member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.WritingToResponseBodyAfterResponseCompleted">
+ <summary>Cannot write to the response body, the response has completed.</summary>
+ </member>
+ <member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.ConnectionAbortedByApplication">
+ <summary>The connection was aborted by the application.</summary>
+ </member>
+ <member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.ConnectionOrStreamAbortedByCancellationToken">
+ <summary>The connection or stream was aborted because a write operation was aborted with a CancellationToken.</summary>
+ </member>
+ <member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.ParameterReadOnlyAfterResponseStarted">
+ <summary>{name} cannot be set because the response has already started.</summary>
+ </member>
+ <member name="M:Microsoft.AspNetCore.Server.IIS.CoreStrings.FormatParameterReadOnlyAfterResponseStarted(System.Object)">
+ <summary>{name} cannot be set because the response has already started.</summary>
+ </member>
+ <member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.BadRequest_RequestBodyTooLarge">
+ <summary>Request body too large.</summary>
+ </member>
+ <member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.MaxRequestBodySizeCannotBeModifiedAfterRead">
+ <summary>The maximum request body size cannot be modified after the app has already started reading from the request body.</summary>
+ </member>
+ <member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.MaxRequestBodySizeCannotBeModifiedForUpgradedRequests">
+ <summary>The maximum request body size cannot be modified after the request has been upgraded.</summary>
+ </member>
+ <member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.NonNegativeNumberOrNullRequired">
+ <summary>Value must be null or a non-negative number.</summary>
+ </member>
+ <member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.BadRequest">
+ <summary>Bad request.</summary>
+ </member>
+ <member name="P:Microsoft.AspNetCore.Server.IIS.CoreStrings.MaxRequestLimitWarning">
+ <summary>Increasing the MaxRequestBodySize conflicts with the max value for IIS limit maxAllowedContentLength. HTTP requests that have a content length greater than maxAllowedContentLength will still be rejected by IIS. You can disable the limit by either removing ...</summary>
+ </member>
+ <member name="P:Microsoft.AspNetCore.Builder.IISServerOptions.AllowSynchronousIO">
+ <summary>
+ Gets or sets a value that controls whether synchronous IO is allowed for the <see cref="P:Microsoft.AspNetCore.Http.HttpContext.Request"/> and <see cref="P:Microsoft.AspNetCore.Http.HttpContext.Response"/>
+ </summary>
+ <remarks>
+ Defaults to false.
+ </remarks>
+ </member>
+ <member name="P:Microsoft.AspNetCore.Builder.IISServerOptions.AutomaticAuthentication">
+ <summary>
+ If true the server should set HttpContext.User. If false the server will only provide an
+ identity when explicitly requested by the AuthenticationScheme.
+ Note Windows Authentication must also be enabled in IIS for this to work.
+ </summary>
+ </member>
+ <member name="P:Microsoft.AspNetCore.Builder.IISServerOptions.AuthenticationDisplayName">
+ <summary>
+ Sets the display name shown to users on login pages. The default is null.
+ </summary>
+ </member>
+ <member name="P:Microsoft.AspNetCore.Builder.IISServerOptions.ForwardWindowsAuthentication">
+ <summary>
+ Used to indicate if the authentication handler should be registered. This is only done if ANCM indicates
+ IIS has a non-anonymous authentication enabled, or for back compat with ANCMs that did not provide this information.
+ </summary>
+ </member>
+ <member name="P:Microsoft.AspNetCore.Builder.IISServerOptions.MaxRequestBodySize">
+ <summary>
+ Gets or sets the maximum allowed size of any request body in bytes.
+ When set to null, the maximum request body size is unlimited.
+ This limit has no effect on upgraded connections which are always unlimited.
+ This can be overridden per-request via <see cref="T:Microsoft.AspNetCore.Http.Features.IHttpMaxRequestBodySizeFeature"/>.
+ </summary>
+ <remarks>
+ Defaults to null (unlimited).
+ </remarks>
+ </member>
+ <member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilderIISExtensions.UseIIS(Microsoft.AspNetCore.Hosting.IWebHostBuilder)">
+ <summary>
+ Configures the port and base path the server should listen on when running behind AspNetCoreModule.
+ The app will also be configured to capture startup errors.
+ </summary>
+ <param name="hostBuilder"></param>
+ <returns></returns>
+ </member>
+ <member name="T:Microsoft.AspNetCore.Hosting.Views.ErrorPageModel">
+ <summary>
+ Holds data to be displayed on the error page.
+ </summary>
+ </member>
+ <member name="P:Microsoft.AspNetCore.Hosting.Views.ErrorPageModel.ErrorDetails">
+ <summary>
+ Detailed information about each exception in the stack.
+ </summary>
+ </member>
+ <member name="T:Microsoft.AspNetCore.HttpSys.Internal.SocketAddress">
+ <devdoc>
+ <para>
+ This class is used when subclassing EndPoint, and provides indication
+ on how to format the memory buffers that winsock uses for network addresses.
+ </para>
+ </devdoc>
+ </member>
+ <member name="M:Microsoft.AspNetCore.HttpSys.Internal.SocketAddress.#ctor(System.Net.Sockets.AddressFamily,System.Int32)">
+ <devdoc>
+ <para>[To be supplied.]</para>
+ </devdoc>
+ </member>
+ <member name="P:Microsoft.AspNetCore.HttpSys.Internal.SocketAddress.Item(System.Int32)">
+ <devdoc>
+ <para>[To be supplied.]</para>
+ </devdoc>
+ </member>
+ <member name="M:Microsoft.AspNetCore.HttpSys.Internal.RawUrlHelper.GetPath(System.Span{System.Byte})">
+ <summary>
+ Find the segment of the URI byte array which represents the path.
+ </summary>
+ </member>
+ <member name="M:Microsoft.AspNetCore.HttpSys.Internal.RawUrlHelper.FindHttpOrHttps(System.Span{System.Byte})">
+ <summary>
+ Compare the beginning portion of the raw URL byte array to https:// and http://
+ </summary>
+ <param name="raw">The byte array represents the raw URI</param>
+ <returns>Length of the matched bytes, 0 if it is not matched.</returns>
+ </member>
+ <member name="M:Microsoft.AspNetCore.HttpSys.Internal.RequestUriBuilder.Unescape(System.Span{System.Byte})">
+ <summary>
+ Unescape a given path string in place. The given path string may contain escaped char.
+ </summary>
+ <param name="rawPath">The raw path string to be unescaped</param>
+ <returns>The unescaped path string</returns>
+ </member>
+ <member name="M:Microsoft.AspNetCore.HttpSys.Internal.RequestUriBuilder.DecodeCore(System.Int32@,System.Int32@,System.Int32,System.Span{System.Byte})">
+ <summary>
+ Unescape the percent-encodings
+ </summary>
+ <param name="reader">The iterator point to the first % char</param>
+ <param name="writer">The place to write to</param>
+ <param name="end">The end of the buffer</param>
+ <param name="buffer">The byte array</param>
+ </member>
+ <member name="M:Microsoft.AspNetCore.HttpSys.Internal.RequestUriBuilder.UnescapePercentEncoding(System.Int32@,System.Int32,System.ReadOnlySpan{System.Byte})">
+ <summary>
+ Read the percent-encoding and try unescape it.
+
+ The operation first peek at the character the <paramref name="scan"/>
+ iterator points at. If it is % the <paramref name="scan"/> is then
+ moved on to scan the following to characters. If the two following
+ characters are hexadecimal literals they will be unescaped and the
+ value will be returned.
+
+ If the first character is not % the <paramref name="scan"/> iterator
+ will be removed beyond the location of % and -1 will be returned.
+
+ If the following two characters can't be successfully unescaped the
+ <paramref name="scan"/> iterator will be move behind the % and -1
+ will be returned.
+ </summary>
+ <param name="scan">The value to read</param>
+ <param name="end">The end of the buffer</param>
+ <param name="buffer">The byte array</param>
+ <returns>The unescaped byte if success. Otherwise return -1.</returns>
+ </member>
+ <member name="M:Microsoft.AspNetCore.HttpSys.Internal.RequestUriBuilder.ReadHex(System.Int32@,System.Int32,System.ReadOnlySpan{System.Byte})">
+ <summary>
+ Read the next char and convert it into hexadecimal value.
+
+ The <paramref name="scan"/> iterator will be moved to the next
+ byte no matter no matter whether the operation successes.
+ </summary>
+ <param name="scan">The value to read</param>
+ <param name="end">The end of the buffer</param>
+ <param name="buffer">The byte array</param>
+ <returns>The hexadecimal value if successes, otherwise -1.</returns>
+ </member>
+ <member name="T:StartupHook">
+ <summary>
+ Startup hooks are pieces of code that will run before a users program main executes
+ See: https://github.com/dotnet/core-setup/blob/master/Documentation/design-docs/host-startup-hook.md
+ The type must be named StartupHook without any namespace, and should be internal.
+ </summary>
+ </member>
+ <member name="M:StartupHook.Initialize">
+ <summary>
+ Startup hooks are pieces of code that will run before a users program main executes
+ See: https://github.com/dotnet/core-setup/blob/master/Documentation/design-docs/host-startup-hook.md
+ </summary>
+ </member>
+ <member name="T:System.Buffers.DiagnosticMemoryPool">
+ <summary>
+ Used to allocate and distribute re-usable blocks of memory.
+ </summary>
+ </member>
+ <member name="F:System.Buffers.DiagnosticMemoryPool.AnySize">
+ <summary>
+ This default value passed in to Rent to use the default value for the pool.
+ </summary>
+ </member>
+ <member name="T:System.Buffers.DiagnosticPoolBlock">
+ <summary>
+ Block tracking object used by the byte buffer memory pool. A slab is a large allocation which is divided into smaller blocks. The
+ individual blocks are then treated as independent array segments.
+ </summary>
+ </member>
+ <member name="F:System.Buffers.DiagnosticPoolBlock._pool">
+ <summary>
+ Back-reference to the memory pool which this block was allocated from. It may only be returned to this pool.
+ </summary>
+ </member>
+ <member name="M:System.Buffers.DiagnosticPoolBlock.#ctor(System.Buffers.DiagnosticMemoryPool,System.Buffers.IMemoryOwner{System.Byte})">
+ <summary>
+ This object cannot be instantiated outside of the static Create method
+ </summary>
+ </member>
+ <member name="T:System.Buffers.MemoryPoolBlock">
+ <summary>
+ Block tracking object used by the byte buffer memory pool. A slab is a large allocation which is divided into smaller blocks. The
+ individual blocks are then treated as independent array segments.
+ </summary>
+ </member>
+ <member name="M:System.Buffers.MemoryPoolBlock.#ctor(System.Buffers.SlabMemoryPool,System.Buffers.MemoryPoolSlab,System.Int32,System.Int32)">
+ <summary>
+ This object cannot be instantiated outside of the static Create method
+ </summary>
+ </member>
+ <member name="P:System.Buffers.MemoryPoolBlock.Pool">
+ <summary>
+ Back-reference to the memory pool which this block was allocated from. It may only be returned to this pool.
+ </summary>
+ </member>
+ <member name="P:System.Buffers.MemoryPoolBlock.Slab">
+ <summary>
+ Back-reference to the slab from which this block was taken, or null if it is one-time-use memory.
+ </summary>
+ </member>
+ <member name="T:System.Buffers.MemoryPoolSlab">
+ <summary>
+ Slab tracking object used by the byte buffer memory pool. A slab is a large allocation which is divided into smaller blocks. The
+ individual blocks are then treated as independent array segments.
+ </summary>
+ </member>
+ <member name="F:System.Buffers.MemoryPoolSlab._gcHandle">
+ <summary>
+ This handle pins the managed array in memory until the slab is disposed. This prevents it from being
+ relocated and enables any subsections of the array to be used as native memory pointers to P/Invoked API calls.
+ </summary>
+ </member>
+ <member name="P:System.Buffers.MemoryPoolSlab.IsActive">
+ <summary>
+ True as long as the blocks from this slab are to be considered returnable to the pool. In order to shrink the
+ memory pool size an entire slab must be removed. That is done by (1) setting IsActive to false and removing the
+ slab from the pool's _slabs collection, (2) as each block currently in use is Return()ed to the pool it will
+ be allowed to be garbage collected rather than re-pooled, and (3) when all block tracking objects are garbage
+ collected and the slab is no longer references the slab will be garbage collected and the memory unpinned will
+ be unpinned by the slab's Dispose.
+ </summary>
+ </member>
+ <member name="T:System.Buffers.SlabMemoryPool">
+ <summary>
+ Used to allocate and distribute re-usable blocks of memory.
+ </summary>
+ </member>
+ <member name="F:System.Buffers.SlabMemoryPool._blockSize">
+ <summary>
+ The size of a block. 4096 is chosen because most operating systems use 4k pages.
+ </summary>
+ </member>
+ <member name="F:System.Buffers.SlabMemoryPool._blockCount">
+ <summary>
+ Allocating 32 contiguous blocks per slab makes the slab size 128k. This is larger than the 85k size which will place the memory
+ in the large object heap. This means the GC will not try to relocate this array, so the fact it remains pinned does not negatively
+ affect memory management's compactification.
+ </summary>
+ </member>
+ <member name="P:System.Buffers.SlabMemoryPool.MaxBufferSize">
+ <summary>
+ Max allocation block size for pooled blocks,
+ larger values can be leased but they will be disposed after use rather than returned to the pool.
+ </summary>
+ </member>
+ <member name="P:System.Buffers.SlabMemoryPool.BlockSize">
+ <summary>
+ The size of a block. 4096 is chosen because most operating systems use 4k pages.
+ </summary>
+ </member>
+ <member name="F:System.Buffers.SlabMemoryPool._slabLength">
+ <summary>
+ 4096 * 32 gives you a slabLength of 128k contiguous bytes allocated per slab
+ </summary>
+ </member>
+ <member name="F:System.Buffers.SlabMemoryPool._blocks">
+ <summary>
+ Thread-safe collection of blocks which are currently in the pool. A slab will pre-allocate all of the block tracking objects
+ and add them to this collection. When memory is requested it is taken from here first, and when it is returned it is re-added.
+ </summary>
+ </member>
+ <member name="F:System.Buffers.SlabMemoryPool._slabs">
+ <summary>
+ Thread-safe collection of slabs which have been allocated by this pool. As long as a slab is in this collection and slab.IsActive,
+ the blocks will be added to _blocks when returned.
+ </summary>
+ </member>
+ <member name="F:System.Buffers.SlabMemoryPool._isDisposed">
+ <summary>
+ This is part of implementing the IDisposable pattern.
+ </summary>
+ </member>
+ <member name="F:System.Buffers.SlabMemoryPool.AnySize">
+ <summary>
+ This default value passed in to Rent to use the default value for the pool.
+ </summary>
+ </member>
+ <member name="M:System.Buffers.SlabMemoryPool.Lease">
+ <summary>
+ Called to take a block from the pool.
+ </summary>
+ <returns>The block that is reserved for the called. It must be passed to Return when it is no longer being used.</returns>
+ </member>
+ <member name="M:System.Buffers.SlabMemoryPool.AllocateSlab">
+ <summary>
+ Internal method called when a block is requested and the pool is empty. It allocates one additional slab, creates all of the
+ block tracking objects, and adds them all to the pool.
+ </summary>
+ </member>
+ <member name="M:System.Buffers.SlabMemoryPool.Return(System.Buffers.MemoryPoolBlock)">
+ <summary>
+ Called to return a block to the pool. Once Return has been called the memory no longer belongs to the caller, and
+ Very Bad Things will happen if the memory is read of modified subsequently. If a caller fails to call Return and the
+ block tracking object is garbage collected, the block tracking object's finalizer will automatically re-create and return
+ a new tracking object into the pool. This will only happen if there is a bug in the server, however it is necessary to avoid
+ leaving "dead zones" in the slab due to lost block tracking objects.
+ </summary>
+ <param name="block">The block to return. It must have been acquired by calling Lease on the same memory pool instance.</param>
+ </member>
+ </members>
+</doc>