1 <?xml version="1.0" encoding="utf-8"?>
4 <name>System.Net.HttpListener</name>
7 <member name="T:System.Net.AuthenticationSchemeSelector">
8 <summary>Selects the authentication scheme for an <see cref="T:System.Net.HttpListener" /> instance.</summary>
9 <param name="httpRequest">The <see cref="T:System.Net.HttpListenerRequest" /> instance for which to select an authentication scheme.</param>
10 <returns>One of the <see cref="T:System.Net.AuthenticationSchemes" /> values that indicates the method of authentication to use for the specified client request.</returns>
12 <member name="T:System.Net.HttpListener">
13 <summary>Provides a simple, programmatically controlled HTTP protocol listener. This class cannot be inherited.</summary>
15 <member name="M:System.Net.HttpListener.#ctor">
16 <summary>Initializes a new instance of the <see cref="T:System.Net.HttpListener" /> class.</summary>
17 <exception cref="T:System.PlatformNotSupportedException">This class cannot be used on the current operating system. Windows Server 2003 or Windows XP SP2 is required to use instances of this class.</exception>
19 <member name="M:System.Net.HttpListener.Abort">
20 <summary>Shuts down the <see cref="T:System.Net.HttpListener" /> object immediately, discarding all currently queued requests.</summary>
22 <member name="M:System.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object)">
23 <summary>Begins asynchronously retrieving an incoming request.</summary>
24 <param name="callback">An <see cref="T:System.AsyncCallback" /> delegate that references the method to invoke when a client request is available.</param>
25 <param name="state">A user-defined object that contains information about the operation. This object is passed to the <paramref name="callback" /> delegate when the operation completes.</param>
26 <exception cref="T:System.Net.HttpListenerException">A Win32 function call failed. Check the exception's <see cref="P:System.Net.HttpListenerException.ErrorCode" /> property to determine the cause of the exception.</exception>
27 <exception cref="T:System.InvalidOperationException">This object has not been started or is currently stopped.</exception>
28 <exception cref="T:System.ObjectDisposedException">This object is closed.</exception>
29 <returns>An <see cref="T:System.IAsyncResult" /> object that indicates the status of the asynchronous operation.</returns>
31 <member name="M:System.Net.HttpListener.Close">
32 <summary>Shuts down the <see cref="T:System.Net.HttpListener" />.</summary>
34 <member name="M:System.Net.HttpListener.EndGetContext(System.IAsyncResult)">
35 <summary>Completes an asynchronous operation to retrieve an incoming client request.</summary>
36 <param name="asyncResult">An <see cref="T:System.IAsyncResult" /> object that was obtained when the asynchronous operation was started.</param>
37 <exception cref="T:System.ArgumentException">
38 <paramref name="asyncResult" /> was not obtained by calling the <see cref="M:System.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object)" /> method.</exception>
39 <exception cref="T:System.ArgumentNullException">
40 <paramref name="asyncResult" /> is <see langword="null" />.</exception>
41 <exception cref="T:System.Net.HttpListenerException">A Win32 function call failed. Check the exception's <see cref="P:System.Net.HttpListenerException.ErrorCode" /> property to determine the cause of the exception.</exception>
42 <exception cref="T:System.InvalidOperationException">The <see cref="M:System.Net.HttpListener.EndGetContext(System.IAsyncResult)" /> method was already called for the specified <paramref name="asyncResult" /> object.</exception>
43 <exception cref="T:System.ObjectDisposedException">This object is closed.</exception>
44 <returns>An <see cref="T:System.Net.HttpListenerContext" /> object that represents the client request.</returns>
46 <member name="M:System.Net.HttpListener.GetContext">
47 <summary>Waits for an incoming request and returns when one is received.</summary>
48 <exception cref="T:System.Net.HttpListenerException">A Win32 function call failed. Check the exception's <see cref="P:System.Net.HttpListenerException.ErrorCode" /> property to determine the cause of the exception.</exception>
49 <exception cref="T:System.InvalidOperationException">This object has not been started or is currently stopped.
53 The <see cref="T:System.Net.HttpListener" /> does not have any Uniform Resource Identifier (URI) prefixes to respond to.</exception>
54 <exception cref="T:System.ObjectDisposedException">This object is closed.</exception>
55 <returns>An <see cref="T:System.Net.HttpListenerContext" /> object that represents a client request.</returns>
57 <member name="M:System.Net.HttpListener.GetContextAsync">
58 <summary>Waits for an incoming request as an asynchronous operation.</summary>
59 <returns>The task object representing the asynchronous operation. The <see cref="P:System.Threading.Tasks.Task`1.Result" /> property on the task object returns an <see cref="T:System.Net.HttpListenerContext" /> object that represents a client request.</returns>
61 <member name="M:System.Net.HttpListener.Start">
62 <summary>Allows this instance to receive incoming requests.</summary>
63 <exception cref="T:System.Net.HttpListenerException">A Win32 function call failed. Check the exception's <see cref="P:System.Net.HttpListenerException.ErrorCode" /> property to determine the cause of the exception.</exception>
64 <exception cref="T:System.ObjectDisposedException">This object is closed.</exception>
66 <member name="M:System.Net.HttpListener.Stop">
67 <summary>Causes this instance to stop receiving new incoming requests and terminates processing of all ongoing requests.</summary>
68 <exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
70 <member name="M:System.Net.HttpListener.System#IDisposable#Dispose">
71 <summary>Releases the resources held by this <see cref="T:System.Net.HttpListener" /> object.</summary>
73 <member name="P:System.Net.HttpListener.AuthenticationSchemes">
74 <summary>Gets or sets the scheme used to authenticate clients.</summary>
75 <exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
76 <returns>A bitwise combination of <see cref="T:System.Net.AuthenticationSchemes" /> enumeration values that indicates how clients are to be authenticated. The default value is <see cref="F:System.Net.AuthenticationSchemes.Anonymous" />.</returns>
78 <member name="P:System.Net.HttpListener.AuthenticationSchemeSelectorDelegate">
79 <summary>Gets or sets the delegate called to determine the protocol used to authenticate clients.</summary>
80 <exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
81 <returns>An <see cref="T:System.Net.AuthenticationSchemeSelector" /> delegate that invokes the method used to select an authentication protocol. The default value is <see langword="null" />.</returns>
83 <member name="P:System.Net.HttpListener.DefaultServiceNames">
84 <summary>Gets a default list of Service Provider Names (SPNs) as determined by registered prefixes.</summary>
85 <returns>A <see cref="T:System.Security.Authentication.ExtendedProtection.ServiceNameCollection" /> that contains a list of SPNs.</returns>
87 <member name="P:System.Net.HttpListener.ExtendedProtectionPolicy">
88 <summary>Gets or sets the <see cref="T:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy" /> to use for extended protection for a session.</summary>
89 <exception cref="T:System.ArgumentException">An attempt was made to set the <see cref="P:System.Net.HttpListener.ExtendedProtectionPolicy" /> property, but the <see cref="P:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.CustomChannelBinding" /> property was not <see langword="null" />.</exception>
90 <exception cref="T:System.ArgumentNullException">An attempt was made to set the <see cref="P:System.Net.HttpListener.ExtendedProtectionPolicy" /> property to <see langword="null" />.</exception>
91 <exception cref="T:System.InvalidOperationException">An attempt was made to set the <see cref="P:System.Net.HttpListener.ExtendedProtectionPolicy" /> property after the <see cref="M:System.Net.HttpListener.Start" /> method was already called.</exception>
92 <exception cref="T:System.ObjectDisposedException">This object is closed.</exception>
93 <exception cref="T:System.PlatformNotSupportedException">The <see cref="P:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.PolicyEnforcement" /> property was set to <see cref="F:System.Security.Authentication.ExtendedProtection.PolicyEnforcement.Always" /> on a platform that does not support extended protection.</exception>
94 <returns>A <see cref="T:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy" /> that specifies the policy to use for extended protection.</returns>
96 <member name="P:System.Net.HttpListener.ExtendedProtectionSelectorDelegate">
97 <summary>Gets or sets the delegate called to determine the <see cref="T:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy" /> to use for each request.</summary>
98 <exception cref="T:System.ArgumentException">An attempt was made to set the <see cref="P:System.Net.HttpListener.ExtendedProtectionSelectorDelegate" /> property, but the <see cref="P:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy.CustomChannelBinding" /> property must be <see langword="null" />.</exception>
99 <exception cref="T:System.ArgumentNullException">An attempt was made to set the <see cref="P:System.Net.HttpListener.ExtendedProtectionSelectorDelegate" /> property to <see langword="null" />.</exception>
100 <exception cref="T:System.InvalidOperationException">An attempt was made to set the <see cref="P:System.Net.HttpListener.ExtendedProtectionSelectorDelegate" /> property after the <see cref="M:System.Net.HttpListener.Start" /> method was already called.</exception>
101 <exception cref="T:System.ObjectDisposedException">This object is closed.</exception>
102 <exception cref="T:System.PlatformNotSupportedException">An attempt was made to set the <see cref="P:System.Net.HttpListener.ExtendedProtectionSelectorDelegate" /> property on a platform that does not support extended protection.</exception>
103 <returns>A <see cref="T:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy" /> that specifies the policy to use for extended protection.</returns>
105 <member name="P:System.Net.HttpListener.IgnoreWriteExceptions">
106 <summary>Gets or sets a <see cref="T:System.Boolean" /> value that specifies whether your application receives exceptions that occur when an <see cref="T:System.Net.HttpListener" /> sends the response to the client.</summary>
107 <exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
109 <see langword="true" /> if this <see cref="T:System.Net.HttpListener" /> should not return exceptions that occur when sending the response to the client; otherwise, <see langword="false" />. The default value is <see langword="false" />.</returns>
111 <member name="P:System.Net.HttpListener.IsListening">
112 <summary>Gets a value that indicates whether <see cref="T:System.Net.HttpListener" /> has been started.</summary>
114 <see langword="true" /> if the <see cref="T:System.Net.HttpListener" /> was started; otherwise, <see langword="false" />.</returns>
116 <member name="P:System.Net.HttpListener.IsSupported">
117 <summary>Gets a value that indicates whether <see cref="T:System.Net.HttpListener" /> can be used with the current operating system.</summary>
119 <see langword="true" /> on all platforms.</returns>
121 <member name="P:System.Net.HttpListener.Prefixes">
122 <summary>Gets the Uniform Resource Identifier (URI) prefixes handled by this <see cref="T:System.Net.HttpListener" /> object.</summary>
123 <exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
124 <returns>An <see cref="T:System.Net.HttpListenerPrefixCollection" /> that contains the URI prefixes that this <see cref="T:System.Net.HttpListener" /> object is configured to handle.</returns>
126 <member name="P:System.Net.HttpListener.Realm">
127 <summary>Gets or sets the realm, or resource partition, associated with this <see cref="T:System.Net.HttpListener" /> object.</summary>
128 <exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
129 <returns>A <see cref="T:System.String" /> value that contains the name of the realm associated with the <see cref="T:System.Net.HttpListener" /> object.</returns>
131 <member name="P:System.Net.HttpListener.TimeoutManager">
132 <summary>The timeout manager for this <see cref="T:System.Net.HttpListener" /> instance.</summary>
133 <returns>The timeout manager for this <see cref="T:System.Net.HttpListener" /> instance.</returns>
135 <member name="P:System.Net.HttpListener.UnsafeConnectionNtlmAuthentication">
136 <summary>Gets or sets a <see cref="T:System.Boolean" /> value that controls whether, when NTLM is used, additional requests using the same Transmission Control Protocol (TCP) connection are required to authenticate.</summary>
137 <exception cref="T:System.ObjectDisposedException">This object has been closed.</exception>
139 <see langword="true" /> if the <see cref="T:System.Security.Principal.IIdentity" /> of the first request will be used for subsequent requests on the same connection; otherwise, <see langword="false" />. The default value is <see langword="false" />.</returns>
141 <member name="T:System.Net.HttpListener.ExtendedProtectionSelector">
142 <summary>A delegate called to determine the <see cref="T:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy" /> to use for each <see cref="T:System.Net.HttpListener" /> request.</summary>
143 <param name="request">The <see cref="T:System.Net.HttpListenerRequest" /> to determine the extended protection policy that the <see cref="T:System.Net.HttpListener" /> instance will use to provide extended protection.</param>
144 <returns>An <see cref="T:System.Security.Authentication.ExtendedProtection.ExtendedProtectionPolicy" /> object that specifies the extended protection policy to use for this request.</returns>
146 <member name="T:System.Net.HttpListenerBasicIdentity">
147 <summary>Holds the user name and password from a basic authentication request.</summary>
149 <member name="M:System.Net.HttpListenerBasicIdentity.#ctor(System.String,System.String)">
150 <summary>Initializes a new instance of the <see cref="T:System.Net.HttpListenerBasicIdentity" /> class using the specified user name and password.</summary>
151 <param name="username">The user name.</param>
152 <param name="password">The password.</param>
154 <member name="P:System.Net.HttpListenerBasicIdentity.Password">
155 <summary>Indicates the password from a basic authentication attempt.</summary>
156 <returns>A <see cref="T:System.String" /> that holds the password.</returns>
158 <member name="T:System.Net.HttpListenerContext">
159 <summary>Provides access to the request and response objects used by the <see cref="T:System.Net.HttpListener" /> class. This class cannot be inherited.</summary>
161 <member name="M:System.Net.HttpListenerContext.AcceptWebSocketAsync(System.String)">
162 <summary>Accept a WebSocket connection as an asynchronous operation.</summary>
163 <param name="subProtocol">The supported WebSocket sub-protocol.</param>
164 <exception cref="T:System.ArgumentException">
165 <paramref name="subProtocol" /> is an empty string
169 <paramref name="subProtocol" /> contains illegal characters.</exception>
170 <exception cref="T:System.Net.WebSockets.WebSocketException">An error occurred when sending the response to complete the WebSocket handshake.</exception>
171 <returns>The task object representing the asynchronous operation. The <see cref="P:System.Threading.Tasks.Task`1.Result" /> property on the task object returns an <see cref="T:System.Net.WebSockets.HttpListenerWebSocketContext" /> object.</returns>
173 <member name="M:System.Net.HttpListenerContext.AcceptWebSocketAsync(System.String,System.Int32,System.TimeSpan)">
174 <summary>Accept a WebSocket connection specifying the supported WebSocket sub-protocol, receive buffer size, and WebSocket keep-alive interval as an asynchronous operation.</summary>
175 <param name="subProtocol">The supported WebSocket sub-protocol.</param>
176 <param name="receiveBufferSize">The receive buffer size in bytes.</param>
177 <param name="keepAliveInterval">The WebSocket protocol keep-alive interval in milliseconds.</param>
178 <exception cref="T:System.ArgumentException">
179 <paramref name="subProtocol" /> is an empty string
183 <paramref name="subProtocol" /> contains illegal characters.</exception>
184 <exception cref="T:System.ArgumentOutOfRangeException">
185 <paramref name="keepAliveInterval" /> is too small.
189 <paramref name="receiveBufferSize" /> is less than 16 bytes
193 <paramref name="receiveBufferSize" /> is greater than 64K bytes.</exception>
194 <exception cref="T:System.Net.WebSockets.WebSocketException">An error occurred when sending the response to complete the WebSocket handshake.</exception>
195 <returns>The task object representing the asynchronous operation. The <see cref="P:System.Threading.Tasks.Task`1.Result" /> property on the task object returns an <see cref="T:System.Net.WebSockets.HttpListenerWebSocketContext" /> object.</returns>
197 <member name="M:System.Net.HttpListenerContext.AcceptWebSocketAsync(System.String,System.Int32,System.TimeSpan,System.ArraySegment{System.Byte})">
198 <summary>Accept a WebSocket connection specifying the supported WebSocket sub-protocol, receive buffer size, WebSocket keep-alive interval, and the internal buffer as an asynchronous operation.</summary>
199 <param name="subProtocol">The supported WebSocket sub-protocol.</param>
200 <param name="receiveBufferSize">The receive buffer size in bytes.</param>
201 <param name="keepAliveInterval">The WebSocket protocol keep-alive interval in milliseconds.</param>
202 <param name="internalBuffer">An internal buffer to use for this operation.</param>
203 <exception cref="T:System.ArgumentException">
204 <paramref name="subProtocol" /> is an empty string
208 <paramref name="subProtocol" /> contains illegal characters.</exception>
209 <exception cref="T:System.ArgumentOutOfRangeException">
210 <paramref name="keepAliveInterval" /> is too small.
214 <paramref name="receiveBufferSize" /> is less than 16 bytes
218 <paramref name="receiveBufferSize" /> is greater than 64K bytes.</exception>
219 <exception cref="T:System.Net.WebSockets.WebSocketException">An error occurred when sending the response to complete the WebSocket handshake.</exception>
220 <returns>The task object representing the asynchronous operation. The <see cref="P:System.Threading.Tasks.Task`1.Result" /> property on the task object returns an <see cref="T:System.Net.WebSockets.HttpListenerWebSocketContext" /> object.</returns>
222 <member name="M:System.Net.HttpListenerContext.AcceptWebSocketAsync(System.String,System.TimeSpan)">
223 <summary>Accept a WebSocket connection specifying the supported WebSocket sub-protocol and WebSocket keep-alive interval as an asynchronous operation.</summary>
224 <param name="subProtocol">The supported WebSocket sub-protocol.</param>
225 <param name="keepAliveInterval">The WebSocket protocol keep-alive interval in milliseconds.</param>
226 <exception cref="T:System.ArgumentException">
227 <paramref name="subProtocol" /> is an empty string
231 <paramref name="subProtocol" /> contains illegal characters.</exception>
232 <exception cref="T:System.ArgumentOutOfRangeException">
233 <paramref name="keepAliveInterval" /> is too small.</exception>
234 <exception cref="T:System.Net.WebSockets.WebSocketException">An error occurred when sending the response to complete the WebSocket handshake.</exception>
235 <returns>The task object representing the asynchronous operation. The <see cref="P:System.Threading.Tasks.Task`1.Result" /> property on the task object returns an <see cref="T:System.Net.WebSockets.HttpListenerWebSocketContext" /> object.</returns>
237 <member name="P:System.Net.HttpListenerContext.Request">
238 <summary>Gets the <see cref="T:System.Net.HttpListenerRequest" /> that represents a client's request for a resource.</summary>
239 <returns>An <see cref="T:System.Net.HttpListenerRequest" /> object that represents the client request.</returns>
241 <member name="P:System.Net.HttpListenerContext.Response">
242 <summary>Gets the <see cref="T:System.Net.HttpListenerResponse" /> object that will be sent to the client in response to the client's request.</summary>
243 <returns>An <see cref="T:System.Net.HttpListenerResponse" /> object used to send a response back to the client.</returns>
245 <member name="P:System.Net.HttpListenerContext.User">
246 <summary>Gets an object used to obtain identity, authentication information, and security roles for the client whose request is represented by this <see cref="T:System.Net.HttpListenerContext" /> object.</summary>
247 <returns>An <see cref="T:System.Security.Principal.IPrincipal" /> object that describes the client, or <see langword="null" /> if the <see cref="T:System.Net.HttpListener" /> that supplied this <see cref="T:System.Net.HttpListenerContext" /> does not require authentication.</returns>
249 <member name="T:System.Net.HttpListenerException">
250 <summary>The exception that is thrown when an error occurs processing an HTTP request.</summary>
252 <member name="M:System.Net.HttpListenerException.#ctor">
253 <summary>Initializes a new instance of the <see cref="T:System.Net.HttpListenerException" /> class.</summary>
255 <member name="M:System.Net.HttpListenerException.#ctor(System.Int32)">
256 <summary>Initializes a new instance of the <see cref="T:System.Net.HttpListenerException" /> class using the specified error code.</summary>
257 <param name="errorCode">A <see cref="T:System.Int32" /> value that identifies the error that occurred.</param>
259 <member name="M:System.Net.HttpListenerException.#ctor(System.Int32,System.String)">
260 <summary>Initializes a new instance of the <see cref="T:System.Net.HttpListenerException" /> class using the specified error code and message.</summary>
261 <param name="errorCode">A <see cref="T:System.Int32" /> value that identifies the error that occurred.</param>
262 <param name="message">A <see cref="T:System.String" /> that describes the error that occurred.</param>
264 <member name="M:System.Net.HttpListenerException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
265 <summary>Initializes a new instance of the <see cref="T:System.Net.HttpListenerException" /> class from the specified instances of the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> and <see cref="T:System.Runtime.Serialization.StreamingContext" /> classes.</summary>
266 <param name="serializationInfo">A <see cref="T:System.Runtime.Serialization.SerializationInfo" /> object that contains the information required to deserialize the new <see cref="T:System.Net.HttpListenerException" /> object.</param>
267 <param name="streamingContext">A <see cref="T:System.Runtime.Serialization.StreamingContext" /> object.</param>
269 <member name="P:System.Net.HttpListenerException.ErrorCode">
270 <summary>Gets a value that identifies the error that occurred.</summary>
271 <returns>A <see cref="T:System.Int32" /> value.</returns>
273 <member name="T:System.Net.HttpListenerPrefixCollection">
274 <summary>Represents the collection used to store Uniform Resource Identifier (URI) prefixes for <see cref="T:System.Net.HttpListener" /> objects.</summary>
276 <member name="M:System.Net.HttpListenerPrefixCollection.Add(System.String)">
277 <summary>Adds a Uniform Resource Identifier (URI) prefix to the collection.</summary>
278 <param name="uriPrefix">A <see cref="T:System.String" /> that identifies the URI information that is compared in incoming requests. The prefix must be terminated with a forward slash ("/").</param>
279 <exception cref="T:System.ArgumentNullException">
280 <paramref name="uriPrefix" /> is <see langword="null" />.</exception>
281 <exception cref="T:System.ArgumentException">
282 <paramref name="uriPrefix" /> does not use the http:// or https:// scheme. These are the only schemes supported for <see cref="T:System.Net.HttpListener" /> objects.
286 <paramref name="uriPrefix" /> is not a correctly formatted URI prefix. Make sure the string is terminated with a "/".</exception>
287 <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.HttpListener" /> associated with this collection is closed.</exception>
288 <exception cref="T:System.Net.HttpListenerException">A Windows function call failed. Check the exception's <see cref="P:System.Net.HttpListenerException.ErrorCode" /> property to determine the cause of the exception. This exception is thrown if another <see cref="T:System.Net.HttpListener" /> has already added the prefix <paramref name="uriPrefix" />.</exception>
290 <member name="M:System.Net.HttpListenerPrefixCollection.Clear">
291 <summary>Removes all the Uniform Resource Identifier (URI) prefixes from the collection.</summary>
292 <exception cref="T:System.Net.HttpListenerException">A Windows function call failed. Check the exception's <see cref="P:System.Net.HttpListenerException.ErrorCode" /> property to determine the cause of the exception.</exception>
293 <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.HttpListener" /> associated with this collection is closed.</exception>
295 <member name="M:System.Net.HttpListenerPrefixCollection.Contains(System.String)">
296 <summary>Returns a <see cref="T:System.Boolean" /> value that indicates whether the specified prefix is contained in the collection.</summary>
297 <param name="uriPrefix">A <see cref="T:System.String" /> that contains the Uniform Resource Identifier (URI) prefix to test.</param>
298 <exception cref="T:System.ArgumentNullException">
299 <paramref name="uriPrefix" /> is <see langword="null" />.</exception>
301 <see langword="true" /> if this collection contains the prefix specified by <paramref name="uriPrefix" />; otherwise, <see langword="false" />.</returns>
303 <member name="M:System.Net.HttpListenerPrefixCollection.CopyTo(System.Array,System.Int32)">
304 <summary>Copies the contents of an <see cref="T:System.Net.HttpListenerPrefixCollection" /> to the specified array.</summary>
305 <param name="array">The one dimensional <see cref="T:System.Array" /> that receives the Uniform Resource Identifier (URI) prefix strings in this collection.</param>
306 <param name="offset">The zero-based index in <paramref name="array" /> at which copying begins.</param>
307 <exception cref="T:System.ArgumentException">
308 <paramref name="array" /> has more than one dimension.</exception>
309 <exception cref="T:System.ArgumentOutOfRangeException">This collection contains more elements than can be stored in <paramref name="array" /> starting at <paramref name="offset" />.</exception>
310 <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.HttpListener" /> associated with this collection is closed.</exception>
311 <exception cref="T:System.InvalidCastException">
312 <paramref name="array" /> cannot store string values.</exception>
314 <member name="M:System.Net.HttpListenerPrefixCollection.CopyTo(System.String[],System.Int32)">
315 <summary>Copies the contents of an <see cref="T:System.Net.HttpListenerPrefixCollection" /> to the specified string array.</summary>
316 <param name="array">The one dimensional string array that receives the Uniform Resource Identifier (URI) prefix strings in this collection.</param>
317 <param name="offset">The zero-based index in <paramref name="array" /> at which copying begins.</param>
318 <exception cref="T:System.ArgumentException">
319 <paramref name="array" /> has more than one dimension.</exception>
320 <exception cref="T:System.ArgumentOutOfRangeException">This collection contains more elements than can be stored in <paramref name="array" /> starting at <paramref name="offset" />.</exception>
321 <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.HttpListener" /> associated with this collection is closed.</exception>
323 <member name="M:System.Net.HttpListenerPrefixCollection.GetEnumerator">
324 <summary>Returns an object that can be used to iterate through the collection.</summary>
325 <returns>An object that implements the <see cref="T:System.Collections.IEnumerator" /> interface and provides access to the strings in this collection.</returns>
327 <member name="M:System.Net.HttpListenerPrefixCollection.Remove(System.String)">
328 <summary>Removes the specified Uniform Resource Identifier (URI) from the list of prefixes handled by the <see cref="T:System.Net.HttpListener" /> object.</summary>
329 <param name="uriPrefix">A <see cref="T:System.String" /> that contains the URI prefix to remove.</param>
330 <exception cref="T:System.ArgumentNullException">
331 <paramref name="uriPrefix" /> is <see langword="null" />.</exception>
332 <exception cref="T:System.Net.HttpListenerException">A Windows function call failed. To determine the cause of the exception, check the exception's error code.</exception>
333 <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Net.HttpListener" /> associated with this collection is closed.</exception>
335 <see langword="true" /> if the <paramref name="uriPrefix" /> was found in the <see cref="T:System.Net.HttpListenerPrefixCollection" /> and removed; otherwise <see langword="false" />.</returns>
337 <member name="M:System.Net.HttpListenerPrefixCollection.System#Collections#IEnumerable#GetEnumerator">
338 <summary>Returns an object that can be used to iterate through the collection.</summary>
339 <returns>An object that implements the <see cref="T:System.Collections.IEnumerator" /> interface and provides access to the strings in this collection.</returns>
341 <member name="P:System.Net.HttpListenerPrefixCollection.Count">
342 <summary>Gets the number of prefixes contained in the collection.</summary>
343 <returns>An <see cref="T:System.Int32" /> that contains the number of prefixes in this collection.</returns>
345 <member name="P:System.Net.HttpListenerPrefixCollection.IsReadOnly">
346 <summary>Gets a value that indicates whether access to the collection is read-only.</summary>
347 <returns>Always returns <see langword="false" />.</returns>
349 <member name="P:System.Net.HttpListenerPrefixCollection.IsSynchronized">
350 <summary>Gets a value that indicates whether access to the collection is synchronized (thread-safe).</summary>
351 <returns>This property always returns <see langword="false" />.</returns>
353 <member name="T:System.Net.HttpListenerRequest">
354 <summary>Describes an incoming HTTP request to an <see cref="T:System.Net.HttpListener" /> object. This class cannot be inherited.</summary>
356 <member name="M:System.Net.HttpListenerRequest.BeginGetClientCertificate(System.AsyncCallback,System.Object)">
357 <summary>Begins an asynchronous request for the client's X.509 v.3 certificate.</summary>
358 <param name="requestCallback">An <see cref="T:System.AsyncCallback" /> delegate that references the method to invoke when the operation is complete.</param>
359 <param name="state">A user-defined object that contains information about the operation. This object is passed to the callback delegate when the operation completes.</param>
360 <returns>An <see cref="T:System.IAsyncResult" /> that indicates the status of the operation.</returns>
362 <member name="M:System.Net.HttpListenerRequest.EndGetClientCertificate(System.IAsyncResult)">
363 <summary>Ends an asynchronous request for the client's X.509 v.3 certificate.</summary>
364 <param name="asyncResult">The pending request for the certificate.</param>
365 <exception cref="T:System.ArgumentNullException">
366 <paramref name="asyncResult" /> is <see langword="null" />.</exception>
367 <exception cref="T:System.ArgumentException">
368 <paramref name="asyncResult" /> was not obtained by calling <see cref="M:System.Net.HttpListenerRequest.BeginGetClientCertificate(System.AsyncCallback,System.Object)" /><paramref name="e" />.</exception>
369 <exception cref="T:System.InvalidOperationException">This method was already called for the operation identified by <paramref name="asyncResult" />.</exception>
370 <returns>The <see cref="T:System.IAsyncResult" /> object that is returned when the operation started.</returns>
372 <member name="M:System.Net.HttpListenerRequest.GetClientCertificate">
373 <summary>Retrieves the client's X.509 v.3 certificate.</summary>
374 <exception cref="T:System.InvalidOperationException">A call to this method to retrieve the client's X.509 v.3 certificate is in progress and therefore another call to this method cannot be made.</exception>
375 <returns>A <see cref="N:System.Security.Cryptography.X509Certificates" /> object that contains the client's X.509 v.3 certificate.</returns>
377 <member name="M:System.Net.HttpListenerRequest.GetClientCertificateAsync">
378 <summary>Retrieves the client's X.509 v.3 certificate as an asynchronous operation.</summary>
379 <returns>The task object representing the asynchronous operation. The <see cref="P:System.Threading.Tasks.Task`1.Result" /> property on the task object returns a <see cref="N:System.Security.Cryptography.X509Certificates" /> object that contains the client's X.509 v.3 certificate.</returns>
381 <member name="P:System.Net.HttpListenerRequest.AcceptTypes">
382 <summary>Gets the MIME types accepted by the client.</summary>
383 <returns>A <see cref="T:System.String" /> array that contains the type names specified in the request's <see langword="Accept" /> header or <see langword="null" /> if the client request did not include an <see langword="Accept" /> header.</returns>
385 <member name="P:System.Net.HttpListenerRequest.ClientCertificateError">
386 <summary>Gets an error code that identifies a problem with the <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate" /> provided by the client.</summary>
387 <exception cref="T:System.InvalidOperationException">The client certificate has not been initialized yet by a call to the <see cref="M:System.Net.HttpListenerRequest.BeginGetClientCertificate(System.AsyncCallback,System.Object)" /> or <see cref="M:System.Net.HttpListenerRequest.GetClientCertificate" /> methods
391 The operation is still in progress.</exception>
392 <returns>An <see cref="T:System.Int32" /> value that contains a Windows error code.</returns>
394 <member name="P:System.Net.HttpListenerRequest.ContentEncoding">
395 <summary>Gets the content encoding that can be used with data sent with the request.</summary>
396 <returns>An <see cref="T:System.Text.Encoding" /> object suitable for use with the data in the <see cref="P:System.Net.HttpListenerRequest.InputStream" /> property.</returns>
398 <member name="P:System.Net.HttpListenerRequest.ContentLength64">
399 <summary>Gets the length of the body data included in the request.</summary>
400 <returns>The value from the request's <see langword="Content-Length" /> header. This value is -1 if the content length is not known.</returns>
402 <member name="P:System.Net.HttpListenerRequest.ContentType">
403 <summary>Gets the MIME type of the body data included in the request.</summary>
404 <returns>A <see cref="T:System.String" /> that contains the text of the request's <see langword="Content-Type" /> header.</returns>
406 <member name="P:System.Net.HttpListenerRequest.Cookies">
407 <summary>Gets the cookies sent with the request.</summary>
408 <returns>A <see cref="T:System.Net.CookieCollection" /> that contains cookies that accompany the request. This property returns an empty collection if the request does not contain cookies.</returns>
410 <member name="P:System.Net.HttpListenerRequest.HasEntityBody">
411 <summary>Gets a <see cref="T:System.Boolean" /> value that indicates whether the request has associated body data.</summary>
413 <see langword="true" /> if the request has associated body data; otherwise, <see langword="false" />.</returns>
415 <member name="P:System.Net.HttpListenerRequest.Headers">
416 <summary>Gets the collection of header name/value pairs sent in the request.</summary>
417 <returns>A <see cref="T:System.Net.WebHeaderCollection" /> that contains the HTTP headers included in the request.</returns>
419 <member name="P:System.Net.HttpListenerRequest.HttpMethod">
420 <summary>Gets the HTTP method specified by the client.</summary>
421 <returns>A <see cref="T:System.String" /> that contains the method used in the request.</returns>
423 <member name="P:System.Net.HttpListenerRequest.InputStream">
424 <summary>Gets a stream that contains the body data sent by the client.</summary>
425 <returns>A readable <see cref="T:System.IO.Stream" /> object that contains the bytes sent by the client in the body of the request. This property returns <see cref="F:System.IO.Stream.Null" /> if no data is sent with the request.</returns>
427 <member name="P:System.Net.HttpListenerRequest.IsAuthenticated">
428 <summary>Gets a <see cref="T:System.Boolean" /> value that indicates whether the client sending this request is authenticated.</summary>
430 <see langword="true" /> if the client was authenticated; otherwise, <see langword="false" />.</returns>
432 <member name="P:System.Net.HttpListenerRequest.IsLocal">
433 <summary>Gets a <see cref="T:System.Boolean" /> value that indicates whether the request is sent from the local computer.</summary>
435 <see langword="true" /> if the request originated on the same computer as the <see cref="T:System.Net.HttpListener" /> object that provided the request; otherwise, <see langword="false" />.</returns>
437 <member name="P:System.Net.HttpListenerRequest.IsSecureConnection">
438 <summary>Gets a <see cref="T:System.Boolean" /> value that indicates whether the TCP connection used to send the request is using the Secure Sockets Layer (SSL) protocol.</summary>
440 <see langword="true" /> if the TCP connection is using SSL; otherwise, <see langword="false" />.</returns>
442 <member name="P:System.Net.HttpListenerRequest.IsWebSocketRequest">
443 <summary>Gets a <see cref="T:System.Boolean" /> value that indicates whether the TCP connection was a WebSocket request.</summary>
444 <returns>Returns <see cref="T:System.Boolean" />.
446 <see langword="true" /> if the TCP connection is a WebSocket request; otherwise, <see langword="false" />.</returns>
448 <member name="P:System.Net.HttpListenerRequest.KeepAlive">
449 <summary>Gets a <see cref="T:System.Boolean" /> value that indicates whether the client requests a persistent connection.</summary>
451 <see langword="true" /> if the connection should be kept open; otherwise, <see langword="false" />.</returns>
453 <member name="P:System.Net.HttpListenerRequest.LocalEndPoint">
454 <summary>Gets the server IP address and port number to which the request is directed.</summary>
455 <returns>An <see cref="T:System.Net.IPEndPoint" /> that represents the IP address that the request is sent to.</returns>
457 <member name="P:System.Net.HttpListenerRequest.ProtocolVersion">
458 <summary>Gets the HTTP version used by the requesting client.</summary>
459 <returns>A <see cref="T:System.Version" /> that identifies the client's version of HTTP.</returns>
461 <member name="P:System.Net.HttpListenerRequest.QueryString">
462 <summary>Gets the query string included in the request.</summary>
463 <returns>A <see cref="T:System.Collections.Specialized.NameValueCollection" /> object that contains the query data included in the request <see cref="P:System.Net.HttpListenerRequest.Url" />.</returns>
465 <member name="P:System.Net.HttpListenerRequest.RawUrl">
466 <summary>Gets the URL information (without the host and port) requested by the client.</summary>
467 <returns>A <see cref="T:System.String" /> that contains the raw URL for this request.</returns>
469 <member name="P:System.Net.HttpListenerRequest.RemoteEndPoint">
470 <summary>Gets the client IP address and port number from which the request originated.</summary>
471 <returns>An <see cref="T:System.Net.IPEndPoint" /> that represents the IP address and port number from which the request originated.</returns>
473 <member name="P:System.Net.HttpListenerRequest.RequestTraceIdentifier">
474 <summary>Gets the request identifier of the incoming HTTP request.</summary>
475 <returns>A <see cref="T:System.Guid" /> object that contains the identifier of the HTTP request.</returns>
477 <member name="P:System.Net.HttpListenerRequest.ServiceName">
478 <summary>Gets the Service Provider Name (SPN) that the client sent on the request.</summary>
479 <returns>A <see cref="T:System.String" /> that contains the SPN the client sent on the request.</returns>
481 <member name="P:System.Net.HttpListenerRequest.TransportContext">
482 <summary>Gets the <see cref="T:System.Net.TransportContext" /> for the client request.</summary>
483 <returns>A <see cref="T:System.Net.TransportContext" /> object for the client request.</returns>
485 <member name="P:System.Net.HttpListenerRequest.Url">
486 <summary>Gets the <see cref="T:System.Uri" /> object requested by the client.</summary>
487 <returns>A <see cref="T:System.Uri" /> object that identifies the resource requested by the client.</returns>
489 <member name="P:System.Net.HttpListenerRequest.UrlReferrer">
490 <summary>Gets the Uniform Resource Identifier (URI) of the resource that referred the client to the server.</summary>
491 <returns>A <see cref="T:System.Uri" /> object that contains the text of the request's <see cref="F:System.Net.HttpRequestHeader.Referer" /> header, or <see langword="null" /> if the header was not included in the request.</returns>
493 <member name="P:System.Net.HttpListenerRequest.UserAgent">
494 <summary>Gets the user agent presented by the client.</summary>
495 <returns>A <see cref="T:System.String" /> object that contains the text of the request's <see langword="User-Agent" /> header.</returns>
497 <member name="P:System.Net.HttpListenerRequest.UserHostAddress">
498 <summary>Gets the server IP address and port number to which the request is directed.</summary>
499 <returns>A <see cref="T:System.String" /> that contains the host address information.</returns>
501 <member name="P:System.Net.HttpListenerRequest.UserHostName">
502 <summary>Gets the DNS name and, if provided, the port number specified by the client.</summary>
503 <returns>A <see cref="T:System.String" /> value that contains the text of the request's <see langword="Host" /> header.</returns>
505 <member name="P:System.Net.HttpListenerRequest.UserLanguages">
506 <summary>Gets the natural languages that are preferred for the response.</summary>
507 <returns>A <see cref="T:System.String" /> array that contains the languages specified in the request's <see cref="F:System.Net.HttpRequestHeader.AcceptLanguage" /> header or <see langword="null" /> if the client request did not include an <see cref="F:System.Net.HttpRequestHeader.AcceptLanguage" /> header.</returns>
509 <member name="T:System.Net.HttpListenerResponse">
510 <summary>Represents a response to a request being handled by an <see cref="T:System.Net.HttpListener" /> object.</summary>
512 <member name="M:System.Net.HttpListenerResponse.Abort">
513 <summary>Closes the connection to the client without sending a response.</summary>
515 <member name="M:System.Net.HttpListenerResponse.AddHeader(System.String,System.String)">
516 <summary>Adds the specified header and value to the HTTP headers for this response.</summary>
517 <param name="name">The name of the HTTP header to set.</param>
518 <param name="value">The value for the <paramref name="name" /> header.</param>
519 <exception cref="T:System.ArgumentNullException">
520 <paramref name="name" /> is <see langword="null" /> or an empty string ("").</exception>
521 <exception cref="T:System.ArgumentException">You are not allowed to specify a value for the specified header.
525 <paramref name="name" /> or <paramref name="value" /> contains invalid characters.</exception>
526 <exception cref="T:System.ArgumentOutOfRangeException">.NET Framework and .NET Core versions 2.0 - 3.1 only: The length of <paramref name="value" /> is greater than 65,535 characters.</exception>
528 <member name="M:System.Net.HttpListenerResponse.AppendCookie(System.Net.Cookie)">
529 <summary>Adds the specified <see cref="T:System.Net.Cookie" /> to the collection of cookies for this response.</summary>
530 <param name="cookie">The <see cref="T:System.Net.Cookie" /> to add to the collection to be sent with this response.</param>
531 <exception cref="T:System.ArgumentNullException">
532 <paramref name="cookie" /> is <see langword="null" />.</exception>
534 <member name="M:System.Net.HttpListenerResponse.AppendHeader(System.String,System.String)">
535 <summary>Appends a value to the specified HTTP header to be sent with this response.</summary>
536 <param name="name">The name of the HTTP header to append <paramref name="value" /> to.</param>
537 <param name="value">The value to append to the <paramref name="name" /> header.</param>
538 <exception cref="T:System.ArgumentException">
539 <paramref name="name" /> is <see langword="null" /> or an empty string ("").
543 You are not allowed to specify a value for the specified header.
547 <paramref name="name" /> or <paramref name="value" /> contains invalid characters.</exception>
548 <exception cref="T:System.ArgumentOutOfRangeException">.NET Framework and .NET Core versions 2.0 - 3.1 only: The length of <paramref name="value" /> is greater than 65,535 characters.</exception>
550 <member name="M:System.Net.HttpListenerResponse.Close">
551 <summary>Sends the response to the client and releases the resources held by this <see cref="T:System.Net.HttpListenerResponse" /> instance.</summary>
553 <member name="M:System.Net.HttpListenerResponse.Close(System.Byte[],System.Boolean)">
554 <summary>Returns the specified byte array to the client and releases the resources held by this <see cref="T:System.Net.HttpListenerResponse" /> instance.</summary>
555 <param name="responseEntity">A <see cref="T:System.Byte" /> array that contains the response to send to the client.</param>
556 <param name="willBlock">
557 <see langword="true" /> to block execution while flushing the stream to the client; otherwise, <see langword="false" />.</param>
558 <exception cref="T:System.ArgumentNullException">
559 <paramref name="responseEntity" /> is <see langword="null" />.</exception>
560 <exception cref="T:System.ObjectDisposedException">This object is closed.</exception>
562 <member name="M:System.Net.HttpListenerResponse.CopyFrom(System.Net.HttpListenerResponse)">
563 <summary>Copies properties from the specified <see cref="T:System.Net.HttpListenerResponse" /> to this response.</summary>
564 <param name="templateResponse">The <see cref="T:System.Net.HttpListenerResponse" /> instance to copy.</param>
566 <member name="M:System.Net.HttpListenerResponse.Redirect(System.String)">
567 <summary>Configures the response to redirect the client to the specified URL.</summary>
568 <param name="url">The URL that the client should use to locate the requested resource.</param>
570 <member name="M:System.Net.HttpListenerResponse.SetCookie(System.Net.Cookie)">
571 <summary>Adds or updates a <see cref="T:System.Net.Cookie" /> in the collection of cookies sent with this response.</summary>
572 <param name="cookie">A <see cref="T:System.Net.Cookie" /> for this response.</param>
573 <exception cref="T:System.ArgumentNullException">
574 <paramref name="cookie" /> is <see langword="null" />.</exception>
575 <exception cref="T:System.ArgumentException">The cookie already exists in the collection and could not be replaced.</exception>
577 <member name="M:System.Net.HttpListenerResponse.System#IDisposable#Dispose">
578 <summary>Releases all resources used by the <see cref="T:System.Net.HttpListenerResponse" />.</summary>
580 <member name="P:System.Net.HttpListenerResponse.ContentEncoding">
581 <summary>Gets or sets the <see cref="T:System.Text.Encoding" /> for this response's <see cref="P:System.Net.HttpListenerResponse.OutputStream" />.</summary>
582 <returns>An <see cref="T:System.Text.Encoding" /> object suitable for use with the data in the <see cref="P:System.Net.HttpListenerResponse.OutputStream" /> property, or <see langword="null" /> if no encoding is specified.</returns>
584 <member name="P:System.Net.HttpListenerResponse.ContentLength64">
585 <summary>Gets or sets the number of bytes in the body data included in the response.</summary>
586 <exception cref="T:System.ArgumentOutOfRangeException">The value specified for a set operation is less than zero.</exception>
587 <exception cref="T:System.InvalidOperationException">The response is already being sent.</exception>
588 <exception cref="T:System.ObjectDisposedException">This object is closed.</exception>
589 <returns>The value of the response's <see langword="Content-Length" /> header.</returns>
591 <member name="P:System.Net.HttpListenerResponse.ContentType">
592 <summary>Gets or sets the MIME type of the content returned.</summary>
593 <exception cref="T:System.ArgumentNullException">The value specified for a set operation is <see langword="null" />.</exception>
594 <exception cref="T:System.ArgumentException">The value specified for a set operation is an empty string ("").</exception>
595 <exception cref="T:System.ObjectDisposedException">This object is closed.</exception>
596 <returns>A <see cref="T:System.String" /> instance that contains the text of the response's <see langword="Content-Type" /> header.</returns>
598 <member name="P:System.Net.HttpListenerResponse.Cookies">
599 <summary>Gets or sets the collection of cookies returned with the response.</summary>
600 <returns>A <see cref="T:System.Net.CookieCollection" /> that contains cookies to accompany the response. The collection is empty if no cookies have been added to the response.</returns>
602 <member name="P:System.Net.HttpListenerResponse.Headers">
603 <summary>Gets or sets the collection of header name/value pairs returned by the server.</summary>
604 <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Net.WebHeaderCollection" /> instance specified for a set operation is not valid for a response.</exception>
605 <returns>A <see cref="T:System.Net.WebHeaderCollection" /> instance that contains all the explicitly set HTTP headers to be included in the response.</returns>
607 <member name="P:System.Net.HttpListenerResponse.KeepAlive">
608 <summary>Gets or sets a value indicating whether the server requests a persistent connection.</summary>
609 <exception cref="T:System.ObjectDisposedException">This object is closed.</exception>
611 <see langword="true" /> if the server requests a persistent connection; otherwise, <see langword="false" />. The default is <see langword="true" />.</returns>
613 <member name="P:System.Net.HttpListenerResponse.OutputStream">
614 <summary>Gets a <see cref="T:System.IO.Stream" /> object to which a response can be written.</summary>
615 <exception cref="T:System.ObjectDisposedException">This object is closed.</exception>
616 <returns>A <see cref="T:System.IO.Stream" /> object to which a response can be written.</returns>
618 <member name="P:System.Net.HttpListenerResponse.ProtocolVersion">
619 <summary>Gets or sets the HTTP version used for the response.</summary>
620 <exception cref="T:System.ArgumentNullException">The value specified for a set operation is <see langword="null" />.</exception>
621 <exception cref="T:System.ArgumentException">The value specified for a set operation does not have its <see cref="P:System.Version.Major" /> property set to 1 or does not have its <see cref="P:System.Version.Minor" /> property set to either 0 or 1.</exception>
622 <exception cref="T:System.ObjectDisposedException">This object is closed.</exception>
623 <returns>A <see cref="T:System.Version" /> object indicating the version of HTTP used when responding to the client. Note that this property is now obsolete.</returns>
625 <member name="P:System.Net.HttpListenerResponse.RedirectLocation">
626 <summary>Gets or sets the value of the HTTP <see langword="Location" /> header in this response.</summary>
627 <exception cref="T:System.ArgumentException">The value specified for a set operation is an empty string ("").</exception>
628 <exception cref="T:System.ObjectDisposedException">This object is closed.</exception>
629 <returns>A <see cref="T:System.String" /> that contains the absolute URL to be sent to the client in the <see langword="Location" /> header.</returns>
631 <member name="P:System.Net.HttpListenerResponse.SendChunked">
632 <summary>Gets or sets whether the response uses chunked transfer encoding.</summary>
634 <see langword="true" /> if the response is set to use chunked transfer encoding; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
636 <member name="P:System.Net.HttpListenerResponse.StatusCode">
637 <summary>Gets or sets the HTTP status code to be returned to the client.</summary>
638 <exception cref="T:System.ObjectDisposedException">This object is closed.</exception>
639 <exception cref="T:System.Net.ProtocolViolationException">The value specified for a set operation is not valid. Valid values are between 100 and 999 inclusive.</exception>
640 <returns>An <see cref="T:System.Int32" /> value that specifies the HTTP status code for the requested resource. The default is <see cref="F:System.Net.HttpStatusCode.OK" />, indicating that the server successfully processed the client's request and included the requested resource in the response body.</returns>
642 <member name="P:System.Net.HttpListenerResponse.StatusDescription">
643 <summary>Gets or sets a text description of the HTTP status code returned to the client.</summary>
644 <exception cref="T:System.ArgumentNullException">The value specified for a set operation is <see langword="null" />.</exception>
645 <exception cref="T:System.ArgumentException">The value specified for a set operation contains non-printable characters.</exception>
646 <returns>The text description of the HTTP status code returned to the client. The default is the RFC 2616 description for the <see cref="P:System.Net.HttpListenerResponse.StatusCode" /> property value, or an empty string ("") if an RFC 2616 description does not exist.</returns>
648 <member name="T:System.Net.HttpListenerTimeoutManager">
649 <summary>The timeout manager to use for an <see cref="T:System.Net.HttpListener" /> object.</summary>
651 <member name="P:System.Net.HttpListenerTimeoutManager.DrainEntityBody">
652 <summary>Gets or sets the time allowed for the <see cref="T:System.Net.HttpListener" /> to drain the entity body on a Keep-Alive connection.</summary>
653 <returns>The time allowed for the <see cref="T:System.Net.HttpListener" /> to drain the entity body on a Keep-Alive connection.</returns>
655 <member name="P:System.Net.HttpListenerTimeoutManager.EntityBody">
656 <summary>Gets or sets the time allowed for the request entity body to arrive.</summary>
657 <returns>The time allowed for the request entity body to arrive.</returns>
659 <member name="P:System.Net.HttpListenerTimeoutManager.HeaderWait">
660 <summary>Gets or sets the time allowed for the <see cref="T:System.Net.HttpListener" /> to parse the request header.</summary>
661 <returns>The time allowed for the <see cref="T:System.Net.HttpListener" /> to parse the request header.</returns>
663 <member name="P:System.Net.HttpListenerTimeoutManager.IdleConnection">
664 <summary>Gets or sets the time allowed for an idle connection.</summary>
665 <returns>The time allowed for an idle connection.</returns>
667 <member name="P:System.Net.HttpListenerTimeoutManager.MinSendBytesPerSecond">
668 <summary>Gets or sets the minimum send rate, in bytes-per-second, for the response.</summary>
669 <returns>The minimum send rate, in bytes-per-second, for the response.</returns>
671 <member name="P:System.Net.HttpListenerTimeoutManager.RequestQueue">
672 <summary>Gets or sets the time allowed for the request to remain in the request queue before the <see cref="T:System.Net.HttpListener" /> picks it up.</summary>
673 <returns>The time allowed for the request to remain in the request queue before the <see cref="T:System.Net.HttpListener" /> picks it up.</returns>
675 <member name="T:System.Net.WebSockets.HttpListenerWebSocketContext">
676 <summary>Provides access to information received by the <see cref="T:System.Net.HttpListener" /> class when accepting WebSocket connections.</summary>
678 <member name="P:System.Net.WebSockets.HttpListenerWebSocketContext.CookieCollection">
679 <summary>Gets the cookies received by the <see cref="T:System.Net.HttpListener" /> object in the WebSocket opening handshake.</summary>
680 <returns>The cookies received by the <see cref="T:System.Net.HttpListener" /> object.</returns>
682 <member name="P:System.Net.WebSockets.HttpListenerWebSocketContext.Headers">
683 <summary>Gets the HTTP headers received by the <see cref="T:System.Net.HttpListener" /> object in the WebSocket opening handshake.</summary>
684 <returns>The HTTP headers received by the <see cref="T:System.Net.HttpListener" /> object.</returns>
686 <member name="P:System.Net.WebSockets.HttpListenerWebSocketContext.IsAuthenticated">
687 <summary>Gets a value that indicates if the WebSocket client is authenticated.</summary>
689 <see langword="true" /> if the WebSocket client is authenticated; otherwise, <see langword="false" />.</returns>
691 <member name="P:System.Net.WebSockets.HttpListenerWebSocketContext.IsLocal">
692 <summary>Gets a value that indicates if the WebSocket client connected from the local machine.</summary>
694 <see langword="true" /> if the WebSocket client connected from the local machine; otherwise, <see langword="false" />.</returns>
696 <member name="P:System.Net.WebSockets.HttpListenerWebSocketContext.IsSecureConnection">
697 <summary>Gets a value that indicates if the WebSocket connection is secured using Secure Sockets Layer (SSL).</summary>
699 <see langword="true" /> if the WebSocket connection is secured using SSL; otherwise, <see langword="false" />.</returns>
701 <member name="P:System.Net.WebSockets.HttpListenerWebSocketContext.Origin">
702 <summary>Gets the value of the Origin HTTP header included in the WebSocket opening handshake.</summary>
703 <returns>The value of the Origin HTTP header.</returns>
705 <member name="P:System.Net.WebSockets.HttpListenerWebSocketContext.RequestUri">
706 <summary>Gets the URI requested by the WebSocket client.</summary>
707 <returns>The URI requested by the WebSocket client.</returns>
709 <member name="P:System.Net.WebSockets.HttpListenerWebSocketContext.SecWebSocketKey">
710 <summary>Gets the value of the SecWebSocketKey HTTP header included in the WebSocket opening handshake.</summary>
711 <returns>The value of the SecWebSocketKey HTTP header.</returns>
713 <member name="P:System.Net.WebSockets.HttpListenerWebSocketContext.SecWebSocketProtocols">
714 <summary>Gets the list of the Secure WebSocket protocols included in the WebSocket opening handshake.</summary>
715 <returns>The list of the Secure WebSocket protocols.</returns>
717 <member name="P:System.Net.WebSockets.HttpListenerWebSocketContext.SecWebSocketVersion">
718 <summary>Gets the list of sub-protocols requested by the WebSocket client.</summary>
719 <returns>The list of sub-protocols requested by the WebSocket client.</returns>
721 <member name="P:System.Net.WebSockets.HttpListenerWebSocketContext.User">
722 <summary>Gets an object used to obtain identity, authentication information, and security roles for the WebSocket client.</summary>
723 <returns>The identity, authentication information, and security roles for the WebSocket client.</returns>
725 <member name="P:System.Net.WebSockets.HttpListenerWebSocketContext.WebSocket">
726 <summary>Gets the <see cref="T:System.Net.WebSockets.WebSocket" /> instance used to send and receive data over the <see cref="T:System.Net.WebSockets.WebSocket" /> connection.</summary>
727 <returns>The <see cref="T:System.Net.WebSockets.WebSocket" /> instance used to send and receive data over the <see cref="T:System.Net.WebSockets.WebSocket" /> connection.</returns>