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="T:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionContextFactory">\r
   8             <summary>\r
   9             A factory for socket based connections contexts.\r
  10             </summary>\r
  11         </member>\r
  12         <member name="M:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionContextFactory.#ctor(Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionFactoryOptions,Microsoft.Extensions.Logging.ILogger)">\r
  13             <summary>\r
  14             Creates the <see cref="T:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionContextFactory"/>.\r
  15             </summary>\r
  16             <param name="options">The options.</param>\r
  17             <param name="logger">The logger.</param>\r
  18         </member>\r
  19         <member name="M:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionContextFactory.Create(System.Net.Sockets.Socket)">\r
  20             <summary>\r
  21             Create a <see cref="T:Microsoft.AspNetCore.Connections.ConnectionContext"/> for a socket.\r
  22             </summary>\r
  23             <param name="socket">The socket for the connection.</param>\r
  24             <returns></returns>\r
  25         </member>\r
  26         <member name="M:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionContextFactory.Dispose">\r
  27             <inheritdoc />\r
  28         </member>\r
  29         <member name="T:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionFactoryOptions">\r
  30             <summary>\r
  31             Options for <see cref="T:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionContextFactory"/>.\r
  32             </summary>\r
  33         </member>\r
  34         <member name="M:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionFactoryOptions.#ctor">\r
  35             <summary>\r
  36             Create a new instance.\r
  37             </summary>\r
  38         </member>\r
  39         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionFactoryOptions.IOQueueCount">\r
  40             <summary>\r
  41             The number of I/O queues used to process requests. Set to 0 to directly schedule I/O to the ThreadPool.\r
  42             </summary>\r
  43             <remarks>\r
  44             Defaults to <see cref="P:System.Environment.ProcessorCount" /> rounded down and clamped between 1 and 16.\r
  45             </remarks>\r
  46         </member>\r
  47         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionFactoryOptions.WaitForDataBeforeAllocatingBuffer">\r
  48             <summary>\r
  49             Wait until there is data available to allocate a buffer. Setting this to false can increase throughput at the cost of increased memory usage.\r
  50             </summary>\r
  51             <remarks>\r
  52             Defaults to true.\r
  53             </remarks>\r
  54         </member>\r
  55         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionFactoryOptions.MaxReadBufferSize">\r
  56             <summary>\r
  57             Gets or sets the maximum unconsumed incoming bytes the transport will buffer.\r
  58             </summary>\r
  59         </member>\r
  60         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionFactoryOptions.MaxWriteBufferSize">\r
  61             <summary>\r
  62             Gets or sets the maximum outgoing bytes the transport will buffer before applying write backpressure.\r
  63             </summary>\r
  64         </member>\r
  65         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionFactoryOptions.UnsafePreferInlineScheduling">\r
  66             <summary>\r
  67             Inline application and transport continuations instead of dispatching to the threadpool.\r
  68             </summary>\r
  69             <remarks>\r
  70             This will run application code on the IO thread which is why this is unsafe.\r
  71             It is recommended to set the DOTNET_SYSTEM_NET_SOCKETS_INLINE_COMPLETIONS environment variable to '1' when using this setting to also inline the completions\r
  72             at the runtime layer as well.\r
  73             This setting can make performance worse if there is expensive work that will end up holding onto the IO thread for longer than needed.\r
  74             Test to make sure this setting helps performance.\r
  75             </remarks>\r
  76         </member>\r
  77         <member name="T:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketTransportFactory">\r
  78             <summary>\r
  79             A factory for socket based connections.\r
  80             </summary>\r
  81         </member>\r
  82         <member name="T:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketTransportOptions">\r
  83             <summary>\r
  84             Options for socket based transports.\r
  85             </summary>\r
  86         </member>\r
  87         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketTransportOptions.IOQueueCount">\r
  88             <summary>\r
  89             The number of I/O queues used to process requests. Set to 0 to directly schedule I/O to the ThreadPool.\r
  90             </summary>\r
  91             <remarks>\r
  92             Defaults to <see cref="P:System.Environment.ProcessorCount" /> rounded down and clamped between 1 and 16.\r
  93             </remarks>\r
  94         </member>\r
  95         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketTransportOptions.WaitForDataBeforeAllocatingBuffer">\r
  96             <summary>\r
  97             Wait until there is data available to allocate a buffer. Setting this to false can increase throughput at the cost of increased memory usage.\r
  98             </summary>\r
  99             <remarks>\r
 100             Defaults to true.\r
 101             </remarks>\r
 102         </member>\r
 103         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketTransportOptions.NoDelay">\r
 104             <summary>\r
 105             Set to false to enable Nagle's algorithm for all connections.\r
 106             </summary>\r
 107             <remarks>\r
 108             Defaults to true.\r
 109             </remarks>\r
 110         </member>\r
 111         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketTransportOptions.Backlog">\r
 112             <summary>\r
 113             The maximum length of the pending connection queue.\r
 114             </summary>\r
 115             <remarks>\r
 116             Defaults to 512.\r
 117             </remarks>\r
 118         </member>\r
 119         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketTransportOptions.MaxReadBufferSize">\r
 120             <summary>\r
 121             Gets or sets the maximum unconsumed incoming bytes the transport will buffer.\r
 122             </summary>\r
 123         </member>\r
 124         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketTransportOptions.MaxWriteBufferSize">\r
 125             <summary>\r
 126             Gets or sets the maximum outgoing bytes the transport will buffer before applying write backpressure.\r
 127             </summary>\r
 128         </member>\r
 129         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketTransportOptions.UnsafePreferInlineScheduling">\r
 130             <summary>\r
 131             Inline application and transport continuations instead of dispatching to the threadpool.\r
 132             </summary>\r
 133             <remarks>\r
 134             This will run application code on the IO thread which is why this is unsafe.\r
 135             It is recommended to set the DOTNET_SYSTEM_NET_SOCKETS_INLINE_COMPLETIONS environment variable to '1' when using this setting to also inline the completions\r
 136             at the runtime layer as well.\r
 137             This setting can make performance worse if there is expensive work that will end up holding onto the IO thread for longer than needed.\r
 138             Test to make sure this setting helps performance.\r
 139             </remarks>\r
 140         </member>\r
 141         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketTransportOptions.CreateBoundListenSocket">\r
 142             <summary>\r
 143             A function used to create a new <see cref="T:System.Net.Sockets.Socket"/> to listen with. If\r
 144             not set, <see cref="M:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketTransportOptions.CreateDefaultBoundListenSocket(System.Net.EndPoint)" /> is used.\r
 145             </summary>\r
 146             <remarks>\r
 147             Implementors are expected to call <see cref="M:System.Net.Sockets.Socket.Bind(System.Net.EndPoint)"/> on the\r
 148             <see cref="T:System.Net.Sockets.Socket"/>. Please note that <see cref="M:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketTransportOptions.CreateDefaultBoundListenSocket(System.Net.EndPoint)"/>\r
 149             calls <see cref="M:System.Net.Sockets.Socket.Bind(System.Net.EndPoint)"/> as part of its implementation, so implementors\r
 150             using this method do not need to call it again.\r
 151             </remarks>\r
 152         </member>\r
 153         <member name="M:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketTransportOptions.CreateDefaultBoundListenSocket(System.Net.EndPoint)">\r
 154             <summary>\r
 155             Creates a default instance of <see cref="T:System.Net.Sockets.Socket"/> for the given <see cref="T:System.Net.EndPoint"/>\r
 156             that can be used by a connection listener to listen for inbound requests. <see cref="M:System.Net.Sockets.Socket.Bind(System.Net.EndPoint)"/>\r
 157             is called by this method.\r
 158             </summary>\r
 159             <param name="endpoint">\r
 160             An <see cref="T:System.Net.EndPoint"/>.\r
 161             </param>\r
 162             <returns>\r
 163             A <see cref="T:System.Net.Sockets.Socket"/> instance.\r
 164             </returns>\r
 165         </member>\r
 166         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketsStrings.FileHandleEndPointNotSupported">\r
 167             <summary>The Socket transport does not support binding to file handles. Consider using the libuv transport instead.</summary>\r
 168         </member>\r
 169         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketsStrings.OnlyIPEndPointsSupported">\r
 170             <summary>Only ListenType.IPEndPoint is supported by the Socket Transport. https://go.microsoft.com/fwlink/?linkid=874850</summary>\r
 171         </member>\r
 172         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketsStrings.TransportAlreadyBound">\r
 173             <summary>Transport is already bound.</summary>\r
 174         </member>\r
 175         <member name="T:Microsoft.AspNetCore.Hosting.WebHostBuilderSocketExtensions">\r
 176             <summary>\r
 177             <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder" /> extension methods to configure the Socket transport to be used by Kestrel.\r
 178             </summary>\r
 179         </member>\r
 180         <member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilderSocketExtensions.UseSockets(Microsoft.AspNetCore.Hosting.IWebHostBuilder)">\r
 181             <summary>\r
 182             Specify Sockets as the transport to be used by Kestrel.\r
 183             </summary>\r
 184             <param name="hostBuilder">\r
 185             The Microsoft.AspNetCore.Hosting.IWebHostBuilder to configure.\r
 186             </param>\r
 187             <returns>\r
 188             The Microsoft.AspNetCore.Hosting.IWebHostBuilder.\r
 189             </returns>\r
 190         </member>\r
 191         <member name="M:Microsoft.AspNetCore.Hosting.WebHostBuilderSocketExtensions.UseSockets(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Action{Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketTransportOptions})">\r
 192             <summary>\r
 193             Specify Sockets as the transport to be used by Kestrel.\r
 194             </summary>\r
 195             <param name="hostBuilder">\r
 196             The Microsoft.AspNetCore.Hosting.IWebHostBuilder to configure.\r
 197             </param>\r
 198             <param name="configureOptions">\r
 199             A callback to configure Libuv options.\r
 200             </param>\r
 201             <returns>\r
 202             The Microsoft.AspNetCore.Hosting.IWebHostBuilder.\r
 203             </returns>\r
 204         </member>\r
 205         <member name="T:System.Buffers.DiagnosticMemoryPool">\r
 206             <summary>\r
 207             Used to allocate and distribute re-usable blocks of memory.\r
 208             </summary>\r
 209         </member>\r
 210         <member name="F:System.Buffers.DiagnosticMemoryPool.AnySize">\r
 211             <summary>\r
 212             This default value passed in to Rent to use the default value for the pool.\r
 213             </summary>\r
 214         </member>\r
 215         <member name="T:System.Buffers.DiagnosticPoolBlock">\r
 216             <summary>\r
 217             Block tracking object used by the byte buffer memory pool. A slab is a large allocation which is divided into smaller blocks. The\r
 218             individual blocks are then treated as independent array segments.\r
 219             </summary>\r
 220         </member>\r
 221         <member name="F:System.Buffers.DiagnosticPoolBlock._pool">\r
 222             <summary>\r
 223             Back-reference to the memory pool which this block was allocated from. It may only be returned to this pool.\r
 224             </summary>\r
 225         </member>\r
 226         <member name="M:System.Buffers.DiagnosticPoolBlock.#ctor(System.Buffers.DiagnosticMemoryPool,System.Buffers.IMemoryOwner{System.Byte})">\r
 227             <summary>\r
 228             This object cannot be instantiated outside of the static Create method\r
 229             </summary>\r
 230         </member>\r
 231         <member name="T:System.Buffers.MemoryPoolBlock">\r
 232             <summary>\r
 233             Wraps an array allocated in the pinned object heap in a reusable block of managed memory\r
 234             </summary>\r
 235         </member>\r
 236         <member name="P:System.Buffers.MemoryPoolBlock.Pool">\r
 237             <summary>\r
 238             Back-reference to the memory pool which this block was allocated from. It may only be returned to this pool.\r
 239             </summary>\r
 240         </member>\r
 241         <member name="T:System.Buffers.PinnedBlockMemoryPool">\r
 242             <summary>\r
 243             Used to allocate and distribute re-usable blocks of memory.\r
 244             </summary>\r
 245         </member>\r
 246         <member name="F:System.Buffers.PinnedBlockMemoryPool._blockSize">\r
 247             <summary>\r
 248             The size of a block. 4096 is chosen because most operating systems use 4k pages.\r
 249             </summary>\r
 250         </member>\r
 251         <member name="P:System.Buffers.PinnedBlockMemoryPool.MaxBufferSize">\r
 252             <summary>\r
 253             Max allocation block size for pooled blocks,\r
 254             larger values can be leased but they will be disposed after use rather than returned to the pool.\r
 255             </summary>\r
 256         </member>\r
 257         <member name="P:System.Buffers.PinnedBlockMemoryPool.BlockSize">\r
 258             <summary>\r
 259             The size of a block. 4096 is chosen because most operating systems use 4k pages.\r
 260             </summary>\r
 261         </member>\r
 262         <member name="F:System.Buffers.PinnedBlockMemoryPool._blocks">\r
 263             <summary>\r
 264             Thread-safe collection of blocks which are currently in the pool. A slab will pre-allocate all of the block tracking objects\r
 265             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
 266             </summary>\r
 267         </member>\r
 268         <member name="F:System.Buffers.PinnedBlockMemoryPool._isDisposed">\r
 269             <summary>\r
 270             This is part of implementing the IDisposable pattern.\r
 271             </summary>\r
 272         </member>\r
 273         <member name="F:System.Buffers.PinnedBlockMemoryPool.AnySize">\r
 274             <summary>\r
 275             This default value passed in to Rent to use the default value for the pool.\r
 276             </summary>\r
 277         </member>\r
 278         <member name="M:System.Buffers.PinnedBlockMemoryPool.Return(System.Buffers.MemoryPoolBlock)">\r
 279             <summary>\r
 280             Called to return a block to the pool. Once Return has been called the memory no longer belongs to the caller, and\r
 281             Very Bad Things will happen if the memory is read of modified subsequently. If a caller fails to call Return and the\r
 282             block tracking object is garbage collected, the block tracking object's finalizer will automatically re-create and return\r
 283             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
 284             leaving "dead zones" in the slab due to lost block tracking objects.\r
 285             </summary>\r
 286             <param name="block">The block to return. It must have been acquired by calling Lease on the same memory pool instance.</param>\r
 287         </member>\r
 288     </members>\r
 289 </doc>\r