fullclr/Microsoft.Threading.Tasks.Extensions.xml
|
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 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
<?xml version="1.0"?>
<doc> <assembly> <name>Microsoft.Threading.Tasks.Extensions</name> </assembly> <members> <member name="M:System.Threading.Tasks.TaskServices.FromCancellation(System.Threading.CancellationToken)"> <summary>Returns a canceled task.</summary> <param name="cancellationToken">The cancellation token.</param> <returns>The canceled task.</returns> </member> <member name="M:System.Threading.Tasks.TaskServices.FromCancellation``1(System.Threading.CancellationToken)"> <summary>Returns a canceled task.</summary> <typeparam name="TResult">Specifies the type of the result.</typeparam> <param name="cancellationToken">The cancellation token.</param> <returns>The canceled task.</returns> </member> <member name="M:System.Threading.Tasks.TaskServices.HandleEapCompletion``1(System.Threading.Tasks.TaskCompletionSource{``0},System.Boolean,System.ComponentModel.AsyncCompletedEventArgs,System.Func{``0},System.Action)"> <summary> Completes the Task if the user state matches the TaskCompletionSource. </summary> <typeparam name="T">Specifies the type of data returned by the Task.</typeparam> <param name="tcs">The TaskCompletionSource.</param> <param name="e">The completion event arguments.</param> <param name="requireMatch">Whether we require the tcs to match the e.UserState.</param> <param name="getResult">A function that gets the result with which to complete the task.</param> <param name="unregisterHandler">An action used to unregister work when the operaiton completes.</param> </member> <member name="T:AsyncExtensions"> <summary> Provides asynchronous wrappers for .NET Framework operations. </summary> </member> <member name="M:AsyncExtensions.ReadAsync(System.IO.Stream,System.Byte[],System.Int32,System.Int32)"> <summary> Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. </summary> <returns>A Task that represents the asynchronous read.</returns> <param name="source">The source.</param> <param name="buffer">The buffer to read data into. </param> <param name="offset">The byte offset in at which to begin reading. </param> <param name="count">The maximum number of bytes to read. </param> <exception cref="T:System.ArgumentException">The array length minus is less than <paramref name="count" />. </exception> <exception cref="T:System.ArgumentNullException"> is null. </exception> <exception cref="T:System.ArgumentOutOfRangeException"> or <paramref name="count" /> is negative. </exception> <exception cref="T:System.IO.IOException">An asynchronous read was attempted past the end of the file. </exception> </member> <member name="M:AsyncExtensions.ReadAsync(System.IO.Stream,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)"> <summary> Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. </summary> <returns>A Task that represents the asynchronous read.</returns> <param name="source">The source.</param> <param name="buffer">The buffer to read data into. </param> <param name="offset">The byte offset in at which to begin reading. </param> <param name="count">The maximum number of bytes to read. </param> <param name="cancellationToken">The cancellation token.</param> <exception cref="T:System.ArgumentException">The array length minus is less than <paramref name="count" />. </exception> <exception cref="T:System.ArgumentNullException"> is null. </exception> <exception cref="T:System.ArgumentOutOfRangeException"> or <paramref name="count" /> is negative. </exception> <exception cref="T:System.IO.IOException">An asynchronous read was attempted past the end of the file. </exception> </member> <member name="M:AsyncExtensions.WriteAsync(System.IO.Stream,System.Byte[],System.Int32,System.Int32)"> <summary> Writes asynchronously a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. </summary> <returns>A Task that represents the asynchronous write.</returns> <param name="source">The source.</param> <param name="buffer">The buffer containing data to write to the current stream.</param> <param name="offset">The zero-based byte offset in at which to begin copying bytes to the current stream.</param> <param name="count">The maximum number of bytes to write. </param> <exception cref="T:System.ArgumentException"> length minus <paramref name="offset" /> is less than <paramref name="count" />. </exception> <exception cref="T:System.ArgumentNullException"> is null. </exception> <exception cref="T:System.ArgumentOutOfRangeException"> or <paramref name="count" /> is negative. </exception> <exception cref="T:System.NotSupportedException">The stream does not support writing. </exception> <exception cref="T:System.ObjectDisposedException">The stream is closed. </exception> <exception cref="T:System.IO.IOException">An I/O error occurred. </exception> </member> <member name="M:AsyncExtensions.WriteAsync(System.IO.Stream,System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)"> <summary> Writes asynchronously a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. </summary> <returns>A Task that represents the asynchronous write.</returns> <param name="source">The source.</param> <param name="buffer">The buffer containing data to write to the current stream.</param> <param name="offset">The zero-based byte offset in at which to begin copying bytes to the current stream.</param> <param name="count">The maximum number of bytes to write. </param> <param name="cancellationToken">The cancellation token.</param> <exception cref="T:System.ArgumentException"> length minus <paramref name="offset" /> is less than <paramref name="count" />. </exception> <exception cref="T:System.ArgumentNullException"> is null. </exception> <exception cref="T:System.ArgumentOutOfRangeException"> or <paramref name="count" /> is negative. </exception> <exception cref="T:System.NotSupportedException">The stream does not support writing. </exception> <exception cref="T:System.ObjectDisposedException">The stream is closed. </exception> <exception cref="T:System.IO.IOException">An I/O error occurred. </exception> </member> <member name="M:AsyncExtensions.FlushAsync(System.IO.Stream)"> <summary> Flushes asynchronously the current stream. </summary> <returns>A Task that represents the asynchronous flush.</returns> </member> <member name="M:AsyncExtensions.FlushAsync(System.IO.Stream,System.Threading.CancellationToken)"> <summary> Flushes asynchronously the current stream. </summary> <returns>A Task that represents the asynchronous flush.</returns> </member> <member name="M:AsyncExtensions.CopyToAsync(System.IO.Stream,System.IO.Stream)"> <summary> Reads all the bytes from the current stream and writes them to the destination stream. </summary> <param name="source">The source stream.</param> <param name="destination">The stream that will contain the contents of the current stream.</param> <returns>A Task that represents the asynchronous operation.</returns> </member> <member name="M:AsyncExtensions.CopyToAsync(System.IO.Stream,System.IO.Stream,System.Int32)"> <summary> Reads all the bytes from the current stream and writes them to the destination stream. </summary> <param name="source">The source stream.</param> <param name="destination">The stream that will contain the contents of the current stream.</param> <param name="bufferSize">The size of the buffer. This value must be greater than zero. The default size is 4096.</param> <returns>A Task that represents the asynchronous operation.</returns> </member> <member name="M:AsyncExtensions.CopyToAsync(System.IO.Stream,System.IO.Stream,System.Int32,System.Threading.CancellationToken)"> <summary> Reads all the bytes from the current stream and writes them to the destination stream. </summary> <param name="source">The source stream.</param> <param name="destination">The stream that will contain the contents of the current stream.</param> <param name="bufferSize">The size of the buffer. This value must be greater than zero. The default size is 4096.</param> <param name="cancellationToken">The cancellation token to use to cancel the asynchronous operation.</param> <returns>A Task that represents the asynchronous operation.</returns> </member> <member name="M:AsyncExtensions.CopyToAsyncInternal(System.IO.Stream,System.IO.Stream,System.Int32,System.Threading.CancellationToken)"> <summary> Reads all the bytes from the current stream and writes them to the destination stream. </summary> <param name="source">The source stream.</param> <param name="destination">The stream that will contain the contents of the current stream.</param> <param name="bufferSize">The size of the buffer. This value must be greater than zero. The default size is 4096.</param> <param name="cancellationToken">The cancellation token to use to cancel the asynchronous operation.</param> <returns>A Task that represents the asynchronous operation.</returns> </member> <member name="M:AsyncExtensions.ReadAsync(System.IO.TextReader,System.Char[],System.Int32,System.Int32)"> <summary> Reads a maximum of count characters from the reader asynchronously and writes the data to buffer, beginning at index. </summary> <param name="buffer"> When the operation completes, contains the specified character array with the values between index and (index + count - 1) replaced by the characters read from the current source. </param> <param name="count"> The maximum number of characters to read. If the end of the stream is reached before count of characters is read into buffer, the current method returns. </param> <param name="index">The place in buffer at which to begin writing.</param> <param name="source">the source reader.</param> <returns>A Task that represents the asynchronous operation.</returns> </member> <member name="M:AsyncExtensions.ReadBlockAsync(System.IO.TextReader,System.Char[],System.Int32,System.Int32)"> <summary> Reads asynchronously a maximum of count characters from the current stream, and writes the data to buffer, beginning at index. </summary> <param name="source">The source reader.</param> <param name="buffer"> When this method returns, this parameter contains the specified character array with the values between index and (index + count -1) replaced by the characters read from the current source. </param> <param name="index">The position in buffer at which to begin writing.</param> <param name="count">The maximum number of characters to read.</param> <returns>A Task that represents the asynchronous operation.</returns> </member> <member name="M:AsyncExtensions.ReadLineAsync(System.IO.TextReader)"> <summary> Reads a line of characters from the reader and returns the string asynchronously. </summary> <param name="source">the source reader.</param> <returns>A Task that represents the asynchronous operation.</returns> </member> <member name="M:AsyncExtensions.ReadToEndAsync(System.IO.TextReader)"> <summary> Reads all characters from the current position to the end of the TextReader and returns them as one string asynchronously. </summary> <param name="source">the source reader.</param> <returns>A Task that represents the asynchronous operation.</returns> </member> <member name="M:AsyncExtensions.WriteAsync(System.IO.TextWriter,System.String)"> <summary>Writes a string asynchronously to a text stream.</summary> <param name="target">The writer.</param> <param name="value">The string to write.</param> <returns>A Task representing the asynchronous write.</returns> </member> <member name="M:AsyncExtensions.WriteAsync(System.IO.TextWriter,System.Char)"> <summary>Writes a char asynchronously to a text stream.</summary> <param name="target">The writer.</param> <param name="value">The char to write.</param> <returns>A Task representing the asynchronous write.</returns> </member> <member name="M:AsyncExtensions.WriteAsync(System.IO.TextWriter,System.Char[])"> <summary>Writes a char array asynchronously to a text stream.</summary> <param name="target">The writer.</param> <param name="buffer">The buffer to write.</param> <returns>A Task representing the asynchronous write.</returns> </member> <member name="M:AsyncExtensions.WriteAsync(System.IO.TextWriter,System.Char[],System.Int32,System.Int32)"> <summary>Writes a subarray of characters asynchronously to a text stream.</summary> <param name="target">The writer.</param> <param name="buffer">The buffer to write.</param> <param name="index">Starting index in the buffer.</param> <param name="count">The number of characters to write.</param> <returns>A Task representing the asynchronous write.</returns> </member> <member name="M:AsyncExtensions.WriteLineAsync(System.IO.TextWriter)"> <summary>Writes a line terminator asynchronously to a text stream.</summary> <param name="target">The writer.</param> <returns>A Task representing the asynchronous write.</returns> </member> <member name="M:AsyncExtensions.WriteLineAsync(System.IO.TextWriter,System.String)"> <summary>Writes a string followed by a line terminator asynchronously to a text stream.</summary> <param name="target">The writer.</param> <param name="value">The string to write.</param> <returns>A Task representing the asynchronous write.</returns> </member> <member name="M:AsyncExtensions.WriteLineAsync(System.IO.TextWriter,System.Char)"> <summary>Writes a char followed by a line terminator asynchronously to a text stream.</summary> <param name="target">The writer.</param> <param name="value">The char to write.</param> <returns>A Task representing the asynchronous write.</returns> </member> <member name="M:AsyncExtensions.WriteLineAsync(System.IO.TextWriter,System.Char[])"> <summary>Writes a char array followed by a line terminator asynchronously to a text stream.</summary> <param name="target">The writer.</param> <param name="buffer">The buffer to write.</param> <returns>A Task representing the asynchronous write.</returns> </member> <member name="M:AsyncExtensions.WriteLineAsync(System.IO.TextWriter,System.Char[],System.Int32,System.Int32)"> <summary>Writes a subarray of characters followed by a line terminator asynchronously to a text stream.</summary> <param name="target">The writer.</param> <param name="buffer">The buffer to write.</param> <param name="index">Starting index in the buffer.</param> <param name="count">The number of characters to write.</param> <returns>A Task representing the asynchronous write.</returns> </member> <member name="M:AsyncExtensions.FlushAsync(System.IO.TextWriter)"> <summary> Clears all buffers for the current writer and causes any buffered data to be written to the underlying device. </summary> <param name="target">The writer.</param> <returns>A Task representing the asynchronous flush.</returns> </member> <member name="M:AsyncExtensions.GetResponseAsync(System.Net.WebRequest)"> <summary>Starts an asynchronous request for a web resource.</summary> <returns>Task that represents the asynchronous request.</returns> <exception cref="T:System.InvalidOperationException">The stream is already in use by a previous call to . </exception> <PermissionSet> <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" /> </PermissionSet> <param name="source">The source.</param> </member> <member name="M:AsyncExtensions.GetRequestStreamAsync(System.Net.WebRequest)"> <summary>Starts an asynchronous request for a object to use to write data.</summary> <returns>Task that represents the asynchronous request.</returns> <exception cref="T:System.Net.ProtocolViolationException">The property is GET and the application writes to the stream. </exception> <exception cref="T:System.InvalidOperationException">The stream is being used by a previous call to . </exception> <exception cref="T:System.ApplicationException">No write stream is available. </exception> <PermissionSet> <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Unrestricted="true" /> </PermissionSet> <param name="source">The source.</param> </member> </members> </doc> |