review.tizen.org Git - platform/core/dotnet/build-tools.git/blob

   1 <?xml version="1.0"?>\r
   2 <doc>\r
   3     <assembly>\r
   4         <name>Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets</name>\r
   5     </assembly>\r
   6     <members>\r
   7         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketTransportOptions.IOQueueCount">\r
   8             <summary>\r
   9             The number of I/O queues used to process requests. Set to 0 to directly schedule I/O to the ThreadPool.\r
  10             </summary>\r
  11             <remarks>\r
  12             Defaults to <see cref="P:System.Environment.ProcessorCount" /> rounded down and clamped between 1 and 16.\r
  13             </remarks>\r
  14         </member>\r
  15         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketTransportOptions.NoDelay">\r
  16             <summary>\r
  17             Set to false to enable Nagle's algorithm for all connections.\r
  18             </summary>\r
  19             <remarks>\r
  20             Defaults to true.\r
  21             </remarks>\r
  22         </member>\r
  23         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketsStrings.OnlyIPEndPointsSupported">\r
  24             <summary>Only ListenType.IPEndPoint is supported by the Socket Transport. https://go.microsoft.com/fwlink/?linkid=874850</summary>\r
  25         </member>\r
  26         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketsStrings.TransportAlreadyBound">\r
  27             <summary>Transport is already bound.</summary>\r
  28         </member>\r
  29         <member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilderSocketExtensions.UseSockets(Microsoft.AspNetCore.Hosting.IWebHostBuilder)">\r
  30             <summary>\r
  31             Specify Sockets as the transport to be used by Kestrel.\r
  32             </summary>\r
  33             <param name="hostBuilder">\r
  34             The Microsoft.AspNetCore.Hosting.IWebHostBuilder to configure.\r
  35             </param>\r
  36             <returns>\r
  37             The Microsoft.AspNetCore.Hosting.IWebHostBuilder.\r
  38             </returns>\r
  39         </member>\r
  40         <member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilderSocketExtensions.UseSockets(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Action{Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketTransportOptions})">\r
  41             <summary>\r
  42             Specify Sockets as the transport to be used by Kestrel.\r
  43             </summary>\r
  44             <param name="hostBuilder">\r
  45             The Microsoft.AspNetCore.Hosting.IWebHostBuilder to configure.\r
  46             </param>\r
  47             <param name="configureOptions">\r
  48             A callback to configure Libuv options.\r
  49             </param>\r
  50             <returns>\r
  51             The Microsoft.AspNetCore.Hosting.IWebHostBuilder.\r
  52             </returns>\r
  53         </member>\r
  54         <member name="T:System.Buffers.DiagnosticMemoryPool">\r
  55             <summary>\r
  56             Used to allocate and distribute re-usable blocks of memory.\r
  57             </summary>\r
  58         </member>\r
  59         <member name="F:System.Buffers.DiagnosticMemoryPool.AnySize">\r
  60             <summary>\r
  61             This default value passed in to Rent to use the default value for the pool.\r
  62             </summary>\r
  63         </member>\r
  64         <member name="T:System.Buffers.DiagnosticPoolBlock">\r
  65             <summary>\r
  66             Block tracking object used by the byte buffer memory pool. A slab is a large allocation which is divided into smaller blocks. The\r
  67             individual blocks are then treated as independent array segments.\r
  68             </summary>\r
  69         </member>\r
  70         <member name="F:System.Buffers.DiagnosticPoolBlock._pool">\r
  71             <summary>\r
  72             Back-reference to the memory pool which this block was allocated from. It may only be returned to this pool.\r
  73             </summary>\r
  74         </member>\r
  75         <member name="M:System.Buffers.DiagnosticPoolBlock.#ctor(System.Buffers.DiagnosticMemoryPool,System.Buffers.IMemoryOwner{System.Byte})">\r
  76             <summary>\r
  77             This object cannot be instantiated outside of the static Create method\r
  78             </summary>\r
  79         </member>\r
  80         <member name="T:System.Buffers.MemoryPoolBlock">\r
  81             <summary>\r
  82             Block tracking object used by the byte buffer memory pool. A slab is a large allocation which is divided into smaller blocks. The\r
  83             individual blocks are then treated as independent array segments.\r
  84             </summary>\r
  85         </member>\r
  86         <member name="M:System.Buffers.MemoryPoolBlock.#ctor(System.Buffers.SlabMemoryPool,System.Buffers.MemoryPoolSlab,System.Int32,System.Int32)">\r
  87             <summary>\r
  88             This object cannot be instantiated outside of the static Create method\r
  89             </summary>\r
  90         </member>\r
  91         <member name="P:System.Buffers.MemoryPoolBlock.Pool">\r
  92             <summary>\r
  93             Back-reference to the memory pool which this block was allocated from. It may only be returned to this pool.\r
  94             </summary>\r
  95         </member>\r
  96         <member name="P:System.Buffers.MemoryPoolBlock.Slab">\r
  97             <summary>\r
  98             Back-reference to the slab from which this block was taken, or null if it is one-time-use memory.\r
  99             </summary>\r
 100         </member>\r
 101         <member name="T:System.Buffers.MemoryPoolSlab">\r
 102             <summary>\r
 103             Slab tracking object used by the byte buffer memory pool. A slab is a large allocation which is divided into smaller blocks. The\r
 104             individual blocks are then treated as independent array segments.\r
 105             </summary>\r
 106         </member>\r
 107         <member name="F:System.Buffers.MemoryPoolSlab._gcHandle">\r
 108             <summary>\r
 109             This handle pins the managed array in memory until the slab is disposed. This prevents it from being\r
 110             relocated and enables any subsections of the array to be used as native memory pointers to P/Invoked API calls.\r
 111             </summary>\r
 112         </member>\r
 113         <member name="P:System.Buffers.MemoryPoolSlab.IsActive">\r
 114             <summary>\r
 115             True as long as the blocks from this slab are to be considered returnable to the pool. In order to shrink the\r
 116             memory pool size an entire slab must be removed. That is done by (1) setting IsActive to false and removing the\r
 117             slab from the pool's _slabs collection, (2) as each block currently in use is Return()ed to the pool it will\r
 118             be allowed to be garbage collected rather than re-pooled, and (3) when all block tracking objects are garbage\r
 119             collected and the slab is no longer references the slab will be garbage collected and the memory unpinned will\r
 120             be unpinned by the slab's Dispose.\r
 121             </summary>\r
 122         </member>\r
 123         <member name="T:System.Buffers.SlabMemoryPool">\r
 124             <summary>\r
 125             Used to allocate and distribute re-usable blocks of memory.\r
 126             </summary>\r
 127         </member>\r
 128         <member name="F:System.Buffers.SlabMemoryPool._blockSize">\r
 129             <summary>\r
 130             The size of a block. 4096 is chosen because most operating systems use 4k pages.\r
 131             </summary>\r
 132         </member>\r
 133         <member name="F:System.Buffers.SlabMemoryPool._blockCount">\r
 134             <summary>\r
 135             Allocating 32 contiguous blocks per slab makes the slab size 128k. This is larger than the 85k size which will place the memory\r
 136             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\r
 137             affect memory management's compactification.\r
 138             </summary>\r
 139         </member>\r
 140         <member name="P:System.Buffers.SlabMemoryPool.MaxBufferSize">\r
 141             <summary>\r
 142             Max allocation block size for pooled blocks,\r
 143             larger values can be leased but they will be disposed after use rather than returned to the pool.\r
 144             </summary>\r
 145         </member>\r
 146         <member name="P:System.Buffers.SlabMemoryPool.BlockSize">\r
 147             <summary>\r
 148             The size of a block. 4096 is chosen because most operating systems use 4k pages.\r
 149             </summary>\r
 150         </member>\r
 151         <member name="F:System.Buffers.SlabMemoryPool._slabLength">\r
 152             <summary>\r
 153             4096 * 32 gives you a slabLength of 128k contiguous bytes allocated per slab\r
 154             </summary>\r
 155         </member>\r
 156         <member name="F:System.Buffers.SlabMemoryPool._blocks">\r
 157             <summary>\r
 158             Thread-safe collection of blocks which are currently in the pool. A slab will pre-allocate all of the block tracking objects\r
 159             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.\r
 160             </summary>\r
 161         </member>\r
 162         <member name="F:System.Buffers.SlabMemoryPool._slabs">\r
 163             <summary>\r
 164             Thread-safe collection of slabs which have been allocated by this pool. As long as a slab is in this collection and slab.IsActive,\r
 165             the blocks will be added to _blocks when returned.\r
 166             </summary>\r
 167         </member>\r
 168         <member name="F:System.Buffers.SlabMemoryPool._isDisposed">\r
 169             <summary>\r
 170             This is part of implementing the IDisposable pattern.\r
 171             </summary>\r
 172         </member>\r
 173         <member name="F:System.Buffers.SlabMemoryPool.AnySize">\r
 174             <summary>\r
 175             This default value passed in to Rent to use the default value for the pool.\r
 176             </summary>\r
 177         </member>\r
 178         <member name="M:System.Buffers.SlabMemoryPool.Lease">\r
 179             <summary>\r
 180             Called to take a block from the pool.\r
 181             </summary>\r
 182             <returns>The block that is reserved for the called. It must be passed to Return when it is no longer being used.</returns>\r
 183         </member>\r
 184         <member name="M:System.Buffers.SlabMemoryPool.AllocateSlab">\r
 185             <summary>\r
 186             Internal method called when a block is requested and the pool is empty. It allocates one additional slab, creates all of the\r
 187             block tracking objects, and adds them all to the pool.\r
 188             </summary>\r
 189         </member>\r
 190         <member name="M:System.Buffers.SlabMemoryPool.Return(System.Buffers.MemoryPoolBlock)">\r
 191             <summary>\r
 192             Called to return a block to the pool. Once Return has been called the memory no longer belongs to the caller, and\r
 193             Very Bad Things will happen if the memory is read of modified subsequently. If a caller fails to call Return and the\r
 194             block tracking object is garbage collected, the block tracking object's finalizer will automatically re-create and return\r
 195             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\r
 196             leaving "dead zones" in the slab due to lost block tracking objects.\r
 197             </summary>\r
 198             <param name="block">The block to return. It must have been acquired by calling Lease on the same memory pool instance.</param>\r
 199         </member>\r
 200     </members>\r
 201 </doc>\r