diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000..a7c8721 Binary files /dev/null and b/.DS_Store differ diff --git a/Assets/.DS_Store b/Assets/.DS_Store new file mode 100644 index 0000000..7d5b280 Binary files /dev/null and b/Assets/.DS_Store differ diff --git a/Assets/1OurScripts/ConnectUnityWithSensors.cs b/Assets/1OurScripts/ConnectUnityWithSensors.cs new file mode 100644 index 0000000..5df6252 --- /dev/null +++ b/Assets/1OurScripts/ConnectUnityWithSensors.cs @@ -0,0 +1,79 @@ +using System.Collections; +using System.Collections.Generic; +using UnityEngine; +using System; +using WebSocketSharp; // Ensure this matches the WebSocket library you're using + +public class ConnectUnityWithSensors : MonoBehaviour +{ + // Websocket Service + WebSocket ws; + //public AudioSource audioSource; // Assign in inspector + //public AudioClip narrationClip; // Assign in inspector + // + public string esp32IPAddress = "10.204.0.249"; // Assign your ESP32 IP Address + public string esp32WebsocketPort = "81"; // Assign your ESP32 WebSocket port, typically "81" + + private bool forceDataReceived = false; + private int receivedForceValue = 0; + + void Start() + { + ConnectWithESP32(); + //StartCoroutine(NarrationAndSignalCoroutine()); + } + + public void ConnectWithESP32() + { + Debug.Log("Connecting Unity with ESP32 via Websockets..."); + ws = new WebSocket($"ws://{esp32IPAddress}:{esp32WebsocketPort}"); + ws.OnOpen += (sender, e) => + { + Debug.Log("WebSocket connected"); + ws.Send("Hello from Unity!"); + }; + ws.OnMessage += (sender, e) => + { + Debug.Log("Received message: " + e.Data); + int parsedValue; + bool isNumeric = int.TryParse(e.Data, out parsedValue); + if (isNumeric) + { + receivedForceValue = parsedValue; + forceDataReceived = true; // Indicate that new data has been received + } + }; + ws.Connect(); + Debug.Log("Websocket state - " + ws.ReadyState); + } + + /*IEnumerator NarrationAndSignalCoroutine() + { + audioSource.PlayOneShot(narrationClip); + yield return new WaitForSeconds(narrationClip.length); + if (ws.IsAlive) + { + ws.Send("Need Force"); + } + }*/ + + void Update() + { + if (forceDataReceived) + { + if (receivedForceValue > 50) + { + Debug.Log("Force threshold exceeded, action triggered."); + } + forceDataReceived = false; // Reset for the next message + } + } + + void OnDestroy() + { + if (ws != null && ws.IsAlive) + { + ws.Close(); + } + } +} diff --git a/Assets/1OurScripts/ConnectUnityWithSensors.cs.meta b/Assets/1OurScripts/ConnectUnityWithSensors.cs.meta new file mode 100644 index 0000000..dd26172 --- /dev/null +++ b/Assets/1OurScripts/ConnectUnityWithSensors.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: 0ecd28734b48f4313bff134f6df55396 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/NuGet.config b/Assets/NuGet.config new file mode 100644 index 0000000..82fb1c8 --- /dev/null +++ b/Assets/NuGet.config @@ -0,0 +1,16 @@ +<?xml version="1.0" encoding="utf-8"?> +<configuration> + <packageSources> + <clear /> + <add key="nuget.org" value="https://api.nuget.org/v3/index.json" /> + </packageSources> + <disabledPackageSources /> + <activePackageSource> + <add key="All" value="(Aggregate source)" /> + </activePackageSource> + <config> + <add key="repositoryPath" value="./Packages" /> + <add key="PackagesConfigDirectoryPath" value="." /> + <add key="slimRestore" value="true" /> + </config> +</configuration> \ No newline at end of file diff --git a/Assets/NuGet.config.meta b/Assets/NuGet.config.meta new file mode 100644 index 0000000..fa90c9f --- /dev/null +++ b/Assets/NuGet.config.meta @@ -0,0 +1,23 @@ +fileFormatVersion: 2 +guid: 3bfefe5057a8141f5b38c75f10dda552 +labels: +- NuGetForUnity +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 0 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/OurESP32Scripts/ESP32/ESP32.ino b/Assets/OurESP32Scripts/ESP32/ESP32.ino new file mode 100644 index 0000000..0fc6615 --- /dev/null +++ b/Assets/OurESP32Scripts/ESP32/ESP32.ino @@ -0,0 +1,92 @@ +#include <ArduinoWebsockets.h> +#include <WiFi.h> + +const char* ssid = "dsv-extrality-lab"; // Change to your WiFi network name +const char* password = "expiring-unstuck-slider"; // Change to your WiFi password + +using namespace websockets; + +WebsocketsServer server; +WebsocketsClient client; +int forceSensorValue = 0; +const int forceSensorPin = 34; // Change to your actual force sensor pin + +void setup() { + Serial.begin(115200); + + // Initialize force sensor pin as input + pinMode(forceSensorPin, INPUT); + + // Connect to WiFi + WiFi.begin(ssid, password); + + // Wait to connect to WiFi + while (WiFi.status() != WL_CONNECTED) { + delay(1000); + Serial.println("Connecting to WiFi..."); + } + + Serial.println("Connected to WiFi"); + Serial.print("IP Address: "); + Serial.println(WiFi.localIP()); + + // Start WebSocket server + server.listen(81); + Serial.println("WebSocket server started."); +} + +void loop() { + //Serial.println(WiFi.localIP()); +if (server.poll()) { //server.poll() checks if any client is waiting to connect + Serial.println("Client is available to connect..."); + client = server.accept(); // Accept() --> what server.accept does, is: "server, please wait until there is a client knocking on the door. when there is a client knocking, let him in and give me it's object". + Serial.println("Client connected..."); + + while (client.available()) { + + Serial.println("Waiting for client to send a message..."); + WebsocketsMessage msg = client.readBlocking();//readBlocking(removes the need for calling poll()) will return the first message or event received. readBlocking can also return Ping, Pong and Close messages. + + // log + Serial.print("Got Message: "); + Serial.println(msg.data()); + // Condition to blink the light at the start of program as a hello indication + if(msg.data().startsWith("Hello")){ + for(int i=0;i<4;i++){ + digitalWrite(11, HIGH); //Blink on + delay(170); + digitalWrite(11, LOW); //Blink off + } + client.send(String(10)); + } + if (msg.data().equalsIgnoreCase("Need Force")) { + digitalWrite(11, HIGH); //Notify user to use force sensor + Serial.println("Reading value from Force Sensor..."); + while (forceSensorValue <= 20) { + + analogReadResolution(10); // This statement tells in how many bits the AnalogRead should happen. + // analogRead function returns the integer 10 bit integer (0 to 1023) + forceSensorValue = analogRead(A0); + + if (forceSensorValue > 20) { + digitalWrite(13, HIGH); + Serial.print(forceSensorValue, DEC); + Serial.print("\n"); // Sending New Line character is important to read data in unity + Serial.flush(); + + // return echo + client.send(String(forceSensorValue)); + digitalWrite(11, LOW); //Notify user NOT to use force sensor + digitalWrite(13, LOW); // Turn off built-in LED to notify user that value reading is done. + forceSensorValue = 0; + break; + } + } + } + + } + // close the connection + client.close(); + } +} + diff --git a/Assets/Packages.meta b/Assets/Packages.meta new file mode 100644 index 0000000..fbabb52 --- /dev/null +++ b/Assets/Packages.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: ba626952818604530b1a713a3f4c9e15 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Packages/WebSocketSharp-netstandard.1.0.1.meta b/Assets/Packages/WebSocketSharp-netstandard.1.0.1.meta new file mode 100644 index 0000000..58198a6 --- /dev/null +++ b/Assets/Packages/WebSocketSharp-netstandard.1.0.1.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: b48e8c73bd75840d084f07aa471692a6 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Packages/WebSocketSharp-netstandard.1.0.1/.signature.p7s b/Assets/Packages/WebSocketSharp-netstandard.1.0.1/.signature.p7s new file mode 100644 index 0000000..38e615d Binary files /dev/null and b/Assets/Packages/WebSocketSharp-netstandard.1.0.1/.signature.p7s differ diff --git a/Assets/Packages/WebSocketSharp-netstandard.1.0.1/WebSocketSharp-netstandard.nuspec b/Assets/Packages/WebSocketSharp-netstandard.1.0.1/WebSocketSharp-netstandard.nuspec new file mode 100644 index 0000000..8af1b95 --- /dev/null +++ b/Assets/Packages/WebSocketSharp-netstandard.1.0.1/WebSocketSharp-netstandard.nuspec @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="utf-8"?> +<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd"> + <metadata> + <id>WebSocketSharp-netstandard</id> + <version>1.0.1</version> + <authors>sta</authors> + <owners>sta</owners> + <requireLicenseAcceptance>false</requireLicenseAcceptance> + <licenseUrl>https://github.com/PingmanTools/websocket-sharp/blob/master/LICENSE.txt</licenseUrl> + <projectUrl>https://github.com/PingmanTools/websocket-sharp/</projectUrl> + <description>websocket-sharp provides the WebSocket protocol client and server. + +It supports: +- RFC 6455 +- WebSocket Client and Server +- Per-message Compression extension +- Secure Connection +- HTTP Authentication (Basic/Digest) +- Query String, Origin header and Cookies +- Connecting through the HTTP Proxy server +- .NET 3.5 or later (includes compatible)</description> + <copyright>sta.blockhead</copyright> + <tags>websocket</tags> + <repository url="https://github.com/PingmanTools/websocket-sharp/" /> + <dependencies> + <group targetFramework=".NETFramework3.5" /> + <group targetFramework=".NETFramework4.5" /> + <group targetFramework=".NETStandard2.0" /> + </dependencies> + </metadata> +</package> \ No newline at end of file diff --git a/Assets/Packages/WebSocketSharp-netstandard.1.0.1/WebSocketSharp-netstandard.nuspec.meta b/Assets/Packages/WebSocketSharp-netstandard.1.0.1/WebSocketSharp-netstandard.nuspec.meta new file mode 100644 index 0000000..7dac618 --- /dev/null +++ b/Assets/Packages/WebSocketSharp-netstandard.1.0.1/WebSocketSharp-netstandard.nuspec.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: b2cc6a0b16ab14fe4ba051dc7f34b6c2 +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Packages/WebSocketSharp-netstandard.1.0.1/lib.meta b/Assets/Packages/WebSocketSharp-netstandard.1.0.1/lib.meta new file mode 100644 index 0000000..b77f2b1 --- /dev/null +++ b/Assets/Packages/WebSocketSharp-netstandard.1.0.1/lib.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: a39cc4c82400245839717ac5f918c11f +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Packages/WebSocketSharp-netstandard.1.0.1/lib/netstandard2.0.meta b/Assets/Packages/WebSocketSharp-netstandard.1.0.1/lib/netstandard2.0.meta new file mode 100644 index 0000000..a0acdfe --- /dev/null +++ b/Assets/Packages/WebSocketSharp-netstandard.1.0.1/lib/netstandard2.0.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: b0cecdec8c24e4c089316e744ff04271 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Packages/WebSocketSharp-netstandard.1.0.1/lib/netstandard2.0/websocket-sharp.dll b/Assets/Packages/WebSocketSharp-netstandard.1.0.1/lib/netstandard2.0/websocket-sharp.dll new file mode 100644 index 0000000..27e2f7f Binary files /dev/null and b/Assets/Packages/WebSocketSharp-netstandard.1.0.1/lib/netstandard2.0/websocket-sharp.dll differ diff --git a/Assets/Packages/WebSocketSharp-netstandard.1.0.1/lib/netstandard2.0/websocket-sharp.dll.meta b/Assets/Packages/WebSocketSharp-netstandard.1.0.1/lib/netstandard2.0/websocket-sharp.dll.meta new file mode 100644 index 0000000..90104c5 --- /dev/null +++ b/Assets/Packages/WebSocketSharp-netstandard.1.0.1/lib/netstandard2.0/websocket-sharp.dll.meta @@ -0,0 +1,23 @@ +fileFormatVersion: 2 +guid: 625d580f04cb2464cad5256f498f47a9 +labels: +- NuGetForUnity +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 0 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Packages/WebSocketSharp-netstandard.1.0.1/lib/netstandard2.0/websocket-sharp.xml b/Assets/Packages/WebSocketSharp-netstandard.1.0.1/lib/netstandard2.0/websocket-sharp.xml new file mode 100644 index 0000000..d4ffb44 --- /dev/null +++ b/Assets/Packages/WebSocketSharp-netstandard.1.0.1/lib/netstandard2.0/websocket-sharp.xml @@ -0,0 +1,10326 @@ +<?xml version="1.0"?> +<doc> + <assembly> + <name>websocket-sharp</name> + </assembly> + <members> + <member name="T:WebSocketSharp.ByteOrder"> + <summary> + Specifies the byte order. + </summary> + </member> + <member name="F:WebSocketSharp.ByteOrder.Little"> + <summary> + Specifies Little-endian. + </summary> + </member> + <member name="F:WebSocketSharp.ByteOrder.Big"> + <summary> + Specifies Big-endian. + </summary> + </member> + <member name="T:WebSocketSharp.CloseEventArgs"> + <summary> + Represents the event data for the <see cref="E:WebSocketSharp.WebSocket.OnClose"/> event. + </summary> + <remarks> + <para> + That event occurs when the WebSocket connection has been closed. + </para> + <para> + If you would like to get the reason for the close, you should access + the <see cref="P:WebSocketSharp.CloseEventArgs.Code"/> or <see cref="P:WebSocketSharp.CloseEventArgs.Reason"/> property. + </para> + </remarks> + </member> + <member name="P:WebSocketSharp.CloseEventArgs.Code"> + <summary> + Gets the status code for the close. + </summary> + <value> + A <see cref="T:System.UInt16"/> that represents the status code for the close if any. + </value> + </member> + <member name="P:WebSocketSharp.CloseEventArgs.Reason"> + <summary> + Gets the reason for the close. + </summary> + <value> + A <see cref="T:System.String"/> that represents the reason for the close if any. + </value> + </member> + <member name="P:WebSocketSharp.CloseEventArgs.WasClean"> + <summary> + Gets a value indicating whether the connection has been closed cleanly. + </summary> + <value> + <c>true</c> if the connection has been closed cleanly; otherwise, <c>false</c>. + </value> + </member> + <member name="T:WebSocketSharp.CloseStatusCode"> + <summary> + Indicates the status code for the WebSocket connection close. + </summary> + <remarks> + <para> + The values of this enumeration are defined in + <see href="http://tools.ietf.org/html/rfc6455#section-7.4"> + Section 7.4</see> of RFC 6455. + </para> + <para> + "Reserved value" cannot be sent as a status code in + closing handshake by an endpoint. + </para> + </remarks> + </member> + <member name="F:WebSocketSharp.CloseStatusCode.Normal"> + <summary> + Equivalent to close status 1000. Indicates normal close. + </summary> + </member> + <member name="F:WebSocketSharp.CloseStatusCode.Away"> + <summary> + Equivalent to close status 1001. Indicates that an endpoint is + going away. + </summary> + </member> + <member name="F:WebSocketSharp.CloseStatusCode.ProtocolError"> + <summary> + Equivalent to close status 1002. Indicates that an endpoint is + terminating the connection due to a protocol error. + </summary> + </member> + <member name="F:WebSocketSharp.CloseStatusCode.UnsupportedData"> + <summary> + Equivalent to close status 1003. Indicates that an endpoint is + terminating the connection because it has received a type of + data that it cannot accept. + </summary> + </member> + <member name="F:WebSocketSharp.CloseStatusCode.Undefined"> + <summary> + Equivalent to close status 1004. Still undefined. A Reserved value. + </summary> + </member> + <member name="F:WebSocketSharp.CloseStatusCode.NoStatus"> + <summary> + Equivalent to close status 1005. Indicates that no status code was + actually present. A Reserved value. + </summary> + </member> + <member name="F:WebSocketSharp.CloseStatusCode.Abnormal"> + <summary> + Equivalent to close status 1006. Indicates that the connection was + closed abnormally. A Reserved value. + </summary> + </member> + <member name="F:WebSocketSharp.CloseStatusCode.InvalidData"> + <summary> + Equivalent to close status 1007. Indicates that an endpoint is + terminating the connection because it has received a message that + contains data that is not consistent with the type of the message. + </summary> + </member> + <member name="F:WebSocketSharp.CloseStatusCode.PolicyViolation"> + <summary> + Equivalent to close status 1008. Indicates that an endpoint is + terminating the connection because it has received a message that + violates its policy. + </summary> + </member> + <member name="F:WebSocketSharp.CloseStatusCode.TooBig"> + <summary> + 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. + </summary> + </member> + <member name="F:WebSocketSharp.CloseStatusCode.MandatoryExtension"> + <summary> + Equivalent to close status 1010. Indicates that a client is + terminating the connection because it has expected the server to + negotiate one or more extension, but the server did not return + them in the handshake response. + </summary> + </member> + <member name="F:WebSocketSharp.CloseStatusCode.ServerError"> + <summary> + Equivalent to close status 1011. Indicates that a server is + terminating the connection because it has encountered an unexpected + condition that prevented it from fulfilling the request. + </summary> + </member> + <member name="F:WebSocketSharp.CloseStatusCode.TlsHandshakeFailure"> + <summary> + Equivalent to close status 1015. Indicates that the connection was + closed due to a failure to perform a TLS handshake. A Reserved value. + </summary> + </member> + <member name="T:WebSocketSharp.CompressionMethod"> + <summary> + Specifies the method for compression. + </summary> + <remarks> + The methods are defined in + <see href="https://tools.ietf.org/html/rfc7692"> + Compression Extensions for WebSocket</see>. + </remarks> + </member> + <member name="F:WebSocketSharp.CompressionMethod.None"> + <summary> + Specifies no compression. + </summary> + </member> + <member name="F:WebSocketSharp.CompressionMethod.Deflate"> + <summary> + Specifies DEFLATE. + </summary> + </member> + <member name="T:WebSocketSharp.ErrorEventArgs"> + <summary> + Represents the event data for the <see cref="E:WebSocketSharp.WebSocket.OnError"/> event. + </summary> + <remarks> + <para> + That event occurs when the <see cref="T:WebSocketSharp.WebSocket"/> gets an error. + </para> + <para> + If you would like to get the error message, you should access + the <see cref="P:WebSocketSharp.ErrorEventArgs.Message"/> property. + </para> + <para> + And if the error is due to an exception, you can get it by accessing + the <see cref="P:WebSocketSharp.ErrorEventArgs.Exception"/> property. + </para> + </remarks> + </member> + <member name="P:WebSocketSharp.ErrorEventArgs.Exception"> + <summary> + Gets the exception that caused the error. + </summary> + <value> + An <see cref="T:System.Exception"/> instance that represents the cause of + the error if it is due to an exception; otherwise, <see langword="null"/>. + </value> + </member> + <member name="P:WebSocketSharp.ErrorEventArgs.Message"> + <summary> + Gets the error message. + </summary> + <value> + A <see cref="T:System.String"/> that represents the error message. + </value> + </member> + <member name="T:WebSocketSharp.Ext"> + <summary> + Provides a set of static methods for websocket-sharp. + </summary> + </member> + <member name="M:WebSocketSharp.Ext.EqualsWith(System.Int32,System.Char,System.Action{System.Int32})"> + <summary> + Determines whether the specified <see cref="T:System.Int32"/> equals the specified <see cref="T:System.Char"/>, + and invokes the specified <c>Action<int></c> delegate at the same time. + </summary> + <returns> + <c>true</c> if <paramref name="value"/> equals <paramref name="c"/>; + otherwise, <c>false</c>. + </returns> + <param name="value"> + An <see cref="T:System.Int32"/> to compare. + </param> + <param name="c"> + A <see cref="T:System.Char"/> to compare. + </param> + <param name="action"> + An <c>Action<int></c> delegate that references the method(s) called + at the same time as comparing. An <see cref="T:System.Int32"/> parameter to pass to + the method(s) is <paramref name="value"/>. + </param> + </member> + <member name="M:WebSocketSharp.Ext.GetAbsolutePath(System.Uri)"> + <summary> + Gets the absolute path from the specified <see cref="T:System.Uri"/>. + </summary> + <returns> + A <see cref="T:System.String"/> that represents the absolute path if it's successfully found; + otherwise, <see langword="null"/>. + </returns> + <param name="uri"> + A <see cref="T:System.Uri"/> that represents the URI to get the absolute path from. + </param> + </member> + <member name="M:WebSocketSharp.Ext.GetName(System.String,System.Char)"> + <summary> + Gets the name from the specified <see cref="T:System.String"/> that contains a pair of name and + value separated by a separator character. + </summary> + <returns> + A <see cref="T:System.String"/> that represents the name if any; otherwise, <c>null</c>. + </returns> + <param name="nameAndValue"> + A <see cref="T:System.String"/> that contains a pair of name and value separated by + a separator character. + </param> + <param name="separator"> + A <see cref="T:System.Char"/> that represents the separator character. + </param> + </member> + <member name="M:WebSocketSharp.Ext.GetValue(System.String,System.Char)"> + <summary> + Gets the value from the specified <see cref="T:System.String"/> that contains a pair of name and + value separated by a separator character. + </summary> + <returns> + A <see cref="T:System.String"/> that represents the value if any; otherwise, <c>null</c>. + </returns> + <param name="nameAndValue"> + A <see cref="T:System.String"/> that contains a pair of name and value separated by + a separator character. + </param> + <param name="separator"> + A <see cref="T:System.Char"/> that represents the separator character. + </param> + </member> + <member name="M:WebSocketSharp.Ext.TryCreateWebSocketUri(System.String,System.Uri@,System.String@)"> + <summary> + Tries to create a new <see cref="T:System.Uri"/> for WebSocket with + the specified <paramref name="uriString"/>. + </summary> + <returns> + <c>true</c> if the <see cref="T:System.Uri"/> was successfully created; + otherwise, <c>false</c>. + </returns> + <param name="uriString"> + A <see cref="T:System.String"/> that represents a WebSocket URL to try. + </param> + <param name="result"> + When this method returns, a <see cref="T:System.Uri"/> that + represents the WebSocket URL or <see langword="null"/> + if <paramref name="uriString"/> is invalid. + </param> + <param name="message"> + When this method returns, a <see cref="T:System.String"/> that + represents an error message or <see langword="null"/> + if <paramref name="uriString"/> is valid. + </param> + </member> + <member name="M:WebSocketSharp.Ext.Contains(System.String,System.Char[])"> + <summary> + Determines whether the specified <see cref="T:System.String"/> contains any of characters in + the specified array of <see cref="T:System.Char"/>. + </summary> + <returns> + <c>true</c> if <paramref name="value"/> contains any of <paramref name="chars"/>; + otherwise, <c>false</c>. + </returns> + <param name="value"> + A <see cref="T:System.String"/> to test. + </param> + <param name="chars"> + An array of <see cref="T:System.Char"/> that contains characters to find. + </param> + </member> + <member name="M:WebSocketSharp.Ext.Contains(System.Collections.Specialized.NameValueCollection,System.String)"> + <summary> + Determines whether the specified <see cref="T:System.Collections.Specialized.NameValueCollection"/> contains + the entry with the specified <paramref name="name"/>. + </summary> + <returns> + <c>true</c> if <paramref name="collection"/> contains the entry with + <paramref name="name"/>; otherwise, <c>false</c>. + </returns> + <param name="collection"> + A <see cref="T:System.Collections.Specialized.NameValueCollection"/> to test. + </param> + <param name="name"> + A <see cref="T:System.String"/> that represents the key of the entry to find. + </param> + </member> + <member name="M:WebSocketSharp.Ext.Contains(System.Collections.Specialized.NameValueCollection,System.String,System.String)"> + <summary> + Determines whether the specified <see cref="T:System.Collections.Specialized.NameValueCollection"/> contains the entry with + the specified both <paramref name="name"/> and <paramref name="value"/>. + </summary> + <returns> + <c>true</c> if <paramref name="collection"/> contains the entry with both + <paramref name="name"/> and <paramref name="value"/>; otherwise, <c>false</c>. + </returns> + <param name="collection"> + A <see cref="T:System.Collections.Specialized.NameValueCollection"/> to test. + </param> + <param name="name"> + A <see cref="T:System.String"/> that represents the key of the entry to find. + </param> + <param name="value"> + A <see cref="T:System.String"/> that represents the value of the entry to find. + </param> + </member> + <member name="M:WebSocketSharp.Ext.Emit(System.EventHandler,System.Object,System.EventArgs)"> + <summary> + Emits the specified <see cref="T:System.EventHandler"/> delegate if it isn't <see langword="null"/>. + </summary> + <param name="eventHandler"> + A <see cref="T:System.EventHandler"/> to emit. + </param> + <param name="sender"> + An <see cref="T:System.Object"/> from which emits this <paramref name="eventHandler"/>. + </param> + <param name="e"> + A <see cref="T:System.EventArgs"/> that contains no event data. + </param> + </member> + <member name="M:WebSocketSharp.Ext.Emit``1(System.EventHandler{``0},System.Object,``0)"> + <summary> + Emits the specified <c>EventHandler<TEventArgs></c> delegate if it isn't + <see langword="null"/>. + </summary> + <param name="eventHandler"> + An <c>EventHandler<TEventArgs></c> to emit. + </param> + <param name="sender"> + An <see cref="T:System.Object"/> from which emits this <paramref name="eventHandler"/>. + </param> + <param name="e"> + A <c>TEventArgs</c> that represents the event data. + </param> + <typeparam name="TEventArgs"> + The type of the event data generated by the event. + </typeparam> + </member> + <member name="M:WebSocketSharp.Ext.GetCookies(System.Collections.Specialized.NameValueCollection,System.Boolean)"> + <summary> + Gets the collection of the HTTP cookies from the specified HTTP <paramref name="headers"/>. + </summary> + <returns> + A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that receives a collection of the HTTP cookies. + </returns> + <param name="headers"> + A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains a collection of the HTTP headers. + </param> + <param name="response"> + <c>true</c> if <paramref name="headers"/> is a collection of the response headers; + otherwise, <c>false</c>. + </param> + </member> + <member name="M:WebSocketSharp.Ext.GetDescription(WebSocketSharp.Net.HttpStatusCode)"> + <summary> + Gets the description of the specified HTTP status <paramref name="code"/>. + </summary> + <returns> + A <see cref="T:System.String"/> that represents the description of the HTTP status code. + </returns> + <param name="code"> + One of <see cref="T:WebSocketSharp.Net.HttpStatusCode"/> enum values, indicates the HTTP status code. + </param> + </member> + <member name="M:WebSocketSharp.Ext.GetStatusDescription(System.Int32)"> + <summary> + Gets the description of the specified HTTP status <paramref name="code"/>. + </summary> + <returns> + A <see cref="T:System.String"/> that represents the description of the HTTP status code. + </returns> + <param name="code"> + An <see cref="T:System.Int32"/> that represents the HTTP status code. + </param> + </member> + <member name="M:WebSocketSharp.Ext.IsCloseStatusCode(System.UInt16)"> + <summary> + Determines whether the specified <see cref="T:System.UInt16"/> is in the + range of the status code for the WebSocket connection close. + </summary> + <remarks> + <para> + The ranges are the following: + </para> + <list type="bullet"> + <item> + <term> + 1000-2999: These numbers are reserved for definition by + the WebSocket protocol. + </term> + </item> + <item> + <term> + 3000-3999: These numbers are reserved for use by libraries, + frameworks, and applications. + </term> + </item> + <item> + <term> + 4000-4999: These numbers are reserved for private use. + </term> + </item> + </list> + </remarks> + <returns> + <c>true</c> if <paramref name="value"/> is in the range of + the status code for the close; otherwise, <c>false</c>. + </returns> + <param name="value"> + A <see cref="T:System.UInt16"/> to test. + </param> + </member> + <member name="M:WebSocketSharp.Ext.IsEnclosedIn(System.String,System.Char)"> + <summary> + Determines whether the specified <see cref="T:System.String"/> is + enclosed in the specified <see cref="T:System.Char"/>. + </summary> + <returns> + <c>true</c> if <paramref name="value"/> is enclosed in + <paramref name="c"/>; otherwise, <c>false</c>. + </returns> + <param name="value"> + A <see cref="T:System.String"/> to test. + </param> + <param name="c"> + A <see cref="T:System.Char"/> to find. + </param> + </member> + <member name="M:WebSocketSharp.Ext.IsHostOrder(WebSocketSharp.ByteOrder)"> + <summary> + Determines whether the specified <see cref="T:WebSocketSharp.ByteOrder"/> is host (this computer + architecture) byte order. + </summary> + <returns> + <c>true</c> if <paramref name="order"/> is host byte order; otherwise, <c>false</c>. + </returns> + <param name="order"> + One of the <see cref="T:WebSocketSharp.ByteOrder"/> enum values, to test. + </param> + </member> + <member name="M:WebSocketSharp.Ext.IsLocal(System.Net.IPAddress)"> + <summary> + Determines whether the specified <see cref="T:System.Net.IPAddress"/> + represents a local IP address. + </summary> + <remarks> + This local means NOT REMOTE for the current host. + </remarks> + <returns> + <c>true</c> if <paramref name="address"/> represents a local IP address; + otherwise, <c>false</c>. + </returns> + <param name="address"> + A <see cref="T:System.Net.IPAddress"/> to test. + </param> + </member> + <member name="M:WebSocketSharp.Ext.IsNullOrEmpty(System.String)"> + <summary> + Determines whether the specified string is <see langword="null"/> or + an empty string. + </summary> + <returns> + <c>true</c> if the string is <see langword="null"/> or an empty string; + otherwise, <c>false</c>. + </returns> + <param name="value"> + A <see cref="T:System.String"/> to test. + </param> + </member> + <member name="M:WebSocketSharp.Ext.IsPredefinedScheme(System.String)"> + <summary> + Determines whether the specified <see cref="T:System.String"/> is + a predefined scheme. + </summary> + <returns> + <c>true</c> if <paramref name="value"/> is a predefined scheme; + otherwise, <c>false</c>. + </returns> + <param name="value"> + A <see cref="T:System.String"/> to test. + </param> + </member> + <member name="M:WebSocketSharp.Ext.IsUpgradeTo(WebSocketSharp.Net.HttpListenerRequest,System.String)"> + <summary> + Determines whether the specified <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/> is + an HTTP Upgrade request to switch to the specified <paramref name="protocol"/>. + </summary> + <returns> + <c>true</c> if <paramref name="request"/> is an HTTP Upgrade request to switch to + <paramref name="protocol"/>; otherwise, <c>false</c>. + </returns> + <param name="request"> + A <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/> that represents the HTTP request. + </param> + <param name="protocol"> + A <see cref="T:System.String"/> that represents the protocol name. + </param> + <exception cref="T:System.ArgumentNullException"> + <para> + <paramref name="request"/> is <see langword="null"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="protocol"/> is <see langword="null"/>. + </para> + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="protocol"/> is empty. + </exception> + </member> + <member name="M:WebSocketSharp.Ext.MaybeUri(System.String)"> + <summary> + Determines whether the specified <see cref="T:System.String"/> is a URI string. + </summary> + <returns> + <c>true</c> if <paramref name="value"/> may be a URI string; + otherwise, <c>false</c>. + </returns> + <param name="value"> + A <see cref="T:System.String"/> to test. + </param> + </member> + <member name="M:WebSocketSharp.Ext.SubArray``1(``0[],System.Int32,System.Int32)"> + <summary> + Retrieves a sub-array from the specified <paramref name="array"/>. A sub-array starts at + the specified element position in <paramref name="array"/>. + </summary> + <returns> + An array of T that receives a sub-array, or an empty array of T if any problems with + the parameters. + </returns> + <param name="array"> + An array of T from which to retrieve a sub-array. + </param> + <param name="startIndex"> + An <see cref="T:System.Int32"/> that represents the zero-based starting position of + a sub-array in <paramref name="array"/>. + </param> + <param name="length"> + An <see cref="T:System.Int32"/> that represents the number of elements to retrieve. + </param> + <typeparam name="T"> + The type of elements in <paramref name="array"/>. + </typeparam> + </member> + <member name="M:WebSocketSharp.Ext.SubArray``1(``0[],System.Int64,System.Int64)"> + <summary> + Retrieves a sub-array from the specified <paramref name="array"/>. A sub-array starts at + the specified element position in <paramref name="array"/>. + </summary> + <returns> + An array of T that receives a sub-array, or an empty array of T if any problems with + the parameters. + </returns> + <param name="array"> + An array of T from which to retrieve a sub-array. + </param> + <param name="startIndex"> + A <see cref="T:System.Int64"/> that represents the zero-based starting position of + a sub-array in <paramref name="array"/>. + </param> + <param name="length"> + A <see cref="T:System.Int64"/> that represents the number of elements to retrieve. + </param> + <typeparam name="T"> + The type of elements in <paramref name="array"/>. + </typeparam> + </member> + <member name="M:WebSocketSharp.Ext.Times(System.Int32,System.Action)"> + <summary> + Executes the specified <see cref="T:System.Action"/> delegate <paramref name="n"/> times. + </summary> + <param name="n"> + An <see cref="T:System.Int32"/> is the number of times to execute. + </param> + <param name="action"> + An <see cref="T:System.Action"/> delegate that references the method(s) to execute. + </param> + </member> + <member name="M:WebSocketSharp.Ext.Times(System.Int64,System.Action)"> + <summary> + Executes the specified <see cref="T:System.Action"/> delegate <paramref name="n"/> times. + </summary> + <param name="n"> + A <see cref="T:System.Int64"/> is the number of times to execute. + </param> + <param name="action"> + An <see cref="T:System.Action"/> delegate that references the method(s) to execute. + </param> + </member> + <member name="M:WebSocketSharp.Ext.Times(System.UInt32,System.Action)"> + <summary> + Executes the specified <see cref="T:System.Action"/> delegate <paramref name="n"/> times. + </summary> + <param name="n"> + A <see cref="T:System.UInt32"/> is the number of times to execute. + </param> + <param name="action"> + An <see cref="T:System.Action"/> delegate that references the method(s) to execute. + </param> + </member> + <member name="M:WebSocketSharp.Ext.Times(System.UInt64,System.Action)"> + <summary> + Executes the specified <see cref="T:System.Action"/> delegate <paramref name="n"/> times. + </summary> + <param name="n"> + A <see cref="T:System.UInt64"/> is the number of times to execute. + </param> + <param name="action"> + An <see cref="T:System.Action"/> delegate that references the method(s) to execute. + </param> + </member> + <member name="M:WebSocketSharp.Ext.Times(System.Int32,System.Action{System.Int32})"> + <summary> + Executes the specified <c>Action<int></c> delegate <paramref name="n"/> times. + </summary> + <param name="n"> + An <see cref="T:System.Int32"/> is the number of times to execute. + </param> + <param name="action"> + An <c>Action<int></c> delegate that references the method(s) to execute. + An <see cref="T:System.Int32"/> parameter to pass to the method(s) is the zero-based count of + iteration. + </param> + </member> + <member name="M:WebSocketSharp.Ext.Times(System.Int64,System.Action{System.Int64})"> + <summary> + Executes the specified <c>Action<long></c> delegate <paramref name="n"/> times. + </summary> + <param name="n"> + A <see cref="T:System.Int64"/> is the number of times to execute. + </param> + <param name="action"> + An <c>Action<long></c> delegate that references the method(s) to execute. + A <see cref="T:System.Int64"/> parameter to pass to the method(s) is the zero-based count of + iteration. + </param> + </member> + <member name="M:WebSocketSharp.Ext.Times(System.UInt32,System.Action{System.UInt32})"> + <summary> + Executes the specified <c>Action<uint></c> delegate <paramref name="n"/> times. + </summary> + <param name="n"> + A <see cref="T:System.UInt32"/> is the number of times to execute. + </param> + <param name="action"> + An <c>Action<uint></c> delegate that references the method(s) to execute. + A <see cref="T:System.UInt32"/> parameter to pass to the method(s) is the zero-based count of + iteration. + </param> + </member> + <member name="M:WebSocketSharp.Ext.Times(System.UInt64,System.Action{System.UInt64})"> + <summary> + Executes the specified <c>Action<ulong></c> delegate <paramref name="n"/> times. + </summary> + <param name="n"> + A <see cref="T:System.UInt64"/> is the number of times to execute. + </param> + <param name="action"> + An <c>Action<ulong></c> delegate that references the method(s) to execute. + A <see cref="T:System.UInt64"/> parameter to pass to this method(s) is the zero-based count of + iteration. + </param> + </member> + <member name="M:WebSocketSharp.Ext.To``1(System.Byte[],WebSocketSharp.ByteOrder)"> + <summary> + Converts the specified array of <see cref="T:System.Byte"/> to the specified type data. + </summary> + <returns> + A T converted from <paramref name="source"/>, or a default value of + T if <paramref name="source"/> is an empty array of <see cref="T:System.Byte"/> or + if the type of T isn't <see cref="T:System.Boolean"/>, <see cref="T:System.Char"/>, <see cref="T:System.Double"/>, + <see cref="T:System.Single"/>, <see cref="T:System.Int32"/>, <see cref="T:System.Int64"/>, <see cref="T:System.Int16"/>, + <see cref="T:System.UInt32"/>, <see cref="T:System.UInt64"/>, or <see cref="T:System.UInt16"/>. + </returns> + <param name="source"> + An array of <see cref="T:System.Byte"/> to convert. + </param> + <param name="sourceOrder"> + One of the <see cref="T:WebSocketSharp.ByteOrder"/> enum values, specifies the byte order of + <paramref name="source"/>. + </param> + <typeparam name="T"> + The type of the return. The T must be a value type. + </typeparam> + <exception cref="T:System.ArgumentNullException"> + <paramref name="source"/> is <see langword="null"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Ext.ToByteArray``1(``0,WebSocketSharp.ByteOrder)"> + <summary> + Converts the specified <paramref name="value"/> to an array of <see cref="T:System.Byte"/>. + </summary> + <returns> + An array of <see cref="T:System.Byte"/> converted from <paramref name="value"/>. + </returns> + <param name="value"> + A T to convert. + </param> + <param name="order"> + One of the <see cref="T:WebSocketSharp.ByteOrder"/> enum values, specifies the byte order of the return. + </param> + <typeparam name="T"> + The type of <paramref name="value"/>. The T must be a value type. + </typeparam> + </member> + <member name="M:WebSocketSharp.Ext.ToHostOrder(System.Byte[],WebSocketSharp.ByteOrder)"> + <summary> + Converts the order of the specified array of <see cref="T:System.Byte"/> to the host byte order. + </summary> + <returns> + An array of <see cref="T:System.Byte"/> converted from <paramref name="source"/>. + </returns> + <param name="source"> + An array of <see cref="T:System.Byte"/> to convert. + </param> + <param name="sourceOrder"> + One of the <see cref="T:WebSocketSharp.ByteOrder"/> enum values, specifies the byte order of + <paramref name="source"/>. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="source"/> is <see langword="null"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Ext.ToString``1(``0[],System.String)"> + <summary> + Converts the specified <paramref name="array"/> to a <see cref="T:System.String"/> that + concatenates the each element of <paramref name="array"/> across the specified + <paramref name="separator"/>. + </summary> + <returns> + A <see cref="T:System.String"/> converted from <paramref name="array"/>, + or <see cref="F:System.String.Empty"/> if <paramref name="array"/> is empty. + </returns> + <param name="array"> + An array of T to convert. + </param> + <param name="separator"> + A <see cref="T:System.String"/> that represents the separator string. + </param> + <typeparam name="T"> + The type of elements in <paramref name="array"/>. + </typeparam> + <exception cref="T:System.ArgumentNullException"> + <paramref name="array"/> is <see langword="null"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Ext.ToUri(System.String)"> + <summary> + Converts the specified <see cref="T:System.String"/> to a <see cref="T:System.Uri"/>. + </summary> + <returns> + A <see cref="T:System.Uri"/> converted from <paramref name="value"/> or + <see langword="null"/> if the convert has failed. + </returns> + <param name="value"> + A <see cref="T:System.String"/> to convert. + </param> + </member> + <member name="M:WebSocketSharp.Ext.UrlDecode(System.String)"> + <summary> + URL-decodes the specified <see cref="T:System.String"/>. + </summary> + <returns> + A <see cref="T:System.String"/> that receives the decoded string or + <paramref name="value"/> if it is <see langword="null"/> or empty. + </returns> + <param name="value"> + A <see cref="T:System.String"/> to decode. + </param> + </member> + <member name="M:WebSocketSharp.Ext.UrlEncode(System.String)"> + <summary> + URL-encodes the specified <see cref="T:System.String"/>. + </summary> + <returns> + A <see cref="T:System.String"/> that receives the encoded string or + <paramref name="value"/> if it is <see langword="null"/> or empty. + </returns> + <param name="value"> + A <see cref="T:System.String"/> to encode. + </param> + </member> + <member name="M:WebSocketSharp.Ext.WriteContent(WebSocketSharp.Net.HttpListenerResponse,System.Byte[])"> + <summary> + Writes and sends the specified <paramref name="content"/> data with the specified + <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/>. + </summary> + <param name="response"> + A <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> that represents the HTTP response used to + send the content data. + </param> + <param name="content"> + An array of <see cref="T:System.Byte"/> that represents the content data to send. + </param> + <exception cref="T:System.ArgumentNullException"> + <para> + <paramref name="response"/> is <see langword="null"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="content"/> is <see langword="null"/>. + </para> + </exception> + </member> + <member name="T:WebSocketSharp.Fin"> + <summary> + Indicates whether a WebSocket frame is the final frame of a message. + </summary> + <remarks> + The values of this enumeration are defined in + <see href="http://tools.ietf.org/html/rfc6455#section-5.2">Section 5.2</see> of RFC 6455. + </remarks> + </member> + <member name="F:WebSocketSharp.Fin.More"> + <summary> + Equivalent to numeric value 0. Indicates more frames of a message follow. + </summary> + </member> + <member name="F:WebSocketSharp.Fin.Final"> + <summary> + Equivalent to numeric value 1. Indicates the final frame of a message. + </summary> + </member> + <member name="T:WebSocketSharp.LogData"> + <summary> + Represents a log data used by the <see cref="T:WebSocketSharp.Logger"/> class. + </summary> + </member> + <member name="P:WebSocketSharp.LogData.Caller"> + <summary> + Gets the information of the logging method caller. + </summary> + <value> + A <see cref="T:System.Diagnostics.StackFrame"/> that provides the information of the logging method caller. + </value> + </member> + <member name="P:WebSocketSharp.LogData.Date"> + <summary> + Gets the date and time when the log data was created. + </summary> + <value> + A <see cref="T:System.DateTime"/> that represents the date and time when the log data was created. + </value> + </member> + <member name="P:WebSocketSharp.LogData.Level"> + <summary> + Gets the logging level of the log data. + </summary> + <value> + One of the <see cref="T:WebSocketSharp.LogLevel"/> enum values, indicates the logging level of the log data. + </value> + </member> + <member name="P:WebSocketSharp.LogData.Message"> + <summary> + Gets the message of the log data. + </summary> + <value> + A <see cref="T:System.String"/> that represents the message of the log data. + </value> + </member> + <member name="M:WebSocketSharp.LogData.ToString"> + <summary> + Returns a <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.LogData"/>. + </summary> + <returns> + A <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.LogData"/>. + </returns> + </member> + <member name="T:WebSocketSharp.Logger"> + <summary> + Provides a set of methods and properties for logging. + </summary> + <remarks> + <para> + If you output a log with lower than the value of the <see cref="P:WebSocketSharp.Logger.Level"/> property, + it cannot be outputted. + </para> + <para> + The default output action writes a log to the standard output stream and the log file + if the <see cref="P:WebSocketSharp.Logger.File"/> property has a valid path to it. + </para> + <para> + If you would like to use the custom output action, you should set + the <see cref="P:WebSocketSharp.Logger.Output"/> property to any <c>Action<LogData, string></c> + delegate. + </para> + </remarks> + </member> + <member name="M:WebSocketSharp.Logger.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Logger"/> class. + </summary> + <remarks> + This constructor initializes the current logging level with <see cref="F:WebSocketSharp.LogLevel.Error"/>. + </remarks> + </member> + <member name="M:WebSocketSharp.Logger.#ctor(WebSocketSharp.LogLevel)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Logger"/> class with + the specified logging <paramref name="level"/>. + </summary> + <param name="level"> + One of the <see cref="T:WebSocketSharp.LogLevel"/> enum values. + </param> + </member> + <member name="M:WebSocketSharp.Logger.#ctor(WebSocketSharp.LogLevel,System.String,System.Action{WebSocketSharp.LogData,System.String})"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Logger"/> class with + the specified logging <paramref name="level"/>, path to the log <paramref name="file"/>, + and <paramref name="output"/> action. + </summary> + <param name="level"> + One of the <see cref="T:WebSocketSharp.LogLevel"/> enum values. + </param> + <param name="file"> + A <see cref="T:System.String"/> that represents the path to the log file. + </param> + <param name="output"> + An <c>Action<LogData, string></c> delegate that references the method(s) used to + output a log. A <see cref="T:System.String"/> parameter passed to this delegate is + <paramref name="file"/>. + </param> + </member> + <member name="P:WebSocketSharp.Logger.File"> + <summary> + Gets or sets the current path to the log file. + </summary> + <value> + A <see cref="T:System.String"/> that represents the current path to the log file if any. + </value> + </member> + <member name="P:WebSocketSharp.Logger.Level"> + <summary> + Gets or sets the current logging level. + </summary> + <remarks> + A log with lower than the value of this property cannot be outputted. + </remarks> + <value> + One of the <see cref="T:WebSocketSharp.LogLevel"/> enum values, specifies the current logging level. + </value> + </member> + <member name="P:WebSocketSharp.Logger.Output"> + <summary> + Gets or sets the current output action used to output a log. + </summary> + <value> + <para> + An <c>Action<LogData, string></c> delegate that references the method(s) used to + output a log. A <see cref="T:System.String"/> parameter passed to this delegate is the value of + the <see cref="P:WebSocketSharp.Logger.File"/> property. + </para> + <para> + If the value to set is <see langword="null"/>, the current output action is changed to + the default output action. + </para> + </value> + </member> + <member name="M:WebSocketSharp.Logger.Debug(System.String)"> + <summary> + Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Debug"/>. + </summary> + <remarks> + If the current logging level is higher than <see cref="F:WebSocketSharp.LogLevel.Debug"/>, + this method doesn't output <paramref name="message"/> as a log. + </remarks> + <param name="message"> + A <see cref="T:System.String"/> that represents the message to output as a log. + </param> + </member> + <member name="M:WebSocketSharp.Logger.Error(System.String)"> + <summary> + Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Error"/>. + </summary> + <remarks> + If the current logging level is higher than <see cref="F:WebSocketSharp.LogLevel.Error"/>, + this method doesn't output <paramref name="message"/> as a log. + </remarks> + <param name="message"> + A <see cref="T:System.String"/> that represents the message to output as a log. + </param> + </member> + <member name="M:WebSocketSharp.Logger.Fatal(System.String)"> + <summary> + Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Fatal"/>. + </summary> + <param name="message"> + A <see cref="T:System.String"/> that represents the message to output as a log. + </param> + </member> + <member name="M:WebSocketSharp.Logger.Info(System.String)"> + <summary> + Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Info"/>. + </summary> + <remarks> + If the current logging level is higher than <see cref="F:WebSocketSharp.LogLevel.Info"/>, + this method doesn't output <paramref name="message"/> as a log. + </remarks> + <param name="message"> + A <see cref="T:System.String"/> that represents the message to output as a log. + </param> + </member> + <member name="M:WebSocketSharp.Logger.Trace(System.String)"> + <summary> + Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Trace"/>. + </summary> + <remarks> + If the current logging level is higher than <see cref="F:WebSocketSharp.LogLevel.Trace"/>, + this method doesn't output <paramref name="message"/> as a log. + </remarks> + <param name="message"> + A <see cref="T:System.String"/> that represents the message to output as a log. + </param> + </member> + <member name="M:WebSocketSharp.Logger.Warn(System.String)"> + <summary> + Outputs <paramref name="message"/> as a log with <see cref="F:WebSocketSharp.LogLevel.Warn"/>. + </summary> + <remarks> + If the current logging level is higher than <see cref="F:WebSocketSharp.LogLevel.Warn"/>, + this method doesn't output <paramref name="message"/> as a log. + </remarks> + <param name="message"> + A <see cref="T:System.String"/> that represents the message to output as a log. + </param> + </member> + <member name="T:WebSocketSharp.LogLevel"> + <summary> + Specifies the logging level. + </summary> + </member> + <member name="F:WebSocketSharp.LogLevel.Trace"> + <summary> + Specifies the bottom logging level. + </summary> + </member> + <member name="F:WebSocketSharp.LogLevel.Debug"> + <summary> + Specifies the 2nd logging level from the bottom. + </summary> + </member> + <member name="F:WebSocketSharp.LogLevel.Info"> + <summary> + Specifies the 3rd logging level from the bottom. + </summary> + </member> + <member name="F:WebSocketSharp.LogLevel.Warn"> + <summary> + Specifies the 3rd logging level from the top. + </summary> + </member> + <member name="F:WebSocketSharp.LogLevel.Error"> + <summary> + Specifies the 2nd logging level from the top. + </summary> + </member> + <member name="F:WebSocketSharp.LogLevel.Fatal"> + <summary> + Specifies the top logging level. + </summary> + </member> + <member name="T:WebSocketSharp.Mask"> + <summary> + Indicates whether the payload data of a WebSocket frame is masked. + </summary> + <remarks> + The values of this enumeration are defined in + <see href="http://tools.ietf.org/html/rfc6455#section-5.2">Section 5.2</see> of RFC 6455. + </remarks> + </member> + <member name="F:WebSocketSharp.Mask.Off"> + <summary> + Equivalent to numeric value 0. Indicates not masked. + </summary> + </member> + <member name="F:WebSocketSharp.Mask.On"> + <summary> + Equivalent to numeric value 1. Indicates masked. + </summary> + </member> + <member name="T:WebSocketSharp.MessageEventArgs"> + <summary> + Represents the event data for the <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event. + </summary> + <remarks> + <para> + That event occurs when the <see cref="T:WebSocketSharp.WebSocket"/> receives + a message or a ping if the <see cref="P:WebSocketSharp.WebSocket.EmitOnPing"/> + property is set to <c>true</c>. + </para> + <para> + If you would like to get the message data, you should access + the <see cref="P:WebSocketSharp.MessageEventArgs.Data"/> or <see cref="P:WebSocketSharp.MessageEventArgs.RawData"/> property. + </para> + </remarks> + </member> + <member name="P:WebSocketSharp.MessageEventArgs.Opcode"> + <summary> + Gets the opcode for the message. + </summary> + <value> + <see cref="F:WebSocketSharp.Opcode.Text"/>, <see cref="F:WebSocketSharp.Opcode.Binary"/>, + or <see cref="F:WebSocketSharp.Opcode.Ping"/>. + </value> + </member> + <member name="P:WebSocketSharp.MessageEventArgs.Data"> + <summary> + Gets the message data as a <see cref="T:System.String"/>. + </summary> + <value> + A <see cref="T:System.String"/> that represents the message data if its type is + text or ping and if decoding it to a string has successfully done; + otherwise, <see langword="null"/>. + </value> + </member> + <member name="P:WebSocketSharp.MessageEventArgs.IsBinary"> + <summary> + Gets a value indicating whether the message type is binary. + </summary> + <value> + <c>true</c> if the message type is binary; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.MessageEventArgs.IsPing"> + <summary> + Gets a value indicating whether the message type is ping. + </summary> + <value> + <c>true</c> if the message type is ping; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.MessageEventArgs.IsText"> + <summary> + Gets a value indicating whether the message type is text. + </summary> + <value> + <c>true</c> if the message type is text; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.MessageEventArgs.RawData"> + <summary> + Gets the message data as an array of <see cref="T:System.Byte"/>. + </summary> + <value> + An array of <see cref="T:System.Byte"/> that represents the message data. + </value> + </member> + <member name="T:WebSocketSharp.Net.AuthenticationSchemes"> + <summary> + Specifies the scheme for authentication. + </summary> + </member> + <member name="F:WebSocketSharp.Net.AuthenticationSchemes.None"> + <summary> + No authentication is allowed. + </summary> + </member> + <member name="F:WebSocketSharp.Net.AuthenticationSchemes.Digest"> + <summary> + Specifies digest authentication. + </summary> + </member> + <member name="F:WebSocketSharp.Net.AuthenticationSchemes.Basic"> + <summary> + Specifies basic authentication. + </summary> + </member> + <member name="F:WebSocketSharp.Net.AuthenticationSchemes.Anonymous"> + <summary> + Specifies anonymous authentication. + </summary> + </member> + <member name="T:WebSocketSharp.Net.ClientSslConfiguration"> + <summary> + Stores the parameters for the <see cref="T:System.Net.Security.SslStream"/> used by clients. + </summary> + </member> + <member name="M:WebSocketSharp.Net.ClientSslConfiguration.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.ClientSslConfiguration"/> class. + </summary> + </member> + <member name="M:WebSocketSharp.Net.ClientSslConfiguration.#ctor(System.String)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.ClientSslConfiguration"/> class + with the specified <paramref name="targetHost"/>. + </summary> + <param name="targetHost"> + A <see cref="T:System.String"/> that represents the target host server name. + </param> + </member> + <member name="M:WebSocketSharp.Net.ClientSslConfiguration.#ctor(WebSocketSharp.Net.ClientSslConfiguration)"> + <summary> + Copies the parameters from the specified <paramref name="configuration"/> to + a new instance of the <see cref="T:WebSocketSharp.Net.ClientSslConfiguration"/> class. + </summary> + <param name="configuration"> + A <see cref="T:WebSocketSharp.Net.ClientSslConfiguration"/> from which to copy. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="configuration"/> is <see langword="null"/>. + </exception> + </member> + <member name="P:WebSocketSharp.Net.ClientSslConfiguration.CheckCertificateRevocation"> + <summary> + Gets or sets a value indicating whether the certificate revocation + list is checked during authentication. + </summary> + <value> + <para> + <c>true</c> if the certificate revocation list is checked during + authentication; otherwise, <c>false</c>. + </para> + <para> + The default value is <c>false</c>. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Net.ClientSslConfiguration.ClientCertificates"> + <summary> + Gets or sets the certificates from which to select one to + supply to the server. + </summary> + <value> + <para> + A <see cref="T:System.Security.Cryptography.X509Certificates.X509CertificateCollection"/> or <see langword="null"/>. + </para> + <para> + That collection contains client certificates from which to select. + </para> + <para> + The default value is <see langword="null"/>. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Net.ClientSslConfiguration.ClientCertificateSelectionCallback"> + <summary> + Gets or sets the callback used to select the certificate to + supply to the server. + </summary> + <remarks> + No certificate is supplied if the callback returns + <see langword="null"/>. + </remarks> + <value> + <para> + A <see cref="T:System.Net.Security.LocalCertificateSelectionCallback"/> delegate that + invokes the method called for selecting the certificate. + </para> + <para> + The default value is a delegate that invokes a method that + only returns <see langword="null"/>. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Net.ClientSslConfiguration.EnabledSslProtocols"> + <summary> + Gets or sets the protocols used for authentication. + </summary> + <value> + <para> + The <see cref="T:System.Security.Authentication.SslProtocols"/> enum values that represent + the protocols used for authentication. + </para> + <para> + The default value is <see cref="F:System.Security.Authentication.SslProtocols.Default"/>. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Net.ClientSslConfiguration.ServerCertificateValidationCallback"> + <summary> + Gets or sets the callback used to validate the certificate + supplied by the server. + </summary> + <remarks> + The certificate is valid if the callback returns <c>true</c>. + </remarks> + <value> + <para> + A <see cref="T:System.Net.Security.RemoteCertificateValidationCallback"/> delegate that + invokes the method called for validating the certificate. + </para> + <para> + The default value is a delegate that invokes a method that + only returns <c>true</c>. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Net.ClientSslConfiguration.TargetHost"> + <summary> + Gets or sets the target host server name. + </summary> + <value> + <para> + A <see cref="T:System.String"/> or <see langword="null"/> + if not specified. + </para> + <para> + That string represents the name of the server that + will share a secure connection with a client. + </para> + </value> + </member> + <member name="T:WebSocketSharp.Net.Cookie"> + <summary> + Provides a set of methods and properties used to manage an HTTP Cookie. + </summary> + <remarks> + <para> + The Cookie class supports the following cookie formats: + <see href="http://web.archive.org/web/20020803110822/http://wp.netscape.com/newsref/std/cookie_spec.html">Netscape specification</see>, + <see href="http://www.ietf.org/rfc/rfc2109.txt">RFC 2109</see>, and + <see href="http://www.ietf.org/rfc/rfc2965.txt">RFC 2965</see> + </para> + <para> + The Cookie class cannot be inherited. + </para> + </remarks> + </member> + <member name="M:WebSocketSharp.Net.Cookie.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.Cookie"/> class. + </summary> + </member> + <member name="M:WebSocketSharp.Net.Cookie.#ctor(System.String,System.String)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.Cookie"/> class with the specified + <paramref name="name"/> and <paramref name="value"/>. + </summary> + <param name="name"> + A <see cref="T:System.String"/> that represents the Name of the cookie. + </param> + <param name="value"> + A <see cref="T:System.String"/> that represents the Value of the cookie. + </param> + <exception cref="T:WebSocketSharp.Net.CookieException"> + <para> + <paramref name="name"/> is <see langword="null"/> or empty. + </para> + <para> + - or - + </para> + <para> + <paramref name="name"/> contains an invalid character. + </para> + <para> + - or - + </para> + <para> + <paramref name="value"/> is <see langword="null"/>. + </para> + <para> + - or - + </para> + <para> + <paramref name="value"/> contains a string not enclosed in double quotes + that contains an invalid character. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Net.Cookie.#ctor(System.String,System.String,System.String)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.Cookie"/> class with the specified + <paramref name="name"/>, <paramref name="value"/>, and <paramref name="path"/>. + </summary> + <param name="name"> + A <see cref="T:System.String"/> that represents the Name of the cookie. + </param> + <param name="value"> + A <see cref="T:System.String"/> that represents the Value of the cookie. + </param> + <param name="path"> + A <see cref="T:System.String"/> that represents the value of the Path attribute of the cookie. + </param> + <exception cref="T:WebSocketSharp.Net.CookieException"> + <para> + <paramref name="name"/> is <see langword="null"/> or empty. + </para> + <para> + - or - + </para> + <para> + <paramref name="name"/> contains an invalid character. + </para> + <para> + - or - + </para> + <para> + <paramref name="value"/> is <see langword="null"/>. + </para> + <para> + - or - + </para> + <para> + <paramref name="value"/> contains a string not enclosed in double quotes + that contains an invalid character. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Net.Cookie.#ctor(System.String,System.String,System.String,System.String)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.Cookie"/> class with the specified + <paramref name="name"/>, <paramref name="value"/>, <paramref name="path"/>, and + <paramref name="domain"/>. + </summary> + <param name="name"> + A <see cref="T:System.String"/> that represents the Name of the cookie. + </param> + <param name="value"> + A <see cref="T:System.String"/> that represents the Value of the cookie. + </param> + <param name="path"> + A <see cref="T:System.String"/> that represents the value of the Path attribute of the cookie. + </param> + <param name="domain"> + A <see cref="T:System.String"/> that represents the value of the Domain attribute of the cookie. + </param> + <exception cref="T:WebSocketSharp.Net.CookieException"> + <para> + <paramref name="name"/> is <see langword="null"/> or empty. + </para> + <para> + - or - + </para> + <para> + <paramref name="name"/> contains an invalid character. + </para> + <para> + - or - + </para> + <para> + <paramref name="value"/> is <see langword="null"/>. + </para> + <para> + - or - + </para> + <para> + <paramref name="value"/> contains a string not enclosed in double quotes + that contains an invalid character. + </para> + </exception> + </member> + <member name="P:WebSocketSharp.Net.Cookie.Comment"> + <summary> + Gets or sets the value of the Comment attribute of the cookie. + </summary> + <value> + A <see cref="T:System.String"/> that represents the comment to document intended use of the cookie. + </value> + </member> + <member name="P:WebSocketSharp.Net.Cookie.CommentUri"> + <summary> + Gets or sets the value of the CommentURL attribute of the cookie. + </summary> + <value> + A <see cref="T:System.Uri"/> that represents the URI that provides the comment to document intended + use of the cookie. + </value> + </member> + <member name="P:WebSocketSharp.Net.Cookie.Discard"> + <summary> + Gets or sets a value indicating whether the client discards the cookie unconditionally + when the client terminates. + </summary> + <value> + <c>true</c> if the client discards the cookie unconditionally when the client terminates; + otherwise, <c>false</c>. The default value is <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.Cookie.Domain"> + <summary> + Gets or sets the value of the Domain attribute of the cookie. + </summary> + <value> + A <see cref="T:System.String"/> that represents the URI for which the cookie is valid. + </value> + </member> + <member name="P:WebSocketSharp.Net.Cookie.Expired"> + <summary> + Gets or sets a value indicating whether the cookie has expired. + </summary> + <value> + <c>true</c> if the cookie has expired; otherwise, <c>false</c>. + The default value is <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.Cookie.Expires"> + <summary> + Gets or sets the value of the Expires attribute of the cookie. + </summary> + <value> + A <see cref="T:System.DateTime"/> that represents the date and time at which the cookie expires. + The default value is <see cref="F:System.DateTime.MinValue"/>. + </value> + </member> + <member name="P:WebSocketSharp.Net.Cookie.HttpOnly"> + <summary> + Gets or sets a value indicating whether non-HTTP APIs can access the cookie. + </summary> + <value> + <c>true</c> if non-HTTP APIs cannot access the cookie; otherwise, <c>false</c>. + The default value is <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.Cookie.Name"> + <summary> + Gets or sets the Name of the cookie. + </summary> + <value> + A <see cref="T:System.String"/> that represents the Name of the cookie. + </value> + <exception cref="T:WebSocketSharp.Net.CookieException"> + <para> + The value specified for a set operation is <see langword="null"/> or empty. + </para> + <para> + - or - + </para> + <para> + The value specified for a set operation contains an invalid character. + </para> + </exception> + </member> + <member name="P:WebSocketSharp.Net.Cookie.Path"> + <summary> + Gets or sets the value of the Path attribute of the cookie. + </summary> + <value> + A <see cref="T:System.String"/> that represents the subset of URI on the origin server + to which the cookie applies. + </value> + </member> + <member name="P:WebSocketSharp.Net.Cookie.Port"> + <summary> + Gets or sets the value of the Port attribute of the cookie. + </summary> + <value> + A <see cref="T:System.String"/> that represents the list of TCP ports to which the cookie applies. + </value> + <exception cref="T:WebSocketSharp.Net.CookieException"> + The value specified for a set operation isn't enclosed in double quotes or + couldn't be parsed. + </exception> + </member> + <member name="P:WebSocketSharp.Net.Cookie.Secure"> + <summary> + Gets or sets a value indicating whether the security level of the cookie is secure. + </summary> + <remarks> + When this property is <c>true</c>, the cookie may be included in the HTTP request + only if the request is transmitted over the HTTPS. + </remarks> + <value> + <c>true</c> if the security level of the cookie is secure; otherwise, <c>false</c>. + The default value is <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.Cookie.TimeStamp"> + <summary> + Gets the time when the cookie was issued. + </summary> + <value> + A <see cref="T:System.DateTime"/> that represents the time when the cookie was issued. + </value> + </member> + <member name="P:WebSocketSharp.Net.Cookie.Value"> + <summary> + Gets or sets the Value of the cookie. + </summary> + <value> + A <see cref="T:System.String"/> that represents the Value of the cookie. + </value> + <exception cref="T:WebSocketSharp.Net.CookieException"> + <para> + The value specified for a set operation is <see langword="null"/>. + </para> + <para> + - or - + </para> + <para> + The value specified for a set operation contains a string not enclosed in double quotes + that contains an invalid character. + </para> + </exception> + </member> + <member name="P:WebSocketSharp.Net.Cookie.Version"> + <summary> + Gets or sets the value of the Version attribute of the cookie. + </summary> + <value> + An <see cref="T:System.Int32"/> that represents the version of the HTTP state management + to which the cookie conforms. + </value> + <exception cref="T:System.ArgumentOutOfRangeException"> + The value specified for a set operation isn't 0 or 1. + </exception> + </member> + <member name="M:WebSocketSharp.Net.Cookie.Equals(System.Object)"> + <summary> + Determines whether the specified <see cref="T:System.Object"/> is equal to the current + <see cref="T:WebSocketSharp.Net.Cookie"/>. + </summary> + <param name="comparand"> + An <see cref="T:System.Object"/> to compare with the current <see cref="T:WebSocketSharp.Net.Cookie"/>. + </param> + <returns> + <c>true</c> if <paramref name="comparand"/> is equal to the current <see cref="T:WebSocketSharp.Net.Cookie"/>; + otherwise, <c>false</c>. + </returns> + </member> + <member name="M:WebSocketSharp.Net.Cookie.GetHashCode"> + <summary> + Serves as a hash function for a <see cref="T:WebSocketSharp.Net.Cookie"/> object. + </summary> + <returns> + An <see cref="T:System.Int32"/> that represents the hash code for the current <see cref="T:WebSocketSharp.Net.Cookie"/>. + </returns> + </member> + <member name="M:WebSocketSharp.Net.Cookie.ToString"> + <summary> + Returns a <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.Net.Cookie"/>. + </summary> + <remarks> + This method returns a <see cref="T:System.String"/> to use to send an HTTP Cookie to + an origin server. + </remarks> + <returns> + A <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.Net.Cookie"/>. + </returns> + </member> + <member name="T:WebSocketSharp.Net.CookieCollection"> + <summary> + Provides a collection container for instances of the <see cref="T:WebSocketSharp.Net.Cookie"/> class. + </summary> + </member> + <member name="M:WebSocketSharp.Net.CookieCollection.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.CookieCollection"/> class. + </summary> + </member> + <member name="P:WebSocketSharp.Net.CookieCollection.Count"> + <summary> + Gets the number of cookies in the collection. + </summary> + <value> + An <see cref="T:System.Int32"/> that represents the number of cookies in the collection. + </value> + </member> + <member name="P:WebSocketSharp.Net.CookieCollection.IsReadOnly"> + <summary> + Gets a value indicating whether the collection is read-only. + </summary> + <value> + <c>true</c> if the collection is read-only; otherwise, <c>false</c>. + The default value is <c>true</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.CookieCollection.IsSynchronized"> + <summary> + Gets a value indicating whether the access to the collection is thread safe. + </summary> + <value> + <c>true</c> if the access to the collection is thread safe; otherwise, <c>false</c>. + The default value is <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.CookieCollection.Item(System.Int32)"> + <summary> + Gets the <see cref="T:WebSocketSharp.Net.Cookie"/> at the specified <paramref name="index"/> from + the collection. + </summary> + <value> + A <see cref="T:WebSocketSharp.Net.Cookie"/> at the specified <paramref name="index"/> in the collection. + </value> + <param name="index"> + An <see cref="T:System.Int32"/> that represents the zero-based index of the <see cref="T:WebSocketSharp.Net.Cookie"/> + to find. + </param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <paramref name="index"/> is out of allowable range of indexes for the collection. + </exception> + </member> + <member name="P:WebSocketSharp.Net.CookieCollection.Item(System.String)"> + <summary> + Gets the <see cref="T:WebSocketSharp.Net.Cookie"/> with the specified <paramref name="name"/> from + the collection. + </summary> + <value> + A <see cref="T:WebSocketSharp.Net.Cookie"/> with the specified <paramref name="name"/> in the collection. + </value> + <param name="name"> + A <see cref="T:System.String"/> that represents the name of the <see cref="T:WebSocketSharp.Net.Cookie"/> to find. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="name"/> is <see langword="null"/>. + </exception> + </member> + <member name="P:WebSocketSharp.Net.CookieCollection.SyncRoot"> + <summary> + Gets an object used to synchronize access to the collection. + </summary> + <value> + An <see cref="T:System.Object"/> used to synchronize access to the collection. + </value> + </member> + <member name="M:WebSocketSharp.Net.CookieCollection.Add(WebSocketSharp.Net.Cookie)"> + <summary> + Adds the specified <paramref name="cookie"/> to the collection. + </summary> + <param name="cookie"> + A <see cref="T:WebSocketSharp.Net.Cookie"/> to add. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="cookie"/> is <see langword="null"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Net.CookieCollection.Add(WebSocketSharp.Net.CookieCollection)"> + <summary> + Adds the specified <paramref name="cookies"/> to the collection. + </summary> + <param name="cookies"> + A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies to add. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="cookies"/> is <see langword="null"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Net.CookieCollection.CopyTo(System.Array,System.Int32)"> + <summary> + Copies the elements of the collection to the specified <see cref="T:System.Array"/>, starting at + the specified <paramref name="index"/> in the <paramref name="array"/>. + </summary> + <param name="array"> + An <see cref="T:System.Array"/> that represents the destination of the elements copied from + the collection. + </param> + <param name="index"> + An <see cref="T:System.Int32"/> that represents the zero-based index in <paramref name="array"/> + at which copying begins. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="array"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + <paramref name="index"/> is less than zero. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="array"/> is multidimensional. + </para> + <para> + -or- + </para> + <para> + The number of elements in the collection is greater than the available space from + <paramref name="index"/> to the end of the destination <paramref name="array"/>. + </para> + </exception> + <exception cref="T:System.InvalidCastException"> + The elements in the collection cannot be cast automatically to the type of the destination + <paramref name="array"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Net.CookieCollection.CopyTo(WebSocketSharp.Net.Cookie[],System.Int32)"> + <summary> + Copies the elements of the collection to the specified array of <see cref="T:WebSocketSharp.Net.Cookie"/>, + starting at the specified <paramref name="index"/> in the <paramref name="array"/>. + </summary> + <param name="array"> + An array of <see cref="T:WebSocketSharp.Net.Cookie"/> that represents the destination of the elements + copied from the collection. + </param> + <param name="index"> + An <see cref="T:System.Int32"/> that represents the zero-based index in <paramref name="array"/> + at which copying begins. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="array"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + <paramref name="index"/> is less than zero. + </exception> + <exception cref="T:System.ArgumentException"> + The number of elements in the collection is greater than the available space from + <paramref name="index"/> to the end of the destination <paramref name="array"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Net.CookieCollection.GetEnumerator"> + <summary> + Gets the enumerator used to iterate through the collection. + </summary> + <returns> + An <see cref="T:System.Collections.IEnumerator"/> instance used to iterate through the collection. + </returns> + </member> + <member name="T:WebSocketSharp.Net.CookieException"> + <summary> + The exception that is thrown when a <see cref="T:WebSocketSharp.Net.Cookie"/> gets an error. + </summary> + </member> + <member name="M:WebSocketSharp.Net.CookieException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.CookieException"/> class from + the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> and <see cref="T:System.Runtime.Serialization.StreamingContext"/>. + </summary> + <param name="serializationInfo"> + A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that contains the serialized object data. + </param> + <param name="streamingContext"> + A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the source for the deserialization. + </param> + </member> + <member name="M:WebSocketSharp.Net.CookieException.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.CookieException"/> class. + </summary> + </member> + <member name="M:WebSocketSharp.Net.CookieException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> + <summary> + Populates the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with the data needed to serialize + the current <see cref="T:WebSocketSharp.Net.CookieException"/>. + </summary> + <param name="serializationInfo"> + A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data. + </param> + <param name="streamingContext"> + A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the destination for the serialization. + </param> + </member> + <member name="M:WebSocketSharp.Net.CookieException.System#Runtime#Serialization#ISerializable#GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> + <summary> + Populates the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with the data needed to serialize + the current <see cref="T:WebSocketSharp.Net.CookieException"/>. + </summary> + <param name="serializationInfo"> + A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data. + </param> + <param name="streamingContext"> + A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the destination for the serialization. + </param> + </member> + <member name="T:WebSocketSharp.Net.HttpBasicIdentity"> + <summary> + Holds the username and password from an HTTP Basic authentication attempt. + </summary> + </member> + <member name="P:WebSocketSharp.Net.HttpBasicIdentity.Password"> + <summary> + Gets the password from a basic authentication attempt. + </summary> + <value> + A <see cref="T:System.String"/> that represents the password. + </value> + </member> + <member name="T:WebSocketSharp.Net.HttpDigestIdentity"> + <summary> + Holds the username and other parameters from + an HTTP Digest authentication attempt. + </summary> + </member> + <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Algorithm"> + <summary> + Gets the algorithm parameter from a digest authentication attempt. + </summary> + <value> + A <see cref="T:System.String"/> that represents the algorithm parameter. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Cnonce"> + <summary> + Gets the cnonce parameter from a digest authentication attempt. + </summary> + <value> + A <see cref="T:System.String"/> that represents the cnonce parameter. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Nc"> + <summary> + Gets the nc parameter from a digest authentication attempt. + </summary> + <value> + A <see cref="T:System.String"/> that represents the nc parameter. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Nonce"> + <summary> + Gets the nonce parameter from a digest authentication attempt. + </summary> + <value> + A <see cref="T:System.String"/> that represents the nonce parameter. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Opaque"> + <summary> + Gets the opaque parameter from a digest authentication attempt. + </summary> + <value> + A <see cref="T:System.String"/> that represents the opaque parameter. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Qop"> + <summary> + Gets the qop parameter from a digest authentication attempt. + </summary> + <value> + A <see cref="T:System.String"/> that represents the qop parameter. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Realm"> + <summary> + Gets the realm parameter from a digest authentication attempt. + </summary> + <value> + A <see cref="T:System.String"/> that represents the realm parameter. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Response"> + <summary> + Gets the response parameter from a digest authentication attempt. + </summary> + <value> + A <see cref="T:System.String"/> that represents the response parameter. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpDigestIdentity.Uri"> + <summary> + Gets the uri parameter from a digest authentication attempt. + </summary> + <value> + A <see cref="T:System.String"/> that represents the uri parameter. + </value> + </member> + <member name="T:WebSocketSharp.Net.HttpListener"> + <summary> + Provides a simple, programmatically controlled HTTP listener. + </summary> + </member> + <member name="M:WebSocketSharp.Net.HttpListener.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListener"/> class. + </summary> + </member> + <member name="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemes"> + <summary> + Gets or sets the scheme used to authenticate the clients. + </summary> + <value> + One of the <see cref="T:WebSocketSharp.Net.AuthenticationSchemes"/> enum values, + represents the scheme used to authenticate the clients. The default value is + <see cref="F:WebSocketSharp.Net.AuthenticationSchemes.Anonymous"/>. + </value> + <exception cref="T:System.ObjectDisposedException"> + This listener has been closed. + </exception> + </member> + <member name="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemeSelector"> + <summary> + Gets or sets the delegate called to select the scheme used to authenticate the clients. + </summary> + <remarks> + 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 <see cref="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemes"/> property as the authentication + scheme for all requests. + </remarks> + <value> + A <c>Func<<see cref="T:WebSocketSharp.Net.HttpListenerRequest"/>, <see cref="P:WebSocketSharp.Net.HttpListener.AuthenticationSchemes"/>></c> + delegate that references the method used to select an authentication scheme. The default + value is <see langword="null"/>. + </value> + <exception cref="T:System.ObjectDisposedException"> + This listener has been closed. + </exception> + </member> + <member name="P:WebSocketSharp.Net.HttpListener.CertificateFolderPath"> + <summary> + Gets or sets the path to the folder in which stores the certificate files used to + authenticate the server on the secure connection. + </summary> + <remarks> + <para> + This property represents the path to the folder in which stores the certificate files + associated with each port number of added URI prefixes. A set of the certificate files + is a pair of the <c>'port number'.cer</c> (DER) and <c>'port number'.key</c> + (DER, RSA Private Key). + </para> + <para> + If this property is <see langword="null"/> or empty, the result of + <c>System.Environment.GetFolderPath + (<see cref="F:System.Environment.SpecialFolder.ApplicationData"/>)</c> is used as the default path. + </para> + </remarks> + <value> + A <see cref="T:System.String"/> that represents the path to the folder in which stores + the certificate files. The default value is <see langword="null"/>. + </value> + <exception cref="T:System.ObjectDisposedException"> + This listener has been closed. + </exception> + </member> + <member name="P:WebSocketSharp.Net.HttpListener.IgnoreWriteExceptions"> + <summary> + Gets or sets a value indicating whether the listener returns exceptions that occur when + sending the response to the client. + </summary> + <value> + <c>true</c> if the listener shouldn't return those exceptions; otherwise, <c>false</c>. + The default value is <c>false</c>. + </value> + <exception cref="T:System.ObjectDisposedException"> + This listener has been closed. + </exception> + </member> + <member name="P:WebSocketSharp.Net.HttpListener.IsListening"> + <summary> + Gets a value indicating whether the listener has been started. + </summary> + <value> + <c>true</c> if the listener has been started; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListener.IsSupported"> + <summary> + Gets a value indicating whether the listener can be used with the current operating system. + </summary> + <value> + <c>true</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListener.Log"> + <summary> + Gets the logging functions. + </summary> + <remarks> + The default logging level is <see cref="F:WebSocketSharp.LogLevel.Error"/>. If you would like to change it, + you should set the <c>Log.Level</c> property to any of the <see cref="T:WebSocketSharp.LogLevel"/> enum + values. + </remarks> + <value> + A <see cref="T:WebSocketSharp.Logger"/> that provides the logging functions. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListener.Prefixes"> + <summary> + Gets the URI prefixes handled by the listener. + </summary> + <value> + A <see cref="T:WebSocketSharp.Net.HttpListenerPrefixCollection"/> that contains the URI prefixes. + </value> + <exception cref="T:System.ObjectDisposedException"> + This listener has been closed. + </exception> + </member> + <member name="P:WebSocketSharp.Net.HttpListener.Realm"> + <summary> + Gets or sets the name of the realm associated with the listener. + </summary> + <remarks> + If this property is <see langword="null"/> or empty, <c>"SECRET AREA"</c> will be used as + the name of the realm. + </remarks> + <value> + A <see cref="T:System.String"/> that represents the name of the realm. The default value is + <see langword="null"/>. + </value> + <exception cref="T:System.ObjectDisposedException"> + This listener has been closed. + </exception> + </member> + <member name="P:WebSocketSharp.Net.HttpListener.SslConfiguration"> + <summary> + Gets or sets the SSL configuration used to authenticate the server and + optionally the client for secure connection. + </summary> + <value> + A <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> that represents the configuration used to + authenticate the server and optionally the client for secure connection. + </value> + <exception cref="T:System.ObjectDisposedException"> + This listener has been closed. + </exception> + </member> + <member name="P:WebSocketSharp.Net.HttpListener.UnsafeConnectionNtlmAuthentication"> + <summary> + 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. + </summary> + <remarks> + This property isn't currently supported and always throws + a <see cref="T:System.NotSupportedException"/>. + </remarks> + <value> + <c>true</c> if the authentication information of first request is used; + otherwise, <c>false</c>. + </value> + <exception cref="T:System.NotSupportedException"> + Any use of this property. + </exception> + </member> + <member name="P:WebSocketSharp.Net.HttpListener.UserCredentialsFinder"> + <summary> + Gets or sets the delegate called to find the credentials for an identity used to + authenticate a client. + </summary> + <value> + A <c>Func<<see cref="T:System.Security.Principal.IIdentity"/>, <see cref="T:WebSocketSharp.Net.NetworkCredential"/>></c> delegate + that references the method used to find the credentials. The default value is + <see langword="null"/>. + </value> + <exception cref="T:System.ObjectDisposedException"> + This listener has been closed. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListener.Abort"> + <summary> + Shuts down the listener immediately. + </summary> + </member> + <member name="M:WebSocketSharp.Net.HttpListener.BeginGetContext(System.AsyncCallback,System.Object)"> + <summary> + Begins getting an incoming request asynchronously. + </summary> + <remarks> + This asynchronous operation must be completed by calling the <c>EndGetContext</c> method. + Typically, the method is invoked by the <paramref name="callback"/> delegate. + </remarks> + <returns> + An <see cref="T:System.IAsyncResult"/> that represents the status of the asynchronous operation. + </returns> + <param name="callback"> + An <see cref="T:System.AsyncCallback"/> delegate that references the method to invoke when + the asynchronous operation completes. + </param> + <param name="state"> + An <see cref="T:System.Object"/> that represents a user defined object to pass to + the <paramref name="callback"/> delegate. + </param> + <exception cref="T:System.InvalidOperationException"> + <para> + This listener has no URI prefix on which listens. + </para> + <para> + -or- + </para> + <para> + This listener hasn't been started, or is currently stopped. + </para> + </exception> + <exception cref="T:System.ObjectDisposedException"> + This listener has been closed. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListener.Close"> + <summary> + Shuts down the listener. + </summary> + </member> + <member name="M:WebSocketSharp.Net.HttpListener.EndGetContext(System.IAsyncResult)"> + <summary> + Ends an asynchronous operation to get an incoming request. + </summary> + <remarks> + This method completes an asynchronous operation started by calling + the <c>BeginGetContext</c> method. + </remarks> + <returns> + A <see cref="T:WebSocketSharp.Net.HttpListenerContext"/> that represents a request. + </returns> + <param name="asyncResult"> + An <see cref="T:System.IAsyncResult"/> obtained by calling the <c>BeginGetContext</c> method. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="asyncResult"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="asyncResult"/> wasn't obtained by calling the <c>BeginGetContext</c> method. + </exception> + <exception cref="T:System.InvalidOperationException"> + This method was already called for the specified <paramref name="asyncResult"/>. + </exception> + <exception cref="T:System.ObjectDisposedException"> + This listener has been closed. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListener.GetContext"> + <summary> + Gets an incoming request. + </summary> + <remarks> + This method waits for an incoming request, and returns when a request is received. + </remarks> + <returns> + A <see cref="T:WebSocketSharp.Net.HttpListenerContext"/> that represents a request. + </returns> + <exception cref="T:System.InvalidOperationException"> + <para> + This listener has no URI prefix on which listens. + </para> + <para> + -or- + </para> + <para> + This listener hasn't been started, or is currently stopped. + </para> + </exception> + <exception cref="T:System.ObjectDisposedException"> + This listener has been closed. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListener.Start"> + <summary> + Starts receiving incoming requests. + </summary> + <exception cref="T:System.ObjectDisposedException"> + This listener has been closed. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListener.Stop"> + <summary> + Stops receiving incoming requests. + </summary> + <exception cref="T:System.ObjectDisposedException"> + This listener has been closed. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListener.System#IDisposable#Dispose"> + <summary> + Releases all resources used by the listener. + </summary> + </member> + <member name="T:WebSocketSharp.Net.HttpListenerContext"> + <summary> + Provides the access to the HTTP request and response objects used by + the <see cref="T:WebSocketSharp.Net.HttpListener"/>. + </summary> + <remarks> + This class cannot be inherited. + </remarks> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerContext.Request"> + <summary> + Gets the HTTP request object that represents a client request. + </summary> + <value> + A <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/> that represents the client request. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerContext.Response"> + <summary> + Gets the HTTP response object used to send a response to the client. + </summary> + <value> + A <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> that represents a response to the client request. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerContext.User"> + <summary> + Gets the client information (identity, authentication, and security roles). + </summary> + <value> + A <see cref="T:System.Security.Principal.IPrincipal"/> instance that represents the client information. + </value> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerContext.AcceptWebSocket(System.String)"> + <summary> + Accepts a WebSocket handshake request. + </summary> + <returns> + A <see cref="T:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext"/> that represents + the WebSocket handshake request. + </returns> + <param name="protocol"> + A <see cref="T:System.String"/> that represents the subprotocol supported on + this WebSocket connection. + </param> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="protocol"/> is empty. + </para> + <para> + -or- + </para> + <para> + <paramref name="protocol"/> contains an invalid character. + </para> + </exception> + <exception cref="T:System.InvalidOperationException"> + This method has already been called. + </exception> + </member> + <member name="T:WebSocketSharp.Net.HttpListenerException"> + <summary> + The exception that is thrown when a <see cref="T:WebSocketSharp.Net.HttpListener"/> gets an error + processing an HTTP request. + </summary> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException"/> class from + the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> and <see cref="T:System.Runtime.Serialization.StreamingContext"/>. + </summary> + <param name="serializationInfo"> + A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that contains the serialized object data. + </param> + <param name="streamingContext"> + A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the source for the deserialization. + </param> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerException.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException"/> class. + </summary> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerException.#ctor(System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException"/> class + with the specified <paramref name="errorCode"/>. + </summary> + <param name="errorCode"> + An <see cref="T:System.Int32"/> that identifies the error. + </param> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerException.#ctor(System.Int32,System.String)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerException"/> class + with the specified <paramref name="errorCode"/> and <paramref name="message"/>. + </summary> + <param name="errorCode"> + An <see cref="T:System.Int32"/> that identifies the error. + </param> + <param name="message"> + A <see cref="T:System.String"/> that describes the error. + </param> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerException.ErrorCode"> + <summary> + Gets the error code that identifies the error that occurred. + </summary> + <value> + An <see cref="T:System.Int32"/> that identifies the error. + </value> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerPrefix.#ctor(System.String)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpListenerPrefix"/> class with + the specified <paramref name="uriPrefix"/>. + </summary> + <remarks> + This constructor must be called after calling the CheckPrefix method. + </remarks> + <param name="uriPrefix"> + A <see cref="T:System.String"/> that represents the URI prefix. + </param> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerPrefix.Equals(System.Object)"> + <summary> + Determines whether this instance and the specified <see cref="T:System.Object"/> have the same value. + </summary> + <remarks> + This method will be required to detect duplicates in any collection. + </remarks> + <param name="obj"> + An <see cref="T:System.Object"/> to compare to this instance. + </param> + <returns> + <c>true</c> if <paramref name="obj"/> is a <see cref="T:WebSocketSharp.Net.HttpListenerPrefix"/> and + its value is the same as this instance; otherwise, <c>false</c>. + </returns> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerPrefix.GetHashCode"> + <summary> + Gets the hash code for this instance. + </summary> + <remarks> + This method will be required to detect duplicates in any collection. + </remarks> + <returns> + An <see cref="T:System.Int32"/> that represents the hash code. + </returns> + </member> + <member name="T:WebSocketSharp.Net.HttpListenerPrefixCollection"> + <summary> + Provides the collection used to store the URI prefixes for the <see cref="T:WebSocketSharp.Net.HttpListener"/>. + </summary> + <remarks> + The <see cref="T:WebSocketSharp.Net.HttpListener"/> responds to the request which has a requested URI that + the prefixes most closely match. + </remarks> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerPrefixCollection.Count"> + <summary> + Gets the number of prefixes in the collection. + </summary> + <value> + An <see cref="T:System.Int32"/> that represents the number of prefixes. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerPrefixCollection.IsReadOnly"> + <summary> + Gets a value indicating whether the access to the collection is read-only. + </summary> + <value> + Always returns <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerPrefixCollection.IsSynchronized"> + <summary> + Gets a value indicating whether the access to the collection is synchronized. + </summary> + <value> + Always returns <c>false</c>. + </value> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.Add(System.String)"> + <summary> + Adds the specified <paramref name="uriPrefix"/> to the collection. + </summary> + <param name="uriPrefix"> + A <see cref="T:System.String"/> that represents the URI prefix to add. The prefix must be + a well-formed URI prefix with http or https scheme, and must end with a <c>'/'</c>. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="uriPrefix"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="uriPrefix"/> is invalid. + </exception> + <exception cref="T:System.ObjectDisposedException"> + The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.Clear"> + <summary> + Removes all URI prefixes from the collection. + </summary> + <exception cref="T:System.ObjectDisposedException"> + The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.Contains(System.String)"> + <summary> + Returns a value indicating whether the collection contains the specified + <paramref name="uriPrefix"/>. + </summary> + <returns> + <c>true</c> if the collection contains <paramref name="uriPrefix"/>; + otherwise, <c>false</c>. + </returns> + <param name="uriPrefix"> + A <see cref="T:System.String"/> that represents the URI prefix to test. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="uriPrefix"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ObjectDisposedException"> + The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.CopyTo(System.Array,System.Int32)"> + <summary> + Copies the contents of the collection to the specified <see cref="T:System.Array"/>. + </summary> + <param name="array"> + An <see cref="T:System.Array"/> that receives the URI prefix strings in the collection. + </param> + <param name="offset"> + An <see cref="T:System.Int32"/> that represents the zero-based index in <paramref name="array"/> + at which copying begins. + </param> + <exception cref="T:System.ObjectDisposedException"> + The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.CopyTo(System.String[],System.Int32)"> + <summary> + Copies the contents of the collection to the specified array of <see cref="T:System.String"/>. + </summary> + <param name="array"> + An array of <see cref="T:System.String"/> that receives the URI prefix strings in the collection. + </param> + <param name="offset"> + An <see cref="T:System.Int32"/> that represents the zero-based index in <paramref name="array"/> + at which copying begins. + </param> + <exception cref="T:System.ObjectDisposedException"> + The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.GetEnumerator"> + <summary> + Gets the enumerator used to iterate through the <see cref="T:WebSocketSharp.Net.HttpListenerPrefixCollection"/>. + </summary> + <returns> + An <see cref="T:System.Collections.Generic.IEnumerator{string}"/> instance used to iterate + through the collection. + </returns> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.Remove(System.String)"> + <summary> + Removes the specified <paramref name="uriPrefix"/> from the collection. + </summary> + <returns> + <c>true</c> if <paramref name="uriPrefix"/> is successfully found and removed; + otherwise, <c>false</c>. + </returns> + <param name="uriPrefix"> + A <see cref="T:System.String"/> that represents the URI prefix to remove. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="uriPrefix"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ObjectDisposedException"> + The <see cref="T:WebSocketSharp.Net.HttpListener"/> associated with this collection is closed. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerPrefixCollection.System#Collections#IEnumerable#GetEnumerator"> + <summary> + Gets the enumerator used to iterate through the <see cref="T:WebSocketSharp.Net.HttpListenerPrefixCollection"/>. + </summary> + <returns> + An <see cref="T:System.Collections.IEnumerator"/> instance used to iterate through the collection. + </returns> + </member> + <member name="T:WebSocketSharp.Net.HttpListenerRequest"> + <summary> + Provides the access to a request to the <see cref="T:WebSocketSharp.Net.HttpListener"/>. + </summary> + <remarks> + The HttpListenerRequest class cannot be inherited. + </remarks> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.AcceptTypes"> + <summary> + Gets the media types which are acceptable for the response. + </summary> + <value> + An array of <see cref="T:System.String"/> that contains the media type names in + the Accept request-header, or <see langword="null"/> if the request didn't include + the Accept header. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.ClientCertificateError"> + <summary> + Gets an error code that identifies a problem with the client's certificate. + </summary> + <value> + Always returns <c>0</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.ContentEncoding"> + <summary> + Gets the encoding for the entity body data included in the request. + </summary> + <value> + A <see cref="T:System.Text.Encoding"/> that represents the encoding for the entity body data, + or <see cref="P:System.Text.Encoding.Default"/> if the request didn't include the information about + the encoding. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.ContentLength64"> + <summary> + Gets the number of bytes in the entity body data included in the request. + </summary> + <value> + A <see cref="T:System.Int64"/> that represents the value of the Content-Length entity-header, + or <c>-1</c> if the value isn't known. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.ContentType"> + <summary> + Gets the media type of the entity body included in the request. + </summary> + <value> + A <see cref="T:System.String"/> that represents the value of the Content-Type entity-header. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.Cookies"> + <summary> + Gets the cookies included in the request. + </summary> + <value> + A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies included in the request. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.HasEntityBody"> + <summary> + Gets a value indicating whether the request has the entity body. + </summary> + <value> + <c>true</c> if the request has the entity body; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.Headers"> + <summary> + Gets the HTTP headers used in the request. + </summary> + <value> + A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the HTTP headers used in the request. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.HttpMethod"> + <summary> + Gets the HTTP method used in the request. + </summary> + <value> + A <see cref="T:System.String"/> that represents the HTTP method used in the request. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.InputStream"> + <summary> + Gets a <see cref="T:System.IO.Stream"/> that contains the entity body data included in the request. + </summary> + <value> + A <see cref="T:System.IO.Stream"/> that contains the entity body data included in the request. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.IsAuthenticated"> + <summary> + Gets a value indicating whether the client that sent the request is authenticated. + </summary> + <value> + <c>true</c> if the client is authenticated; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.IsLocal"> + <summary> + Gets a value indicating whether the request is sent from the local computer. + </summary> + <value> + <c>true</c> if the request is sent from the local computer; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.IsSecureConnection"> + <summary> + Gets a value indicating whether the HTTP connection is secured using the SSL protocol. + </summary> + <value> + <c>true</c> if the HTTP connection is secured; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.IsWebSocketRequest"> + <summary> + Gets a value indicating whether the request is a WebSocket connection request. + </summary> + <value> + <c>true</c> if the request is a WebSocket connection request; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.KeepAlive"> + <summary> + Gets a value indicating whether the client requests a persistent connection. + </summary> + <value> + <c>true</c> if the client requests a persistent connection; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.LocalEndPoint"> + <summary> + Gets the server endpoint as an IP address and a port number. + </summary> + <value> + A <see cref="T:System.Net.IPEndPoint"/> that represents the server endpoint. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.ProtocolVersion"> + <summary> + Gets the HTTP version used in the request. + </summary> + <value> + A <see cref="T:System.Version"/> that represents the HTTP version used in the request. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.QueryString"> + <summary> + Gets the query string included in the request. + </summary> + <value> + A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the query string parameters. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.RawUrl"> + <summary> + Gets the raw URL (without the scheme, host, and port) requested by the client. + </summary> + <value> + A <see cref="T:System.String"/> that represents the raw URL requested by the client. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.RemoteEndPoint"> + <summary> + Gets the client endpoint as an IP address and a port number. + </summary> + <value> + A <see cref="T:System.Net.IPEndPoint"/> that represents the client endpoint. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.RequestTraceIdentifier"> + <summary> + Gets the request identifier of a incoming HTTP request. + </summary> + <value> + A <see cref="T:System.Guid"/> that represents the identifier of a request. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.Url"> + <summary> + Gets the URL requested by the client. + </summary> + <value> + A <see cref="T:System.Uri"/> that represents the URL requested by the client. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.UrlReferrer"> + <summary> + Gets the URL of the resource from which the requested URL was obtained. + </summary> + <value> + A <see cref="T:System.Uri"/> that represents the value of the Referer request-header, + or <see langword="null"/> if the request didn't include an Referer header. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.UserAgent"> + <summary> + Gets the information about the user agent originating the request. + </summary> + <value> + A <see cref="T:System.String"/> that represents the value of the User-Agent request-header. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.UserHostAddress"> + <summary> + Gets the server endpoint as an IP address and a port number. + </summary> + <value> + A <see cref="T:System.String"/> that represents the server endpoint. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.UserHostName"> + <summary> + Gets the internet host name and port number (if present) specified by the client. + </summary> + <value> + A <see cref="T:System.String"/> that represents the value of the Host request-header. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerRequest.UserLanguages"> + <summary> + Gets the natural languages which are preferred for the response. + </summary> + <value> + An array of <see cref="T:System.String"/> that contains the natural language names in + the Accept-Language request-header, or <see langword="null"/> if the request + didn't include an Accept-Language header. + </value> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerRequest.BeginGetClientCertificate(System.AsyncCallback,System.Object)"> + <summary> + Begins getting the client's X.509 v.3 certificate asynchronously. + </summary> + <remarks> + This asynchronous operation must be completed by calling + the <see cref="M:WebSocketSharp.Net.HttpListenerRequest.EndGetClientCertificate(System.IAsyncResult)"/> method. Typically, + that method is invoked by the <paramref name="requestCallback"/> delegate. + </remarks> + <returns> + An <see cref="T:System.IAsyncResult"/> that contains the status of the asynchronous operation. + </returns> + <param name="requestCallback"> + An <see cref="T:System.AsyncCallback"/> delegate that references the method(s) called when + the asynchronous operation completes. + </param> + <param name="state"> + An <see cref="T:System.Object"/> that contains a user defined object to pass to + the <paramref name="requestCallback"/> delegate. + </param> + <exception cref="T:System.NotImplementedException"> + This method isn't implemented. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerRequest.EndGetClientCertificate(System.IAsyncResult)"> + <summary> + Ends an asynchronous operation to get the client's X.509 v.3 certificate. + </summary> + <remarks> + This method completes an asynchronous operation started by calling + the <see cref="M:WebSocketSharp.Net.HttpListenerRequest.BeginGetClientCertificate(System.AsyncCallback,System.Object)"/> method. + </remarks> + <returns> + A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that contains the client's X.509 v.3 certificate. + </returns> + <param name="asyncResult"> + An <see cref="T:System.IAsyncResult"/> obtained by calling + the <see cref="M:WebSocketSharp.Net.HttpListenerRequest.BeginGetClientCertificate(System.AsyncCallback,System.Object)"/> method. + </param> + <exception cref="T:System.NotImplementedException"> + This method isn't implemented. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerRequest.GetClientCertificate"> + <summary> + Gets the client's X.509 v.3 certificate. + </summary> + <returns> + A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that contains the client's X.509 v.3 certificate. + </returns> + <exception cref="T:System.NotImplementedException"> + This method isn't implemented. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerRequest.ToString"> + <summary> + Returns a <see cref="T:System.String"/> that represents + the current <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/>. + </summary> + <returns> + A <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/>. + </returns> + </member> + <member name="T:WebSocketSharp.Net.HttpListenerResponse"> + <summary> + Provides the access to a response to a request received by the <see cref="T:WebSocketSharp.Net.HttpListener"/>. + </summary> + <remarks> + The HttpListenerResponse class cannot be inherited. + </remarks> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerResponse.ContentEncoding"> + <summary> + Gets or sets the encoding for the entity body data included in the response. + </summary> + <value> + A <see cref="T:System.Text.Encoding"/> that represents the encoding for the entity body data, + or <see langword="null"/> if no encoding is specified. + </value> + <exception cref="T:System.ObjectDisposedException"> + This object is closed. + </exception> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerResponse.ContentLength64"> + <summary> + Gets or sets the number of bytes in the entity body data included in the response. + </summary> + <value> + A <see cref="T:System.Int64"/> that represents the value of the Content-Length entity-header. + </value> + <exception cref="T:System.ArgumentOutOfRangeException"> + The value specified for a set operation is less than zero. + </exception> + <exception cref="T:System.InvalidOperationException"> + The response has already been sent. + </exception> + <exception cref="T:System.ObjectDisposedException"> + This object is closed. + </exception> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerResponse.ContentType"> + <summary> + Gets or sets the media type of the entity body included in the response. + </summary> + <value> + A <see cref="T:System.String"/> that represents the media type of the entity body, + or <see langword="null"/> if no media type is specified. This value is + used for the value of the Content-Type entity-header. + </value> + <exception cref="T:System.ArgumentException"> + The value specified for a set operation is empty. + </exception> + <exception cref="T:System.ObjectDisposedException"> + This object is closed. + </exception> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerResponse.Cookies"> + <summary> + Gets or sets the cookies sent with the response. + </summary> + <value> + A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies sent with the response. + </value> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerResponse.Headers"> + <summary> + Gets or sets the HTTP headers sent to the client. + </summary> + <value> + A <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> that contains the headers sent to the client. + </value> + <exception cref="T:System.InvalidOperationException"> + The value specified for a set operation isn't valid for a response. + </exception> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerResponse.KeepAlive"> + <summary> + Gets or sets a value indicating whether the server requests a persistent connection. + </summary> + <value> + <c>true</c> if the server requests a persistent connection; otherwise, <c>false</c>. + The default value is <c>true</c>. + </value> + <exception cref="T:System.InvalidOperationException"> + The response has already been sent. + </exception> + <exception cref="T:System.ObjectDisposedException"> + This object is closed. + </exception> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerResponse.OutputStream"> + <summary> + Gets a <see cref="T:System.IO.Stream"/> to use to write the entity body data. + </summary> + <value> + A <see cref="T:System.IO.Stream"/> to use to write the entity body data. + </value> + <exception cref="T:System.ObjectDisposedException"> + This object is closed. + </exception> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerResponse.ProtocolVersion"> + <summary> + Gets or sets the HTTP version used in the response. + </summary> + <value> + A <see cref="T:System.Version"/> that represents the version used in the response. + </value> + <exception cref="T:System.ArgumentNullException"> + The value specified for a set operation is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + The value specified for a set operation doesn't have its <c>Major</c> property set to 1 or + doesn't have its <c>Minor</c> property set to either 0 or 1. + </exception> + <exception cref="T:System.InvalidOperationException"> + The response has already been sent. + </exception> + <exception cref="T:System.ObjectDisposedException"> + This object is closed. + </exception> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerResponse.RedirectLocation"> + <summary> + Gets or sets the URL to which the client is redirected to locate a requested resource. + </summary> + <value> + A <see cref="T:System.String"/> that represents the value of the Location response-header, + or <see langword="null"/> if no redirect location is specified. + </value> + <exception cref="T:System.ArgumentException"> + The value specified for a set operation isn't an absolute URL. + </exception> + <exception cref="T:System.ObjectDisposedException"> + This object is closed. + </exception> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerResponse.SendChunked"> + <summary> + Gets or sets a value indicating whether the response uses the chunked transfer encoding. + </summary> + <value> + <c>true</c> if the response uses the chunked transfer encoding; + otherwise, <c>false</c>. The default value is <c>false</c>. + </value> + <exception cref="T:System.InvalidOperationException"> + The response has already been sent. + </exception> + <exception cref="T:System.ObjectDisposedException"> + This object is closed. + </exception> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerResponse.StatusCode"> + <summary> + Gets or sets the HTTP status code returned to the client. + </summary> + <value> + An <see cref="T:System.Int32"/> that represents the status code for the response to + the request. The default value is same as <see cref="F:WebSocketSharp.Net.HttpStatusCode.OK"/>. + </value> + <exception cref="T:System.InvalidOperationException"> + The response has already been sent. + </exception> + <exception cref="T:System.ObjectDisposedException"> + This object is closed. + </exception> + <exception cref="T:System.Net.ProtocolViolationException"> + The value specified for a set operation is invalid. Valid values are + between 100 and 999 inclusive. + </exception> + </member> + <member name="P:WebSocketSharp.Net.HttpListenerResponse.StatusDescription"> + <summary> + Gets or sets the description of the HTTP status code returned to the client. + </summary> + <value> + A <see cref="T:System.String"/> that represents the description of the status code. The default + value is the <see href="http://tools.ietf.org/html/rfc2616#section-10">RFC 2616</see> + description for the <see cref="P:WebSocketSharp.Net.HttpListenerResponse.StatusCode"/> property value, + or <see cref="F:System.String.Empty"/> if an RFC 2616 description doesn't exist. + </value> + <exception cref="T:System.ArgumentException"> + The value specified for a set operation contains invalid characters. + </exception> + <exception cref="T:System.InvalidOperationException"> + The response has already been sent. + </exception> + <exception cref="T:System.ObjectDisposedException"> + This object is closed. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerResponse.Abort"> + <summary> + Closes the connection to the client without returning a response. + </summary> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerResponse.AddHeader(System.String,System.String)"> + <summary> + Adds an HTTP header with the specified <paramref name="name"/> and + <paramref name="value"/> to the headers for the response. + </summary> + <param name="name"> + A <see cref="T:System.String"/> that represents the name of the header to add. + </param> + <param name="value"> + A <see cref="T:System.String"/> that represents the value of the header to add. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="name"/> is <see langword="null"/> or empty. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="name"/> or <paramref name="value"/> contains invalid characters. + </para> + <para> + -or- + </para> + <para> + <paramref name="name"/> is a restricted header name. + </para> + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + The length of <paramref name="value"/> is greater than 65,535 characters. + </exception> + <exception cref="T:System.InvalidOperationException"> + The header cannot be allowed to add to the current headers. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerResponse.AppendCookie(WebSocketSharp.Net.Cookie)"> + <summary> + Appends the specified <paramref name="cookie"/> to the cookies sent with the response. + </summary> + <param name="cookie"> + A <see cref="T:WebSocketSharp.Net.Cookie"/> to append. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="cookie"/> is <see langword="null"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerResponse.AppendHeader(System.String,System.String)"> + <summary> + Appends a <paramref name="value"/> to the specified HTTP header sent with the response. + </summary> + <param name="name"> + A <see cref="T:System.String"/> that represents the name of the header to append + <paramref name="value"/> to. + </param> + <param name="value"> + A <see cref="T:System.String"/> that represents the value to append to the header. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="name"/> is <see langword="null"/> or empty. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="name"/> or <paramref name="value"/> contains invalid characters. + </para> + <para> + -or- + </para> + <para> + <paramref name="name"/> is a restricted header name. + </para> + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + The length of <paramref name="value"/> is greater than 65,535 characters. + </exception> + <exception cref="T:System.InvalidOperationException"> + The current headers cannot allow the header to append a value. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerResponse.Close"> + <summary> + Returns the response to the client and releases the resources used by + this <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> instance. + </summary> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerResponse.Close(System.Byte[],System.Boolean)"> + <summary> + Returns the response with the specified array of <see cref="T:System.Byte"/> to the client and + releases the resources used by this <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> instance. + </summary> + <param name="responseEntity"> + An array of <see cref="T:System.Byte"/> that contains the response entity body data. + </param> + <param name="willBlock"> + <c>true</c> if this method blocks execution while flushing the stream to the client; + otherwise, <c>false</c>. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="responseEntity"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ObjectDisposedException"> + This object is closed. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerResponse.CopyFrom(WebSocketSharp.Net.HttpListenerResponse)"> + <summary> + Copies some properties from the specified <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> to + this response. + </summary> + <param name="templateResponse"> + A <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> to copy. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="templateResponse"/> is <see langword="null"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerResponse.Redirect(System.String)"> + <summary> + Configures the response to redirect the client's request to + the specified <paramref name="url"/>. + </summary> + <remarks> + This method sets the <see cref="P:WebSocketSharp.Net.HttpListenerResponse.RedirectLocation"/> property to + <paramref name="url"/>, the <see cref="P:WebSocketSharp.Net.HttpListenerResponse.StatusCode"/> property to + <c>302</c>, and the <see cref="P:WebSocketSharp.Net.HttpListenerResponse.StatusDescription"/> property to + <c>"Found"</c>. + </remarks> + <param name="url"> + A <see cref="T:System.String"/> that represents the URL to redirect the client's request to. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="url"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="url"/> isn't an absolute URL. + </exception> + <exception cref="T:System.InvalidOperationException"> + The response has already been sent. + </exception> + <exception cref="T:System.ObjectDisposedException"> + This object is closed. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerResponse.SetCookie(WebSocketSharp.Net.Cookie)"> + <summary> + Adds or updates a <paramref name="cookie"/> in the cookies sent with the response. + </summary> + <param name="cookie"> + A <see cref="T:WebSocketSharp.Net.Cookie"/> to set. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="cookie"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="cookie"/> already exists in the cookies and couldn't be replaced. + </exception> + </member> + <member name="M:WebSocketSharp.Net.HttpListenerResponse.System#IDisposable#Dispose"> + <summary> + Releases all resources used by the <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/>. + </summary> + </member> + <member name="T:WebSocketSharp.Net.HttpRequestHeader"> + <summary> + Contains the HTTP headers that may be specified in a client request. + </summary> + <remarks> + The HttpRequestHeader enumeration contains the HTTP request headers defined in + <see href="http://tools.ietf.org/html/rfc2616#section-14">RFC 2616</see> for the HTTP/1.1 and + <see href="http://tools.ietf.org/html/rfc6455#section-11.3">RFC 6455</see> for the WebSocket. + </remarks> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.CacheControl"> + <summary> + Indicates the Cache-Control header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.Connection"> + <summary> + Indicates the Connection header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.Date"> + <summary> + Indicates the Date header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.KeepAlive"> + <summary> + Indicates the Keep-Alive header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.Pragma"> + <summary> + Indicates the Pragma header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.Trailer"> + <summary> + Indicates the Trailer header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.TransferEncoding"> + <summary> + Indicates the Transfer-Encoding header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.Upgrade"> + <summary> + Indicates the Upgrade header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.Via"> + <summary> + Indicates the Via header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.Warning"> + <summary> + Indicates the Warning header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.Allow"> + <summary> + Indicates the Allow header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentLength"> + <summary> + Indicates the Content-Length header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentType"> + <summary> + Indicates the Content-Type header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentEncoding"> + <summary> + Indicates the Content-Encoding header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentLanguage"> + <summary> + Indicates the Content-Language header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentLocation"> + <summary> + Indicates the Content-Location header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentMd5"> + <summary> + Indicates the Content-MD5 header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.ContentRange"> + <summary> + Indicates the Content-Range header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.Expires"> + <summary> + Indicates the Expires header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.LastModified"> + <summary> + Indicates the Last-Modified header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.Accept"> + <summary> + Indicates the Accept header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.AcceptCharset"> + <summary> + Indicates the Accept-Charset header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.AcceptEncoding"> + <summary> + Indicates the Accept-Encoding header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.AcceptLanguage"> + <summary> + Indicates the Accept-Language header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.Authorization"> + <summary> + Indicates the Authorization header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.Cookie"> + <summary> + Indicates the Cookie header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.Expect"> + <summary> + Indicates the Expect header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.From"> + <summary> + Indicates the From header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.Host"> + <summary> + Indicates the Host header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.IfMatch"> + <summary> + Indicates the If-Match header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.IfModifiedSince"> + <summary> + Indicates the If-Modified-Since header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.IfNoneMatch"> + <summary> + Indicates the If-None-Match header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.IfRange"> + <summary> + Indicates the If-Range header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.IfUnmodifiedSince"> + <summary> + Indicates the If-Unmodified-Since header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.MaxForwards"> + <summary> + Indicates the Max-Forwards header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.ProxyAuthorization"> + <summary> + Indicates the Proxy-Authorization header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.Referer"> + <summary> + Indicates the Referer header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.Range"> + <summary> + Indicates the Range header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.Te"> + <summary> + Indicates the TE header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.Translate"> + <summary> + Indicates the Translate header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.UserAgent"> + <summary> + Indicates the User-Agent header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.SecWebSocketKey"> + <summary> + Indicates the Sec-WebSocket-Key header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.SecWebSocketExtensions"> + <summary> + Indicates the Sec-WebSocket-Extensions header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.SecWebSocketProtocol"> + <summary> + Indicates the Sec-WebSocket-Protocol header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpRequestHeader.SecWebSocketVersion"> + <summary> + Indicates the Sec-WebSocket-Version header. + </summary> + </member> + <member name="T:WebSocketSharp.Net.HttpResponseHeader"> + <summary> + Contains the HTTP headers that can be specified in a server response. + </summary> + <remarks> + The HttpResponseHeader enumeration contains the HTTP response headers defined in + <see href="http://tools.ietf.org/html/rfc2616#section-14">RFC 2616</see> for the HTTP/1.1 and + <see href="http://tools.ietf.org/html/rfc6455#section-11.3">RFC 6455</see> for the WebSocket. + </remarks> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.CacheControl"> + <summary> + Indicates the Cache-Control header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.Connection"> + <summary> + Indicates the Connection header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.Date"> + <summary> + Indicates the Date header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.KeepAlive"> + <summary> + Indicates the Keep-Alive header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.Pragma"> + <summary> + Indicates the Pragma header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.Trailer"> + <summary> + Indicates the Trailer header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.TransferEncoding"> + <summary> + Indicates the Transfer-Encoding header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.Upgrade"> + <summary> + Indicates the Upgrade header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.Via"> + <summary> + Indicates the Via header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.Warning"> + <summary> + Indicates the Warning header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.Allow"> + <summary> + Indicates the Allow header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentLength"> + <summary> + Indicates the Content-Length header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentType"> + <summary> + Indicates the Content-Type header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentEncoding"> + <summary> + Indicates the Content-Encoding header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentLanguage"> + <summary> + Indicates the Content-Language header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentLocation"> + <summary> + Indicates the Content-Location header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentMd5"> + <summary> + Indicates the Content-MD5 header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.ContentRange"> + <summary> + Indicates the Content-Range header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.Expires"> + <summary> + Indicates the Expires header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.LastModified"> + <summary> + Indicates the Last-Modified header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.AcceptRanges"> + <summary> + Indicates the Accept-Ranges header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.Age"> + <summary> + Indicates the Age header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.ETag"> + <summary> + Indicates the ETag header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.Location"> + <summary> + Indicates the Location header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.ProxyAuthenticate"> + <summary> + Indicates the Proxy-Authenticate header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.RetryAfter"> + <summary> + Indicates the Retry-After header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.Server"> + <summary> + Indicates the Server header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.SetCookie"> + <summary> + Indicates the Set-Cookie header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.Vary"> + <summary> + Indicates the Vary header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.WwwAuthenticate"> + <summary> + Indicates the WWW-Authenticate header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.SecWebSocketExtensions"> + <summary> + Indicates the Sec-WebSocket-Extensions header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.SecWebSocketAccept"> + <summary> + Indicates the Sec-WebSocket-Accept header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.SecWebSocketProtocol"> + <summary> + Indicates the Sec-WebSocket-Protocol header. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpResponseHeader.SecWebSocketVersion"> + <summary> + Indicates the Sec-WebSocket-Version header. + </summary> + </member> + <member name="T:WebSocketSharp.Net.HttpStatusCode"> + <summary> + Contains the values of the HTTP status codes. + </summary> + <remarks> + The HttpStatusCode enumeration contains the values of the HTTP status codes defined in + <see href="http://tools.ietf.org/html/rfc2616#section-10">RFC 2616</see> for the HTTP/1.1. + </remarks> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.Continue"> + <summary> + Equivalent to status code 100. + Indicates that the client should continue with its request. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.SwitchingProtocols"> + <summary> + Equivalent to status code 101. + Indicates that the server is switching the HTTP version or protocol on the connection. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.OK"> + <summary> + Equivalent to status code 200. + Indicates that the client's request has succeeded. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.Created"> + <summary> + Equivalent to status code 201. + Indicates that the client's request has been fulfilled and resulted in a new resource being + created. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.Accepted"> + <summary> + Equivalent to status code 202. + Indicates that the client's request has been accepted for processing, but the processing + hasn't been completed. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.NonAuthoritativeInformation"> + <summary> + Equivalent to status code 203. + Indicates that the returned metainformation is from a local or a third-party copy instead of + the origin server. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.NoContent"> + <summary> + Equivalent to status code 204. + Indicates that the server has fulfilled the client's request but doesn't need to return + an entity-body. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.ResetContent"> + <summary> + 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. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.PartialContent"> + <summary> + Equivalent to status code 206. + Indicates that the server has fulfilled the partial GET request for the resource. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.MultipleChoices"> + <summary> + <para> + Equivalent to status code 300. + Indicates that the requested resource corresponds to any of multiple representations. + </para> + <para> + MultipleChoices is a synonym for Ambiguous. + </para> + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.Ambiguous"> + <summary> + <para> + Equivalent to status code 300. + Indicates that the requested resource corresponds to any of multiple representations. + </para> + <para> + Ambiguous is a synonym for MultipleChoices. + </para> + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.MovedPermanently"> + <summary> + <para> + Equivalent to status code 301. + Indicates that the requested resource has been assigned a new permanent URI and + any future references to this resource should use one of the returned URIs. + </para> + <para> + MovedPermanently is a synonym for Moved. + </para> + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.Moved"> + <summary> + <para> + Equivalent to status code 301. + Indicates that the requested resource has been assigned a new permanent URI and + any future references to this resource should use one of the returned URIs. + </para> + <para> + Moved is a synonym for MovedPermanently. + </para> + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.Found"> + <summary> + <para> + Equivalent to status code 302. + Indicates that the requested resource is located temporarily under a different URI. + </para> + <para> + Found is a synonym for Redirect. + </para> + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.Redirect"> + <summary> + <para> + Equivalent to status code 302. + Indicates that the requested resource is located temporarily under a different URI. + </para> + <para> + Redirect is a synonym for Found. + </para> + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.SeeOther"> + <summary> + <para> + Equivalent to status code 303. + Indicates that the response to the request can be found under a different URI and + should be retrieved using a GET method on that resource. + </para> + <para> + SeeOther is a synonym for RedirectMethod. + </para> + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.RedirectMethod"> + <summary> + <para> + Equivalent to status code 303. + Indicates that the response to the request can be found under a different URI and + should be retrieved using a GET method on that resource. + </para> + <para> + RedirectMethod is a synonym for SeeOther. + </para> + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.NotModified"> + <summary> + 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. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.UseProxy"> + <summary> + Equivalent to status code 305. + Indicates that the requested resource must be accessed through the proxy given by + the Location field. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.Unused"> + <summary> + 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. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.TemporaryRedirect"> + <summary> + <para> + Equivalent to status code 307. + Indicates that the requested resource is located temporarily under a different URI. + </para> + <para> + TemporaryRedirect is a synonym for RedirectKeepVerb. + </para> + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.RedirectKeepVerb"> + <summary> + <para> + Equivalent to status code 307. + Indicates that the requested resource is located temporarily under a different URI. + </para> + <para> + RedirectKeepVerb is a synonym for TemporaryRedirect. + </para> + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.BadRequest"> + <summary> + Equivalent to status code 400. + Indicates that the client's request couldn't be understood by the server due to + malformed syntax. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.Unauthorized"> + <summary> + Equivalent to status code 401. + Indicates that the client's request requires user authentication. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.PaymentRequired"> + <summary> + Equivalent to status code 402. + This status code is reserved for future use. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.Forbidden"> + <summary> + Equivalent to status code 403. + Indicates that the server understood the client's request but is refusing to fulfill it. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.NotFound"> + <summary> + Equivalent to status code 404. + Indicates that the server hasn't found anything matching the request URI. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.MethodNotAllowed"> + <summary> + 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. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.NotAcceptable"> + <summary> + 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. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.ProxyAuthenticationRequired"> + <summary> + Equivalent to status code 407. + Indicates that the client must first authenticate itself with the proxy. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.RequestTimeout"> + <summary> + Equivalent to status code 408. + Indicates that the client didn't produce a request within the time that the server was + prepared to wait. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.Conflict"> + <summary> + Equivalent to status code 409. + Indicates that the client's request couldn't be completed due to a conflict on the server. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.Gone"> + <summary> + Equivalent to status code 410. + Indicates that the requested resource is no longer available at the server and + no forwarding address is known. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.LengthRequired"> + <summary> + Equivalent to status code 411. + Indicates that the server refuses to accept the client's request without a defined + Content-Length. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.PreconditionFailed"> + <summary> + 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. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.RequestEntityTooLarge"> + <summary> + 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. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.RequestUriTooLong"> + <summary> + Equivalent to status code 414. + Indicates that the request URI is longer than the server is willing to interpret. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.UnsupportedMediaType"> + <summary> + 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. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.RequestedRangeNotSatisfiable"> + <summary> + 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. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.ExpectationFailed"> + <summary> + Equivalent to status code 417. + Indicates that the expectation given in an Expect request header couldn't be met by + the server. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.InternalServerError"> + <summary> + Equivalent to status code 500. + Indicates that the server encountered an unexpected condition which prevented it from + fulfilling the client's request. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.NotImplemented"> + <summary> + Equivalent to status code 501. + Indicates that the server doesn't support the functionality required to fulfill the client's + request. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.BadGateway"> + <summary> + Equivalent to status code 502. + Indicates that a gateway or proxy server received an invalid response from the upstream + server. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.ServiceUnavailable"> + <summary> + 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. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.GatewayTimeout"> + <summary> + 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. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpStatusCode.HttpVersionNotSupported"> + <summary> + Equivalent to status code 505. + Indicates that the server doesn't support the HTTP version used in the client's request. + </summary> + </member> + <member name="M:WebSocketSharp.Net.HttpUtility.HtmlDecode(System.String)"> + <summary> + Decodes an HTML-encoded <see cref="T:System.String"/> and returns the decoded <see cref="T:System.String"/>. + </summary> + <returns> + A <see cref="T:System.String"/> that represents the decoded string. + </returns> + <param name="s"> + A <see cref="T:System.String"/> to decode. + </param> + </member> + <member name="M:WebSocketSharp.Net.HttpUtility.HtmlDecode(System.String,System.IO.TextWriter)"> + <summary> + Decodes an HTML-encoded <see cref="T:System.String"/> and sends the decoded <see cref="T:System.String"/> + to the specified <see cref="T:System.IO.TextWriter"/>. + </summary> + <param name="s"> + A <see cref="T:System.String"/> to decode. + </param> + <param name="output"> + A <see cref="T:System.IO.TextWriter"/> that receives the decoded string. + </param> + </member> + <member name="M:WebSocketSharp.Net.HttpUtility.HtmlEncode(System.String)"> + <summary> + HTML-encodes a <see cref="T:System.String"/> and returns the encoded <see cref="T:System.String"/>. + </summary> + <returns> + A <see cref="T:System.String"/> that represents the encoded string. + </returns> + <param name="s"> + A <see cref="T:System.String"/> to encode. + </param> + </member> + <member name="M:WebSocketSharp.Net.HttpUtility.HtmlEncode(System.String,System.IO.TextWriter)"> + <summary> + HTML-encodes a <see cref="T:System.String"/> and sends the encoded <see cref="T:System.String"/> + to the specified <see cref="T:System.IO.TextWriter"/>. + </summary> + <param name="s"> + A <see cref="T:System.String"/> to encode. + </param> + <param name="output"> + A <see cref="T:System.IO.TextWriter"/> that receives the encoded string. + </param> + </member> + <member name="T:WebSocketSharp.Net.HttpVersion"> + <summary> + Provides the HTTP version numbers. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpVersion.Version10"> + <summary> + Provides a <see cref="T:System.Version"/> instance for the HTTP/1.0. + </summary> + </member> + <member name="F:WebSocketSharp.Net.HttpVersion.Version11"> + <summary> + Provides a <see cref="T:System.Version"/> instance for the HTTP/1.1. + </summary> + </member> + <member name="M:WebSocketSharp.Net.HttpVersion.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.HttpVersion"/> class. + </summary> + </member> + <member name="T:WebSocketSharp.Net.NetworkCredential"> + <summary> + Provides the credentials for the password-based authentication. + </summary> + </member> + <member name="M:WebSocketSharp.Net.NetworkCredential.#ctor(System.String,System.String)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.NetworkCredential"/> class with + the specified <paramref name="username"/> and <paramref name="password"/>. + </summary> + <param name="username"> + A <see cref="T:System.String"/> that represents the username associated with + the credentials. + </param> + <param name="password"> + A <see cref="T:System.String"/> that represents the password for the username + associated with the credentials. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="username"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="username"/> is empty. + </exception> + </member> + <member name="M:WebSocketSharp.Net.NetworkCredential.#ctor(System.String,System.String,System.String,System.String[])"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.NetworkCredential"/> class with + the specified <paramref name="username"/>, <paramref name="password"/>, + <paramref name="domain"/> and <paramref name="roles"/>. + </summary> + <param name="username"> + A <see cref="T:System.String"/> that represents the username associated with + the credentials. + </param> + <param name="password"> + A <see cref="T:System.String"/> that represents the password for the username + associated with the credentials. + </param> + <param name="domain"> + A <see cref="T:System.String"/> that represents the domain associated with + the credentials. + </param> + <param name="roles"> + An array of <see cref="T:System.String"/> that represents the roles + associated with the credentials if any. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="username"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="username"/> is empty. + </exception> + </member> + <member name="P:WebSocketSharp.Net.NetworkCredential.Domain"> + <summary> + Gets the domain associated with the credentials. + </summary> + <remarks> + This property returns an empty string if the domain was + initialized with <see langword="null"/>. + </remarks> + <value> + A <see cref="T:System.String"/> that represents the domain name + to which the username belongs. + </value> + </member> + <member name="P:WebSocketSharp.Net.NetworkCredential.Password"> + <summary> + Gets the password for the username associated with the credentials. + </summary> + <remarks> + This property returns an empty string if the password was + initialized with <see langword="null"/>. + </remarks> + <value> + A <see cref="T:System.String"/> that represents the password. + </value> + </member> + <member name="P:WebSocketSharp.Net.NetworkCredential.Roles"> + <summary> + Gets the roles associated with the credentials. + </summary> + <remarks> + This property returns an empty array if the roles were + initialized with <see langword="null"/>. + </remarks> + <value> + An array of <see cref="T:System.String"/> that represents the role names + to which the username belongs. + </value> + </member> + <member name="P:WebSocketSharp.Net.NetworkCredential.Username"> + <summary> + Gets the username associated with the credentials. + </summary> + <value> + A <see cref="T:System.String"/> that represents the username. + </value> + </member> + <member name="T:WebSocketSharp.Net.ServerSslConfiguration"> + <summary> + Stores the parameters for the <see cref="T:System.Net.Security.SslStream"/> used by servers. + </summary> + </member> + <member name="M:WebSocketSharp.Net.ServerSslConfiguration.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> class. + </summary> + </member> + <member name="M:WebSocketSharp.Net.ServerSslConfiguration.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> class + with the specified <paramref name="serverCertificate"/>. + </summary> + <param name="serverCertificate"> + A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that represents the certificate used to + authenticate the server. + </param> + </member> + <member name="M:WebSocketSharp.Net.ServerSslConfiguration.#ctor(WebSocketSharp.Net.ServerSslConfiguration)"> + <summary> + Copies the parameters from the specified <paramref name="configuration"/> to + a new instance of the <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> class. + </summary> + <param name="configuration"> + A <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> from which to copy. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="configuration"/> is <see langword="null"/>. + </exception> + </member> + <member name="P:WebSocketSharp.Net.ServerSslConfiguration.CheckCertificateRevocation"> + <summary> + Gets or sets a value indicating whether the certificate revocation + list is checked during authentication. + </summary> + <value> + <para> + <c>true</c> if the certificate revocation list is checked during + authentication; otherwise, <c>false</c>. + </para> + <para> + The default value is <c>false</c>. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Net.ServerSslConfiguration.ClientCertificateRequired"> + <summary> + Gets or sets a value indicating whether the client is asked for + a certificate for authentication. + </summary> + <value> + <para> + <c>true</c> if the client is asked for a certificate for + authentication; otherwise, <c>false</c>. + </para> + <para> + The default value is <c>false</c>. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Net.ServerSslConfiguration.ClientCertificateValidationCallback"> + <summary> + Gets or sets the callback used to validate the certificate + supplied by the client. + </summary> + <remarks> + The certificate is valid if the callback returns <c>true</c>. + </remarks> + <value> + <para> + A <see cref="T:System.Net.Security.RemoteCertificateValidationCallback"/> delegate that + invokes the method called for validating the certificate. + </para> + <para> + The default value is a delegate that invokes a method that + only returns <c>true</c>. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Net.ServerSslConfiguration.EnabledSslProtocols"> + <summary> + Gets or sets the protocols used for authentication. + </summary> + <value> + <para> + The <see cref="T:System.Security.Authentication.SslProtocols"/> enum values that represent + the protocols used for authentication. + </para> + <para> + The default value is <see cref="F:System.Security.Authentication.SslProtocols.Default"/>. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Net.ServerSslConfiguration.ServerCertificate"> + <summary> + Gets or sets the certificate used to authenticate the server. + </summary> + <value> + <para> + A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> or <see langword="null"/> + if not specified. + </para> + <para> + That instance represents an X.509 certificate. + </para> + </value> + </member> + <member name="T:WebSocketSharp.Net.WebHeaderCollection"> + <summary> + Provides a collection of the HTTP headers associated with a request or response. + </summary> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> class from + the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> and <see cref="T:System.Runtime.Serialization.StreamingContext"/>. + </summary> + <param name="serializationInfo"> + A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that contains the serialized object data. + </param> + <param name="streamingContext"> + A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the source for the deserialization. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="serializationInfo"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + An element with the specified name isn't found in <paramref name="serializationInfo"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> class. + </summary> + </member> + <member name="P:WebSocketSharp.Net.WebHeaderCollection.AllKeys"> + <summary> + Gets all header names in the collection. + </summary> + <value> + An array of <see cref="T:System.String"/> that contains all header names in the collection. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebHeaderCollection.Count"> + <summary> + Gets the number of headers in the collection. + </summary> + <value> + An <see cref="T:System.Int32"/> that represents the number of headers in the collection. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebHeaderCollection.Item(WebSocketSharp.Net.HttpRequestHeader)"> + <summary> + Gets or sets the specified request <paramref name="header"/> in the collection. + </summary> + <value> + A <see cref="T:System.String"/> that represents the value of the request <paramref name="header"/>. + </value> + <param name="header"> + One of the <see cref="T:WebSocketSharp.Net.HttpRequestHeader"/> enum values, represents + the request header to get or set. + </param> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="header"/> is a restricted header. + </para> + <para> + -or- + </para> + <para> + <paramref name="value"/> contains invalid characters. + </para> + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + The length of <paramref name="value"/> is greater than 65,535 characters. + </exception> + <exception cref="T:System.InvalidOperationException"> + The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow + the request <paramref name="header"/>. + </exception> + </member> + <member name="P:WebSocketSharp.Net.WebHeaderCollection.Item(WebSocketSharp.Net.HttpResponseHeader)"> + <summary> + Gets or sets the specified response <paramref name="header"/> in the collection. + </summary> + <value> + A <see cref="T:System.String"/> that represents the value of the response <paramref name="header"/>. + </value> + <param name="header"> + One of the <see cref="T:WebSocketSharp.Net.HttpResponseHeader"/> enum values, represents + the response header to get or set. + </param> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="header"/> is a restricted header. + </para> + <para> + -or- + </para> + <para> + <paramref name="value"/> contains invalid characters. + </para> + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + The length of <paramref name="value"/> is greater than 65,535 characters. + </exception> + <exception cref="T:System.InvalidOperationException"> + The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow + the response <paramref name="header"/>. + </exception> + </member> + <member name="P:WebSocketSharp.Net.WebHeaderCollection.Keys"> + <summary> + Gets a collection of header names in the collection. + </summary> + <value> + A <see cref="T:System.Collections.Specialized.NameObjectCollectionBase.KeysCollection"/> that contains + all header names in the collection. + </value> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.AddWithoutValidate(System.String,System.String)"> + <summary> + Adds a header to the collection without checking if the header is on + the restricted header list. + </summary> + <param name="headerName"> + A <see cref="T:System.String"/> that represents the name of the header to add. + </param> + <param name="headerValue"> + A <see cref="T:System.String"/> that represents the value of the header to add. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="headerName"/> is <see langword="null"/> or empty. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="headerName"/> or <paramref name="headerValue"/> contains invalid characters. + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + The length of <paramref name="headerValue"/> is greater than 65,535 characters. + </exception> + <exception cref="T:System.InvalidOperationException"> + The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow + the <paramref name="headerName"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.Add(System.String)"> + <summary> + Adds the specified <paramref name="header"/> to the collection. + </summary> + <param name="header"> + A <see cref="T:System.String"/> that represents the header with the name and value separated by + a colon (<c>':'</c>). + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="header"/> is <see langword="null"/>, empty, or the name part of + <paramref name="header"/> is empty. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="header"/> doesn't contain a colon. + </para> + <para> + -or- + </para> + <para> + <paramref name="header"/> is a restricted header. + </para> + <para> + -or- + </para> + <para> + The name or value part of <paramref name="header"/> contains invalid characters. + </para> + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + The length of the value part of <paramref name="header"/> is greater than 65,535 characters. + </exception> + <exception cref="T:System.InvalidOperationException"> + The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow + the <paramref name="header"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.Add(WebSocketSharp.Net.HttpRequestHeader,System.String)"> + <summary> + Adds the specified request <paramref name="header"/> with + the specified <paramref name="value"/> to the collection. + </summary> + <param name="header"> + One of the <see cref="T:WebSocketSharp.Net.HttpRequestHeader"/> enum values, represents + the request header to add. + </param> + <param name="value"> + A <see cref="T:System.String"/> that represents the value of the header to add. + </param> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="header"/> is a restricted header. + </para> + <para> + -or- + </para> + <para> + <paramref name="value"/> contains invalid characters. + </para> + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + The length of <paramref name="value"/> is greater than 65,535 characters. + </exception> + <exception cref="T:System.InvalidOperationException"> + The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow + the request <paramref name="header"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.Add(WebSocketSharp.Net.HttpResponseHeader,System.String)"> + <summary> + Adds the specified response <paramref name="header"/> with + the specified <paramref name="value"/> to the collection. + </summary> + <param name="header"> + One of the <see cref="T:WebSocketSharp.Net.HttpResponseHeader"/> enum values, represents + the response header to add. + </param> + <param name="value"> + A <see cref="T:System.String"/> that represents the value of the header to add. + </param> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="header"/> is a restricted header. + </para> + <para> + -or- + </para> + <para> + <paramref name="value"/> contains invalid characters. + </para> + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + The length of <paramref name="value"/> is greater than 65,535 characters. + </exception> + <exception cref="T:System.InvalidOperationException"> + The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow + the response <paramref name="header"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.Add(System.String,System.String)"> + <summary> + Adds a header with the specified <paramref name="name"/> and + <paramref name="value"/> to the collection. + </summary> + <param name="name"> + A <see cref="T:System.String"/> that represents the name of the header to add. + </param> + <param name="value"> + A <see cref="T:System.String"/> that represents the value of the header to add. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="name"/> is <see langword="null"/> or empty. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="name"/> or <paramref name="value"/> contains invalid characters. + </para> + <para> + -or- + </para> + <para> + <paramref name="name"/> is a restricted header name. + </para> + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + The length of <paramref name="value"/> is greater than 65,535 characters. + </exception> + <exception cref="T:System.InvalidOperationException"> + The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow + the header <paramref name="name"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.Clear"> + <summary> + Removes all headers from the collection. + </summary> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.Get(System.Int32)"> + <summary> + Get the value of the header at the specified <paramref name="index"/> in the collection. + </summary> + <returns> + A <see cref="T:System.String"/> that receives the value of the header. + </returns> + <param name="index"> + An <see cref="T:System.Int32"/> that represents the zero-based index of the header to find. + </param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <paramref name="index"/> is out of allowable range of indexes for the collection. + </exception> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.Get(System.String)"> + <summary> + Get the value of the header with the specified <paramref name="name"/> in the collection. + </summary> + <returns> + A <see cref="T:System.String"/> that receives the value of the header if found; + otherwise, <see langword="null"/>. + </returns> + <param name="name"> + A <see cref="T:System.String"/> that represents the name of the header to find. + </param> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.GetEnumerator"> + <summary> + Gets the enumerator used to iterate through the collection. + </summary> + <returns> + An <see cref="T:System.Collections.IEnumerator"/> instance used to iterate through the collection. + </returns> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.GetKey(System.Int32)"> + <summary> + Get the name of the header at the specified <paramref name="index"/> in the collection. + </summary> + <returns> + A <see cref="T:System.String"/> that receives the header name. + </returns> + <param name="index"> + An <see cref="T:System.Int32"/> that represents the zero-based index of the header to find. + </param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <paramref name="index"/> is out of allowable range of indexes for the collection. + </exception> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.GetValues(System.Int32)"> + <summary> + Gets an array of header values stored in the specified <paramref name="index"/> position of + the collection. + </summary> + <returns> + An array of <see cref="T:System.String"/> that receives the header values if found; + otherwise, <see langword="null"/>. + </returns> + <param name="index"> + An <see cref="T:System.Int32"/> that represents the zero-based index of the header to find. + </param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <paramref name="index"/> is out of allowable range of indexes for the collection. + </exception> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.GetValues(System.String)"> + <summary> + Gets an array of header values stored in the specified <paramref name="header"/>. + </summary> + <returns> + An array of <see cref="T:System.String"/> that receives the header values if found; + otherwise, <see langword="null"/>. + </returns> + <param name="header"> + A <see cref="T:System.String"/> that represents the name of the header to find. + </param> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> + <summary> + Populates the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with the data needed to serialize + the <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/>. + </summary> + <param name="serializationInfo"> + A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data. + </param> + <param name="streamingContext"> + A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the destination for the serialization. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="serializationInfo"/> is <see langword="null"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.IsRestricted(System.String)"> + <summary> + Determines whether the specified header can be set for the request. + </summary> + <returns> + <c>true</c> if the header is restricted; otherwise, <c>false</c>. + </returns> + <param name="headerName"> + A <see cref="T:System.String"/> that represents the name of the header to test. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="headerName"/> is <see langword="null"/> or empty. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="headerName"/> contains invalid characters. + </exception> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.IsRestricted(System.String,System.Boolean)"> + <summary> + Determines whether the specified header can be set for the request or the response. + </summary> + <returns> + <c>true</c> if the header is restricted; otherwise, <c>false</c>. + </returns> + <param name="headerName"> + A <see cref="T:System.String"/> that represents the name of the header to test. + </param> + <param name="response"> + <c>true</c> if does the test for the response; for the request, <c>false</c>. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="headerName"/> is <see langword="null"/> or empty. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="headerName"/> contains invalid characters. + </exception> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.OnDeserialization(System.Object)"> + <summary> + Implements the <see cref="T:System.Runtime.Serialization.ISerializable"/> interface and raises the deserialization event + when the deserialization is complete. + </summary> + <param name="sender"> + An <see cref="T:System.Object"/> that represents the source of the deserialization event. + </param> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.Remove(WebSocketSharp.Net.HttpRequestHeader)"> + <summary> + Removes the specified request <paramref name="header"/> from the collection. + </summary> + <param name="header"> + One of the <see cref="T:WebSocketSharp.Net.HttpRequestHeader"/> enum values, represents + the request header to remove. + </param> + <exception cref="T:System.ArgumentException"> + <paramref name="header"/> is a restricted header. + </exception> + <exception cref="T:System.InvalidOperationException"> + The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow + the request <paramref name="header"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.Remove(WebSocketSharp.Net.HttpResponseHeader)"> + <summary> + Removes the specified response <paramref name="header"/> from the collection. + </summary> + <param name="header"> + One of the <see cref="T:WebSocketSharp.Net.HttpResponseHeader"/> enum values, represents + the response header to remove. + </param> + <exception cref="T:System.ArgumentException"> + <paramref name="header"/> is a restricted header. + </exception> + <exception cref="T:System.InvalidOperationException"> + The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow + the response <paramref name="header"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.Remove(System.String)"> + <summary> + Removes the specified header from the collection. + </summary> + <param name="name"> + A <see cref="T:System.String"/> that represents the name of the header to remove. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="name"/> is <see langword="null"/> or empty. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="name"/> contains invalid characters. + </para> + <para> + -or- + </para> + <para> + <paramref name="name"/> is a restricted header name. + </para> + </exception> + <exception cref="T:System.InvalidOperationException"> + The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow + the header <paramref name="name"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.Set(WebSocketSharp.Net.HttpRequestHeader,System.String)"> + <summary> + Sets the specified request <paramref name="header"/> to the specified value. + </summary> + <param name="header"> + One of the <see cref="T:WebSocketSharp.Net.HttpRequestHeader"/> enum values, represents + the request header to set. + </param> + <param name="value"> + A <see cref="T:System.String"/> that represents the value of the request header to set. + </param> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="header"/> is a restricted header. + </para> + <para> + -or- + </para> + <para> + <paramref name="value"/> contains invalid characters. + </para> + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + The length of <paramref name="value"/> is greater than 65,535 characters. + </exception> + <exception cref="T:System.InvalidOperationException"> + The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow + the request <paramref name="header"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.Set(WebSocketSharp.Net.HttpResponseHeader,System.String)"> + <summary> + Sets the specified response <paramref name="header"/> to the specified value. + </summary> + <param name="header"> + One of the <see cref="T:WebSocketSharp.Net.HttpResponseHeader"/> enum values, represents + the response header to set. + </param> + <param name="value"> + A <see cref="T:System.String"/> that represents the value of the response header to set. + </param> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="header"/> is a restricted header. + </para> + <para> + -or- + </para> + <para> + <paramref name="value"/> contains invalid characters. + </para> + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + The length of <paramref name="value"/> is greater than 65,535 characters. + </exception> + <exception cref="T:System.InvalidOperationException"> + The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow + the response <paramref name="header"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.Set(System.String,System.String)"> + <summary> + Sets the specified header to the specified value. + </summary> + <param name="name"> + A <see cref="T:System.String"/> that represents the name of the header to set. + </param> + <param name="value"> + A <see cref="T:System.String"/> that represents the value of the header to set. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="name"/> is <see langword="null"/> or empty. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="name"/> or <paramref name="value"/> contains invalid characters. + </para> + <para> + -or- + </para> + <para> + <paramref name="name"/> is a restricted header name. + </para> + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + The length of <paramref name="value"/> is greater than 65,535 characters. + </exception> + <exception cref="T:System.InvalidOperationException"> + The current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> instance doesn't allow + the header <paramref name="name"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.ToByteArray"> + <summary> + Converts the current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/> to an array of <see cref="T:System.Byte"/>. + </summary> + <returns> + An array of <see cref="T:System.Byte"/> that receives the converted current + <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/>. + </returns> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.ToString"> + <summary> + Returns a <see cref="T:System.String"/> that represents the current + <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/>. + </summary> + <returns> + A <see cref="T:System.String"/> that represents the current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/>. + </returns> + </member> + <member name="M:WebSocketSharp.Net.WebHeaderCollection.System#Runtime#Serialization#ISerializable#GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> + <summary> + Populates the specified <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with the data needed to serialize + the current <see cref="T:WebSocketSharp.Net.WebHeaderCollection"/>. + </summary> + <param name="serializationInfo"> + A <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data. + </param> + <param name="streamingContext"> + A <see cref="T:System.Runtime.Serialization.StreamingContext"/> that specifies the destination for the serialization. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="serializationInfo"/> is <see langword="null"/>. + </exception> + </member> + <member name="T:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext"> + <summary> + Provides the properties used to access the information in + a WebSocket handshake request received by the <see cref="T:WebSocketSharp.Net.HttpListener"/>. + </summary> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.CookieCollection"> + <summary> + Gets the HTTP cookies included in the request. + </summary> + <value> + A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.Headers"> + <summary> + Gets the HTTP headers included in the request. + </summary> + <value> + A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the headers. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.Host"> + <summary> + Gets the value of the Host header included in the request. + </summary> + <value> + A <see cref="T:System.String"/> that represents the value of the Host header. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.IsAuthenticated"> + <summary> + Gets a value indicating whether the client is authenticated. + </summary> + <value> + <c>true</c> if the client is authenticated; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.IsLocal"> + <summary> + Gets a value indicating whether the client connected from the local computer. + </summary> + <value> + <c>true</c> if the client connected from the local computer; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.IsSecureConnection"> + <summary> + Gets a value indicating whether the WebSocket connection is secured. + </summary> + <value> + <c>true</c> if the connection is secured; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.IsWebSocketRequest"> + <summary> + Gets a value indicating whether the request is a WebSocket handshake request. + </summary> + <value> + <c>true</c> if the request is a WebSocket handshake request; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.Origin"> + <summary> + Gets the value of the Origin header included in the request. + </summary> + <value> + A <see cref="T:System.String"/> that represents the value of the Origin header. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.QueryString"> + <summary> + Gets the query string included in the request. + </summary> + <value> + A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the query string parameters. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.RequestUri"> + <summary> + Gets the URI requested by the client. + </summary> + <value> + A <see cref="T:System.Uri"/> that represents the requested URI. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.SecWebSocketKey"> + <summary> + Gets the value of the Sec-WebSocket-Key header included in the request. + </summary> + <remarks> + This property provides a part of the information used by the server to prove that + it received a valid WebSocket handshake request. + </remarks> + <value> + A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Key header. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.SecWebSocketProtocols"> + <summary> + Gets the values of the Sec-WebSocket-Protocol header included in the request. + </summary> + <remarks> + This property represents the subprotocols requested by the client. + </remarks> + <value> + An <see cref="T:System.Collections.Generic.IEnumerable{string}"/> instance that provides + an enumerator which supports the iteration over the values of the Sec-WebSocket-Protocol + header. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.SecWebSocketVersion"> + <summary> + Gets the value of the Sec-WebSocket-Version header included in the request. + </summary> + <remarks> + This property represents the WebSocket protocol version. + </remarks> + <value> + A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Version header. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.ServerEndPoint"> + <summary> + Gets the server endpoint as an IP address and a port number. + </summary> + <value> + A <see cref="T:System.Net.IPEndPoint"/> that represents the server endpoint. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.User"> + <summary> + Gets the client information (identity, authentication, and security roles). + </summary> + <value> + A <see cref="T:System.Security.Principal.IPrincipal"/> instance that represents the client information. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.UserEndPoint"> + <summary> + Gets the client endpoint as an IP address and a port number. + </summary> + <value> + A <see cref="T:System.Net.IPEndPoint"/> that represents the client endpoint. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.WebSocket"> + <summary> + Gets the <see cref="T:WebSocketSharp.WebSocket"/> instance used for + two-way communication between client and server. + </summary> + <value> + A <see cref="T:WebSocketSharp.WebSocket"/>. + </value> + </member> + <member name="M:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext.ToString"> + <summary> + Returns a <see cref="T:System.String"/> that represents + the current <see cref="T:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext"/>. + </summary> + <returns> + A <see cref="T:System.String"/> that represents + the current <see cref="T:WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext"/>. + </returns> + </member> + <member name="T:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext"> + <summary> + Provides the properties used to access the information in + a WebSocket handshake request received by the <see cref="T:System.Net.Sockets.TcpListener"/>. + </summary> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.CookieCollection"> + <summary> + Gets the HTTP cookies included in the request. + </summary> + <value> + A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.Headers"> + <summary> + Gets the HTTP headers included in the request. + </summary> + <value> + A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the headers. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.Host"> + <summary> + Gets the value of the Host header included in the request. + </summary> + <value> + A <see cref="T:System.String"/> that represents the value of the Host header. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.IsAuthenticated"> + <summary> + Gets a value indicating whether the client is authenticated. + </summary> + <value> + <c>true</c> if the client is authenticated; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.IsLocal"> + <summary> + Gets a value indicating whether the client connected from the local computer. + </summary> + <value> + <c>true</c> if the client connected from the local computer; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.IsSecureConnection"> + <summary> + Gets a value indicating whether the WebSocket connection is secured. + </summary> + <value> + <c>true</c> if the connection is secured; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.IsWebSocketRequest"> + <summary> + Gets a value indicating whether the request is a WebSocket handshake request. + </summary> + <value> + <c>true</c> if the request is a WebSocket handshake request; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.Origin"> + <summary> + Gets the value of the Origin header included in the request. + </summary> + <value> + A <see cref="T:System.String"/> that represents the value of the Origin header. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.QueryString"> + <summary> + Gets the query string included in the request. + </summary> + <value> + A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the query string parameters. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.RequestUri"> + <summary> + Gets the URI requested by the client. + </summary> + <value> + A <see cref="T:System.Uri"/> that represents the requested URI. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.SecWebSocketKey"> + <summary> + Gets the value of the Sec-WebSocket-Key header included in the request. + </summary> + <remarks> + This property provides a part of the information used by the server to prove that + it received a valid WebSocket handshake request. + </remarks> + <value> + A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Key header. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.SecWebSocketProtocols"> + <summary> + Gets the values of the Sec-WebSocket-Protocol header included in the request. + </summary> + <remarks> + This property represents the subprotocols requested by the client. + </remarks> + <value> + An <see cref="T:System.Collections.Generic.IEnumerable{string}"/> instance that provides + an enumerator which supports the iteration over the values of the Sec-WebSocket-Protocol + header. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.SecWebSocketVersion"> + <summary> + Gets the value of the Sec-WebSocket-Version header included in the request. + </summary> + <remarks> + This property represents the WebSocket protocol version. + </remarks> + <value> + A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Version header. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.ServerEndPoint"> + <summary> + Gets the server endpoint as an IP address and a port number. + </summary> + <value> + A <see cref="T:System.Net.IPEndPoint"/> that represents the server endpoint. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.User"> + <summary> + Gets the client information (identity, authentication, and security roles). + </summary> + <value> + A <see cref="T:System.Security.Principal.IPrincipal"/> instance that represents the client information. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.UserEndPoint"> + <summary> + Gets the client endpoint as an IP address and a port number. + </summary> + <value> + A <see cref="T:System.Net.IPEndPoint"/> that represents the client endpoint. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.WebSocket"> + <summary> + Gets the <see cref="T:WebSocketSharp.WebSocket"/> instance used for + two-way communication between client and server. + </summary> + <value> + A <see cref="T:WebSocketSharp.WebSocket"/>. + </value> + </member> + <member name="M:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext.ToString"> + <summary> + Returns a <see cref="T:System.String"/> that represents + the current <see cref="T:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext"/>. + </summary> + <returns> + A <see cref="T:System.String"/> that represents + the current <see cref="T:WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext"/>. + </returns> + </member> + <member name="T:WebSocketSharp.Net.WebSockets.WebSocketContext"> + <summary> + Exposes the properties used to access the information in a WebSocket handshake request. + </summary> + <remarks> + This class is an abstract class. + </remarks> + </member> + <member name="M:WebSocketSharp.Net.WebSockets.WebSocketContext.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Net.WebSockets.WebSocketContext"/> class. + </summary> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.CookieCollection"> + <summary> + Gets the HTTP cookies included in the request. + </summary> + <value> + A <see cref="T:WebSocketSharp.Net.CookieCollection"/> that contains the cookies. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.Headers"> + <summary> + Gets the HTTP headers included in the request. + </summary> + <value> + A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the headers. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.Host"> + <summary> + Gets the value of the Host header included in the request. + </summary> + <value> + A <see cref="T:System.String"/> that represents the value of the Host header. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.IsAuthenticated"> + <summary> + Gets a value indicating whether the client is authenticated. + </summary> + <value> + <c>true</c> if the client is authenticated; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.IsLocal"> + <summary> + Gets a value indicating whether the client connected from the local computer. + </summary> + <value> + <c>true</c> if the client connected from the local computer; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.IsSecureConnection"> + <summary> + Gets a value indicating whether the WebSocket connection is secured. + </summary> + <value> + <c>true</c> if the connection is secured; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.IsWebSocketRequest"> + <summary> + Gets a value indicating whether the request is a WebSocket handshake request. + </summary> + <value> + <c>true</c> if the request is a WebSocket handshake request; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.Origin"> + <summary> + Gets the value of the Origin header included in the request. + </summary> + <value> + A <see cref="T:System.String"/> that represents the value of the Origin header. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.QueryString"> + <summary> + Gets the query string included in the request. + </summary> + <value> + A <see cref="T:System.Collections.Specialized.NameValueCollection"/> that contains the query string parameters. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.RequestUri"> + <summary> + Gets the URI requested by the client. + </summary> + <value> + A <see cref="T:System.Uri"/> that represents the requested URI. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.SecWebSocketKey"> + <summary> + Gets the value of the Sec-WebSocket-Key header included in the request. + </summary> + <remarks> + This property provides a part of the information used by the server to prove that + it received a valid WebSocket handshake request. + </remarks> + <value> + A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Key header. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.SecWebSocketProtocols"> + <summary> + Gets the values of the Sec-WebSocket-Protocol header included in the request. + </summary> + <remarks> + This property represents the subprotocols requested by the client. + </remarks> + <value> + An <see cref="T:System.Collections.Generic.IEnumerable{string}"/> instance that provides + an enumerator which supports the iteration over the values of the Sec-WebSocket-Protocol + header. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.SecWebSocketVersion"> + <summary> + Gets the value of the Sec-WebSocket-Version header included in the request. + </summary> + <remarks> + This property represents the WebSocket protocol version. + </remarks> + <value> + A <see cref="T:System.String"/> that represents the value of the Sec-WebSocket-Version header. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.ServerEndPoint"> + <summary> + Gets the server endpoint as an IP address and a port number. + </summary> + <value> + A <see cref="T:System.Net.IPEndPoint"/> that represents the server endpoint. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.User"> + <summary> + Gets the client information (identity, authentication, and security roles). + </summary> + <value> + A <see cref="T:System.Security.Principal.IPrincipal"/> instance that represents the client information. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.UserEndPoint"> + <summary> + Gets the client endpoint as an IP address and a port number. + </summary> + <value> + A <see cref="T:System.Net.IPEndPoint"/> that represents the client endpoint. + </value> + </member> + <member name="P:WebSocketSharp.Net.WebSockets.WebSocketContext.WebSocket"> + <summary> + Gets the <see cref="T:WebSocketSharp.WebSocket"/> instance used for + two-way communication between client and server. + </summary> + <value> + A <see cref="T:WebSocketSharp.WebSocket"/>. + </value> + </member> + <member name="T:WebSocketSharp.Opcode"> + <summary> + Indicates the WebSocket frame type. + </summary> + <remarks> + The values of this enumeration are defined in + <see href="http://tools.ietf.org/html/rfc6455#section-5.2"> + Section 5.2</see> of RFC 6455. + </remarks> + </member> + <member name="F:WebSocketSharp.Opcode.Cont"> + <summary> + Equivalent to numeric value 0. Indicates continuation frame. + </summary> + </member> + <member name="F:WebSocketSharp.Opcode.Text"> + <summary> + Equivalent to numeric value 1. Indicates text frame. + </summary> + </member> + <member name="F:WebSocketSharp.Opcode.Binary"> + <summary> + Equivalent to numeric value 2. Indicates binary frame. + </summary> + </member> + <member name="F:WebSocketSharp.Opcode.Close"> + <summary> + Equivalent to numeric value 8. Indicates connection close frame. + </summary> + </member> + <member name="F:WebSocketSharp.Opcode.Ping"> + <summary> + Equivalent to numeric value 9. Indicates ping frame. + </summary> + </member> + <member name="F:WebSocketSharp.Opcode.Pong"> + <summary> + Equivalent to numeric value 10. Indicates pong frame. + </summary> + </member> + <member name="F:WebSocketSharp.PayloadData.Empty"> + <summary> + Represents the empty payload data. + </summary> + </member> + <member name="F:WebSocketSharp.PayloadData.MaxLength"> + <summary> + Represents the allowable max length. + </summary> + <remarks> + <para> + A <see cref="T:WebSocketSharp.WebSocketException"/> will occur if the payload data length is + greater than the value of this field. + </para> + <para> + If you would like to change the value, you must set it to a value between + <c>WebSocket.FragmentLength</c> and <c>Int64.MaxValue</c> inclusive. + </para> + </remarks> + </member> + <member name="T:WebSocketSharp.Rsv"> + <summary> + Indicates whether each RSV (RSV1, RSV2, and RSV3) of a WebSocket frame is non-zero. + </summary> + <remarks> + The values of this enumeration are defined in + <see href="http://tools.ietf.org/html/rfc6455#section-5.2">Section 5.2</see> of RFC 6455. + </remarks> + </member> + <member name="F:WebSocketSharp.Rsv.Off"> + <summary> + Equivalent to numeric value 0. Indicates zero. + </summary> + </member> + <member name="F:WebSocketSharp.Rsv.On"> + <summary> + Equivalent to numeric value 1. Indicates non-zero. + </summary> + </member> + <member name="T:WebSocketSharp.Server.HttpRequestEventArgs"> + <summary> + Represents the event data for the HTTP request events of + the <see cref="T:WebSocketSharp.Server.HttpServer"/>. + </summary> + <remarks> + <para> + An HTTP request event occurs when the <see cref="T:WebSocketSharp.Server.HttpServer"/> + receives an HTTP request. + </para> + <para> + You should access the <see cref="P:WebSocketSharp.Server.HttpRequestEventArgs.Request"/> property if you would + like to get the request data sent from a client. + </para> + <para> + And you should access the <see cref="P:WebSocketSharp.Server.HttpRequestEventArgs.Response"/> property if you would + like to get the response data to return to the client. + </para> + </remarks> + </member> + <member name="P:WebSocketSharp.Server.HttpRequestEventArgs.Request"> + <summary> + Gets the request data sent from a client. + </summary> + <value> + A <see cref="T:WebSocketSharp.Net.HttpListenerRequest"/> that provides the methods and + properties for the request data. + </value> + </member> + <member name="P:WebSocketSharp.Server.HttpRequestEventArgs.Response"> + <summary> + Gets the response data to return to the client. + </summary> + <value> + A <see cref="T:WebSocketSharp.Net.HttpListenerResponse"/> that provides the methods and + properties for the response data. + </value> + </member> + <member name="P:WebSocketSharp.Server.HttpRequestEventArgs.User"> + <summary> + Gets the information for the client. + </summary> + <value> + <para> + A <see cref="T:System.Security.Principal.IPrincipal"/> instance or <see langword="null"/> + if not authenticated. + </para> + <para> + That instance describes the identity, authentication scheme, + and security roles for the client. + </para> + </value> + </member> + <member name="M:WebSocketSharp.Server.HttpRequestEventArgs.ReadFile(System.String)"> + <summary> + Reads the specified file from the document folder of + the <see cref="T:WebSocketSharp.Server.HttpServer"/>. + </summary> + <returns> + <para> + An array of <see cref="T:System.Byte"/> or <see langword="null"/> + if it fails. + </para> + <para> + That array receives the contents of the file. + </para> + </returns> + <param name="path"> + A <see cref="T:System.String"/> that represents a virtual path to + find the file from the document folder. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="path"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="path"/> is an empty string. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> contains "..". + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.HttpRequestEventArgs.TryReadFile(System.String,System.Byte[]@)"> + <summary> + Tries to read the specified file from the document folder of + the <see cref="T:WebSocketSharp.Server.HttpServer"/>. + </summary> + <returns> + <c>true</c> if it succeeds to read; otherwise, <c>false</c>. + </returns> + <param name="path"> + A <see cref="T:System.String"/> that represents a virtual path to + find the file from the document folder. + </param> + <param name="contents"> + <para> + When this method returns, an array of <see cref="T:System.Byte"/> or + <see langword="null"/> if it fails. + </para> + <para> + That array receives the contents of the file. + </para> + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="path"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="path"/> is an empty string. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> contains "..". + </para> + </exception> + </member> + <member name="T:WebSocketSharp.Server.HttpServer"> + <summary> + Provides a simple HTTP server that allows to accept + WebSocket handshake requests. + </summary> + <remarks> + This class can provide multiple WebSocket services. + </remarks> + </member> + <member name="M:WebSocketSharp.Server.HttpServer.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class. + </summary> + <remarks> + The new instance listens for incoming requests on + <see cref="F:System.Net.IPAddress.Any"/> and port 80. + </remarks> + </member> + <member name="M:WebSocketSharp.Server.HttpServer.#ctor(System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class with + the specified <paramref name="port"/>. + </summary> + <remarks> + <para> + The new instance listens for incoming requests on + <see cref="F:System.Net.IPAddress.Any"/> and <paramref name="port"/>. + </para> + <para> + It provides secure connections if <paramref name="port"/> is 443. + </para> + </remarks> + <param name="port"> + An <see cref="T:System.Int32"/> that represents the number of the port + on which to listen. + </param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <paramref name="port"/> is less than 1 or greater than 65535. + </exception> + </member> + <member name="M:WebSocketSharp.Server.HttpServer.#ctor(System.String)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class with + the specified <paramref name="url"/>. + </summary> + <remarks> + <para> + The new instance listens for incoming requests on the IP address of the + host of <paramref name="url"/> and the port of <paramref name="url"/>. + </para> + <para> + Either port 80 or 443 is used if <paramref name="url"/> includes + no port. Port 443 is used if the scheme of <paramref name="url"/> + is https; otherwise, port 80 is used. + </para> + <para> + The new instance provides secure connections if the scheme of + <paramref name="url"/> is https. + </para> + </remarks> + <param name="url"> + A <see cref="T:System.String"/> that represents the HTTP URL of the server. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="url"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="url"/> is empty. + </para> + <para> + -or- + </para> + <para> + <paramref name="url"/> is invalid. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.HttpServer.#ctor(System.Int32,System.Boolean)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class with + the specified <paramref name="port"/> and <paramref name="secure"/>. + </summary> + <remarks> + The new instance listens for incoming requests on + <see cref="F:System.Net.IPAddress.Any"/> and <paramref name="port"/>. + </remarks> + <param name="port"> + An <see cref="T:System.Int32"/> that represents the number of the port + on which to listen. + </param> + <param name="secure"> + A <see cref="T:System.Boolean"/>: <c>true</c> if the new instance provides + secure connections; otherwise, <c>false</c>. + </param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <paramref name="port"/> is less than 1 or greater than 65535. + </exception> + </member> + <member name="M:WebSocketSharp.Server.HttpServer.#ctor(System.Net.IPAddress,System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class with + the specified <paramref name="address"/> and <paramref name="port"/>. + </summary> + <remarks> + <para> + The new instance listens for incoming requests on + <paramref name="address"/> and <paramref name="port"/>. + </para> + <para> + It provides secure connections if <paramref name="port"/> is 443. + </para> + </remarks> + <param name="address"> + A <see cref="T:System.Net.IPAddress"/> that represents + the local IP address on which to listen. + </param> + <param name="port"> + An <see cref="T:System.Int32"/> that represents the number of the port + on which to listen. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="address"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="address"/> is not a local IP address. + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + <paramref name="port"/> is less than 1 or greater than 65535. + </exception> + </member> + <member name="M:WebSocketSharp.Server.HttpServer.#ctor(System.Net.IPAddress,System.Int32,System.Boolean)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Server.HttpServer"/> class with + the specified <paramref name="address"/>, <paramref name="port"/>, + and <paramref name="secure"/>. + </summary> + <remarks> + The new instance listens for incoming requests on + <paramref name="address"/> and <paramref name="port"/>. + </remarks> + <param name="address"> + A <see cref="T:System.Net.IPAddress"/> that represents + the local IP address on which to listen. + </param> + <param name="port"> + An <see cref="T:System.Int32"/> that represents the number of the port + on which to listen. + </param> + <param name="secure"> + A <see cref="T:System.Boolean"/>: <c>true</c> if the new instance provides + secure connections; otherwise, <c>false</c>. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="address"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="address"/> is not a local IP address. + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + <paramref name="port"/> is less than 1 or greater than 65535. + </exception> + </member> + <member name="P:WebSocketSharp.Server.HttpServer.Address"> + <summary> + Gets the IP address of the server. + </summary> + <value> + A <see cref="T:System.Net.IPAddress"/> that represents the local + IP address on which to listen for incoming requests. + </value> + </member> + <member name="P:WebSocketSharp.Server.HttpServer.AuthenticationSchemes"> + <summary> + Gets or sets the scheme used to authenticate the clients. + </summary> + <remarks> + The set operation does nothing if the server has already + started or it is shutting down. + </remarks> + <value> + <para> + One of the <see cref="T:WebSocketSharp.Net.AuthenticationSchemes"/> + enum values. + </para> + <para> + It represents the scheme used to authenticate the clients. + </para> + <para> + The default value is + <see cref="F:WebSocketSharp.Net.AuthenticationSchemes.Anonymous"/>. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Server.HttpServer.DocumentRootPath"> + <summary> + Gets or sets the path to the document folder of the server. + </summary> + <remarks> + <para> + '/' or '\' is trimmed from the end of the value if any. + </para> + <para> + The set operation does nothing if the server has already + started or it is shutting down. + </para> + </remarks> + <value> + <para> + A <see cref="T:System.String"/> that represents a path to the folder + from which to find the requested file. + </para> + <para> + The default value is "./Public". + </para> + </value> + <exception cref="T:System.ArgumentNullException"> + The value specified for a set operation is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + The value specified for a set operation is an empty string. + </para> + <para> + -or- + </para> + <para> + The value specified for a set operation is an invalid path string. + </para> + <para> + -or- + </para> + <para> + The value specified for a set operation is an absolute root. + </para> + </exception> + </member> + <member name="P:WebSocketSharp.Server.HttpServer.IsListening"> + <summary> + Gets a value indicating whether the server has started. + </summary> + <value> + <c>true</c> if the server has started; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Server.HttpServer.IsSecure"> + <summary> + Gets a value indicating whether the server provides + secure connections. + </summary> + <value> + <c>true</c> if the server provides secure connections; + otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Server.HttpServer.KeepClean"> + <summary> + Gets or sets a value indicating whether the server cleans up + the inactive sessions periodically. + </summary> + <remarks> + The set operation does nothing if the server has already + started or it is shutting down. + </remarks> + <value> + <para> + <c>true</c> if the server cleans up the inactive sessions + every 60 seconds; otherwise, <c>false</c>. + </para> + <para> + The default value is <c>true</c>. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Server.HttpServer.Log"> + <summary> + Gets the logging function for the server. + </summary> + <remarks> + The default logging level is <see cref="F:WebSocketSharp.LogLevel.Error"/>. + </remarks> + <value> + A <see cref="T:WebSocketSharp.Logger"/> that provides the logging function. + </value> + </member> + <member name="P:WebSocketSharp.Server.HttpServer.Port"> + <summary> + Gets the port of the server. + </summary> + <value> + An <see cref="T:System.Int32"/> that represents the number of the port + on which to listen for incoming requests. + </value> + </member> + <member name="P:WebSocketSharp.Server.HttpServer.Realm"> + <summary> + Gets or sets the realm used for authentication. + </summary> + <remarks> + <para> + "SECRET AREA" is used as the realm if the value is + <see langword="null"/> or an empty string. + </para> + <para> + The set operation does nothing if the server has + already started or it is shutting down. + </para> + </remarks> + <value> + <para> + A <see cref="T:System.String"/> or <see langword="null"/> by default. + </para> + <para> + That string represents the name of the realm. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Server.HttpServer.ReuseAddress"> + <summary> + Gets or sets a value indicating whether the server is allowed to + be bound to an address that is already in use. + </summary> + <remarks> + <para> + You should set this property to <c>true</c> if you would + like to resolve to wait for socket in TIME_WAIT state. + </para> + <para> + The set operation does nothing if the server has already + started or it is shutting down. + </para> + </remarks> + <value> + <para> + <c>true</c> if the server is allowed to be bound to an address + that is already in use; otherwise, <c>false</c>. + </para> + <para> + The default value is <c>false</c>. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Server.HttpServer.SslConfiguration"> + <summary> + Gets the configuration for secure connections. + </summary> + <remarks> + This configuration will be referenced when attempts to start, + so it must be configured before the start method is called. + </remarks> + <value> + A <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> that represents + the configuration used to provide secure connections. + </value> + <exception cref="T:System.InvalidOperationException"> + This instance does not provide secure connections. + </exception> + </member> + <member name="P:WebSocketSharp.Server.HttpServer.UserCredentialsFinder"> + <summary> + Gets or sets the delegate used to find the credentials + for an identity. + </summary> + <remarks> + <para> + No credentials are found if the method invoked by + the delegate returns <see langword="null"/> or + the value is <see langword="null"/>. + </para> + <para> + The set operation does nothing if the server has + already started or it is shutting down. + </para> + </remarks> + <value> + <para> + A <c>Func<<see cref="T:System.Security.Principal.IIdentity"/>, + <see cref="T:WebSocketSharp.Net.NetworkCredential"/>></c> delegate or + <see langword="null"/> if not needed. + </para> + <para> + That delegate invokes the method called for finding + the credentials used to authenticate a client. + </para> + <para> + The default value is <see langword="null"/>. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Server.HttpServer.WaitTime"> + <summary> + Gets or sets the time to wait for the response to the WebSocket Ping or + Close. + </summary> + <remarks> + The set operation does nothing if the server has already started or + it is shutting down. + </remarks> + <value> + <para> + A <see cref="T:System.TimeSpan"/> to wait for the response. + </para> + <para> + The default value is the same as 1 second. + </para> + </value> + <exception cref="T:System.ArgumentOutOfRangeException"> + The value specified for a set operation is zero or less. + </exception> + </member> + <member name="P:WebSocketSharp.Server.HttpServer.WebSocketServices"> + <summary> + Gets the management function for the WebSocket services + provided by the server. + </summary> + <value> + A <see cref="T:WebSocketSharp.Server.WebSocketServiceManager"/> that manages + the WebSocket services provided by the server. + </value> + </member> + <member name="E:WebSocketSharp.Server.HttpServer.OnConnect"> + <summary> + Occurs when the server receives an HTTP CONNECT request. + </summary> + </member> + <member name="E:WebSocketSharp.Server.HttpServer.OnDelete"> + <summary> + Occurs when the server receives an HTTP DELETE request. + </summary> + </member> + <member name="E:WebSocketSharp.Server.HttpServer.OnGet"> + <summary> + Occurs when the server receives an HTTP GET request. + </summary> + </member> + <member name="E:WebSocketSharp.Server.HttpServer.OnHead"> + <summary> + Occurs when the server receives an HTTP HEAD request. + </summary> + </member> + <member name="E:WebSocketSharp.Server.HttpServer.OnOptions"> + <summary> + Occurs when the server receives an HTTP OPTIONS request. + </summary> + </member> + <member name="E:WebSocketSharp.Server.HttpServer.OnPatch"> + <summary> + Occurs when the server receives an HTTP PATCH request. + </summary> + </member> + <member name="E:WebSocketSharp.Server.HttpServer.OnPost"> + <summary> + Occurs when the server receives an HTTP POST request. + </summary> + </member> + <member name="E:WebSocketSharp.Server.HttpServer.OnPut"> + <summary> + Occurs when the server receives an HTTP PUT request. + </summary> + </member> + <member name="E:WebSocketSharp.Server.HttpServer.OnTrace"> + <summary> + Occurs when the server receives an HTTP TRACE request. + </summary> + </member> + <member name="M:WebSocketSharp.Server.HttpServer.AddWebSocketService``1(System.String,System.Func{``0})"> + <summary> + Adds a WebSocket service with the specified behavior, + <paramref name="path"/>, and <paramref name="creator"/>. + </summary> + <remarks> + <paramref name="path"/> is converted to a URL-decoded string and + '/' is trimmed from the end of the converted string if any. + </remarks> + <param name="path"> + A <see cref="T:System.String"/> that represents an absolute path to + the service to add. + </param> + <param name="creator"> + <para> + A <c>Func<TBehavior></c> delegate. + </para> + <para> + It invokes the method called for creating + a new session instance for the service. + </para> + <para> + The method must create a new instance of + the specified behavior class and return it. + </para> + </param> + <typeparam name="TBehavior"> + <para> + The type of the behavior for the service. + </para> + <para> + It must inherit the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class. + </para> + </typeparam> + <exception cref="T:System.ArgumentNullException"> + <para> + <paramref name="path"/> is <see langword="null"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="creator"/> is <see langword="null"/>. + </para> + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="path"/> is an empty string. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> is not an absolute path. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> includes either or both + query and fragment components. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> is already in use. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.HttpServer.AddWebSocketService``1(System.String)"> + <summary> + Adds a WebSocket service with the specified behavior and + <paramref name="path"/>. + </summary> + <remarks> + <paramref name="path"/> is converted to a URL-decoded string and + '/' is trimmed from the end of the converted string if any. + </remarks> + <param name="path"> + A <see cref="T:System.String"/> that represents an absolute path to + the service to add. + </param> + <typeparam name="TBehaviorWithNew"> + <para> + The type of the behavior for the service. + </para> + <para> + It must inherit the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class and + must have a public parameterless constructor. + </para> + </typeparam> + <exception cref="T:System.ArgumentNullException"> + <paramref name="path"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="path"/> is an empty string. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> is not an absolute path. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> includes either or both + query and fragment components. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> is already in use. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.HttpServer.AddWebSocketService``1(System.String,System.Action{``0})"> + <summary> + Adds a WebSocket service with the specified behavior, + <paramref name="path"/>, and <paramref name="initializer"/>. + </summary> + <remarks> + <paramref name="path"/> is converted to a URL-decoded string and + '/' is trimmed from the end of the converted string if any. + </remarks> + <param name="path"> + A <see cref="T:System.String"/> that represents an absolute path to + the service to add. + </param> + <param name="initializer"> + <para> + An <c>Action<TBehaviorWithNew></c> delegate or + <see langword="null"/> if not needed. + </para> + <para> + That delegate invokes the method called for initializing + a new session instance for the service. + </para> + </param> + <typeparam name="TBehaviorWithNew"> + <para> + The type of the behavior for the service. + </para> + <para> + It must inherit the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class and + must have a public parameterless constructor. + </para> + </typeparam> + <exception cref="T:System.ArgumentNullException"> + <paramref name="path"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="path"/> is an empty string. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> is not an absolute path. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> includes either or both + query and fragment components. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> is already in use. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.HttpServer.GetFile(System.String)"> + <summary> + Gets the contents of the specified file from the document + folder of the server. + </summary> + <returns> + <para> + An array of <see cref="T:System.Byte"/> or <see langword="null"/> + if it fails. + </para> + <para> + That array represents the contents of the file. + </para> + </returns> + <param name="path"> + A <see cref="T:System.String"/> that represents a virtual path to + find the file from the document folder. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="path"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="path"/> is an empty string. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> contains "..". + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.HttpServer.RemoveWebSocketService(System.String)"> + <summary> + Removes a WebSocket service with the specified <paramref name="path"/>. + </summary> + <remarks> + <para> + <paramref name="path"/> is converted to a URL-decoded string and + '/' is trimmed from the end of the converted string if any. + </para> + <para> + The service is stopped with close status 1001 (going away) + if it has already started. + </para> + </remarks> + <returns> + <c>true</c> if the service is successfully found and removed; + otherwise, <c>false</c>. + </returns> + <param name="path"> + A <see cref="T:System.String"/> that represents an absolute path to + the service to remove. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="path"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="path"/> is an empty string. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> is not an absolute path. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> includes either or both + query and fragment components. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.HttpServer.Start"> + <summary> + Starts receiving incoming requests. + </summary> + <remarks> + This method does nothing if the server has already started or + it is shutting down. + </remarks> + <exception cref="T:System.InvalidOperationException"> + <para> + There is no server certificate for secure connections. + </para> + <para> + -or- + </para> + <para> + The underlying <see cref="T:WebSocketSharp.Net.HttpListener"/> has failed to start. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.HttpServer.Stop"> + <summary> + Stops receiving incoming requests and closes each connection. + </summary> + <remarks> + This method does nothing if the server is not started, + it is shutting down, or it has already stopped. + </remarks> + </member> + <member name="M:WebSocketSharp.Server.HttpServer.Stop(System.UInt16,System.String)"> + <summary> + Stops receiving incoming requests and closes each connection. + </summary> + <remarks> + This method does nothing if the server is not started, + it is shutting down, or it has already stopped. + </remarks> + <param name="code"> + <para> + A <see cref="T:System.UInt16"/> that represents the status code + indicating the reason for the WebSocket connection close. + </para> + <para> + The status codes are defined in + <see href="http://tools.ietf.org/html/rfc6455#section-7.4"> + Section 7.4</see> of RFC 6455. + </para> + </param> + <param name="reason"> + <para> + A <see cref="T:System.String"/> that represents the reason for + the WebSocket connection close. + </para> + <para> + The size must be 123 bytes or less in UTF-8. + </para> + </param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <para> + <paramref name="code"/> is less than 1000 or greater than 4999. + </para> + <para> + -or- + </para> + <para> + The size of <paramref name="reason"/> is greater than 123 bytes. + </para> + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="code"/> is 1010 (mandatory extension). + </para> + <para> + -or- + </para> + <para> + <paramref name="code"/> is 1005 (no status) and + there is <paramref name="reason"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="reason"/> could not be UTF-8-encoded. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.HttpServer.Stop(WebSocketSharp.CloseStatusCode,System.String)"> + <summary> + Stops receiving incoming requests and closes each connection. + </summary> + <remarks> + This method does nothing if the server is not started, + it is shutting down, or it has already stopped. + </remarks> + <param name="code"> + <para> + One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values. + </para> + <para> + It represents the status code indicating the reason for + the WebSocket connection close. + </para> + </param> + <param name="reason"> + <para> + A <see cref="T:System.String"/> that represents the reason for + the WebSocket connection close. + </para> + <para> + The size must be 123 bytes or less in UTF-8. + </para> + </param> + <exception cref="T:System.ArgumentOutOfRangeException"> + The size of <paramref name="reason"/> is greater than 123 bytes. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="code"/> is + <see cref="F:WebSocketSharp.CloseStatusCode.MandatoryExtension"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="code"/> is + <see cref="F:WebSocketSharp.CloseStatusCode.NoStatus"/> and + there is <paramref name="reason"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="reason"/> could not be UTF-8-encoded. + </para> + </exception> + </member> + <member name="T:WebSocketSharp.Server.IWebSocketSession"> + <summary> + Exposes the properties used to access the information in a session in a WebSocket service. + </summary> + </member> + <member name="P:WebSocketSharp.Server.IWebSocketSession.Context"> + <summary> + Gets the information in the connection request to the WebSocket service. + </summary> + <value> + A <see cref="T:WebSocketSharp.Net.WebSockets.WebSocketContext"/> that provides the access to the connection request. + </value> + </member> + <member name="P:WebSocketSharp.Server.IWebSocketSession.ID"> + <summary> + Gets the unique ID of the session. + </summary> + <value> + A <see cref="T:System.String"/> that represents the unique ID of the session. + </value> + </member> + <member name="P:WebSocketSharp.Server.IWebSocketSession.Protocol"> + <summary> + Gets the WebSocket subprotocol used in the session. + </summary> + <value> + A <see cref="T:System.String"/> that represents the subprotocol if any. + </value> + </member> + <member name="P:WebSocketSharp.Server.IWebSocketSession.StartTime"> + <summary> + Gets the time that the session has started. + </summary> + <value> + A <see cref="T:System.DateTime"/> that represents the time that the session has started. + </value> + </member> + <member name="P:WebSocketSharp.Server.IWebSocketSession.State"> + <summary> + Gets the state of the <see cref="T:WebSocketSharp.WebSocket"/> used in the session. + </summary> + <value> + One of the <see cref="T:WebSocketSharp.WebSocketState"/> enum values, indicates the state of + the <see cref="T:WebSocketSharp.WebSocket"/> used in the session. + </value> + </member> + <member name="T:WebSocketSharp.Server.WebSocketBehavior"> + <summary> + Exposes the methods and properties used to define the behavior of a WebSocket service + provided by the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> or <see cref="T:WebSocketSharp.Server.HttpServer"/>. + </summary> + <remarks> + The WebSocketBehavior class is an abstract class. + </remarks> + </member> + <member name="M:WebSocketSharp.Server.WebSocketBehavior.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class. + </summary> + </member> + <member name="P:WebSocketSharp.Server.WebSocketBehavior.Log"> + <summary> + Gets the logging functions. + </summary> + <value> + A <see cref="T:WebSocketSharp.Logger"/> that provides the logging functions, + or <see langword="null"/> if the WebSocket connection isn't established. + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketBehavior.Sessions"> + <summary> + Gets the access to the sessions in the WebSocket service. + </summary> + <value> + A <see cref="T:WebSocketSharp.Server.WebSocketSessionManager"/> that provides the access to the sessions, + or <see langword="null"/> if the WebSocket connection isn't established. + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketBehavior.Context"> + <summary> + Gets the information in a handshake request to the WebSocket service. + </summary> + <value> + A <see cref="T:WebSocketSharp.Net.WebSockets.WebSocketContext"/> instance that provides the access to the handshake request, + or <see langword="null"/> if the WebSocket connection isn't established. + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketBehavior.CookiesValidator"> + <summary> + Gets or sets the delegate called to validate the HTTP cookies included in + a handshake request to the WebSocket service. + </summary> + <remarks> + This delegate is called when the <see cref="T:WebSocketSharp.WebSocket"/> used in a session validates + the handshake request. + </remarks> + <value> + <para> + A <c>Func<CookieCollection, CookieCollection, bool></c> delegate that references + the method(s) used to validate the cookies. + </para> + <para> + 1st <see cref="T:WebSocketSharp.Net.CookieCollection"/> parameter passed to this delegate contains + the cookies to validate if any. + </para> + <para> + 2nd <see cref="T:WebSocketSharp.Net.CookieCollection"/> parameter passed to this delegate receives + the cookies to send to the client. + </para> + <para> + This delegate should return <c>true</c> if the cookies are valid. + </para> + <para> + The default value is <see langword="null"/>, and it does nothing to validate. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketBehavior.EmitOnPing"> + <summary> + Gets or sets a value indicating whether the <see cref="T:WebSocketSharp.WebSocket"/> used in a session emits + a <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event when receives a Ping. + </summary> + <value> + <c>true</c> if the <see cref="T:WebSocketSharp.WebSocket"/> emits a <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event + when receives a Ping; otherwise, <c>false</c>. The default value is <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketBehavior.ID"> + <summary> + Gets the unique ID of a session. + </summary> + <value> + A <see cref="T:System.String"/> that represents the unique ID of the session, + or <see langword="null"/> if the WebSocket connection isn't established. + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketBehavior.IgnoreExtensions"> + <summary> + Gets or sets a value indicating whether the WebSocket service ignores + the Sec-WebSocket-Extensions header included in a handshake request. + </summary> + <value> + <c>true</c> if the WebSocket service ignores the extensions requested from + a client; otherwise, <c>false</c>. The default value is <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketBehavior.OriginValidator"> + <summary> + Gets or sets the delegate called to validate the Origin header included in + a handshake request to the WebSocket service. + </summary> + <remarks> + This delegate is called when the <see cref="T:WebSocketSharp.WebSocket"/> used in a session validates + the handshake request. + </remarks> + <value> + <para> + A <c>Func<string, bool></c> delegate that references the method(s) used to + validate the origin header. + </para> + <para> + <see cref="T:System.String"/> parameter passed to this delegate represents the value of + the origin header to validate if any. + </para> + <para> + This delegate should return <c>true</c> if the origin header is valid. + </para> + <para> + The default value is <see langword="null"/>, and it does nothing to validate. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketBehavior.Protocol"> + <summary> + Gets or sets the WebSocket subprotocol used in the WebSocket service. + </summary> + <remarks> + Set operation of this property is available before the WebSocket connection has + been established. + </remarks> + <value> + <para> + A <see cref="T:System.String"/> that represents the subprotocol if any. + The default value is <see cref="F:System.String.Empty"/>. + </para> + <para> + The value to set must be a token defined in + <see href="http://tools.ietf.org/html/rfc2616#section-2.2">RFC 2616</see>. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketBehavior.StartTime"> + <summary> + Gets the time that a session has started. + </summary> + <value> + A <see cref="T:System.DateTime"/> that represents the time that the session has started, + or <see cref="F:System.DateTime.MaxValue"/> if the WebSocket connection isn't established. + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketBehavior.State"> + <summary> + Gets the state of the <see cref="T:WebSocketSharp.WebSocket"/> used in a session. + </summary> + <value> + One of the <see cref="T:WebSocketSharp.WebSocketState"/> enum values, indicates the state of + the <see cref="T:WebSocketSharp.WebSocket"/>. + </value> + </member> + <member name="M:WebSocketSharp.Server.WebSocketBehavior.Error(System.String,System.Exception)"> + <summary> + Calls the <see cref="M:WebSocketSharp.Server.WebSocketBehavior.OnError(WebSocketSharp.ErrorEventArgs)"/> method with the specified <paramref name="message"/> and + <paramref name="exception"/>. + </summary> + <remarks> + This method doesn't call the <see cref="M:WebSocketSharp.Server.WebSocketBehavior.OnError(WebSocketSharp.ErrorEventArgs)"/> method if <paramref name="message"/> is + <see langword="null"/> or empty. + </remarks> + <param name="message"> + A <see cref="T:System.String"/> that represents the error message. + </param> + <param name="exception"> + An <see cref="T:System.Exception"/> instance that represents the cause of the error if any. + </param> + </member> + <member name="M:WebSocketSharp.Server.WebSocketBehavior.OnClose(WebSocketSharp.CloseEventArgs)"> + <summary> + Called when the WebSocket connection used in a session has been closed. + </summary> + <param name="e"> + A <see cref="T:WebSocketSharp.CloseEventArgs"/> that represents the event data passed to + a <see cref="E:WebSocketSharp.WebSocket.OnClose"/> event. + </param> + </member> + <member name="M:WebSocketSharp.Server.WebSocketBehavior.OnError(WebSocketSharp.ErrorEventArgs)"> + <summary> + Called when the <see cref="T:WebSocketSharp.WebSocket"/> used in a session gets an error. + </summary> + <param name="e"> + A <see cref="T:WebSocketSharp.ErrorEventArgs"/> that represents the event data passed to + a <see cref="E:WebSocketSharp.WebSocket.OnError"/> event. + </param> + </member> + <member name="M:WebSocketSharp.Server.WebSocketBehavior.OnMessage(WebSocketSharp.MessageEventArgs)"> + <summary> + Called when the <see cref="T:WebSocketSharp.WebSocket"/> used in a session receives a message. + </summary> + <param name="e"> + A <see cref="T:WebSocketSharp.MessageEventArgs"/> that represents the event data passed to + a <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event. + </param> + </member> + <member name="M:WebSocketSharp.Server.WebSocketBehavior.OnOpen"> + <summary> + Called when the WebSocket connection used in a session has been established. + </summary> + </member> + <member name="M:WebSocketSharp.Server.WebSocketBehavior.Send(System.Byte[])"> + <summary> + Sends binary <paramref name="data"/> to the client on a session. + </summary> + <remarks> + This method is available after the WebSocket connection has been established. + </remarks> + <param name="data"> + An array of <see cref="T:System.Byte"/> that represents the binary data to send. + </param> + </member> + <member name="M:WebSocketSharp.Server.WebSocketBehavior.Send(System.IO.FileInfo)"> + <summary> + Sends the specified <paramref name="file"/> as binary data to the client on a session. + </summary> + <remarks> + This method is available after the WebSocket connection has been established. + </remarks> + <param name="file"> + A <see cref="T:System.IO.FileInfo"/> that represents the file to send. + </param> + </member> + <member name="M:WebSocketSharp.Server.WebSocketBehavior.Send(System.String)"> + <summary> + Sends text <paramref name="data"/> to the client on a session. + </summary> + <remarks> + This method is available after the WebSocket connection has been established. + </remarks> + <param name="data"> + A <see cref="T:System.String"/> that represents the text data to send. + </param> + </member> + <member name="M:WebSocketSharp.Server.WebSocketBehavior.SendAsync(System.Byte[],System.Action{System.Boolean})"> + <summary> + Sends binary <paramref name="data"/> asynchronously to the client on a session. + </summary> + <remarks> + <para> + This method is available after the WebSocket connection has been established. + </para> + <para> + This method doesn't wait for the send to be complete. + </para> + </remarks> + <param name="data"> + An array of <see cref="T:System.Byte"/> that represents the binary data to send. + </param> + <param name="completed"> + An <c>Action<bool></c> delegate that references the method(s) called when + the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c> + if the send is complete successfully. + </param> + </member> + <member name="M:WebSocketSharp.Server.WebSocketBehavior.SendAsync(System.IO.FileInfo,System.Action{System.Boolean})"> + <summary> + Sends the specified <paramref name="file"/> as binary data asynchronously to + the client on a session. + </summary> + <remarks> + <para> + This method is available after the WebSocket connection has been established. + </para> + <para> + This method doesn't wait for the send to be complete. + </para> + </remarks> + <param name="file"> + A <see cref="T:System.IO.FileInfo"/> that represents the file to send. + </param> + <param name="completed"> + An <c>Action<bool></c> delegate that references the method(s) called when + the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c> + if the send is complete successfully. + </param> + </member> + <member name="M:WebSocketSharp.Server.WebSocketBehavior.SendAsync(System.String,System.Action{System.Boolean})"> + <summary> + Sends text <paramref name="data"/> asynchronously to the client on a session. + </summary> + <remarks> + <para> + This method is available after the WebSocket connection has been established. + </para> + <para> + This method doesn't wait for the send to be complete. + </para> + </remarks> + <param name="data"> + A <see cref="T:System.String"/> that represents the text data to send. + </param> + <param name="completed"> + An <c>Action<bool></c> delegate that references the method(s) called when + the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c> + if the send is complete successfully. + </param> + </member> + <member name="M:WebSocketSharp.Server.WebSocketBehavior.SendAsync(System.IO.Stream,System.Int32,System.Action{System.Boolean})"> + <summary> + Sends binary data from the specified <see cref="T:System.IO.Stream"/> asynchronously to + the client on a session. + </summary> + <remarks> + <para> + This method is available after the WebSocket connection has been established. + </para> + <para> + This method doesn't wait for the send to be complete. + </para> + </remarks> + <param name="stream"> + A <see cref="T:System.IO.Stream"/> from which contains the binary data to send. + </param> + <param name="length"> + An <see cref="T:System.Int32"/> that represents the number of bytes to send. + </param> + <param name="completed"> + An <c>Action<bool></c> delegate that references the method(s) called when + the send is complete. A <see cref="T:System.Boolean"/> passed to this delegate is <c>true</c> + if the send is complete successfully. + </param> + </member> + <member name="T:WebSocketSharp.Server.WebSocketServer"> + <summary> + Provides a WebSocket protocol server. + </summary> + <remarks> + This class can provide multiple WebSocket services. + </remarks> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class. + </summary> + <remarks> + The new instance listens for incoming handshake requests on + <see cref="F:System.Net.IPAddress.Any"/> and port 80. + </remarks> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class + with the specified <paramref name="port"/>. + </summary> + <remarks> + <para> + The new instance listens for incoming handshake requests on + <see cref="F:System.Net.IPAddress.Any"/> and <paramref name="port"/>. + </para> + <para> + It provides secure connections if <paramref name="port"/> is 443. + </para> + </remarks> + <param name="port"> + An <see cref="T:System.Int32"/> that represents the number of the port + on which to listen. + </param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <paramref name="port"/> is less than 1 or greater than 65535. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.String)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class + with the specified <paramref name="url"/>. + </summary> + <remarks> + <para> + The new instance listens for incoming handshake requests on + the IP address of the host of <paramref name="url"/> and + the port of <paramref name="url"/>. + </para> + <para> + Either port 80 or 443 is used if <paramref name="url"/> includes + no port. Port 443 is used if the scheme of <paramref name="url"/> + is wss; otherwise, port 80 is used. + </para> + <para> + The new instance provides secure connections if the scheme of + <paramref name="url"/> is wss. + </para> + </remarks> + <param name="url"> + A <see cref="T:System.String"/> that represents the WebSocket URL of the server. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="url"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="url"/> is an empty string. + </para> + <para> + -or- + </para> + <para> + <paramref name="url"/> is invalid. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.Int32,System.Boolean)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class + with the specified <paramref name="port"/> and <paramref name="secure"/>. + </summary> + <remarks> + The new instance listens for incoming handshake requests on + <see cref="F:System.Net.IPAddress.Any"/> and <paramref name="port"/>. + </remarks> + <param name="port"> + An <see cref="T:System.Int32"/> that represents the number of the port + on which to listen. + </param> + <param name="secure"> + A <see cref="T:System.Boolean"/>: <c>true</c> if the new instance provides + secure connections; otherwise, <c>false</c>. + </param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <paramref name="port"/> is less than 1 or greater than 65535. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.Net.IPAddress,System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class + with the specified <paramref name="address"/> and <paramref name="port"/>. + </summary> + <remarks> + <para> + The new instance listens for incoming handshake requests on + <paramref name="address"/> and <paramref name="port"/>. + </para> + <para> + It provides secure connections if <paramref name="port"/> is 443. + </para> + </remarks> + <param name="address"> + A <see cref="T:System.Net.IPAddress"/> that represents the local + IP address on which to listen. + </param> + <param name="port"> + An <see cref="T:System.Int32"/> that represents the number of the port + on which to listen. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="address"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="address"/> is not a local IP address. + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + <paramref name="port"/> is less than 1 or greater than 65535. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServer.#ctor(System.Net.IPAddress,System.Int32,System.Boolean)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> class + with the specified <paramref name="address"/>, <paramref name="port"/>, + and <paramref name="secure"/>. + </summary> + <remarks> + The new instance listens for incoming handshake requests on + <paramref name="address"/> and <paramref name="port"/>. + </remarks> + <param name="address"> + A <see cref="T:System.Net.IPAddress"/> that represents the local + IP address on which to listen. + </param> + <param name="port"> + An <see cref="T:System.Int32"/> that represents the number of the port + on which to listen. + </param> + <param name="secure"> + A <see cref="T:System.Boolean"/>: <c>true</c> if the new instance provides + secure connections; otherwise, <c>false</c>. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="address"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="address"/> is not a local IP address. + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + <paramref name="port"/> is less than 1 or greater than 65535. + </exception> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServer.Address"> + <summary> + Gets the IP address of the server. + </summary> + <value> + A <see cref="T:System.Net.IPAddress"/> that represents the local + IP address on which to listen for incoming handshake requests. + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServer.AllowForwardedRequest"> + <summary> + Gets or sets a value indicating whether the server accepts every + handshake request without checking the request URI. + </summary> + <remarks> + The set operation does nothing if the server has already started or + it is shutting down. + </remarks> + <value> + <para> + <c>true</c> if the server accepts every handshake request without + checking the request URI; otherwise, <c>false</c>. + </para> + <para> + The default value is <c>false</c>. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServer.AuthenticationSchemes"> + <summary> + Gets or sets the scheme used to authenticate the clients. + </summary> + <remarks> + The set operation does nothing if the server has already started or + it is shutting down. + </remarks> + <value> + <para> + One of the <see cref="T:WebSocketSharp.Net.AuthenticationSchemes"/> + enum values. + </para> + <para> + It represents the scheme used to authenticate the clients. + </para> + <para> + The default value is + <see cref="F:WebSocketSharp.Net.AuthenticationSchemes.Anonymous"/>. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServer.IsListening"> + <summary> + Gets a value indicating whether the server has started. + </summary> + <value> + <c>true</c> if the server has started; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServer.IsSecure"> + <summary> + Gets a value indicating whether the server provides + secure connections. + </summary> + <value> + <c>true</c> if the server provides secure connections; + otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServer.KeepClean"> + <summary> + Gets or sets a value indicating whether the server cleans up + the inactive sessions periodically. + </summary> + <remarks> + The set operation does nothing if the server has already started or + it is shutting down. + </remarks> + <value> + <para> + <c>true</c> if the server cleans up the inactive sessions every + 60 seconds; otherwise, <c>false</c>. + </para> + <para> + The default value is <c>true</c>. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServer.Log"> + <summary> + Gets the logging function for the server. + </summary> + <remarks> + The default logging level is <see cref="F:WebSocketSharp.LogLevel.Error"/>. + </remarks> + <value> + A <see cref="T:WebSocketSharp.Logger"/> that provides the logging function. + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServer.Port"> + <summary> + Gets the port of the server. + </summary> + <value> + An <see cref="T:System.Int32"/> that represents the number of the port + on which to listen for incoming handshake requests. + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServer.Realm"> + <summary> + Gets or sets the realm used for authentication. + </summary> + <remarks> + <para> + "SECRET AREA" is used as the realm if the value is + <see langword="null"/> or an empty string. + </para> + <para> + The set operation does nothing if the server has + already started or it is shutting down. + </para> + </remarks> + <value> + <para> + A <see cref="T:System.String"/> or <see langword="null"/> by default. + </para> + <para> + That string represents the name of the realm. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServer.ReuseAddress"> + <summary> + Gets or sets a value indicating whether the server is allowed to + be bound to an address that is already in use. + </summary> + <remarks> + <para> + You should set this property to <c>true</c> if you would + like to resolve to wait for socket in TIME_WAIT state. + </para> + <para> + The set operation does nothing if the server has already + started or it is shutting down. + </para> + </remarks> + <value> + <para> + <c>true</c> if the server is allowed to be bound to an address + that is already in use; otherwise, <c>false</c>. + </para> + <para> + The default value is <c>false</c>. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServer.SslConfiguration"> + <summary> + Gets the configuration for secure connections. + </summary> + <remarks> + This configuration will be referenced when attempts to start, + so it must be configured before the start method is called. + </remarks> + <value> + A <see cref="T:WebSocketSharp.Net.ServerSslConfiguration"/> that represents + the configuration used to provide secure connections. + </value> + <exception cref="T:System.InvalidOperationException"> + This instance does not provide secure connections. + </exception> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServer.UserCredentialsFinder"> + <summary> + Gets or sets the delegate used to find the credentials + for an identity. + </summary> + <remarks> + <para> + No credentials are found if the method invoked by + the delegate returns <see langword="null"/> or + the value is <see langword="null"/>. + </para> + <para> + The set operation does nothing if the server has + already started or it is shutting down. + </para> + </remarks> + <value> + <para> + A <c>Func<<see cref="T:System.Security.Principal.IIdentity"/>, + <see cref="T:WebSocketSharp.Net.NetworkCredential"/>></c> delegate or + <see langword="null"/> if not needed. + </para> + <para> + That delegate invokes the method called for finding + the credentials used to authenticate a client. + </para> + <para> + The default value is <see langword="null"/>. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServer.WaitTime"> + <summary> + Gets or sets the time to wait for the response to the WebSocket Ping or + Close. + </summary> + <remarks> + The set operation does nothing if the server has already started or + it is shutting down. + </remarks> + <value> + <para> + A <see cref="T:System.TimeSpan"/> to wait for the response. + </para> + <para> + The default value is the same as 1 second. + </para> + </value> + <exception cref="T:System.ArgumentOutOfRangeException"> + The value specified for a set operation is zero or less. + </exception> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServer.WebSocketServices"> + <summary> + Gets the management function for the WebSocket services + provided by the server. + </summary> + <value> + A <see cref="T:WebSocketSharp.Server.WebSocketServiceManager"/> that manages + the WebSocket services provided by the server. + </value> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServer.AddWebSocketService``1(System.String,System.Func{``0})"> + <summary> + Adds a WebSocket service with the specified behavior, + <paramref name="path"/>, and <paramref name="creator"/>. + </summary> + <remarks> + <paramref name="path"/> is converted to a URL-decoded string and + '/' is trimmed from the end of the converted string if any. + </remarks> + <param name="path"> + A <see cref="T:System.String"/> that represents an absolute path to + the service to add. + </param> + <param name="creator"> + <para> + A <c>Func<TBehavior></c> delegate. + </para> + <para> + It invokes the method called for creating a new session + instance for the service. + </para> + <para> + The method must create a new instance of the specified + behavior class and return it. + </para> + </param> + <typeparam name="TBehavior"> + <para> + The type of the behavior for the service. + </para> + <para> + It must inherit the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class. + </para> + </typeparam> + <exception cref="T:System.ArgumentNullException"> + <para> + <paramref name="path"/> is <see langword="null"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="creator"/> is <see langword="null"/>. + </para> + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="path"/> is an empty string. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> is not an absolute path. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> includes either or both + query and fragment components. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> is already in use. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServer.AddWebSocketService``1(System.String)"> + <summary> + Adds a WebSocket service with the specified behavior and + <paramref name="path"/>. + </summary> + <remarks> + <paramref name="path"/> is converted to a URL-decoded string and + '/' is trimmed from the end of the converted string if any. + </remarks> + <param name="path"> + A <see cref="T:System.String"/> that represents an absolute path to + the service to add. + </param> + <typeparam name="TBehaviorWithNew"> + <para> + The type of the behavior for the service. + </para> + <para> + It must inherit the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class and + have a public parameterless constructor. + </para> + </typeparam> + <exception cref="T:System.ArgumentNullException"> + <paramref name="path"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="path"/> is an empty string. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> is not an absolute path. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> includes either or both + query and fragment components. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> is already in use. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServer.AddWebSocketService``1(System.String,System.Action{``0})"> + <summary> + Adds a WebSocket service with the specified behavior, + <paramref name="path"/>, and <paramref name="initializer"/>. + </summary> + <remarks> + <paramref name="path"/> is converted to a URL-decoded string and + '/' is trimmed from the end of the converted string if any. + </remarks> + <param name="path"> + A <see cref="T:System.String"/> that represents an absolute path to + the service to add. + </param> + <param name="initializer"> + <para> + An <c>Action<TBehaviorWithNew></c> delegate or + <see langword="null"/> if not needed. + </para> + <para> + That delegate invokes the method called for initializing + a new session instance for the service. + </para> + </param> + <typeparam name="TBehaviorWithNew"> + <para> + The type of the behavior for the service. + </para> + <para> + It must inherit the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class and + have a public parameterless constructor. + </para> + </typeparam> + <exception cref="T:System.ArgumentNullException"> + <paramref name="path"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="path"/> is an empty string. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> is not an absolute path. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> includes either or both + query and fragment components. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> is already in use. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServer.RemoveWebSocketService(System.String)"> + <summary> + Removes a WebSocket service with the specified <paramref name="path"/>. + </summary> + <remarks> + <para> + <paramref name="path"/> is converted to a URL-decoded string and + '/' is trimmed from the end of the converted string if any. + </para> + <para> + The service is stopped with close status 1001 (going away) + if it has already started. + </para> + </remarks> + <returns> + <c>true</c> if the service is successfully found and removed; + otherwise, <c>false</c>. + </returns> + <param name="path"> + A <see cref="T:System.String"/> that represents an absolute path to + the service to remove. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="path"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="path"/> is an empty string. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> is not an absolute path. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> includes either or both + query and fragment components. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServer.Start"> + <summary> + Starts receiving incoming handshake requests. + </summary> + <remarks> + This method does nothing if the server has already started or + it is shutting down. + </remarks> + <exception cref="T:System.InvalidOperationException"> + <para> + There is no server certificate for secure connections. + </para> + <para> + -or- + </para> + <para> + The underlying <see cref="T:System.Net.Sockets.TcpListener"/> has failed to start. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServer.Stop"> + <summary> + Stops receiving incoming handshake requests and closes + each connection. + </summary> + <remarks> + This method does nothing if the server is not started, + it is shutting down, or it has already stopped. + </remarks> + <exception cref="T:System.InvalidOperationException"> + The underlying <see cref="T:System.Net.Sockets.TcpListener"/> has failed to stop. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServer.Stop(System.UInt16,System.String)"> + <summary> + Stops receiving incoming handshake requests and closes each + connection with the specified <paramref name="code"/> and + <paramref name="reason"/>. + </summary> + <remarks> + This method does nothing if the server is not started, + it is shutting down, or it has already stopped. + </remarks> + <param name="code"> + <para> + A <see cref="T:System.UInt16"/> that represents the status code + indicating the reason for the close. + </para> + <para> + The status codes are defined in + <see href="http://tools.ietf.org/html/rfc6455#section-7.4"> + Section 7.4</see> of RFC 6455. + </para> + </param> + <param name="reason"> + <para> + A <see cref="T:System.String"/> that represents the reason for the close. + </para> + <para> + The size must be 123 bytes or less in UTF-8. + </para> + </param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <para> + <paramref name="code"/> is less than 1000 or greater than 4999. + </para> + <para> + -or- + </para> + <para> + The size of <paramref name="reason"/> is greater than 123 bytes. + </para> + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="code"/> is 1010 (mandatory extension). + </para> + <para> + -or- + </para> + <para> + <paramref name="code"/> is 1005 (no status) and + there is <paramref name="reason"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="reason"/> could not be UTF-8-encoded. + </para> + </exception> + <exception cref="T:System.InvalidOperationException"> + The underlying <see cref="T:System.Net.Sockets.TcpListener"/> has failed to stop. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServer.Stop(WebSocketSharp.CloseStatusCode,System.String)"> + <summary> + Stops receiving incoming handshake requests and closes each + connection with the specified <paramref name="code"/> and + <paramref name="reason"/>. + </summary> + <remarks> + This method does nothing if the server is not started, + it is shutting down, or it has already stopped. + </remarks> + <param name="code"> + <para> + One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values. + </para> + <para> + It represents the status code indicating the reason for the close. + </para> + </param> + <param name="reason"> + <para> + A <see cref="T:System.String"/> that represents the reason for the close. + </para> + <para> + The size must be 123 bytes or less in UTF-8. + </para> + </param> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="code"/> is + <see cref="F:WebSocketSharp.CloseStatusCode.MandatoryExtension"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="code"/> is + <see cref="F:WebSocketSharp.CloseStatusCode.NoStatus"/> and + there is <paramref name="reason"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="reason"/> could not be UTF-8-encoded. + </para> + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + The size of <paramref name="reason"/> is greater than 123 bytes. + </exception> + <exception cref="T:System.InvalidOperationException"> + The underlying <see cref="T:System.Net.Sockets.TcpListener"/> has failed to stop. + </exception> + </member> + <member name="T:WebSocketSharp.Server.WebSocketServiceHost"> + <summary> + Exposes the methods and properties used to access the information in + a WebSocket service provided by the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> or + <see cref="T:WebSocketSharp.Server.HttpServer"/>. + </summary> + <remarks> + This class is an abstract class. + </remarks> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServiceHost.#ctor(System.String,WebSocketSharp.Logger)"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.Server.WebSocketServiceHost"/> class + with the specified <paramref name="path"/> and <paramref name="log"/>. + </summary> + <param name="path"> + A <see cref="T:System.String"/> that represents the absolute path to the service. + </param> + <param name="log"> + A <see cref="T:WebSocketSharp.Logger"/> that represents the logging function for the service. + </param> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServiceHost.Log"> + <summary> + Gets the logging function for the service. + </summary> + <value> + A <see cref="T:WebSocketSharp.Logger"/> that provides the logging function. + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServiceHost.KeepClean"> + <summary> + Gets or sets a value indicating whether the service cleans up + the inactive sessions periodically. + </summary> + <remarks> + The set operation does nothing if the service has already started or + it is shutting down. + </remarks> + <value> + <c>true</c> if the service cleans up the inactive sessions every + 60 seconds; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServiceHost.Path"> + <summary> + Gets the path to the service. + </summary> + <value> + A <see cref="T:System.String"/> that represents the absolute path to + the service. + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServiceHost.Sessions"> + <summary> + Gets the management function for the sessions in the service. + </summary> + <value> + A <see cref="T:WebSocketSharp.Server.WebSocketSessionManager"/> that manages the sessions in + the service. + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServiceHost.BehaviorType"> + <summary> + Gets the <see cref="T:System.Type"/> of the behavior of the service. + </summary> + <value> + A <see cref="T:System.Type"/> that represents the type of the behavior of + the service. + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServiceHost.WaitTime"> + <summary> + Gets or sets the time to wait for the response to the WebSocket Ping or + Close. + </summary> + <remarks> + The set operation does nothing if the service has already started or + it is shutting down. + </remarks> + <value> + A <see cref="T:System.TimeSpan"/> to wait for the response. + </value> + <exception cref="T:System.ArgumentOutOfRangeException"> + The value specified for a set operation is zero or less. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServiceHost.CreateSession"> + <summary> + Creates a new session for the service. + </summary> + <returns> + A <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> instance that represents + the new session. + </returns> + </member> + <member name="T:WebSocketSharp.Server.WebSocketServiceManager"> + <summary> + Provides the management function for the WebSocket services. + </summary> + <remarks> + This class manages the WebSocket services provided by + the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> or <see cref="T:WebSocketSharp.Server.HttpServer"/>. + </remarks> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServiceManager.Count"> + <summary> + Gets the number of the WebSocket services. + </summary> + <value> + An <see cref="T:System.Int32"/> that represents the number of the services. + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServiceManager.Hosts"> + <summary> + Gets the host instances for the WebSocket services. + </summary> + <value> + <para> + An <c>IEnumerable<WebSocketServiceHost></c> instance. + </para> + <para> + It provides an enumerator which supports the iteration over + the collection of the host instances. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServiceManager.Item(System.String)"> + <summary> + Gets the host instance for a WebSocket service with + the specified <paramref name="path"/>. + </summary> + <remarks> + <paramref name="path"/> is converted to a URL-decoded string and + / is trimmed from the end of the converted string if any. + </remarks> + <value> + <para> + A <see cref="T:WebSocketSharp.Server.WebSocketServiceHost"/> instance or + <see langword="null"/> if not found. + </para> + <para> + That host instance provides the function to access + the information in the service. + </para> + </value> + <param name="path"> + A <see cref="T:System.String"/> that represents an absolute path to + the service to find. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="path"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="path"/> is empty. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> is not an absolute path. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> includes either or both + query and fragment components. + </para> + </exception> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServiceManager.KeepClean"> + <summary> + Gets or sets a value indicating whether the inactive sessions in + the WebSocket services are cleaned up periodically. + </summary> + <remarks> + The set operation does nothing if the server has already started or + it is shutting down. + </remarks> + <value> + <c>true</c> if the inactive sessions are cleaned up every 60 seconds; + otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServiceManager.Paths"> + <summary> + Gets the paths for the WebSocket services. + </summary> + <value> + <para> + An <c>IEnumerable<string></c> instance. + </para> + <para> + It provides an enumerator which supports the iteration over + the collection of the paths. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServiceManager.SessionCount"> + <summary> + Gets the total number of the sessions in the WebSocket services. + </summary> + <value> + An <see cref="T:System.Int32"/> that represents the total number of + the sessions in the services. + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketServiceManager.WaitTime"> + <summary> + Gets or sets the time to wait for the response to the WebSocket Ping or + Close. + </summary> + <remarks> + The set operation does nothing if the server has already started or + it is shutting down. + </remarks> + <value> + A <see cref="T:System.TimeSpan"/> to wait for the response. + </value> + <exception cref="T:System.ArgumentOutOfRangeException"> + The value specified for a set operation is zero or less. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServiceManager.AddService``1(System.String,System.Action{``0})"> + <summary> + Adds a WebSocket service with the specified behavior, + <paramref name="path"/>, and <paramref name="initializer"/>. + </summary> + <remarks> + <paramref name="path"/> is converted to a URL-decoded string and + / is trimmed from the end of the converted string if any. + </remarks> + <param name="path"> + A <see cref="T:System.String"/> that represents an absolute path to + the service to add. + </param> + <param name="initializer"> + <para> + An <c>Action<TBehavior></c> delegate or + <see langword="null"/> if not needed. + </para> + <para> + That delegate invokes the method called for initializing + a new session instance for the service. + </para> + </param> + <typeparam name="TBehavior"> + The type of the behavior for the service. It must inherit + the <see cref="T:WebSocketSharp.Server.WebSocketBehavior"/> class and it must have + a public parameterless constructor. + </typeparam> + <exception cref="T:System.ArgumentNullException"> + <paramref name="path"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="path"/> is empty. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> is not an absolute path. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> includes either or both + query and fragment components. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> is already in use. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServiceManager.Broadcast(System.Byte[])"> + <summary> + Sends <paramref name="data"/> to every client in the WebSocket services. + </summary> + <param name="data"> + An array of <see cref="T:System.Byte"/> that represents the binary data to send. + </param> + <exception cref="T:System.InvalidOperationException"> + The current state of the manager is not Start. + </exception> + <exception cref="T:System.ArgumentNullException"> + <paramref name="data"/> is <see langword="null"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServiceManager.Broadcast(System.String)"> + <summary> + Sends <paramref name="data"/> to every client in the WebSocket services. + </summary> + <param name="data"> + A <see cref="T:System.String"/> that represents the text data to send. + </param> + <exception cref="T:System.InvalidOperationException"> + The current state of the manager is not Start. + </exception> + <exception cref="T:System.ArgumentNullException"> + <paramref name="data"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="data"/> could not be UTF-8-encoded. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServiceManager.BroadcastAsync(System.Byte[],System.Action)"> + <summary> + Sends <paramref name="data"/> asynchronously to every client in + the WebSocket services. + </summary> + <remarks> + This method does not wait for the send to be complete. + </remarks> + <param name="data"> + An array of <see cref="T:System.Byte"/> that represents the binary data to send. + </param> + <param name="completed"> + <para> + An <see cref="T:System.Action"/> delegate or <see langword="null"/> + if not needed. + </para> + <para> + The delegate invokes the method called when the send is complete. + </para> + </param> + <exception cref="T:System.InvalidOperationException"> + The current state of the manager is not Start. + </exception> + <exception cref="T:System.ArgumentNullException"> + <paramref name="data"/> is <see langword="null"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServiceManager.BroadcastAsync(System.String,System.Action)"> + <summary> + Sends <paramref name="data"/> asynchronously to every client in + the WebSocket services. + </summary> + <remarks> + This method does not wait for the send to be complete. + </remarks> + <param name="data"> + A <see cref="T:System.String"/> that represents the text data to send. + </param> + <param name="completed"> + <para> + An <see cref="T:System.Action"/> delegate or <see langword="null"/> + if not needed. + </para> + <para> + The delegate invokes the method called when the send is complete. + </para> + </param> + <exception cref="T:System.InvalidOperationException"> + The current state of the manager is not Start. + </exception> + <exception cref="T:System.ArgumentNullException"> + <paramref name="data"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="data"/> could not be UTF-8-encoded. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServiceManager.BroadcastAsync(System.IO.Stream,System.Int32,System.Action)"> + <summary> + Sends the data from <paramref name="stream"/> asynchronously to + every client in the WebSocket services. + </summary> + <remarks> + <para> + The data is sent as the binary data. + </para> + <para> + This method does not wait for the send to be complete. + </para> + </remarks> + <param name="stream"> + A <see cref="T:System.IO.Stream"/> instance from which to read the data to send. + </param> + <param name="length"> + An <see cref="T:System.Int32"/> that specifies the number of bytes to send. + </param> + <param name="completed"> + <para> + An <see cref="T:System.Action"/> delegate or <see langword="null"/> + if not needed. + </para> + <para> + The delegate invokes the method called when the send is complete. + </para> + </param> + <exception cref="T:System.InvalidOperationException"> + The current state of the manager is not Start. + </exception> + <exception cref="T:System.ArgumentNullException"> + <paramref name="stream"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="stream"/> cannot be read. + </para> + <para> + -or- + </para> + <para> + <paramref name="length"/> is less than 1. + </para> + <para> + -or- + </para> + <para> + No data could be read from <paramref name="stream"/>. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServiceManager.Broadping"> + <summary> + Sends a ping to every client in the WebSocket services. + </summary> + <returns> + <para> + A <c>Dictionary<string, Dictionary<string, bool>></c>. + </para> + <para> + It represents a collection of pairs of a service path and another + collection of pairs of a session ID and a value indicating whether + a pong has been received from the client within a time. + </para> + </returns> + <exception cref="T:System.InvalidOperationException"> + The current state of the manager is not Start. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServiceManager.Broadping(System.String)"> + <summary> + Sends a ping with <paramref name="message"/> to every client in + the WebSocket services. + </summary> + <returns> + <para> + A <c>Dictionary<string, Dictionary<string, bool>></c>. + </para> + <para> + It represents a collection of pairs of a service path and another + collection of pairs of a session ID and a value indicating whether + a pong has been received from the client within a time. + </para> + </returns> + <param name="message"> + <para> + A <see cref="T:System.String"/> that represents the message to send. + </para> + <para> + The size must be 125 bytes or less in UTF-8. + </para> + </param> + <exception cref="T:System.InvalidOperationException"> + The current state of the manager is not Start. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="message"/> could not be UTF-8-encoded. + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + The size of <paramref name="message"/> is greater than 125 bytes. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServiceManager.Clear"> + <summary> + Removes all WebSocket services managed by the manager. + </summary> + <remarks> + A service is stopped with close status 1001 (going away) + if it has already started. + </remarks> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServiceManager.RemoveService(System.String)"> + <summary> + Removes a WebSocket service with the specified <paramref name="path"/>. + </summary> + <remarks> + <para> + <paramref name="path"/> is converted to a URL-decoded string and + / is trimmed from the end of the converted string if any. + </para> + <para> + The service is stopped with close status 1001 (going away) + if it has already started. + </para> + </remarks> + <returns> + <c>true</c> if the service is successfully found and removed; + otherwise, <c>false</c>. + </returns> + <param name="path"> + A <see cref="T:System.String"/> that represents an absolute path to + the service to remove. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="path"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="path"/> is empty. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> is not an absolute path. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> includes either or both + query and fragment components. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketServiceManager.TryGetServiceHost(System.String,WebSocketSharp.Server.WebSocketServiceHost@)"> + <summary> + Tries to get the host instance for a WebSocket service with + the specified <paramref name="path"/>. + </summary> + <remarks> + <paramref name="path"/> is converted to a URL-decoded string and + / is trimmed from the end of the converted string if any. + </remarks> + <returns> + <c>true</c> if the service is successfully found; + otherwise, <c>false</c>. + </returns> + <param name="path"> + A <see cref="T:System.String"/> that represents an absolute path to + the service to find. + </param> + <param name="host"> + <para> + When this method returns, a <see cref="T:WebSocketSharp.Server.WebSocketServiceHost"/> + instance or <see langword="null"/> if not found. + </para> + <para> + That host instance provides the function to access + the information in the service. + </para> + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="path"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="path"/> is empty. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> is not an absolute path. + </para> + <para> + -or- + </para> + <para> + <paramref name="path"/> includes either or both + query and fragment components. + </para> + </exception> + </member> + <member name="T:WebSocketSharp.Server.WebSocketSessionManager"> + <summary> + Provides the management function for the sessions in a WebSocket service. + </summary> + <remarks> + This class manages the sessions in a WebSocket service provided by + the <see cref="T:WebSocketSharp.Server.WebSocketServer"/> or <see cref="T:WebSocketSharp.Server.HttpServer"/>. + </remarks> + </member> + <member name="P:WebSocketSharp.Server.WebSocketSessionManager.ActiveIDs"> + <summary> + Gets the IDs for the active sessions in the WebSocket service. + </summary> + <value> + <para> + An <c>IEnumerable<string></c> instance. + </para> + <para> + It provides an enumerator which supports the iteration over + the collection of the IDs for the active sessions. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketSessionManager.Count"> + <summary> + Gets the number of the sessions in the WebSocket service. + </summary> + <value> + An <see cref="T:System.Int32"/> that represents the number of the sessions. + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketSessionManager.IDs"> + <summary> + Gets the IDs for the sessions in the WebSocket service. + </summary> + <value> + <para> + An <c>IEnumerable<string></c> instance. + </para> + <para> + It provides an enumerator which supports the iteration over + the collection of the IDs for the sessions. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketSessionManager.InactiveIDs"> + <summary> + Gets the IDs for the inactive sessions in the WebSocket service. + </summary> + <value> + <para> + An <c>IEnumerable<string></c> instance. + </para> + <para> + It provides an enumerator which supports the iteration over + the collection of the IDs for the inactive sessions. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketSessionManager.Item(System.String)"> + <summary> + Gets the session instance with <paramref name="id"/>. + </summary> + <value> + <para> + A <see cref="T:WebSocketSharp.Server.IWebSocketSession"/> instance or <see langword="null"/> + if not found. + </para> + <para> + The session instance provides the function to access the information + in the session. + </para> + </value> + <param name="id"> + A <see cref="T:System.String"/> that represents the ID of the session to find. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="id"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="id"/> is an empty string. + </exception> + </member> + <member name="P:WebSocketSharp.Server.WebSocketSessionManager.KeepClean"> + <summary> + Gets or sets a value indicating whether the inactive sessions in + the WebSocket service are cleaned up periodically. + </summary> + <remarks> + The set operation does nothing if the service has already started or + it is shutting down. + </remarks> + <value> + <c>true</c> if the inactive sessions are cleaned up every 60 seconds; + otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketSessionManager.Sessions"> + <summary> + Gets the session instances in the WebSocket service. + </summary> + <value> + <para> + An <c>IEnumerable<IWebSocketSession></c> instance. + </para> + <para> + It provides an enumerator which supports the iteration over + the collection of the session instances. + </para> + </value> + </member> + <member name="P:WebSocketSharp.Server.WebSocketSessionManager.WaitTime"> + <summary> + Gets or sets the time to wait for the response to the WebSocket Ping or + Close. + </summary> + <remarks> + The set operation does nothing if the service has already started or + it is shutting down. + </remarks> + <value> + A <see cref="T:System.TimeSpan"/> to wait for the response. + </value> + <exception cref="T:System.ArgumentOutOfRangeException"> + The value specified for a set operation is zero or less. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketSessionManager.Broadcast(System.Byte[])"> + <summary> + Sends <paramref name="data"/> to every client in the WebSocket service. + </summary> + <param name="data"> + An array of <see cref="T:System.Byte"/> that represents the binary data to send. + </param> + <exception cref="T:System.InvalidOperationException"> + The current state of the manager is not Start. + </exception> + <exception cref="T:System.ArgumentNullException"> + <paramref name="data"/> is <see langword="null"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketSessionManager.Broadcast(System.String)"> + <summary> + Sends <paramref name="data"/> to every client in the WebSocket service. + </summary> + <param name="data"> + A <see cref="T:System.String"/> that represents the text data to send. + </param> + <exception cref="T:System.InvalidOperationException"> + The current state of the manager is not Start. + </exception> + <exception cref="T:System.ArgumentNullException"> + <paramref name="data"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="data"/> could not be UTF-8-encoded. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketSessionManager.Broadcast(System.IO.Stream,System.Int32)"> + <summary> + Sends the data from <paramref name="stream"/> to every client in + the WebSocket service. + </summary> + <remarks> + The data is sent as the binary data. + </remarks> + <param name="stream"> + A <see cref="T:System.IO.Stream"/> instance from which to read the data to send. + </param> + <param name="length"> + An <see cref="T:System.Int32"/> that specifies the number of bytes to send. + </param> + <exception cref="T:System.InvalidOperationException"> + The current state of the manager is not Start. + </exception> + <exception cref="T:System.ArgumentNullException"> + <paramref name="stream"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="stream"/> cannot be read. + </para> + <para> + -or- + </para> + <para> + <paramref name="length"/> is less than 1. + </para> + <para> + -or- + </para> + <para> + No data could be read from <paramref name="stream"/>. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketSessionManager.BroadcastAsync(System.Byte[],System.Action)"> + <summary> + Sends <paramref name="data"/> asynchronously to every client in + the WebSocket service. + </summary> + <remarks> + This method does not wait for the send to be complete. + </remarks> + <param name="data"> + An array of <see cref="T:System.Byte"/> that represents the binary data to send. + </param> + <param name="completed"> + <para> + An <see cref="T:System.Action"/> delegate or <see langword="null"/> + if not needed. + </para> + <para> + The delegate invokes the method called when the send is complete. + </para> + </param> + <exception cref="T:System.InvalidOperationException"> + The current state of the manager is not Start. + </exception> + <exception cref="T:System.ArgumentNullException"> + <paramref name="data"/> is <see langword="null"/>. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketSessionManager.BroadcastAsync(System.String,System.Action)"> + <summary> + Sends <paramref name="data"/> asynchronously to every client in + the WebSocket service. + </summary> + <remarks> + This method does not wait for the send to be complete. + </remarks> + <param name="data"> + A <see cref="T:System.String"/> that represents the text data to send. + </param> + <param name="completed"> + <para> + An <see cref="T:System.Action"/> delegate or <see langword="null"/> + if not needed. + </para> + <para> + The delegate invokes the method called when the send is complete. + </para> + </param> + <exception cref="T:System.InvalidOperationException"> + The current state of the manager is not Start. + </exception> + <exception cref="T:System.ArgumentNullException"> + <paramref name="data"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="data"/> could not be UTF-8-encoded. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketSessionManager.BroadcastAsync(System.IO.Stream,System.Int32,System.Action)"> + <summary> + Sends the data from <paramref name="stream"/> asynchronously to + every client in the WebSocket service. + </summary> + <remarks> + <para> + The data is sent as the binary data. + </para> + <para> + This method does not wait for the send to be complete. + </para> + </remarks> + <param name="stream"> + A <see cref="T:System.IO.Stream"/> instance from which to read the data to send. + </param> + <param name="length"> + An <see cref="T:System.Int32"/> that specifies the number of bytes to send. + </param> + <param name="completed"> + <para> + An <see cref="T:System.Action"/> delegate or <see langword="null"/> + if not needed. + </para> + <para> + The delegate invokes the method called when the send is complete. + </para> + </param> + <exception cref="T:System.InvalidOperationException"> + The current state of the manager is not Start. + </exception> + <exception cref="T:System.ArgumentNullException"> + <paramref name="stream"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="stream"/> cannot be read. + </para> + <para> + -or- + </para> + <para> + <paramref name="length"/> is less than 1. + </para> + <para> + -or- + </para> + <para> + No data could be read from <paramref name="stream"/>. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketSessionManager.Broadping"> + <summary> + Sends a ping to every client in the WebSocket service. + </summary> + <returns> + <para> + A <c>Dictionary<string, bool></c>. + </para> + <para> + It represents a collection of pairs of a session ID and + a value indicating whether a pong has been received from + the client within a time. + </para> + </returns> + <exception cref="T:System.InvalidOperationException"> + The current state of the manager is not Start. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketSessionManager.Broadping(System.String)"> + <summary> + Sends a ping with <paramref name="message"/> to every client in + the WebSocket service. + </summary> + <returns> + <para> + A <c>Dictionary<string, bool></c>. + </para> + <para> + It represents a collection of pairs of a session ID and + a value indicating whether a pong has been received from + the client within a time. + </para> + </returns> + <param name="message"> + <para> + A <see cref="T:System.String"/> that represents the message to send. + </para> + <para> + The size must be 125 bytes or less in UTF-8. + </para> + </param> + <exception cref="T:System.InvalidOperationException"> + The current state of the manager is not Start. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="message"/> could not be UTF-8-encoded. + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + The size of <paramref name="message"/> is greater than 125 bytes. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketSessionManager.CloseSession(System.String)"> + <summary> + Closes the specified session. + </summary> + <param name="id"> + A <see cref="T:System.String"/> that represents the ID of the session to close. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="id"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="id"/> is an empty string. + </exception> + <exception cref="T:System.InvalidOperationException"> + The session could not be found. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketSessionManager.CloseSession(System.String,System.UInt16,System.String)"> + <summary> + Closes the specified session with <paramref name="code"/> and + <paramref name="reason"/>. + </summary> + <param name="id"> + A <see cref="T:System.String"/> that represents the ID of the session to close. + </param> + <param name="code"> + <para> + A <see cref="T:System.UInt16"/> that represents the status code indicating + the reason for the close. + </para> + <para> + The status codes are defined in + <see href="http://tools.ietf.org/html/rfc6455#section-7.4"> + Section 7.4</see> of RFC 6455. + </para> + </param> + <param name="reason"> + <para> + A <see cref="T:System.String"/> that represents the reason for the close. + </para> + <para> + The size must be 123 bytes or less in UTF-8. + </para> + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="id"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="id"/> is an empty string. + </para> + <para> + -or- + </para> + <para> + <paramref name="code"/> is 1010 (mandatory extension). + </para> + <para> + -or- + </para> + <para> + <paramref name="code"/> is 1005 (no status) and there is + <paramref name="reason"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="reason"/> could not be UTF-8-encoded. + </para> + </exception> + <exception cref="T:System.InvalidOperationException"> + The session could not be found. + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + <para> + <paramref name="code"/> is less than 1000 or greater than 4999. + </para> + <para> + -or- + </para> + <para> + The size of <paramref name="reason"/> is greater than 123 bytes. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketSessionManager.CloseSession(System.String,WebSocketSharp.CloseStatusCode,System.String)"> + <summary> + Closes the specified session with <paramref name="code"/> and + <paramref name="reason"/>. + </summary> + <param name="id"> + A <see cref="T:System.String"/> that represents the ID of the session to close. + </param> + <param name="code"> + <para> + One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values. + </para> + <para> + It represents the status code indicating the reason for the close. + </para> + </param> + <param name="reason"> + <para> + A <see cref="T:System.String"/> that represents the reason for the close. + </para> + <para> + The size must be 123 bytes or less in UTF-8. + </para> + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="id"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="id"/> is an empty string. + </para> + <para> + -or- + </para> + <para> + <paramref name="code"/> is + <see cref="F:WebSocketSharp.CloseStatusCode.MandatoryExtension"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="code"/> is + <see cref="F:WebSocketSharp.CloseStatusCode.NoStatus"/> and there is + <paramref name="reason"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="reason"/> could not be UTF-8-encoded. + </para> + </exception> + <exception cref="T:System.InvalidOperationException"> + The session could not be found. + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + The size of <paramref name="reason"/> is greater than 123 bytes. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketSessionManager.PingTo(System.String)"> + <summary> + Sends a ping to the client using the specified session. + </summary> + <returns> + <c>true</c> if the send has done with no error and a pong has been + received from the client within a time; otherwise, <c>false</c>. + </returns> + <param name="id"> + A <see cref="T:System.String"/> that represents the ID of the session. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="id"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="id"/> is an empty string. + </exception> + <exception cref="T:System.InvalidOperationException"> + The session could not be found. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketSessionManager.PingTo(System.String,System.String)"> + <summary> + Sends a ping with <paramref name="message"/> to the client using + the specified session. + </summary> + <returns> + <c>true</c> if the send has done with no error and a pong has been + received from the client within a time; otherwise, <c>false</c>. + </returns> + <param name="message"> + <para> + A <see cref="T:System.String"/> that represents the message to send. + </para> + <para> + The size must be 125 bytes or less in UTF-8. + </para> + </param> + <param name="id"> + A <see cref="T:System.String"/> that represents the ID of the session. + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="id"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="id"/> is an empty string. + </para> + <para> + -or- + </para> + <para> + <paramref name="message"/> could not be UTF-8-encoded. + </para> + </exception> + <exception cref="T:System.InvalidOperationException"> + The session could not be found. + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + The size of <paramref name="message"/> is greater than 125 bytes. + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketSessionManager.SendTo(System.Byte[],System.String)"> + <summary> + Sends <paramref name="data"/> to the client using the specified session. + </summary> + <param name="data"> + An array of <see cref="T:System.Byte"/> that represents the binary data to send. + </param> + <param name="id"> + A <see cref="T:System.String"/> that represents the ID of the session. + </param> + <exception cref="T:System.ArgumentNullException"> + <para> + <paramref name="id"/> is <see langword="null"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="data"/> is <see langword="null"/>. + </para> + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="id"/> is an empty string. + </exception> + <exception cref="T:System.InvalidOperationException"> + <para> + The session could not be found. + </para> + <para> + -or- + </para> + <para> + The current state of the WebSocket connection is not Open. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketSessionManager.SendTo(System.String,System.String)"> + <summary> + Sends <paramref name="data"/> to the client using the specified session. + </summary> + <param name="data"> + A <see cref="T:System.String"/> that represents the text data to send. + </param> + <param name="id"> + A <see cref="T:System.String"/> that represents the ID of the session. + </param> + <exception cref="T:System.ArgumentNullException"> + <para> + <paramref name="id"/> is <see langword="null"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="data"/> is <see langword="null"/>. + </para> + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="id"/> is an empty string. + </para> + <para> + -or- + </para> + <para> + <paramref name="data"/> could not be UTF-8-encoded. + </para> + </exception> + <exception cref="T:System.InvalidOperationException"> + <para> + The session could not be found. + </para> + <para> + -or- + </para> + <para> + The current state of the WebSocket connection is not Open. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketSessionManager.SendTo(System.IO.Stream,System.Int32,System.String)"> + <summary> + Sends the data from <paramref name="stream"/> to the client using + the specified session. + </summary> + <remarks> + The data is sent as the binary data. + </remarks> + <param name="stream"> + A <see cref="T:System.IO.Stream"/> instance from which to read the data to send. + </param> + <param name="length"> + An <see cref="T:System.Int32"/> that specifies the number of bytes to send. + </param> + <param name="id"> + A <see cref="T:System.String"/> that represents the ID of the session. + </param> + <exception cref="T:System.ArgumentNullException"> + <para> + <paramref name="id"/> is <see langword="null"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="stream"/> is <see langword="null"/>. + </para> + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="id"/> is an empty string. + </para> + <para> + -or- + </para> + <para> + <paramref name="stream"/> cannot be read. + </para> + <para> + -or- + </para> + <para> + <paramref name="length"/> is less than 1. + </para> + <para> + -or- + </para> + <para> + No data could be read from <paramref name="stream"/>. + </para> + </exception> + <exception cref="T:System.InvalidOperationException"> + <para> + The session could not be found. + </para> + <para> + -or- + </para> + <para> + The current state of the WebSocket connection is not Open. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketSessionManager.SendToAsync(System.Byte[],System.String,System.Action{System.Boolean})"> + <summary> + Sends <paramref name="data"/> asynchronously to the client using + the specified session. + </summary> + <remarks> + This method does not wait for the send to be complete. + </remarks> + <param name="data"> + An array of <see cref="T:System.Byte"/> that represents the binary data to send. + </param> + <param name="id"> + A <see cref="T:System.String"/> that represents the ID of the session. + </param> + <param name="completed"> + <para> + An <c>Action<bool></c> delegate or <see langword="null"/> + if not needed. + </para> + <para> + The delegate invokes the method called when the send is complete. + </para> + <para> + <c>true</c> is passed to the method if the send has done with + no error; otherwise, <c>false</c>. + </para> + </param> + <exception cref="T:System.ArgumentNullException"> + <para> + <paramref name="id"/> is <see langword="null"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="data"/> is <see langword="null"/>. + </para> + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="id"/> is an empty string. + </exception> + <exception cref="T:System.InvalidOperationException"> + <para> + The session could not be found. + </para> + <para> + -or- + </para> + <para> + The current state of the WebSocket connection is not Open. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketSessionManager.SendToAsync(System.String,System.String,System.Action{System.Boolean})"> + <summary> + Sends <paramref name="data"/> asynchronously to the client using + the specified session. + </summary> + <remarks> + This method does not wait for the send to be complete. + </remarks> + <param name="data"> + A <see cref="T:System.String"/> that represents the text data to send. + </param> + <param name="id"> + A <see cref="T:System.String"/> that represents the ID of the session. + </param> + <param name="completed"> + <para> + An <c>Action<bool></c> delegate or <see langword="null"/> + if not needed. + </para> + <para> + The delegate invokes the method called when the send is complete. + </para> + <para> + <c>true</c> is passed to the method if the send has done with + no error; otherwise, <c>false</c>. + </para> + </param> + <exception cref="T:System.ArgumentNullException"> + <para> + <paramref name="id"/> is <see langword="null"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="data"/> is <see langword="null"/>. + </para> + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="id"/> is an empty string. + </para> + <para> + -or- + </para> + <para> + <paramref name="data"/> could not be UTF-8-encoded. + </para> + </exception> + <exception cref="T:System.InvalidOperationException"> + <para> + The session could not be found. + </para> + <para> + -or- + </para> + <para> + The current state of the WebSocket connection is not Open. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketSessionManager.SendToAsync(System.IO.Stream,System.Int32,System.String,System.Action{System.Boolean})"> + <summary> + Sends the data from <paramref name="stream"/> asynchronously to + the client using the specified session. + </summary> + <remarks> + <para> + The data is sent as the binary data. + </para> + <para> + This method does not wait for the send to be complete. + </para> + </remarks> + <param name="stream"> + A <see cref="T:System.IO.Stream"/> instance from which to read the data to send. + </param> + <param name="length"> + An <see cref="T:System.Int32"/> that specifies the number of bytes to send. + </param> + <param name="id"> + A <see cref="T:System.String"/> that represents the ID of the session. + </param> + <param name="completed"> + <para> + An <c>Action<bool></c> delegate or <see langword="null"/> + if not needed. + </para> + <para> + The delegate invokes the method called when the send is complete. + </para> + <para> + <c>true</c> is passed to the method if the send has done with + no error; otherwise, <c>false</c>. + </para> + </param> + <exception cref="T:System.ArgumentNullException"> + <para> + <paramref name="id"/> is <see langword="null"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="stream"/> is <see langword="null"/>. + </para> + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="id"/> is an empty string. + </para> + <para> + -or- + </para> + <para> + <paramref name="stream"/> cannot be read. + </para> + <para> + -or- + </para> + <para> + <paramref name="length"/> is less than 1. + </para> + <para> + -or- + </para> + <para> + No data could be read from <paramref name="stream"/>. + </para> + </exception> + <exception cref="T:System.InvalidOperationException"> + <para> + The session could not be found. + </para> + <para> + -or- + </para> + <para> + The current state of the WebSocket connection is not Open. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.Server.WebSocketSessionManager.Sweep"> + <summary> + Cleans up the inactive sessions in the WebSocket service. + </summary> + </member> + <member name="M:WebSocketSharp.Server.WebSocketSessionManager.TryGetSession(System.String,WebSocketSharp.Server.IWebSocketSession@)"> + <summary> + Tries to get the session instance with <paramref name="id"/>. + </summary> + <returns> + <c>true</c> if the session is successfully found; otherwise, + <c>false</c>. + </returns> + <param name="id"> + A <see cref="T:System.String"/> that represents the ID of the session to find. + </param> + <param name="session"> + <para> + When this method returns, a <see cref="T:WebSocketSharp.Server.IWebSocketSession"/> + instance or <see langword="null"/> if not found. + </para> + <para> + The session instance provides the function to access + the information in the session. + </para> + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="id"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="id"/> is an empty string. + </exception> + </member> + <member name="T:WebSocketSharp.WebSocket"> + <summary> + Implements the WebSocket interface. + </summary> + <remarks> + The WebSocket class provides a set of methods and properties for two-way communication using + the WebSocket protocol (<see href="http://tools.ietf.org/html/rfc6455">RFC 6455</see>). + </remarks> + </member> + <member name="F:WebSocketSharp.WebSocket.EmptyBytes"> + <summary> + Represents the empty array of <see cref="T:System.Byte"/> used internally. + </summary> + </member> + <member name="F:WebSocketSharp.WebSocket.FragmentLength"> + <summary> + Represents the length used to determine whether the data should be fragmented in sending. + </summary> + <remarks> + <para> + The data will be fragmented if that length is greater than the value of this field. + </para> + <para> + If you would like to change the value, you must set it to a value between <c>125</c> and + <c>Int32.MaxValue - 14</c> inclusive. + </para> + </remarks> + </member> + <member name="F:WebSocketSharp.WebSocket.RandomNumber"> + <summary> + Represents the random number generator used internally. + </summary> + </member> + <member name="M:WebSocketSharp.WebSocket.#ctor(System.String,System.String[])"> + <summary> + Initializes a new instance of the <see cref="T:WebSocketSharp.WebSocket"/> class with + <paramref name="url"/> and <paramref name="protocols"/>. + </summary> + <param name="url"> + A <see cref="T:System.String"/> that specifies the URL of the WebSocket + server to connect. + </param> + <param name="protocols"> + <para> + An array of <see cref="T:System.String"/> that specifies the names of + the subprotocols if necessary. + </para> + <para> + Each value of the array must be a token defined in + <see href="http://tools.ietf.org/html/rfc2616#section-2.2"> + RFC 2616</see>. + </para> + </param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="url"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="url"/> is an empty string. + </para> + <para> + -or- + </para> + <para> + <paramref name="url"/> is an invalid WebSocket URL string. + </para> + <para> + -or- + </para> + <para> + <paramref name="protocols"/> contains a value that is not a token. + </para> + <para> + -or- + </para> + <para> + <paramref name="protocols"/> contains a value twice. + </para> + </exception> + </member> + <member name="P:WebSocketSharp.WebSocket.Compression"> + <summary> + Gets or sets the compression method used to compress a message. + </summary> + <remarks> + The set operation does nothing if the connection has already been + established or it is closing. + </remarks> + <value> + <para> + One of the <see cref="T:WebSocketSharp.CompressionMethod"/> enum values. + </para> + <para> + It represents the compression method used to compress a message. + </para> + <para> + The default value is <see cref="F:WebSocketSharp.CompressionMethod.None"/>. + </para> + </value> + <exception cref="T:System.InvalidOperationException"> + The set operation cannot be used by servers. + </exception> + </member> + <member name="P:WebSocketSharp.WebSocket.Cookies"> + <summary> + Gets the HTTP cookies included in the WebSocket handshake request and response. + </summary> + <value> + An <see cref="T:System.Collections.Generic.IEnumerable{WebSocketSharp.Net.Cookie}"/> + instance that provides an enumerator which supports the iteration over the collection of + the cookies. + </value> + </member> + <member name="P:WebSocketSharp.WebSocket.Credentials"> + <summary> + Gets the credentials for the HTTP authentication (Basic/Digest). + </summary> + <value> + A <see cref="T:WebSocketSharp.Net.NetworkCredential"/> that represents the credentials for + the authentication. The default value is <see langword="null"/>. + </value> + </member> + <member name="P:WebSocketSharp.WebSocket.EmitOnPing"> + <summary> + Gets or sets a value indicating whether the <see cref="T:WebSocketSharp.WebSocket"/> emits + a <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event when receives a ping. + </summary> + <value> + <c>true</c> if the <see cref="T:WebSocketSharp.WebSocket"/> emits a <see cref="E:WebSocketSharp.WebSocket.OnMessage"/> event + when receives a ping; otherwise, <c>false</c>. The default value is <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.WebSocket.EnableRedirection"> + <summary> + Gets or sets a value indicating whether the URL redirection for + the handshake request is allowed. + </summary> + <remarks> + The set operation does nothing if the connection has already been + established or it is closing. + </remarks> + <value> + <para> + <c>true</c> if the URL redirection for the handshake request is + allowed; otherwise, <c>false</c>. + </para> + <para> + The default value is <c>false</c>. + </para> + </value> + <exception cref="T:System.InvalidOperationException"> + The set operation cannot be used by servers. + </exception> + </member> + <member name="P:WebSocketSharp.WebSocket.Extensions"> + <summary> + Gets the WebSocket extensions selected by the server. + </summary> + <value> + A <see cref="T:System.String"/> that represents the extensions if any. + The default value is <see cref="F:System.String.Empty"/>. + </value> + </member> + <member name="P:WebSocketSharp.WebSocket.IsAlive"> + <summary> + Gets a value indicating whether the WebSocket connection is alive. + </summary> + <value> + <c>true</c> if the connection is alive; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.WebSocket.IsSecure"> + <summary> + Gets a value indicating whether the WebSocket connection is secure. + </summary> + <value> + <c>true</c> if the connection is secure; otherwise, <c>false</c>. + </value> + </member> + <member name="P:WebSocketSharp.WebSocket.Log"> + <summary> + Gets the logging functions. + </summary> + <remarks> + The default logging level is <see cref="F:WebSocketSharp.LogLevel.Error"/>. If you would like to change it, + you should set this <c>Log.Level</c> property to any of the <see cref="T:WebSocketSharp.LogLevel"/> enum + values. + </remarks> + <value> + A <see cref="T:WebSocketSharp.Logger"/> that provides the logging functions. + </value> + </member> + <member name="P:WebSocketSharp.WebSocket.Origin"> + <summary> + Gets or sets the value of the HTTP Origin header to send with + the handshake request. + </summary> + <remarks> + <para> + The HTTP Origin header is defined in + <see href="http://tools.ietf.org/html/rfc6454#section-7"> + Section 7 of RFC 6454</see>. + </para> + <para> + This instance sends the Origin header if this property has any. + </para> + <para> + The set operation does nothing if the connection has already been + established or it is closing. + </para> + </remarks> + <value> + <para> + A <see cref="T:System.String"/> that represents the value of the Origin + header to send. + </para> + <para> + The syntax is <scheme>://<host>[:<port>]. + </para> + <para> + The default value is <see langword="null"/>. + </para> + </value> + <exception cref="T:System.InvalidOperationException"> + The set operation is not available if this instance is not a client. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + The value specified for a set operation is not an absolute URI string. + </para> + <para> + -or- + </para> + <para> + The value specified for a set operation includes the path segments. + </para> + </exception> + </member> + <member name="P:WebSocketSharp.WebSocket.Protocol"> + <summary> + Gets the WebSocket subprotocol selected by the server. + </summary> + <value> + A <see cref="T:System.String"/> that represents the subprotocol if any. + The default value is <see cref="F:System.String.Empty"/>. + </value> + </member> + <member name="P:WebSocketSharp.WebSocket.ReadyState"> + <summary> + Gets the state of the WebSocket connection. + </summary> + <value> + One of the <see cref="T:WebSocketSharp.WebSocketState"/> enum values that indicates + the current state of the connection. The default value is + <see cref="F:WebSocketSharp.WebSocketState.Connecting"/>. + </value> + </member> + <member name="P:WebSocketSharp.WebSocket.SslConfiguration"> + <summary> + Gets the configuration for secure connection. + </summary> + <remarks> + This configuration will be referenced when attempts to connect, + so it must be configured before any connect method is called. + </remarks> + <value> + A <see cref="T:WebSocketSharp.Net.ClientSslConfiguration"/> that represents + the configuration used to establish a secure connection. + </value> + <exception cref="T:System.InvalidOperationException"> + <para> + This instance is not a client. + </para> + <para> + This instance does not use a secure connection. + </para> + </exception> + </member> + <member name="P:WebSocketSharp.WebSocket.Url"> + <summary> + Gets the WebSocket URL used to connect, or accepted. + </summary> + <value> + A <see cref="T:System.Uri"/> that represents the URL used to connect, or accepted. + </value> + </member> + <member name="P:WebSocketSharp.WebSocket.WaitTime"> + <summary> + Gets or sets the time to wait for the response to the ping or close. + </summary> + <remarks> + The set operation does nothing if the connection has already been + established or it is closing. + </remarks> + <value> + <para> + A <see cref="T:System.TimeSpan"/> to wait for the response. + </para> + <para> + The default value is the same as 5 seconds if the instance is + a client. + </para> + </value> + <exception cref="T:System.ArgumentOutOfRangeException"> + The value specified for a set operation is zero or less. + </exception> + </member> + <member name="E:WebSocketSharp.WebSocket.OnClose"> + <summary> + Occurs when the WebSocket connection has been closed. + </summary> + </member> + <member name="E:WebSocketSharp.WebSocket.OnError"> + <summary> + Occurs when the <see cref="T:WebSocketSharp.WebSocket"/> gets an error. + </summary> + </member> + <member name="E:WebSocketSharp.WebSocket.OnMessage"> + <summary> + Occurs when the <see cref="T:WebSocketSharp.WebSocket"/> receives a message. + </summary> + </member> + <member name="E:WebSocketSharp.WebSocket.OnOpen"> + <summary> + Occurs when the WebSocket connection has been established. + </summary> + </member> + <member name="M:WebSocketSharp.WebSocket.Accept"> + <summary> + Accepts the WebSocket handshake request. + </summary> + <remarks> + This method is not available in a client. + </remarks> + </member> + <member name="M:WebSocketSharp.WebSocket.AcceptAsync"> + <summary> + Accepts the WebSocket handshake request asynchronously. + </summary> + <remarks> + <para> + This method does not wait for the accept to be complete. + </para> + <para> + This method is not available in a client. + </para> + </remarks> + </member> + <member name="M:WebSocketSharp.WebSocket.Close"> + <summary> + Closes the connection. + </summary> + <remarks> + This method does nothing if the current state of the connection is + Closing or Closed. + </remarks> + </member> + <member name="M:WebSocketSharp.WebSocket.Close(System.UInt16)"> + <summary> + Closes the connection with the specified <paramref name="code"/>. + </summary> + <remarks> + This method does nothing if the current state of the connection is + Closing or Closed. + </remarks> + <param name="code"> + <para> + A <see cref="T:System.UInt16"/> that represents the status code + indicating the reason for the close. + </para> + <para> + The status codes are defined in + <see href="http://tools.ietf.org/html/rfc6455#section-7.4"> + Section 7.4</see> of RFC 6455. + </para> + </param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <paramref name="code"/> is less than 1000 or greater than 4999. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="code"/> is 1011 (server error). + It cannot be used by clients. + </para> + <para> + -or- + </para> + <para> + <paramref name="code"/> is 1010 (mandatory extension). + It cannot be used by servers. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.WebSocket.Close(WebSocketSharp.CloseStatusCode)"> + <summary> + Closes the connection with the specified <paramref name="code"/>. + </summary> + <remarks> + This method does nothing if the current state of the connection is + Closing or Closed. + </remarks> + <param name="code"> + <para> + One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values. + </para> + <para> + It represents the status code indicating the reason for the close. + </para> + </param> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="code"/> is + <see cref="F:WebSocketSharp.CloseStatusCode.ServerError"/>. + It cannot be used by clients. + </para> + <para> + -or- + </para> + <para> + <paramref name="code"/> is + <see cref="F:WebSocketSharp.CloseStatusCode.MandatoryExtension"/>. + It cannot be used by servers. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.WebSocket.Close(System.UInt16,System.String)"> + <summary> + Closes the connection with the specified <paramref name="code"/> and + <paramref name="reason"/>. + </summary> + <remarks> + This method does nothing if the current state of the connection is + Closing or Closed. + </remarks> + <param name="code"> + <para> + A <see cref="T:System.UInt16"/> that represents the status code + indicating the reason for the close. + </para> + <para> + The status codes are defined in + <see href="http://tools.ietf.org/html/rfc6455#section-7.4"> + Section 7.4</see> of RFC 6455. + </para> + </param> + <param name="reason"> + <para> + A <see cref="T:System.String"/> that represents the reason for the close. + </para> + <para> + The size must be 123 bytes or less in UTF-8. + </para> + </param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <para> + <paramref name="code"/> is less than 1000 or greater than 4999. + </para> + <para> + -or- + </para> + <para> + The size of <paramref name="reason"/> is greater than 123 bytes. + </para> + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="code"/> is 1011 (server error). + It cannot be used by clients. + </para> + <para> + -or- + </para> + <para> + <paramref name="code"/> is 1010 (mandatory extension). + It cannot be used by servers. + </para> + <para> + -or- + </para> + <para> + <paramref name="code"/> is 1005 (no status) and + there is <paramref name="reason"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="reason"/> could not be UTF-8-encoded. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.WebSocket.Close(WebSocketSharp.CloseStatusCode,System.String)"> + <summary> + Closes the connection with the specified <paramref name="code"/> and + <paramref name="reason"/>. + </summary> + <remarks> + This method does nothing if the current state of the connection is + Closing or Closed. + </remarks> + <param name="code"> + <para> + One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values. + </para> + <para> + It represents the status code indicating the reason for the close. + </para> + </param> + <param name="reason"> + <para> + A <see cref="T:System.String"/> that represents the reason for the close. + </para> + <para> + The size must be 123 bytes or less in UTF-8. + </para> + </param> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="code"/> is + <see cref="F:WebSocketSharp.CloseStatusCode.ServerError"/>. + It cannot be used by clients. + </para> + <para> + -or- + </para> + <para> + <paramref name="code"/> is + <see cref="F:WebSocketSharp.CloseStatusCode.MandatoryExtension"/>. + It cannot be used by servers. + </para> + <para> + -or- + </para> + <para> + <paramref name="code"/> is + <see cref="F:WebSocketSharp.CloseStatusCode.NoStatus"/> and + there is <paramref name="reason"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="reason"/> could not be UTF-8-encoded. + </para> + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + The size of <paramref name="reason"/> is greater than 123 bytes. + </exception> + </member> + <member name="M:WebSocketSharp.WebSocket.CloseAsync"> + <summary> + Closes the connection asynchronously. + </summary> + <remarks> + <para> + This method does not wait for the close to be complete. + </para> + <para> + And this method does nothing if the current state of + the connection is Closing or Closed. + </para> + </remarks> + </member> + <member name="M:WebSocketSharp.WebSocket.CloseAsync(System.UInt16)"> + <summary> + Closes the connection asynchronously with the specified + <paramref name="code"/>. + </summary> + <remarks> + <para> + This method does not wait for the close to be complete. + </para> + <para> + And this method does nothing if the current state of + the connection is Closing or Closed. + </para> + </remarks> + <param name="code"> + <para> + A <see cref="T:System.UInt16"/> that represents the status code + indicating the reason for the close. + </para> + <para> + The status codes are defined in + <see href="http://tools.ietf.org/html/rfc6455#section-7.4"> + Section 7.4</see> of RFC 6455. + </para> + </param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <paramref name="code"/> is less than 1000 or greater than 4999. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="code"/> is 1011 (server error). + It cannot be used by clients. + </para> + <para> + -or- + </para> + <para> + <paramref name="code"/> is 1010 (mandatory extension). + It cannot be used by servers. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.WebSocket.CloseAsync(WebSocketSharp.CloseStatusCode)"> + <summary> + Closes the connection asynchronously with the specified + <paramref name="code"/>. + </summary> + <remarks> + <para> + This method does not wait for the close to be complete. + </para> + <para> + And this method does nothing if the current state of + the connection is Closing or Closed. + </para> + </remarks> + <param name="code"> + <para> + One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values. + </para> + <para> + It represents the status code indicating the reason for the close. + </para> + </param> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="code"/> is + <see cref="F:WebSocketSharp.CloseStatusCode.ServerError"/>. + It cannot be used by clients. + </para> + <para> + -or- + </para> + <para> + <paramref name="code"/> is + <see cref="F:WebSocketSharp.CloseStatusCode.MandatoryExtension"/>. + It cannot be used by servers. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.WebSocket.CloseAsync(System.UInt16,System.String)"> + <summary> + Closes the connection asynchronously with the specified + <paramref name="code"/> and <paramref name="reason"/>. + </summary> + <remarks> + <para> + This method does not wait for the close to be complete. + </para> + <para> + And this method does nothing if the current state of + the connection is Closing or Closed. + </para> + </remarks> + <param name="code"> + <para> + A <see cref="T:System.UInt16"/> that represents the status code + indicating the reason for the close. + </para> + <para> + The status codes are defined in + <see href="http://tools.ietf.org/html/rfc6455#section-7.4"> + Section 7.4</see> of RFC 6455. + </para> + </param> + <param name="reason"> + <para> + A <see cref="T:System.String"/> that represents the reason for the close. + </para> + <para> + The size must be 123 bytes or less in UTF-8. + </para> + </param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <para> + <paramref name="code"/> is less than 1000 or greater than 4999. + </para> + <para> + -or- + </para> + <para> + The size of <paramref name="reason"/> is greater than 123 bytes. + </para> + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="code"/> is 1011 (server error). + It cannot be used by clients. + </para> + <para> + -or- + </para> + <para> + <paramref name="code"/> is 1010 (mandatory extension). + It cannot be used by servers. + </para> + <para> + -or- + </para> + <para> + <paramref name="code"/> is 1005 (no status) and + there is <paramref name="reason"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="reason"/> could not be UTF-8-encoded. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.WebSocket.CloseAsync(WebSocketSharp.CloseStatusCode,System.String)"> + <summary> + Closes the connection asynchronously with the specified + <paramref name="code"/> and <paramref name="reason"/>. + </summary> + <remarks> + <para> + This method does not wait for the close to be complete. + </para> + <para> + And this method does nothing if the current state of + the connection is Closing or Closed. + </para> + </remarks> + <param name="code"> + <para> + One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values. + </para> + <para> + It represents the status code indicating the reason for the close. + </para> + </param> + <param name="reason"> + <para> + A <see cref="T:System.String"/> that represents the reason for the close. + </para> + <para> + The size must be 123 bytes or less in UTF-8. + </para> + </param> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="code"/> is + <see cref="F:WebSocketSharp.CloseStatusCode.ServerError"/>. + It cannot be used by clients. + </para> + <para> + -or- + </para> + <para> + <paramref name="code"/> is + <see cref="F:WebSocketSharp.CloseStatusCode.MandatoryExtension"/>. + It cannot be used by servers. + </para> + <para> + -or- + </para> + <para> + <paramref name="code"/> is + <see cref="F:WebSocketSharp.CloseStatusCode.NoStatus"/> and + there is <paramref name="reason"/>. + </para> + <para> + -or- + </para> + <para> + <paramref name="reason"/> could not be UTF-8-encoded. + </para> + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + The size of <paramref name="reason"/> is greater than 123 bytes. + </exception> + </member> + <member name="M:WebSocketSharp.WebSocket.Connect"> + <summary> + Establishes a WebSocket connection. + </summary> + <remarks> + This method is not available in a server. + </remarks> + </member> + <member name="M:WebSocketSharp.WebSocket.ConnectAsync"> + <summary> + Establishes a WebSocket connection asynchronously. + </summary> + <remarks> + <para> + This method does not wait for the connect to be complete. + </para> + <para> + This method is not available in a server. + </para> + </remarks> + </member> + <member name="M:WebSocketSharp.WebSocket.Ping"> + <summary> + Sends a ping using the WebSocket connection. + </summary> + <returns> + <c>true</c> if the send has done with no error and a pong has been + received within a time; otherwise, <c>false</c>. + </returns> + </member> + <member name="M:WebSocketSharp.WebSocket.Ping(System.String)"> + <summary> + Sends a ping with <paramref name="message"/> using the WebSocket + connection. + </summary> + <returns> + <c>true</c> if the send has done with no error and a pong has been + received within a time; otherwise, <c>false</c>. + </returns> + <param name="message"> + <para> + A <see cref="T:System.String"/> that represents the message to send. + </para> + <para> + The size must be 125 bytes or less in UTF-8. + </para> + </param> + <exception cref="T:System.ArgumentException"> + <paramref name="message"/> could not be UTF-8-encoded. + </exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + The size of <paramref name="message"/> is greater than 125 bytes. + </exception> + </member> + <member name="M:WebSocketSharp.WebSocket.Send(System.Byte[])"> + <summary> + Sends <paramref name="data"/> using the WebSocket connection. + </summary> + <param name="data"> + An array of <see cref="T:System.Byte"/> that represents the binary data to send. + </param> + <exception cref="T:System.InvalidOperationException"> + The current state of the connection is not Open. + </exception> + <exception cref="T:System.ArgumentNullException"> + <paramref name="data"/> is <see langword="null"/>. + </exception> + </member> + <member name="M:WebSocketSharp.WebSocket.Send(System.IO.FileInfo)"> + <summary> + Sends the specified file using the WebSocket connection. + </summary> + <remarks> + The file is sent as the binary data. + </remarks> + <param name="fileInfo"> + A <see cref="T:System.IO.FileInfo"/> that specifies the file to send. + </param> + <exception cref="T:System.InvalidOperationException"> + The current state of the connection is not Open. + </exception> + <exception cref="T:System.ArgumentNullException"> + <paramref name="fileInfo"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + The file does not exist. + </para> + <para> + -or- + </para> + <para> + The file could not be opened. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.WebSocket.Send(System.String)"> + <summary> + Sends <paramref name="data"/> using the WebSocket connection. + </summary> + <param name="data"> + A <see cref="T:System.String"/> that represents the text data to send. + </param> + <exception cref="T:System.InvalidOperationException"> + The current state of the connection is not Open. + </exception> + <exception cref="T:System.ArgumentNullException"> + <paramref name="data"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="data"/> could not be UTF-8-encoded. + </exception> + </member> + <member name="M:WebSocketSharp.WebSocket.Send(System.IO.Stream,System.Int32)"> + <summary> + Sends the data from <paramref name="stream"/> using the WebSocket + connection. + </summary> + <remarks> + The data is sent as the binary data. + </remarks> + <param name="stream"> + A <see cref="T:System.IO.Stream"/> instance from which to read the data to send. + </param> + <param name="length"> + An <see cref="T:System.Int32"/> that specifies the number of bytes to send. + </param> + <exception cref="T:System.InvalidOperationException"> + The current state of the connection is not Open. + </exception> + <exception cref="T:System.ArgumentNullException"> + <paramref name="stream"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="stream"/> cannot be read. + </para> + <para> + -or- + </para> + <para> + <paramref name="length"/> is less than 1. + </para> + <para> + -or- + </para> + <para> + No data could be read from <paramref name="stream"/>. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.WebSocket.SendAsync(System.Byte[],System.Action{System.Boolean})"> + <summary> + Sends <paramref name="data"/> asynchronously using the WebSocket + connection. + </summary> + <remarks> + This method does not wait for the send to be complete. + </remarks> + <param name="data"> + An array of <see cref="T:System.Byte"/> that represents the binary data to send. + </param> + <param name="completed"> + <para> + An <c>Action<bool></c> delegate or <see langword="null"/> + if not needed. + </para> + <para> + The delegate invokes the method called when the send is complete. + </para> + <para> + <c>true</c> is passed to the method if the send has done with + no error; otherwise, <c>false</c>. + </para> + </param> + <exception cref="T:System.InvalidOperationException"> + The current state of the connection is not Open. + </exception> + <exception cref="T:System.ArgumentNullException"> + <paramref name="data"/> is <see langword="null"/>. + </exception> + </member> + <member name="M:WebSocketSharp.WebSocket.SendAsync(System.IO.FileInfo,System.Action{System.Boolean})"> + <summary> + Sends the specified file asynchronously using the WebSocket connection. + </summary> + <remarks> + <para> + The file is sent as the binary data. + </para> + <para> + This method does not wait for the send to be complete. + </para> + </remarks> + <param name="fileInfo"> + A <see cref="T:System.IO.FileInfo"/> that specifies the file to send. + </param> + <param name="completed"> + <para> + An <c>Action<bool></c> delegate or <see langword="null"/> + if not needed. + </para> + <para> + The delegate invokes the method called when the send is complete. + </para> + <para> + <c>true</c> is passed to the method if the send has done with + no error; otherwise, <c>false</c>. + </para> + </param> + <exception cref="T:System.InvalidOperationException"> + The current state of the connection is not Open. + </exception> + <exception cref="T:System.ArgumentNullException"> + <paramref name="fileInfo"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + The file does not exist. + </para> + <para> + -or- + </para> + <para> + The file could not be opened. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.WebSocket.SendAsync(System.String,System.Action{System.Boolean})"> + <summary> + Sends <paramref name="data"/> asynchronously using the WebSocket + connection. + </summary> + <remarks> + This method does not wait for the send to be complete. + </remarks> + <param name="data"> + A <see cref="T:System.String"/> that represents the text data to send. + </param> + <param name="completed"> + <para> + An <c>Action<bool></c> delegate or <see langword="null"/> + if not needed. + </para> + <para> + The delegate invokes the method called when the send is complete. + </para> + <para> + <c>true</c> is passed to the method if the send has done with + no error; otherwise, <c>false</c>. + </para> + </param> + <exception cref="T:System.InvalidOperationException"> + The current state of the connection is not Open. + </exception> + <exception cref="T:System.ArgumentNullException"> + <paramref name="data"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <paramref name="data"/> could not be UTF-8-encoded. + </exception> + </member> + <member name="M:WebSocketSharp.WebSocket.SendAsync(System.IO.Stream,System.Int32,System.Action{System.Boolean})"> + <summary> + Sends the data from <paramref name="stream"/> asynchronously using + the WebSocket connection. + </summary> + <remarks> + <para> + The data is sent as the binary data. + </para> + <para> + This method does not wait for the send to be complete. + </para> + </remarks> + <param name="stream"> + A <see cref="T:System.IO.Stream"/> instance from which to read the data to send. + </param> + <param name="length"> + An <see cref="T:System.Int32"/> that specifies the number of bytes to send. + </param> + <param name="completed"> + <para> + An <c>Action<bool></c> delegate or <see langword="null"/> + if not needed. + </para> + <para> + The delegate invokes the method called when the send is complete. + </para> + <para> + <c>true</c> is passed to the method if the send has done with + no error; otherwise, <c>false</c>. + </para> + </param> + <exception cref="T:System.InvalidOperationException"> + The current state of the connection is not Open. + </exception> + <exception cref="T:System.ArgumentNullException"> + <paramref name="stream"/> is <see langword="null"/>. + </exception> + <exception cref="T:System.ArgumentException"> + <para> + <paramref name="stream"/> cannot be read. + </para> + <para> + -or- + </para> + <para> + <paramref name="length"/> is less than 1. + </para> + <para> + -or- + </para> + <para> + No data could be read from <paramref name="stream"/>. + </para> + </exception> + </member> + <member name="M:WebSocketSharp.WebSocket.SetCookie(WebSocketSharp.Net.Cookie)"> + <summary> + Sets an HTTP <paramref name="cookie"/> to send with + the WebSocket handshake request to the server. + </summary> + <remarks> + This method is not available in a server. + </remarks> + <param name="cookie"> + A <see cref="T:WebSocketSharp.Net.Cookie"/> that represents a cookie to send. + </param> + </member> + <member name="M:WebSocketSharp.WebSocket.SetCredentials(System.String,System.String,System.Boolean)"> + <summary> + Sets a pair of <paramref name="username"/> and <paramref name="password"/> for + the HTTP authentication (Basic/Digest). + </summary> + <remarks> + This method is not available in a server. + </remarks> + <param name="username"> + <para> + A <see cref="T:System.String"/> that represents the user name used to authenticate. + </para> + <para> + If <paramref name="username"/> is <see langword="null"/> or empty, + the credentials will be initialized and not be sent. + </para> + </param> + <param name="password"> + A <see cref="T:System.String"/> that represents the password for + <paramref name="username"/> used to authenticate. + </param> + <param name="preAuth"> + <c>true</c> if the <see cref="T:WebSocketSharp.WebSocket"/> sends the credentials for + the Basic authentication with the first handshake request to the server; + otherwise, <c>false</c>. + </param> + </member> + <member name="M:WebSocketSharp.WebSocket.SetProxy(System.String,System.String,System.String)"> + <summary> + Sets the HTTP proxy server URL to connect through, and if necessary, + a pair of <paramref name="username"/> and <paramref name="password"/> for + the proxy server authentication (Basic/Digest). + </summary> + <remarks> + This method is not available in a server. + </remarks> + <param name="url"> + <para> + A <see cref="T:System.String"/> that represents the HTTP proxy server URL to + connect through. The syntax must be http://<host>[:<port>]. + </para> + <para> + If <paramref name="url"/> is <see langword="null"/> or empty, + the url and credentials for the proxy will be initialized, + and the <see cref="T:WebSocketSharp.WebSocket"/> will not use the proxy to + connect through. + </para> + </param> + <param name="username"> + <para> + A <see cref="T:System.String"/> that represents the user name used to authenticate. + </para> + <para> + If <paramref name="username"/> is <see langword="null"/> or empty, + the credentials for the proxy will be initialized and not be sent. + </para> + </param> + <param name="password"> + A <see cref="T:System.String"/> that represents the password for + <paramref name="username"/> used to authenticate. + </param> + </member> + <member name="M:WebSocketSharp.WebSocket.System#IDisposable#Dispose"> + <summary> + Closes the connection and releases all associated resources. + </summary> + <remarks> + <para> + This method closes the connection with close status 1001 (going away). + </para> + <para> + And this method does nothing if the current state of the connection is + Closing or Closed. + </para> + </remarks> + </member> + <member name="T:WebSocketSharp.WebSocketException"> + <summary> + The exception that is thrown when a fatal error occurs in + the WebSocket communication. + </summary> + </member> + <member name="P:WebSocketSharp.WebSocketException.Code"> + <summary> + Gets the status code indicating the cause of the exception. + </summary> + <value> + One of the <see cref="T:WebSocketSharp.CloseStatusCode"/> enum values that represents + the status code indicating the cause of the exception. + </value> + </member> + <member name="F:WebSocketSharp.WebSocketFrame.EmptyPingBytes"> + <summary> + Represents the ping frame without the payload data as an array of <see cref="T:System.Byte"/>. + </summary> + <remarks> + The value of this field is created from a non masked frame, so it can only be used to + send a ping from a server. + </remarks> + </member> + <member name="T:WebSocketSharp.WebSocketState"> + <summary> + Indicates the state of a WebSocket connection. + </summary> + <remarks> + The values of this enumeration are defined in + <see href="http://www.w3.org/TR/websockets/#dom-websocket-readystate"> + The WebSocket API</see>. + </remarks> + </member> + <member name="F:WebSocketSharp.WebSocketState.Connecting"> + <summary> + Equivalent to numeric value 0. Indicates that the connection has not + yet been established. + </summary> + </member> + <member name="F:WebSocketSharp.WebSocketState.Open"> + <summary> + Equivalent to numeric value 1. Indicates that the connection has + been established, and the communication is possible. + </summary> + </member> + <member name="F:WebSocketSharp.WebSocketState.Closing"> + <summary> + Equivalent to numeric value 2. Indicates that the connection is + going through the closing handshake, or the close method has + been invoked. + </summary> + </member> + <member name="F:WebSocketSharp.WebSocketState.Closed"> + <summary> + Equivalent to numeric value 3. Indicates that the connection has + been closed or could not be established. + </summary> + </member> + </members> +</doc> diff --git a/Assets/Packages/WebSocketSharp-netstandard.1.0.1/lib/netstandard2.0/websocket-sharp.xml.meta b/Assets/Packages/WebSocketSharp-netstandard.1.0.1/lib/netstandard2.0/websocket-sharp.xml.meta new file mode 100644 index 0000000..f6c9543 --- /dev/null +++ b/Assets/Packages/WebSocketSharp-netstandard.1.0.1/lib/netstandard2.0/websocket-sharp.xml.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: cf0f4143cd53f4c9683577a5bfbc0649 +TextScriptImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Assets/Scenes/MainScene.unity b/Assets/Scenes/MainScene.unity index c84b8bf..1a95a7c 100644 --- a/Assets/Scenes/MainScene.unity +++ b/Assets/Scenes/MainScene.unity @@ -10812,6 +10812,52 @@ Transform: - {fileID: 1342061459} m_Father: {fileID: 1617586590} m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0} +--- !u!1 &979159584 +GameObject: + m_ObjectHideFlags: 0 + m_CorrespondingSourceObject: {fileID: 0} + m_PrefabInstance: {fileID: 0} + m_PrefabAsset: {fileID: 0} + serializedVersion: 6 + m_Component: + - component: {fileID: 979159585} + - component: {fileID: 979159586} + m_Layer: 0 + m_Name: GameManager + m_TagString: Untagged + m_Icon: {fileID: 0} + m_NavMeshLayer: 0 + m_StaticEditorFlags: 0 + m_IsActive: 1 +--- !u!4 &979159585 +Transform: + m_ObjectHideFlags: 0 + m_CorrespondingSourceObject: {fileID: 0} + m_PrefabInstance: {fileID: 0} + m_PrefabAsset: {fileID: 0} + m_GameObject: {fileID: 979159584} + serializedVersion: 2 + m_LocalRotation: {x: 0, y: 0, z: 0, w: 1} + m_LocalPosition: {x: -1.1969378, y: 1.3545454, z: -0.41485047} + m_LocalScale: {x: 1, y: 1, z: 1} + m_ConstrainProportionsScale: 0 + m_Children: [] + m_Father: {fileID: 0} + m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0} +--- !u!114 &979159586 +MonoBehaviour: + m_ObjectHideFlags: 0 + m_CorrespondingSourceObject: {fileID: 0} + m_PrefabInstance: {fileID: 0} + m_PrefabAsset: {fileID: 0} + m_GameObject: {fileID: 979159584} + m_Enabled: 1 + m_EditorHideFlags: 0 + m_Script: {fileID: 11500000, guid: 0ecd28734b48f4313bff134f6df55396, type: 3} + m_Name: + m_EditorClassIdentifier: + esp32IPAddress: 10.204.0.249 + esp32WebsocketPort: 81 --- !u!1001 &980743549 PrefabInstance: m_ObjectHideFlags: 0 @@ -19343,7 +19389,7 @@ PrefabInstance: - target: {fileID: 1446526844107249175, guid: 8c24f4efc20ae488386410c07ba7ec0c, type: 3} propertyPath: m_LocalPosition.x - value: -0.313 + value: 0.2 objectReference: {fileID: 0} - target: {fileID: 1446526844107249175, guid: 8c24f4efc20ae488386410c07ba7ec0c, type: 3} @@ -23867,3 +23913,4 @@ SceneRoots: - {fileID: 977726988} - {fileID: 1117825302} - {fileID: 350103768} + - {fileID: 979159585} diff --git a/Assets/packages.config b/Assets/packages.config new file mode 100644 index 0000000..c3e3167 --- /dev/null +++ b/Assets/packages.config @@ -0,0 +1,4 @@ +<?xml version="1.0" encoding="utf-8"?> +<packages> + <package id="WebSocketSharp-netstandard" version="1.0.1" manuallyInstalled="true" /> +</packages> \ No newline at end of file diff --git a/Assets/packages.config.meta b/Assets/packages.config.meta new file mode 100644 index 0000000..e46acc5 --- /dev/null +++ b/Assets/packages.config.meta @@ -0,0 +1,23 @@ +fileFormatVersion: 2 +guid: 19514aafa78aa4bee841c36d9526ca93 +labels: +- NuGetForUnity +PluginImporter: + externalObjects: {} + serializedVersion: 2 + iconMap: {} + executionOrder: {} + defineConstraints: [] + isPreloaded: 0 + isOverridable: 0 + isExplicitlyReferenced: 0 + validateReferences: 1 + platformData: + - first: + Any: + second: + enabled: 1 + settings: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Packages/manifest.json b/Packages/manifest.json index 4eecedb..9f1ede9 100644 --- a/Packages/manifest.json +++ b/Packages/manifest.json @@ -1,5 +1,6 @@ { "dependencies": { + "com.github-glitchenzo.nugetforunity": "https://github.com/GlitchEnzo/NuGetForUnity.git?path=/src/NuGetForUnity", "com.meta.xr.sdk.all": "60.0.0", "com.meta.xr.sdk.interaction.ovr.samples": "62.0.0", "com.unity.collab-proxy": "2.2.0", diff --git a/Packages/packages-lock.json b/Packages/packages-lock.json index 2edf150..86e344b 100644 --- a/Packages/packages-lock.json +++ b/Packages/packages-lock.json @@ -1,5 +1,12 @@ { "dependencies": { + "com.github-glitchenzo.nugetforunity": { + "version": "https://github.com/GlitchEnzo/NuGetForUnity.git?path=/src/NuGetForUnity", + "depth": 0, + "source": "git", + "dependencies": {}, + "hash": "75f68222d0a4bd2b468dbf3e6a17a191d28041ab" + }, "com.meta.xr.mrutilitykit": { "version": "60.0.0", "depth": 1,