-
Notifications
You must be signed in to change notification settings - Fork 14
Provides a set of static methods for websocket-sharp.
Determines whether the specified contains any of characters in the specified array of .
Returns: if contains any of ; otherwise, .
| Name | Description |
|---|---|
| value: | A [[ |
| Name | Description |
| ----- | ------ |
| chars: | An array of [[ |
Determines whether the specified contains the entry with the specified .
Returns: if contains the entry with ; otherwise, .
| Name | Description |
|---|---|
| collection: | A [[ |
| Name | Description |
| ----- | ------ |
| name: | A [[ |
M:WebSocketSharp.Ext.Contains(System.Collections.Specialized.NameValueCollection,System.String,System.String)
Determines whether the specified contains the entry with the specified both and .
Returns: if contains the entry with both and ; otherwise, .
| Name | Description |
|---|---|
| collection: | A [[ |
| Name | Description |
| ----- | ------ |
| name: | A [[ |
| Name | Description |
| ----- | ------ |
| value: | A [[ |
| Name | Description |
|---|---|
| eventHandler: | A [[ |
| Name | Description |
| ----- | ------ |
| sender: | An [[ |
| Name | Description |
| ----- | ------ |
| e: | A [[ |
| Name | Description |
|---|---|
| eventHandler: | An to emit. |
| Name | Description |
| ----- | ------ |
| sender: | An [[ |
| Name | Description |
| ----- | ------ |
| e: | A that represents the event data. |
Gets the collection of the HTTP cookies from the specified HTTP .
Returns: A that receives a collection of the HTTP cookies.
| Name | Description |
|---|---|
| headers: | A [[ |
| Name | Description |
| ----- | ------ |
| response: | if is a collection of the response headers; otherwise, . |
Gets the description of the specified HTTP status .
Returns: A that represents the description of the HTTP status code.
| Name | Description |
|---|---|
| code: | One of [[ |
Gets the description of the specified HTTP status .
Returns: A that represents the description of the HTTP status code.
| Name | Description |
|---|---|
| code: | An [[ |
Determines whether the specified is in the allowable range of the WebSocket close status code.
Not allowable ranges are the following:
Returns: if is in the allowable range of the WebSocket close status code; otherwise, .
| Name | Description |
|---|---|
| value: | A [[ |
Determines whether the specified is enclosed in the specified .
Returns: if is enclosed in ; otherwise, .
| Name | Description |
|---|---|
| value: | A [[ |
| Name | Description |
| ----- | ------ |
| c: | A [[ |
Determines whether the specified is host (this computer architecture) byte order.
Returns: if is host byte order; otherwise, .
| Name | Description |
|---|---|
| order: | One of the [[ |
Determines whether the specified represents the local IP address.
Returns: if represents the local IP address; otherwise, .
| Name | Description |
|---|---|
| address: | A [[ |
| Name | Description |
|---|---|
| value: | A [[ |
Determines whether the specified is a predefined scheme.
Returns: if is a predefined scheme; otherwise, .
| Name | Description |
|---|---|
| value: | A [[ |
Determines whether the specified is a URI string.
Returns: if may be a URI string; otherwise, .
| Name | Description |
|---|---|
| value: | A [[ |
Retrieves a sub-array from the specified . A sub-array starts at the specified element position in .
Returns: An array of T that receives a sub-array, or an empty array of T if any problems with the parameters.
| Name | Description |
|---|---|
| array: | An array of T from which to retrieve a sub-array. |
| Name | Description |
| ----- | ------ |
| startIndex: | An [[ |
| Name | Description |
| ----- | ------ |
| length: | An [[ |
Retrieves a sub-array from the specified . A sub-array starts at the specified element position in .
Returns: An array of T that receives a sub-array, or an empty array of T if any problems with the parameters.
| Name | Description |
|---|---|
| array: | An array of T from which to retrieve a sub-array. |
| Name | Description |
| ----- | ------ |
| startIndex: | A [[ |
| Name | Description |
| ----- | ------ |
| length: | A [[ |
Executes the specified delegate times.
| Name | Description |
|---|---|
| n: | An [[ |
| Name | Description |
| ----- | ------ |
| action: | An delegate that references the method(s) to execute. An [[ |
Converts the order of the specified array of to the host byte order.
Returns: An array of converted from .
| Name | Description |
|---|---|
| source: | An array of [[ |
| Name | Description |
| ----- | ------ |
| sourceOrder: | One of the [[ |
Converts the specified to a that concatenates the each element of across the specified .
Returns: A converted from , or if is empty.
| Name | Description |
|---|---|
| array: | An array of T to convert. |
| Name | Description |
| ----- | ------ |
| separator: | A [[ |
| Name | Description |
|---|---|
| uriString: | A [[ |
| Name | Description |
|---|---|
| value: | A [[ |
| Name | Description |
|---|---|
| value: | A [[ |
Determines whether the specified equals the specified , and invokes the specified Action delegate at the same time.
Returns: if equals ; otherwise, .
| Name | Description |
|---|---|
| value: | An [[ |
| Name | Description |
| ----- | ------ |
| c: | A [[ |
| Name | Description |
| ----- | ------ |
| action: | An Action delegate that references the method(s) called at the same time as comparing. An [[ |
| [[T:System.ArgumentOutOfRangeException | T:System.ArgumentOutOfRangeException]]: isn't between 0 and 255. |
Gets the absolute path from the specified .
| Name | Description |
|---|---|
| uri: | A [[ |
Gets the value from the specified that contains a pair of name and value separated by a separator character.
Returns: A that represents the value if any; otherwise, .
| Name | Description |
|---|---|
| nameAndValue: | A [[ |
| Name | Description |
| ----- | ------ |
| separator: | A [[ |
Tries to create a for WebSocket with the specified .
Returns: if a is successfully created; otherwise, .
| Name | Description |
|---|---|
| uriString: | A [[ |
| Name | Description |
| ----- | ------ |
| message: | When this method returns, a [[ |
Contains the event data associated with a event.
Gets the message data as an array of .
Gets the type of the message.
Contains the event data associated with a event.
Gets a value indicating whether the WebSocket connection has been closed cleanly.
Contains the values that indicate whether the byte order is a Little-endian or Big-endian.
Indicates a Little-endian.
Indicates a Big-endian.
Contains the event data associated with a event.
Gets the instance that caused the error.
Gets the error message.
Implements the WebSocket interface.
Initializes a new instance of the class with the specified WebSocket URL and subprotocols.
| Name | Description |
|---|---|
| url: | A [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: |
Occurs when the WebSocket connection has been closed.
Occurs when the gets an error.
Occurs when the receives a message.
Occurs when the WebSocket connection has been established.
Gets or sets the compression method used to compress the message on the WebSocket connection.
Gets the HTTP cookies included in the WebSocket connection request and response.
Gets the credentials for the HTTP authentication (Basic/Digest).
Gets the WebSocket extensions selected by the server.
Gets a value indicating whether the WebSocket connection is alive.
Gets a value indicating whether the WebSocket connection is secure.
Gets or sets the value of the Origin header to send with the WebSocket connection request to the server.
Gets the WebSocket subprotocol selected by the server.
Gets the state of the WebSocket connection.
Gets or sets the callback used to validate the certificate supplied by the server.
Gets the WebSocket URL to connect.
Closes the WebSocket connection, and releases all associated resources.
Closes the WebSocket connection with the specified , and releases all associated resources.
This method emits a event if isn't in the allowable range of the WebSocket close status code.
| Name | Description |
|---|---|
| code: | A [[ |
Closes the WebSocket connection with the specified , and releases all associated resources.
| Name | Description |
|---|---|
| code: | One of the [[ |
Closes the WebSocket connection with the specified and , and releases all associated resources.
This method emits a event if isn't in the allowable range of the WebSocket close status code or the size of is greater than 123 bytes.
| Name | Description |
|---|---|
| code: | A [[ |
| Name | Description |
| ----- | ------ |
| reason: | A [[ |
Closes the WebSocket connection with the specified and , and releases all associated resources.
This method emits a event if the size of is greater than 123 bytes.
| Name | Description |
|---|---|
| code: | One of the [[ |
| Name | Description |
| ----- | ------ |
| reason: | A [[ |
Closes the WebSocket connection asynchronously, and releases all associated resources.
This method doesn't wait for the close to be complete.
Closes the WebSocket connection asynchronously with the specified , and releases all associated resources.
| Name | Description |
|---|---|
| code: | A [[ |
Closes the WebSocket connection asynchronously with the specified , and releases all associated resources.
This method doesn't wait for the close to be complete.
| Name | Description |
|---|---|
| code: | One of the [[ |
Closes the WebSocket connection asynchronously with the specified and , and releases all associated resources.
| Name | Description |
|---|---|
| code: | A [[ |
| Name | Description |
| ----- | ------ |
| reason: | A [[ |
Closes the WebSocket connection asynchronously with the specified and , and releases all associated resources.
| Name | Description |
|---|---|
| code: | One of the [[ |
| Name | Description |
| ----- | ------ |
| reason: | A [[ |
Establishes a WebSocket connection.
Establishes a WebSocket connection asynchronously.
This method doesn't wait for the connect to be complete.
Sends a Ping using the WebSocket connection.
Returns: if the receives a Pong to this Ping in a time; otherwise, .
Sends a Ping with the specified using the WebSocket connection.
Returns: if the receives a Pong to this Ping in a time; otherwise, .
| Name | Description |
|---|---|
| message: | A [[ |
Sends a binary using the WebSocket connection.
| Name | Description |
|---|---|
| data: | An array of [[ |
Sends the specified as a binary data using the WebSocket connection.
| Name | Description |
|---|---|
| file: | A [[ |
Sends a text using the WebSocket connection.
| Name | Description |
|---|---|
| data: | A [[ |
Sends a binary asynchronously using the WebSocket connection.
This method doesn't wait for the send to be complete.
| Name | Description |
|---|---|
| data: | An array of [[ |
Sends the specified as a binary data asynchronously using the WebSocket connection.
This method doesn't wait for the send to be complete.
| Name | Description |
|---|---|
| file: | A [[ |
Sends a text asynchronously using the WebSocket connection.
This method doesn't wait for the send to be complete.
| Name | Description |
|---|---|
| data: | A [[ |
Sends a binary data from the specified asynchronously using the WebSocket connection.
This method doesn't wait for the send to be complete.
| Name | Description |
|---|---|
| stream: | A [[ |
| Name | Description |
| ----- | ------ |
| length: | An [[ |
Sets an HTTP to send with the WebSocket connection request to the server.
| Name | Description |
|---|---|
| cookie: | A [[ |
Sets a pair of and for the HTTP authentication (Basic/Digest).
| Name | Description |
|---|---|
| username: | A [[ |
| Name | Description |
| ----- | ------ |
| password: | A [[ |
| Name | Description |
| ----- | ------ |
| preAuth: | if the [[ |
Sets the HTTP Proxy server URL to connect through, and a pair of and for the proxy server authentication (Basic/Digest).
| Name | Description |
|---|---|
| url: | A [[ |
| Name | Description |
| ----- | ------ |
| username: | A [[ |
| Name | Description |
| ----- | ------ |
| password: | A [[ |
Closes the WebSocket connection, and releases all associated resources.
Provides a WebSocket protocol server.
The WebSocketServer class can provide multiple WebSocket services.
Initializes a new instance of the class.
An instance initialized by this constructor listens for the incoming connection requests on port 80.
Initializes a new instance of the class with the specified .
| Name | Description |
|---|---|
| port: | An [[ |
| [[T:System.ArgumentOutOfRangeException | T:System.ArgumentOutOfRangeException]]: isn't between 1 and 65535. |
Initializes a new instance of the class with the specified WebSocket URL.
| Name | Description |
|---|---|
| url: | A [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: is invalid. |
M:WebSocketSharp.Server.WebSocketServer.#ctor(System.Int32,System.Security.Cryptography.X509Certificates.X509Certificate2)
Initializes a new instance of the class with the specified and .
An instance initialized by this constructor listens for the incoming connection requests on .
| Name | Description |
|---|---|
| port: | An [[ |
| Name | Description |
| ----- | ------ |
| certificate: | A [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: Pair of and is invalid. |
T:System.ArgumentOutOfRangeException: isn't between 1 and 65535.
Initializes a new instance of the class with the specified and .
| Name | Description |
|---|---|
| address: | A [[ |
| Name | Description |
| ----- | ------ |
| port: | An [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: isn't a local IP address. |
T:System.ArgumentOutOfRangeException: isn't between 1 and 65535.
M:WebSocketSharp.Server.WebSocketServer.#ctor(System.Net.IPAddress,System.Int32,System.Security.Cryptography.X509Certificates.X509Certificate2)
Initializes a new instance of the class with the specified , , and .
An instance initialized by this constructor listens for the incoming connection requests on .
| Name | Description |
|---|---|
| address: | A [[ |
| Name | Description |
| ----- | ------ |
| port: | An [[ |
| Name | Description |
| ----- | ------ |
| certificate: | A [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: |
T:System.ArgumentOutOfRangeException: isn't between 1 and 65535.
Gets the local IP address of the server.
Gets or sets the scheme used to authenticate the clients.
Gets a value indicating whether the server has started.
Gets a value indicating whether the server provides a secure connection.
Gets or sets a value indicating whether the server cleans up the inactive sessions periodically.
Gets the port on which to listen for incoming connection requests.
Gets or sets the name of the realm associated with the server.
Gets or sets a value indicating whether the server is allowed to be bound to an address that is already in use.
If you would like to resolve to wait for socket in state, you should set this property to .
Gets or sets the delegate called to find the credentials for an identity used to authenticate a client.
Gets or sets the wait time for the response to the WebSocket Ping or Close.
Gets the access to the WebSocket services provided by the server.
Adds a WebSocket service with the specified behavior and .
This method converts to URL-decoded string, and removes from tail end of .
| Name | Description |
|---|---|
| path: | A [[ |
Adds a WebSocket service with the specified behavior, , and .
| Name | Description |
|---|---|
| path: | A [[ |
| Name | Description |
| ----- | ------ |
| initializer: | A Func delegate that references the method used to initialize a new specified typed [[ |
Removes the WebSocket service with the specified .
This method converts to URL-decoded string, and removes from tail end of .
Returns: if the service is successfully found and removed; otherwise, .
| Name | Description |
|---|---|
| path: | A [[ |
Starts receiving the WebSocket connection requests.
Stops receiving the WebSocket connection requests.
Stops receiving the WebSocket connection requests with the specified and .
| Name | Description |
|---|---|
| code: | A [[ |
| Name | Description |
| ----- | ------ |
| reason: | A [[ |
Stops receiving the WebSocket connection requests with the specified and .
| Name | Description |
|---|---|
| code: | One of the [[ |
| Name | Description |
| ----- | ------ |
| reason: | A [[ |
Exposes the methods and properties used to access the information in a WebSocket service provided by the .
The WebSocketServiceHost class is an abstract class.
Initializes a new instance of the class.
Gets or sets a value indicating whether the WebSocket service cleans up the inactive sessions periodically.
Gets the path to the WebSocket service.
Gets the access to the sessions in the WebSocket service.
Gets the of the behavior of the WebSocket service.
Gets or sets the wait time for the response to the WebSocket Ping or Close.
Creates a new session in the WebSocket service.
Returns: A instance that represents a new session.
Exposes the properties used to access the information in a session in a WebSocket service.
Gets the information in the connection request to the WebSocket service.
Gets the unique ID of the session.
Gets the WebSocket subprotocol used in the session.
Gets the time that the session has started.
Gets the state of the used in the session.
Manages the sessions in a Websocket service.
Gets the IDs for the active sessions in the Websocket service.
Gets the number of the sessions in the Websocket service.
Gets the IDs for the sessions in the Websocket service.
Gets the IDs for the inactive sessions in the Websocket service.
Gets the session with the specified .
| Name | Description |
|---|---|
| id: | A [[ |
Gets a value indicating whether the manager cleans up the inactive sessions in the WebSocket service periodically.
Gets the sessions in the Websocket service.
Gets the wait time for the response to the WebSocket Ping or Close.
Broadcasts a binary to every client in the WebSocket service.
| Name | Description |
|---|---|
| data: | An array of [[ |
Broadcasts a text to every client in the WebSocket service.
| Name | Description |
|---|---|
| data: | A [[ |
Broadcasts a binary asynchronously to every client in the WebSocket service.
This method doesn't wait for the broadcast to be complete.
| Name | Description |
|---|---|
| data: | An array of [[ |
Broadcasts a text asynchronously to every client in the WebSocket service.
This method doesn't wait for the broadcast to be complete.
| Name | Description |
|---|---|
| data: | A [[ |
Broadcasts a binary data from the specified asynchronously to every client in the WebSocket service.
This method doesn't wait for the broadcast to be complete.
| Name | Description |
|---|---|
| stream: | A [[ |
| Name | Description |
| ----- | ------ |
| length: | An [[ |
Sends a Ping to every client in the WebSocket service.
Returns: A that contains a collection of pairs of a session ID and a value indicating whether the manager received a Pong from each client in a time.
Sends a Ping with the specified to every client in the WebSocket service.
Returns: A that contains a collection of pairs of a session ID and a value indicating whether the manager received a Pong from each client in a time.
| Name | Description |
|---|---|
| message: | A [[ |
Closes the session with the specified .
| Name | Description |
|---|---|
| id: | A [[ |
M:WebSocketSharp.Server.WebSocketSessionManager.CloseSession(System.String,System.UInt16,System.String)
Closes the session with the specified , , and .
| Name | Description |
|---|---|
| id: | A [[ |
| Name | Description |
| ----- | ------ |
| code: | A [[ |
| Name | Description |
| ----- | ------ |
| reason: | A [[ |
M:WebSocketSharp.Server.WebSocketSessionManager.CloseSession(System.String,WebSocketSharp.CloseStatusCode,System.String)
Closes the session with the specified , , and .
| Name | Description |
|---|---|
| id: | A [[ |
| Name | Description |
| ----- | ------ |
| code: | One of the [[ |
| Name | Description |
| ----- | ------ |
| reason: | A [[ |
Sends a Ping to the client on the session with the specified .
Returns: if the manager receives a Pong from the client in a time; otherwise, .
| Name | Description |
|---|---|
| id: | A [[ |
Sends a Ping with the specified to the client on the session with the specified .
Returns: if the manager receives a Pong from the client in a time; otherwise, .
| Name | Description |
|---|---|
| id: | A [[ |
| Name | Description |
| ----- | ------ |
| message: | A [[ |
Sends a binary to the client on the session with the specified .
| Name | Description |
|---|---|
| id: | A [[ |
| Name | Description |
| ----- | ------ |
| data: | An array of [[ |
Sends a text to the client on the session with the specified .
| Name | Description |
|---|---|
| id: | A [[ |
| Name | Description |
| ----- | ------ |
| data: | A [[ |
Sends a binary asynchronously to the client on the session with the specified .
This method doesn't wait for the send to be complete.
| Name | Description |
|---|---|
| id: | A [[ |
| Name | Description |
| ----- | ------ |
| data: | An array of [[ |
Sends a text asynchronously to the client on the session with the specified .
This method doesn't wait for the send to be complete.
| Name | Description |
|---|---|
| id: | A [[ |
| Name | Description |
| ----- | ------ |
| data: | A [[ |
M:WebSocketSharp.Server.WebSocketSessionManager.SendToAsync(System.String,System.IO.Stream,System.Int32)
Sends a binary data from the specified asynchronously to the client on the session with the specified .
This method doesn't wait for the send to be complete.
| Name | Description |
|---|---|
| id: | A [[ |
| Name | Description |
| ----- | ------ |
| stream: | A [[ |
| Name | Description |
| ----- | ------ |
| length: | An [[ |
Cleans up the inactive sessions in the WebSocket service.
M:WebSocketSharp.Server.WebSocketSessionManager.TryGetSession(System.String,WebSocketSharp.Server.IWebSocketSession@)
Tries to get the session with the specified .
Returns: if the session is successfully found; otherwise, .
| Name | Description |
|---|---|
| id: | A [[ |
Manages the WebSocket services provided by the or .
Gets the number of the WebSocket services.
Gets the host instances for the Websocket services.
Gets the WebSocket service host with the specified .
| Name | Description |
|---|---|
| path: | A [[ |
Gets a value indicating whether the manager cleans up the inactive sessions in the WebSocket services periodically.
Gets the paths for the WebSocket services.
Gets the total number of the sessions in the WebSocket services.
Gets the wait time for the response to the WebSocket Ping or Close.
Broadcasts a binary to every client in the WebSocket services.
| Name | Description |
|---|---|
| data: | An array of [[ |
Broadcasts a text to every client in the WebSocket services.
| Name | Description |
|---|---|
| data: | A [[ |
Broadcasts a binary asynchronously to every client in the WebSocket services.
This method doesn't wait for the broadcast to be complete.
| Name | Description |
|---|---|
| data: | An array of [[ |
Broadcasts a text asynchronously to every client in the WebSocket services.
This method doesn't wait for the broadcast to be complete.
| Name | Description |
|---|---|
| data: | A [[ |
Broadcasts a binary data from the specified asynchronously to every client in the WebSocket services.
This method doesn't wait for the broadcast to be complete.
| Name | Description |
|---|---|
| stream: | A [[ |
| Name | Description |
| ----- | ------ |
| length: | An [[ |
Sends a Ping to every client in the WebSocket services.
Sends a Ping with the specified to every client in the WebSocket services.
| Name | Description |
|---|---|
| message: | A [[ |
M:WebSocketSharp.Server.WebSocketServiceManager.TryGetServiceHost(System.String,WebSocketSharp.Server.WebSocketServiceHost@)
Tries to get the WebSocket service host with the specified .
Returns: if the service is successfully found; otherwise, .
| Name | Description |
|---|---|
| path: | A [[ |
Exposes the methods and properties used to define the behavior of a WebSocket service provided by the or .
The WebSocketBehavior class is an abstract class.
Initializes a new instance of the class.
Gets the information in the current connection request to the WebSocket service.
Gets or sets the delegate called to validate the HTTP cookies included in a connection request to the WebSocket service.
The delegate is called when the used in the current session validates the connection request.
Gets the unique ID of the current session.
Gets or sets the delegate called to validate the Origin header included in a connection request to the WebSocket service.
The delegate is called when the used in the current session validates the connection request.
Gets or sets the WebSocket subprotocol used in the current session.
Set operation of this property is available before the WebSocket connection has been established.
Gets the time that the current session has started.
Gets the state of the used in the current session.
Gets the access to the sessions in the WebSocket service.
Calls the method with the specified and .
| Name | Description |
|---|---|
| message: | A [[ |
| Name | Description |
| ----- | ------ |
| exception: | An [[ |
Called when the WebSocket connection used in the current session has been closed.
| Name | Description |
|---|---|
| e: | A [[ |
Called when the used in the current session gets an error.
| Name | Description |
|---|---|
| e: | A [[ |
Called when the used in the current session receives a message.
| Name | Description |
|---|---|
| e: | A [[ |
Called when the WebSocket connection used in the current session has been established.
Sends a binary to the client on the current session.
This method is available after the WebSocket connection has been established.
| Name | Description |
|---|---|
| data: | An array of [[ |
Sends the specified as a binary data to the client on the current session.
This method is available after the WebSocket connection has been established.
| Name | Description |
|---|---|
| file: | A [[ |
Sends a text to the client on the current session.
This method is available after the WebSocket connection has been established.
| Name | Description |
|---|---|
| data: | A [[ |
Sends a binary asynchronously to the client on the current session.
| Name | Description |
|---|---|
| data: | An array of [[ |
Sends the specified as a binary data asynchronously to the client on the current session.
| Name | Description |
|---|---|
| file: | A [[ |
Sends a text asynchronously to the client on the current session.
| Name | Description |
|---|---|
| data: | A [[ |
| Name | Description |
| ----- | ------ |
| completed: | An delegate that references the method(s) called when the send is complete. A [[ |
Sends a binary data from the specified asynchronously to the client on the current session.
| Name | Description |
|---|---|
| stream: | A [[ |
| Name | Description |
| ----- | ------ |
| length: | An [[ |
| Name | Description |
| ----- | ------ |
| completed: | An delegate that references the method(s) called when the send is complete. A [[ |
Contains the values of the schemes for authentication.
Indicates that no authentication is allowed.
Indicates digest authentication.
Indicates basic authentication.
Indicates anonymous authentication.
Provides a set of methods and properties used to manage an HTTP Cookie.
Initializes a new instance of the class.
Initializes a new instance of the class with the specified and .
| Name | Description |
|---|---|
| name: | A [[ |
| Name | Description |
| ----- | ------ |
| value: | A [[ |
| [[T:WebSocketSharp.Net.CookieException | T:WebSocketSharp.Net.CookieException]]: |
Initializes a new instance of the class with the specified , , and .
| Name | Description |
|---|---|
| name: | A [[ |
| Name | Description |
| ----- | ------ |
| value: | A [[ |
| Name | Description |
| ----- | ------ |
| path: | A [[ |
| [[T:WebSocketSharp.Net.CookieException | T:WebSocketSharp.Net.CookieException]]: |
Initializes a new instance of the class with the specified , , , and .
| Name | Description |
|---|---|
| name: | A [[ |
| Name | Description |
| ----- | ------ |
| value: | A [[ |
| Name | Description |
| ----- | ------ |
| path: | A [[ |
| Name | Description |
| ----- | ------ |
| domain: | A [[ |
| [[T:WebSocketSharp.Net.CookieException | T:WebSocketSharp.Net.CookieException]]: |
Gets or sets the value of the Comment attribute of the cookie.
Gets or sets the value of the CommentURL attribute of the cookie.
Gets or sets a value indicating whether the client discards the cookie unconditionally when the client terminates.
Gets or sets the value of the Domain attribute of the cookie.
Gets or sets a value indicating whether the cookie has expired.
Gets or sets the value of the Expires attribute of the cookie.
Gets or sets a value indicating whether non-HTTP APIs can access the cookie.
Gets or sets the Name of the cookie.
T:WebSocketSharp.Net.CookieException:
Gets or sets the value of the Path attribute of the cookie.
Gets or sets the value of the Port attribute of the cookie.
T:WebSocketSharp.Net.CookieException: The value specified for a set operation isn't enclosed in double quotes or couldn't be parsed.
Gets or sets a value indicating whether the security level of the cookie is secure.
When this property is , the cookie may be included in the HTTP request only if the request is transmitted over the HTTPS.
Gets the time when the cookie was issued.
Gets or sets the Value of the cookie.
T:WebSocketSharp.Net.CookieException:
Gets or sets the value of the Version attribute of the cookie.
T:System.ArgumentOutOfRangeException: The value specified for a set operation isn't 0 or 1.
Determines whether the specified is equal to the current .
| Name | Description |
|---|---|
| comparand: | An [[ |
| Returns: if is equal to the current [[ | T:WebSocketSharp.Net.Cookie]]; otherwise, . |
Serves as a hash function for a object.
Returns: An that represents the hash code for the current .
Returns a that represents the current .
This method returns a to use to send an HTTP Cookie to an origin server.
Returns: A that represents the current .
Provides a collection container for instances of the class.
Initializes a new instance of the class.
Gets the number of cookies in the collection.
Gets a value indicating whether the collection is read-only.
Gets a value indicating whether the access to the collection is thread safe.
Gets the at the specified from the collection.
| Name | Description |
|---|---|
| index: | An [[ |
| [[T:System.ArgumentOutOfRangeException | T:System.ArgumentOutOfRangeException]]: is out of allowable range of indexes for the collection. |
Gets the with the specified from the collection.
| Name | Description |
|---|---|
| name: | A [[ |
Gets an object used to synchronize access to the collection.
Adds the specified to the collection.
| Name | Description |
|---|---|
| cookie: | A [[ |
Adds the specified to the collection.
| Name | Description |
|---|---|
| cookies: | A [[ |
Copies the elements of the collection to the specified , starting at the specified in the .
| Name | Description |
|---|---|
| array: | An [[ |
| Name | Description |
| ----- | ------ |
| index: | An [[ |
| [[T:System.ArgumentOutOfRangeException | T:System.ArgumentOutOfRangeException]]: is less than zero. |
T:System.InvalidCastException: The elements in the collection cannot be cast automatically to the type of the destination .
Copies the elements of the collection to the specified array of , starting at the specified in the .
| Name | Description |
|---|---|
| array: | An array of [[ |
| Name | Description |
| ----- | ------ |
| index: | An [[ |
| [[T:System.ArgumentOutOfRangeException | T:System.ArgumentOutOfRangeException]]: is less than zero. |
T:System.ArgumentException: The number of elements in the collection is greater than the available space from to the end of the destination .
Gets the enumerator used to iterate through the collection.
Returns: An instance used to iterate through the collection.
The exception that is thrown when a gets an error.
M:WebSocketSharp.Net.CookieException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)
Initializes a new instance of the class from the specified and .
| Name | Description |
|---|---|
| serializationInfo: | A [[ |
| Name | Description |
| ----- | ------ |
| streamingContext: | A [[ |
Initializes a new instance of the class.
M:WebSocketSharp.Net.CookieException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)
Populates the specified with the data needed to serialize the current .
| Name | Description |
|---|---|
| serializationInfo: | A [[ |
| Name | Description |
| ----- | ------ |
| streamingContext: | A [[ |
M:WebSocketSharp.Net.CookieException.System#Runtime#Serialization#ISerializable#GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)
Populates the specified with the data needed to serialize the current .
| Name | Description |
|---|---|
| serializationInfo: | A [[ |
| Name | Description |
| ----- | ------ |
| streamingContext: | A [[ |
Provides a simple, programmatically controlled HTTP listener.
Initializes a new instance of the class.
Gets or sets the scheme used to authenticate the clients.
T:System.ObjectDisposedException: This listener has been closed.
Gets or sets the delegate called to select the scheme used to authenticate the clients.
If you set this property, the listener uses the authentication scheme selected by the delegate for each request. Or if you don't set, the listener uses the value of the property as the authentication scheme for all requests.
T:System.ObjectDisposedException: This listener has been closed.
Gets or sets the path to the folder in which stores the certificate files used to authenticate the server on the secure connection.
T:System.ObjectDisposedException: This listener has been closed.
Gets or sets the default certificate used to authenticate the server on the secure connection.
T:System.ObjectDisposedException: This listener has been closed.
Gets or sets a value indicating whether the listener returns exceptions that occur when sending the response to the client.
T:System.ObjectDisposedException: This listener has been closed.
Gets a value indicating whether the listener has been started.
Gets a value indicating whether the listener can be used with the current operating system.
Gets the URI prefixes handled by the listener.
T:System.ObjectDisposedException: This listener has been closed.
Gets or sets the name of the realm associated with the listener.
T:System.ObjectDisposedException: This listener has been closed.
Gets or sets a value indicating whether, when NTLM authentication is used, the authentication information of first request is used to authenticate additional requests on the same connection.
This property isn't currently supported and always throws a .
T:System.NotSupportedException: Any use of this property.
Gets or sets the delegate called to find the credentials for an identity used to authenticate a client.
T:System.ObjectDisposedException: This listener has been closed.
Shuts down the listener immediately.
Begins getting an incoming request asynchronously.
This asynchronous operation must be completed by calling the method. Typically, the method is invoked by the delegate.
Returns: An that represents the status of the asynchronous operation.
| Name | Description |
|---|---|
| callback: | An [[ |
| Name | Description |
| ----- | ------ |
| state: | An [[ |
| [[T:System.InvalidOperationException | T:System.InvalidOperationException]]: |
T:System.ObjectDisposedException: This listener has been closed.
Shuts down the listener.
Ends an asynchronous operation to get an incoming request.
This method completes an asynchronous operation started by calling the method.
Returns: A that represents a request.
| Name | Description |
|---|---|
| asyncResult: | An [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: wasn't obtained by calling the method. |
T:System.InvalidOperationException: This method was already called for the specified .
T:System.ObjectDisposedException: This listener has been closed.
Gets an incoming request.
This method waits for an incoming request, and returns when a request is received.
Returns: A that represents a request.
T:System.InvalidOperationException:
T:System.ObjectDisposedException: This listener has been closed.
Starts receiving incoming requests.
T:System.ObjectDisposedException: This listener has been closed.
Stops receiving incoming requests.
T:System.ObjectDisposedException: This listener has been closed.
Releases all resources used by the listener.
Provides a set of methods and properties used to access the HTTP request and response information used by the .
The HttpListenerContext class cannot be inherited.
Gets the HTTP request information from a client.
Gets the HTTP response information used to send to the client.
Gets the client information (identity, authentication, and security roles).
Accepts a WebSocket connection request.
Returns: A that represents the WebSocket connection request.
| Name | Description |
|---|---|
| protocol: | A [[ |
| Name | Description |
| ----- | ------ |
| logger: | A [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: |
The exception that is thrown when a gets an error processing an HTTP request.
M:WebSocketSharp.Net.HttpListenerException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)
Initializes a new instance of the class from the specified and .
| Name | Description |
|---|---|
| serializationInfo: | A [[ |
| Name | Description |
| ----- | ------ |
| streamingContext: | A [[ |
Initializes a new instance of the class.
Initializes a new instance of the class with the specified .
| Name | Description |
|---|---|
| errorCode: | An [[ |
Initializes a new instance of the class with the specified and .
| Name | Description |
|---|---|
| errorCode: | An [[ |
| Name | Description |
| ----- | ------ |
| message: | A [[ |
Gets the error code that identifies the error that occurred.
Provides the collection used to store the URI prefixes for the .
The responds to the request which has a requested URI that the prefixes most closely match.
Gets the number of prefixes in the collection.
Gets a value indicating whether the access to the collection is read-only.
Gets a value indicating whether the access to the collection is synchronized.
Adds the specified to the collection.
| Name | Description |
|---|---|
| uriPrefix: | A [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: is invalid. |
T:System.ObjectDisposedException: The associated with this collection is closed.
Removes all URI prefixes from the collection.
T:System.ObjectDisposedException: The associated with this collection is closed.
Returns a value indicating whether the collection contains the specified .
Returns: if the collection contains ; otherwise, .
| Name | Description |
|---|---|
| uriPrefix: | A [[ |
| [[T:System.ObjectDisposedException | T:System.ObjectDisposedException]]: The [[ |
Copies the contents of the collection to the specified .
| Name | Description |
|---|---|
| array: | An [[ |
| Name | Description |
| ----- | ------ |
| offset: | An [[ |
| [[T:System.ObjectDisposedException | T:System.ObjectDisposedException]]: The [[ |
Copies the contents of the collection to the specified array of .
| Name | Description |
|---|---|
| array: | An array of [[ |
| Name | Description |
| ----- | ------ |
| offset: | An [[ |
| [[T:System.ObjectDisposedException | T:System.ObjectDisposedException]]: The [[ |
Gets the enumerator used to iterate through the .
Returns: An instance used to iterate through the collection.
Removes the specified from the collection.
Returns: if is successfully found and removed; otherwise, .
| Name | Description |
|---|---|
| uriPrefix: | A [[ |
| [[T:System.ObjectDisposedException | T:System.ObjectDisposedException]]: The [[ |
Gets the enumerator used to iterate through the .
Returns: An instance used to iterate through the collection.
Provides the access to a request to the .
The HttpListenerRequest class cannot be inherited.
Gets the media types which are acceptable for the response.
Gets an error code that identifies a problem with the client's certificate.
Gets the encoding for the entity body data included in the request.
Gets the size of the entity body data included in the request.
Gets the media type of the entity body included in the request.
Gets the cookies included in the request.
Gets a value indicating whether the request has the entity body.
Gets the HTTP headers used in the request.
Gets the HTTP method used in the request.
Gets a that contains the entity body data included in the request.
Gets a value indicating whether the client that sent the request is authenticated.
Gets a value indicating whether the request is sent from the local computer.
Gets a value indicating whether the HTTP connection is secured using the SSL protocol.
Gets a value indicating whether the request is a WebSocket connection request.
Gets a value indicating whether the client requests a persistent connection.
Gets the server endpoint as an IP address and a port number.
Gets the HTTP version used in the request.
Gets the query string included in the request.
Gets the raw URL (without the scheme, host, and port) requested by the client.
Gets the client endpoint as an IP address and a port number.
Gets the request identifier of a incoming HTTP request.
Gets the URL requested by the client.
Gets the URL of the resource from which the requested URL was obtained.
Gets the information about the user agent originating the request.
Gets the server endpoint as an IP address and a port number.
Gets the internet host name and port number (if present) specified by the client.
Gets the natural languages which are preferred for the response.
M:WebSocketSharp.Net.HttpListenerRequest.BeginGetClientCertificate(System.AsyncCallback,System.Object)
Begins getting the client's X.509 v.3 certificate asynchronously.
This asynchronous operation must be completed by calling the method. Typically, that method is invoked by the delegate.
Returns: An that contains the status of the asynchronous operation.
| Name | Description |
|---|---|
| requestCallback: | An [[ |
| Name | Description |
| ----- | ------ |
| state: | An [[ |
| [[T:System.NotImplementedException | T:System.NotImplementedException]]: This method isn't implemented. |
Ends an asynchronous operation to get the client's X.509 v.3 certificate.
This method completes an asynchronous operation started by calling the method.
Returns: A that contains the client's X.509 v.3 certificate.
| Name | Description |
|---|---|
| asyncResult: | An [[ |
| [[T:System.NotImplementedException | T:System.NotImplementedException]]: This method isn't implemented. |
Gets the client's X.509 v.3 certificate.
Returns: A that contains the client's X.509 v.3 certificate.
T:System.NotImplementedException: This method isn't implemented.
Returns a that represents the current .
Returns: A that represents the current .
Provides the access to a response to a request received by the .
The HttpListenerResponse class cannot be inherited.
Gets or sets the encoding for the entity body data included in the response.
T:System.InvalidOperationException: The response has already been sent.
T:System.ObjectDisposedException: This object is closed.
Gets or sets the size of the entity body data included in the response.
T:System.ArgumentOutOfRangeException: The value specified for a set operation is less than zero.
T:System.InvalidOperationException: The response has already been sent.
T:System.ObjectDisposedException: This object is closed.
Gets or sets the media type of the entity body included in the response.
T:System.ArgumentException: The value specified for a set operation is empty.
T:System.InvalidOperationException: The response has already been sent.
T:System.ObjectDisposedException: This object is closed.
Gets or sets the cookies sent with the response.
T:System.InvalidOperationException: The response has already been sent.
T:System.ObjectDisposedException: This object is closed.
Gets or sets the HTTP headers sent to the client.
T:System.InvalidOperationException: The response has already been sent.
T:System.ObjectDisposedException: This object is closed.
Gets or sets a value indicating whether the server requests a persistent connection.
T:System.InvalidOperationException: The response has already been sent.
T:System.ObjectDisposedException: This object is closed.
Gets a to use to write the entity body data.
T:System.ObjectDisposedException: This object is closed.
Gets or sets the HTTP version used in the response.
T:System.ArgumentException: The value specified for a set operation doesn't have its property set to 1 or doesn't have its property set to either 0 or 1.
T:System.InvalidOperationException: The response has already been sent.
T:System.ObjectDisposedException: This object is closed.
Gets or sets the URL to which the client is redirected to locate a requested resource.
T:System.ArgumentException: The value specified for a set operation is empty.
T:System.InvalidOperationException: The response has already been sent.
T:System.ObjectDisposedException: This object is closed.
Gets or sets a value indicating whether the response uses the chunked transfer encoding.
T:System.InvalidOperationException: The response has already been sent.
T:System.ObjectDisposedException: This object is closed.
Gets or sets the HTTP status code returned to the client.
T:System.InvalidOperationException: The response has already been sent.
T:System.Net.ProtocolViolationException: The value specified for a set operation is invalid. Valid values are between 100 and 999.
T:System.ObjectDisposedException: This object is closed.
Gets or sets the description of the HTTP status code returned to the client.
T:System.InvalidOperationException: The response has already been sent.
T:System.ObjectDisposedException: This object is closed.
Closes the connection to the client without returning a response.
Adds an HTTP header with the specified and to the headers for the response.
| Name | Description |
|---|---|
| name: | A [[ |
| Name | Description |
| ----- | ------ |
| value: | A [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: |
T:System.ArgumentOutOfRangeException: The length of is greater than 65,535 characters.
T:System.InvalidOperationException:
T:System.ObjectDisposedException: This object is closed.
Appends the specified to the cookies sent with the response.
| Name | Description |
|---|---|
| cookie: | A [[ |
| [[T:System.InvalidOperationException | T:System.InvalidOperationException]]: The response has already been sent. |
T:System.ObjectDisposedException: This object is closed.
Appends a to the specified HTTP header sent with the response.
| Name | Description |
|---|---|
| name: | A [[ |
| Name | Description |
| ----- | ------ |
| value: | A [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: |
T:System.ArgumentOutOfRangeException: The length of is greater than 65,535 characters.
T:System.InvalidOperationException:
T:System.ObjectDisposedException: This object is closed.
Returns the response to the client and releases the resources used by this instance.
Returns the response with the specified array of to the client and releases the resources used by this instance.
| Name | Description |
|---|---|
| responseEntity: | An array of [[ |
| Name | Description |
| ----- | ------ |
| willBlock: | if this method blocks execution while flushing the stream to the client; otherwise, . |
| [[T:System.InvalidOperationException | T:System.InvalidOperationException]]: The response has already been sent. |
T:System.ObjectDisposedException: This object is closed.
Copies properties from the specified to this response.
| Name | Description |
|---|---|
| templateResponse: | A [[ |
| [[T:System.InvalidOperationException | T:System.InvalidOperationException]]: The response has already been sent. |
T:System.ObjectDisposedException: This object is closed.
Configures the response to redirect the client's request to the specified .
| Name | Description |
|---|---|
| url: | A [[ |
| [[T:System.InvalidOperationException | T:System.InvalidOperationException]]: The response has already been sent. |
T:System.ObjectDisposedException: This object is closed.
Adds or updates a in the cookies sent with the response.
| Name | Description |
|---|---|
| cookie: | A [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: already exists in the cookies and couldn't be replaced. |
T:System.InvalidOperationException: The response has already been sent.
T:System.ObjectDisposedException: This object is closed.
Releases all resources used by the .
Decodes an HTML-encoded and returns the decoded .
Returns: A that represents the decoded string.
| Name | Description |
|---|---|
| s: | A [[ |
Decodes an HTML-encoded and sends the decoded to the specified .
| Name | Description |
|---|---|
| s: | A [[ |
| Name | Description |
| ----- | ------ |
| output: | A [[ |
HTML-encodes a and returns the encoded .
Returns: A that represents the encoded string.
| Name | Description |
|---|---|
| s: | A [[ |
HTML-encodes a and sends the encoded to the specified .
| Name | Description |
|---|---|
| s: | A [[ |
| Name | Description |
| ----- | ------ |
| output: | A [[ |
Provides a collection of the HTTP headers associated with a request or response.
M:WebSocketSharp.Net.WebHeaderCollection.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)
Initializes a new instance of the class from the specified and .
| Name | Description |
|---|---|
| serializationInfo: | A [[ |
| Name | Description |
| ----- | ------ |
| streamingContext: | A [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: An element with the specified name isn't found in . |
Initializes a new instance of the class.
Gets all header names in the collection.
Gets the number of headers in the collection.
Gets or sets the specified request in the collection.
| Name | Description |
|---|---|
| header: | One of the [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: |
T:System.ArgumentOutOfRangeException: The length of is greater than 65,535 characters.
T:System.InvalidOperationException: The current instance doesn't allow the request .
Gets or sets the specified response in the collection.
| Name | Description |
|---|---|
| header: | One of the [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: |
T:System.ArgumentOutOfRangeException: The length of is greater than 65,535 characters.
T:System.InvalidOperationException: The current instance doesn't allow the response .
Gets a collection of header names in the collection.
Adds a header to the collection without checking whether the header is on the restricted header list.
| Name | Description |
|---|---|
| headerName: | A [[ |
| Name | Description |
| ----- | ------ |
| headerValue: | A [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: or contains invalid characters. |
T:System.ArgumentOutOfRangeException: The length of is greater than 65,535 characters.
T:System.InvalidOperationException: The current instance doesn't allow the .
Adds the specified to the collection.
| Name | Description |
|---|---|
| header: | A [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: |
T:System.ArgumentOutOfRangeException: The length of the value part of is greater than 65,535 characters.
T:System.InvalidOperationException: The current instance doesn't allow the .
Adds the specified request with the specified to the collection.
| Name | Description |
|---|---|
| header: | One of the [[ |
| Name | Description |
| ----- | ------ |
| value: | A [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: |
T:System.ArgumentOutOfRangeException: The length of is greater than 65,535 characters.
T:System.InvalidOperationException: The current instance doesn't allow the request .
Adds the specified response with the specified to the collection.
| Name | Description |
|---|---|
| header: | One of the [[ |
| Name | Description |
| ----- | ------ |
| value: | A [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: |
T:System.ArgumentOutOfRangeException: The length of is greater than 65,535 characters.
T:System.InvalidOperationException: The current instance doesn't allow the response .
Adds a header with the specified and to the collection.
| Name | Description |
|---|---|
| name: | A [[ |
| Name | Description |
| ----- | ------ |
| value: | A [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: |
T:System.ArgumentOutOfRangeException: The length of is greater than 65,535 characters.
T:System.InvalidOperationException: The current instance doesn't allow the header .
Removes all headers from the collection.
Get the value of the header at the specified in the collection.
Returns: A that receives the value of the header.
| Name | Description |
|---|---|
| index: | An [[ |
| [[T:System.ArgumentOutOfRangeException | T:System.ArgumentOutOfRangeException]]: is out of allowable range of indexes for the collection. |
Get the value of the header with the specified in the collection.
| Name | Description |
|---|---|
| name: | A [[ |
Gets the enumerator used to iterate through the collection.
Returns: An instance used to iterate through the collection.
Get the name of the header at the specified in the collection.
Returns: A that receives the header name.
| Name | Description |
|---|---|
| index: | An [[ |
| [[T:System.ArgumentOutOfRangeException | T:System.ArgumentOutOfRangeException]]: is out of allowable range of indexes for the collection. |
Gets an array of header values stored in the specified position of the collection.
| Name | Description |
|---|---|
| index: | An [[ |
| [[T:System.ArgumentOutOfRangeException | T:System.ArgumentOutOfRangeException]]: is out of allowable range of indexes for the collection. |
Gets an array of header values stored in the specified .
| Name | Description |
|---|---|
| header: | A [[ |
M:WebSocketSharp.Net.WebHeaderCollection.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)
Populates the specified with the data needed to serialize the .
| Name | Description |
|---|---|
| serializationInfo: | A [[ |
| Name | Description |
| ----- | ------ |
| streamingContext: | A [[ |
Determines whether the specified header can be set for the request.
Returns: if the header is restricted; otherwise, .
| Name | Description |
|---|---|
| headerName: | A [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: contains invalid characters. |
Determines whether the specified header can be set for the request or the response.
Returns: if the header is restricted; otherwise, .
| Name | Description |
|---|---|
| headerName: | A [[ |
| Name | Description |
| ----- | ------ |
| response: | if does the test for the response; for the request, . |
| [[T:System.ArgumentException | T:System.ArgumentException]]: contains invalid characters. |
Implements the interface and raises the deserialization event when the deserialization is complete.
| Name | Description |
|---|---|
| sender: | An [[ |
Removes the specified request from the collection.
| Name | Description |
|---|---|
| header: | One of the [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: is a restricted header. |
T:System.InvalidOperationException: The current instance doesn't allow the request .
Removes the specified response from the collection.
| Name | Description |
|---|---|
| header: | One of the [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: is a restricted header. |
T:System.InvalidOperationException: The current instance doesn't allow the response .
Removes the specified header from the collection.
| Name | Description |
|---|---|
| name: | A [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: |
T:System.InvalidOperationException: The current instance doesn't allow the header .
Sets the specified request to the specified value.
| Name | Description |
|---|---|
| header: | One of the [[ |
| Name | Description |
| ----- | ------ |
| value: | A [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: |
T:System.ArgumentOutOfRangeException: The length of is greater than 65,535 characters.
T:System.InvalidOperationException: The current instance doesn't allow the request .
Sets the specified response to the specified value.
| Name | Description |
|---|---|
| header: | One of the [[ |
| Name | Description |
| ----- | ------ |
| value: | A [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: |
T:System.ArgumentOutOfRangeException: The length of is greater than 65,535 characters.
T:System.InvalidOperationException: The current instance doesn't allow the response .
Sets the specified header to the specified value.
| Name | Description |
|---|---|
| name: | A [[ |
| Name | Description |
| ----- | ------ |
| value: | A [[ |
| [[T:System.ArgumentException | T:System.ArgumentException]]: |
T:System.ArgumentOutOfRangeException: The length of is greater than 65,535 characters.
T:System.InvalidOperationException: The current instance doesn't allow the header .
Converts the current to an array of .
Returns: An array of that receives the converted current .
Returns a that represents the current .
Returns: A that represents the current .
M:WebSocketSharp.Net.WebHeaderCollection.System#Runtime#Serialization#ISerializable#GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)
Populates the specified with the data needed to serialize the current .
| Name | Description |
|---|---|
| serializationInfo: | A [[ |
| Name | Description |
| ----- | ------ |
| streamingContext: | A [[ |
Provides the HTTP version numbers.
Provides a instance for HTTP 1.0.
Provides a instance for HTTP 1.1.
Initializes a new instance of the class.
Contains the values of the HTTP status codes.
Equivalent to status code 100. Indicates that the client should continue with its request.
Equivalent to status code 101. Indicates that the server is switching the HTTP version or protocol on the connection.
Equivalent to status code 200. Indicates that the client's request has succeeded.
Equivalent to status code 201. Indicates that the client's request has been fulfilled and resulted in a new resource being created.
Equivalent to status code 202. Indicates that the client's request has been accepted for processing, but the processing hasn't been completed.
Equivalent to status code 203. Indicates that the returned metainformation is from a local or a third-party copy instead of the origin server.
Equivalent to status code 204. Indicates that the server has fulfilled the client's request but doesn't need to return an entity-body.
Equivalent to status code 205. Indicates that the server has fulfilled the client's request, and the user agent should reset the document view which caused the request to be sent.
Equivalent to status code 206. Indicates that the server has fulfilled the partial GET request for the resource.
Equivalent to status code 304. Indicates that the client has performed a conditional GET request and access is allowed, but the document hasn't been modified.
Equivalent to status code 305. Indicates that the requested resource must be accessed through the proxy given by the Location field.
Equivalent to status code 306. This status code was used in a previous version of the specification, is no longer used, and is reserved for future use.
Equivalent to status code 400. Indicates that the client's request couldn't be understood by the server due to malformed syntax.
Equivalent to status code 401. Indicates that the client's request requires user authentication.
Equivalent to status code 402. This status code is reserved for future use.
Equivalent to status code 403. Indicates that the server understood the client's request but is refusing to fulfill it.
Equivalent to status code 404. Indicates that the server hasn't found anything matching the request URI.
Equivalent to status code 405. Indicates that the method specified in the request line isn't allowed for the resource identified by the request URI.
Equivalent to status code 406. Indicates that the server doesn't have the appropriate resource to respond to the Accept headers in the client's request.
Equivalent to status code 407. Indicates that the client must first authenticate itself with the proxy.
Equivalent to status code 408. Indicates that the client didn't produce a request within the time that the server was prepared to wait.
Equivalent to status code 409. Indicates that the client's request couldn't be completed due to a conflict on the server.
Equivalent to status code 410. Indicates that the requested resource is no longer available at the server and no forwarding address is known.
Equivalent to status code 411. Indicates that the server refuses to accept the client's request without a defined Content-Length.
Equivalent to status code 412. Indicates that the precondition given in one or more of the request headers evaluated to false when it was tested on the server.
Equivalent to status code 413. Indicates that the entity of the client's request is larger than the server is willing or able to process.
Equivalent to status code 414. Indicates that the request URI is longer than the server is willing to interpret.
Equivalent to status code 415. Indicates that the entity of the client's request is in a format not supported by the requested resource for the requested method.
Equivalent to status code 416. Indicates that none of the range specifier values in a Range request header overlap the current extent of the selected resource.
Equivalent to status code 417. Indicates that the expectation given in an Expect request header couldn't be met by the server.
Equivalent to status code 500. Indicates that the server encountered an unexpected condition which prevented it from fulfilling the client's request.
Equivalent to status code 501. Indicates that the server doesn't support the functionality required to fulfill the client's request.
Equivalent to status code 502. Indicates that a gateway or proxy server received an invalid response from the upstream server.
Equivalent to status code 503. Indicates that the server is currently unable to handle the client's request due to a temporary overloading or maintenance of the server.
Equivalent to status code 504. Indicates that a gateway or proxy server didn't receive a timely response from the upstream server or some other auxiliary server.
Equivalent to status code 505. Indicates that the server doesn't support the HTTP version used in the client's request.
Provides the properties used to access the information in a WebSocket connection request received by the .
Gets the HTTP cookies included in the request.
Gets the HTTP headers included in the request.
Gets the value of the Host header included in the request.
Gets a value indicating whether the client is authenticated.
Gets a value indicating whether the client connected from the local computer.
Gets a value indicating whether the WebSocket connection is secured.
Gets a value indicating whether the request is a WebSocket connection request.
Gets the value of the Origin header included in the request.
Gets the query string included in the request.
Gets the URI requested by the client.
Gets the value of the Sec-WebSocket-Key header included in the request.
This property provides a part of the information used by the server to prove that it received a valid WebSocket connection request.
Gets the values of the Sec-WebSocket-Protocol header included in the request.
This property represents the subprotocols requested by the client.
Gets the value of the Sec-WebSocket-Version header included in the request.
This property represents the WebSocket protocol version.
Gets the server endpoint as an IP address and a port number.
Gets the client information (identity, authentication, and security roles).
Gets the client endpoint as an IP address and a port number.
Gets the instance used for two-way communication between client and server.
Returns a that represents the current .
Returns: A that represents the current .
Provides the properties used to access the information in a WebSocket connection request received by the .
Gets the HTTP cookies included in the request.
Gets the HTTP headers included in the request.
Gets the value of the Host header included in the request.
Gets a value indicating whether the client is authenticated.
Gets a value indicating whether the client connected from the local computer.
Gets a value indicating whether the WebSocket connection is secured.
Gets a value indicating whether the request is a WebSocket connection request.
Gets the value of the Origin header included in the request.
Gets the query string included in the request.
Gets the URI requested by the client.
Gets the value of the Sec-WebSocket-Key header included in the request.
This property provides a part of the information used by the server to prove that it received a valid WebSocket connection request.
Gets the values of the Sec-WebSocket-Protocol header included in the request.
This property represents the subprotocols requested by the client.
Gets the value of the Sec-WebSocket-Version header included in the request.
This property represents the WebSocket protocol version.
Gets the server endpoint as an IP address and a port number.
Gets the client information (identity, authentication, and security roles).
Gets the client endpoint as an IP address and a port number.
Gets the instance used for two-way communication between client and server.
Returns a that represents the current .
Returns: A that represents the current .
Exposes the properties used to access the information in a WebSocket connection request.
The WebSocketContext class is an abstract class.
Gets the HTTP cookies included in the request.
Gets the HTTP headers included in the request.
Gets the value of the Host header included in the request.
Gets a value indicating whether the client is authenticated.
Gets a value indicating whether the client connected from the local computer.
Gets a value indicating whether the WebSocket connection is secured.
Gets a value indicating whether the request is a WebSocket connection request.
Gets the value of the Origin header included in the request.
Gets the query string included in the request.
Gets the URI requested by the client.
Gets the value of the Sec-WebSocket-Key header included in the request.
This property provides a part of the information used by the server to prove that it received a valid WebSocket connection request.
Gets the values of the Sec-WebSocket-Protocol header included in the request.
This property represents the subprotocols requested by the client.
Gets the value of the Sec-WebSocket-Version header included in the request.
This property represents the WebSocket protocol version.
Gets the server endpoint as an IP address and a port number.
Gets the client information (identity, authentication, and security roles).
Gets the client endpoint as an IP address and a port number.
Gets the instance used for two-way communication between client and server.
Holds the user name and password from the HTTP Basic authentication credentials.
Gets the password from the HTTP Basic authentication credentials.
Holds the user name and other parameters from the HTTP Digest authentication credentials.
Gets the algorithm parameter from the HTTP Digest authentication credentials.
Gets the cnonce parameter from the HTTP Digest authentication credentials.
Gets the nc parameter from the HTTP Digest authentication credentials.
Gets the nonce parameter from the HTTP Digest authentication credentials.
Gets the opaque parameter from the HTTP Digest authentication credentials.
Gets the qop parameter from the HTTP Digest authentication credentials.
Gets the realm parameter from the HTTP Digest authentication credentials.
Gets the response parameter from the HTTP Digest authentication credentials.
Gets the uri parameter from the HTTP Digest authentication credentials.
Provides the credentials for HTTP authentication (Basic/Digest).
Initializes a new instance of the class with the specified user name and password.
| Name | Description |
|---|---|
| username: | A [[ |
| Name | Description |
| ----- | ------ |
| password: | A [[ |
M:WebSocketSharp.Net.NetworkCredential.#ctor(System.String,System.String,System.String,System.String[])
Initializes a new instance of the class with the specified user name, password, domain, and roles.
| Name | Description |
|---|---|
| username: | A [[ |
| Name | Description |
| ----- | ------ |
| password: | A [[ |
| Name | Description |
| ----- | ------ |
| domain: | A [[ |
| Name | Description |
| ----- | ------ |
| roles: | An array of [[ |
Gets the name of the user domain associated with the credentials.
Gets the password for the user name associated with the credentials.
Gets the role names to which the user associated with the credentials belongs.
Gets the user name associated with the credentials.
Contains the values of the status code for the WebSocket connection close.
Equivalent to close status 1000. Indicates a normal close.
Equivalent to close status 1001. Indicates that an endpoint is going away.
Equivalent to close status 1002. Indicates that an endpoint is terminating the connection due to a protocol error.
Equivalent to close status 1003. Indicates that an endpoint is terminating the connection because it has received an unacceptable type message.
Equivalent to close status 1004. Still undefined. A Reserved value.
Equivalent to close status 1005. Indicates that no status code was actually present. A Reserved value.
Equivalent to close status 1006. Indicates that the connection was closed abnormally. A Reserved value.
Equivalent to close status 1007. Indicates that an endpoint is terminating the connection because it has received a message that contains a data that isn't consistent with the type of the message.
Equivalent to close status 1008. Indicates that an endpoint is terminating the connection because it has received a message that violates its policy.
Equivalent to close status 1009. Indicates that an endpoint is terminating the connection because it has received a message that is too big to process.
Equivalent to close status 1010. Indicates that the client is terminating the connection because it has expected the server to negotiate one or more extension, but the server didn't return them in the handshake response.
Equivalent to close status 1011. Indicates that the server is terminating the connection because it has encountered an unexpected condition that prevented it from fulfilling the request.
Equivalent to close status 1015. Indicates that the connection was closed due to a failure to perform a TLS handshake. A Reserved value.
Contains the values of the opcode that indicates the type of a WebSocket frame.
Equivalent to numeric value 0. Indicates a continuation frame.
Equivalent to numeric value 1. Indicates a text frame.
Equivalent to numeric value 2. Indicates a binary frame.
Equivalent to numeric value 8. Indicates a connection close frame.
Equivalent to numeric value 9. Indicates a ping frame.
Equivalent to numeric value 10. Indicates a pong frame.
Contains the values of the compression method used to compress the message on the WebSocket connection.
Indicates non compression.
Indicates using DEFLATE.
The exception that is thrown when a gets a fatal error.
Gets the status code indicating the cause of the exception.
Contains the values of the state of the WebSocket connection.
Equivalent to numeric value 0. Indicates that the connection hasn't yet been established.
Equivalent to numeric value 1. Indicates that the connection is established and the communication is possible.
Equivalent to numeric value 2. Indicates that the connection is going through the closing handshake or the method has been invoked.
Equivalent to numeric value 3. Indicates that the connection has been closed or couldn't be opened.