diff --git a/.gitignore b/.gitignore index 342d5044..a31355f1 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ -## Ignore MonoDevelop temporary files. +## Ignore MonoDevelop build results and temporary files. +bin *.mdb *.pidb diff --git a/Example/bin/Debug/example.exe b/Example/bin/Debug/example.exe deleted file mode 100755 index c68da2e6..00000000 Binary files a/Example/bin/Debug/example.exe and /dev/null differ diff --git a/Example/bin/Debug/websocket-sharp.dll b/Example/bin/Debug/websocket-sharp.dll deleted file mode 100755 index 91ce13ec..00000000 Binary files a/Example/bin/Debug/websocket-sharp.dll and /dev/null differ diff --git a/Example/bin/Debug_Ubuntu/example.exe b/Example/bin/Debug_Ubuntu/example.exe deleted file mode 100755 index b5d9763f..00000000 Binary files a/Example/bin/Debug_Ubuntu/example.exe and /dev/null differ diff --git a/Example/bin/Debug_Ubuntu/websocket-sharp.dll b/Example/bin/Debug_Ubuntu/websocket-sharp.dll deleted file mode 100755 index 0e13d30d..00000000 Binary files a/Example/bin/Debug_Ubuntu/websocket-sharp.dll and /dev/null differ diff --git a/Example/bin/Release/example.exe b/Example/bin/Release/example.exe deleted file mode 100755 index ec050864..00000000 Binary files a/Example/bin/Release/example.exe and /dev/null differ diff --git a/Example/bin/Release/websocket-sharp.dll b/Example/bin/Release/websocket-sharp.dll deleted file mode 100755 index 6f9c4bc5..00000000 Binary files a/Example/bin/Release/websocket-sharp.dll and /dev/null differ diff --git a/Example/bin/Release_Ubuntu/example.exe b/Example/bin/Release_Ubuntu/example.exe deleted file mode 100755 index 67fae3d4..00000000 Binary files a/Example/bin/Release_Ubuntu/example.exe and /dev/null differ diff --git a/Example/bin/Release_Ubuntu/websocket-sharp.dll b/Example/bin/Release_Ubuntu/websocket-sharp.dll deleted file mode 100755 index 8a8b6453..00000000 Binary files a/Example/bin/Release_Ubuntu/websocket-sharp.dll and /dev/null differ diff --git a/Example1/bin/Debug/example1.exe b/Example1/bin/Debug/example1.exe deleted file mode 100755 index 4caf51b9..00000000 Binary files a/Example1/bin/Debug/example1.exe and /dev/null differ diff --git a/Example1/bin/Debug/websocket-sharp.dll b/Example1/bin/Debug/websocket-sharp.dll deleted file mode 100755 index 91ce13ec..00000000 Binary files a/Example1/bin/Debug/websocket-sharp.dll and /dev/null differ diff --git a/Example1/bin/Debug_Ubuntu/example1.exe b/Example1/bin/Debug_Ubuntu/example1.exe deleted file mode 100755 index b95c663c..00000000 Binary files a/Example1/bin/Debug_Ubuntu/example1.exe and /dev/null differ diff --git a/Example1/bin/Debug_Ubuntu/websocket-sharp.dll b/Example1/bin/Debug_Ubuntu/websocket-sharp.dll deleted file mode 100755 index 0e13d30d..00000000 Binary files a/Example1/bin/Debug_Ubuntu/websocket-sharp.dll and /dev/null differ diff --git a/Example1/bin/Release/example1.exe b/Example1/bin/Release/example1.exe deleted file mode 100755 index 6afc86d4..00000000 Binary files a/Example1/bin/Release/example1.exe and /dev/null differ diff --git a/Example1/bin/Release/websocket-sharp.dll b/Example1/bin/Release/websocket-sharp.dll deleted file mode 100755 index 6f9c4bc5..00000000 Binary files a/Example1/bin/Release/websocket-sharp.dll and /dev/null differ diff --git a/Example1/bin/Release_Ubuntu/example1.exe b/Example1/bin/Release_Ubuntu/example1.exe deleted file mode 100755 index 4183027d..00000000 Binary files a/Example1/bin/Release_Ubuntu/example1.exe and /dev/null differ diff --git a/Example1/bin/Release_Ubuntu/websocket-sharp.dll b/Example1/bin/Release_Ubuntu/websocket-sharp.dll deleted file mode 100755 index 8a8b6453..00000000 Binary files a/Example1/bin/Release_Ubuntu/websocket-sharp.dll and /dev/null differ diff --git a/Example2/bin/Debug/example2.exe b/Example2/bin/Debug/example2.exe deleted file mode 100755 index 1e60f8d6..00000000 Binary files a/Example2/bin/Debug/example2.exe and /dev/null differ diff --git a/Example2/bin/Debug/example2.exe.config b/Example2/bin/Debug/example2.exe.config deleted file mode 100644 index 84bc00fa..00000000 --- a/Example2/bin/Debug/example2.exe.config +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/Example2/bin/Debug/websocket-sharp.dll b/Example2/bin/Debug/websocket-sharp.dll deleted file mode 100755 index 91ce13ec..00000000 Binary files a/Example2/bin/Debug/websocket-sharp.dll and /dev/null differ diff --git a/Example2/bin/Debug_Ubuntu/example2.exe b/Example2/bin/Debug_Ubuntu/example2.exe deleted file mode 100755 index 81949614..00000000 Binary files a/Example2/bin/Debug_Ubuntu/example2.exe and /dev/null differ diff --git a/Example2/bin/Debug_Ubuntu/example2.exe.config b/Example2/bin/Debug_Ubuntu/example2.exe.config deleted file mode 100644 index 84bc00fa..00000000 --- a/Example2/bin/Debug_Ubuntu/example2.exe.config +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/Example2/bin/Debug_Ubuntu/websocket-sharp.dll b/Example2/bin/Debug_Ubuntu/websocket-sharp.dll deleted file mode 100755 index 0e13d30d..00000000 Binary files a/Example2/bin/Debug_Ubuntu/websocket-sharp.dll and /dev/null differ diff --git a/Example2/bin/Release/example2.exe b/Example2/bin/Release/example2.exe deleted file mode 100755 index 2dfaee4d..00000000 Binary files a/Example2/bin/Release/example2.exe and /dev/null differ diff --git a/Example2/bin/Release/example2.exe.config b/Example2/bin/Release/example2.exe.config deleted file mode 100644 index 84bc00fa..00000000 --- a/Example2/bin/Release/example2.exe.config +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/Example2/bin/Release/websocket-sharp.dll b/Example2/bin/Release/websocket-sharp.dll deleted file mode 100755 index 6f9c4bc5..00000000 Binary files a/Example2/bin/Release/websocket-sharp.dll and /dev/null differ diff --git a/Example2/bin/Release_Ubuntu/example2.exe b/Example2/bin/Release_Ubuntu/example2.exe deleted file mode 100755 index e3e9b063..00000000 Binary files a/Example2/bin/Release_Ubuntu/example2.exe and /dev/null differ diff --git a/Example2/bin/Release_Ubuntu/example2.exe.config b/Example2/bin/Release_Ubuntu/example2.exe.config deleted file mode 100644 index 84bc00fa..00000000 --- a/Example2/bin/Release_Ubuntu/example2.exe.config +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/Example2/bin/Release_Ubuntu/websocket-sharp.dll b/Example2/bin/Release_Ubuntu/websocket-sharp.dll deleted file mode 100755 index 8a8b6453..00000000 Binary files a/Example2/bin/Release_Ubuntu/websocket-sharp.dll and /dev/null differ diff --git a/Example3/bin/Debug/Example3.exe b/Example3/bin/Debug/Example3.exe deleted file mode 100755 index 7a8da71f..00000000 Binary files a/Example3/bin/Debug/Example3.exe and /dev/null differ diff --git a/Example3/bin/Debug/Example3.exe.config b/Example3/bin/Debug/Example3.exe.config deleted file mode 100644 index c1a9c3b8..00000000 --- a/Example3/bin/Debug/Example3.exe.config +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/Example3/bin/Debug/websocket-sharp.dll b/Example3/bin/Debug/websocket-sharp.dll deleted file mode 100755 index 91ce13ec..00000000 Binary files a/Example3/bin/Debug/websocket-sharp.dll and /dev/null differ diff --git a/Example3/bin/Debug_Ubuntu/Example3.exe b/Example3/bin/Debug_Ubuntu/Example3.exe deleted file mode 100755 index 0c3cffd6..00000000 Binary files a/Example3/bin/Debug_Ubuntu/Example3.exe and /dev/null differ diff --git a/Example3/bin/Debug_Ubuntu/Example3.exe.config b/Example3/bin/Debug_Ubuntu/Example3.exe.config deleted file mode 100644 index c1a9c3b8..00000000 --- a/Example3/bin/Debug_Ubuntu/Example3.exe.config +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/Example3/bin/Debug_Ubuntu/websocket-sharp.dll b/Example3/bin/Debug_Ubuntu/websocket-sharp.dll deleted file mode 100755 index 0e13d30d..00000000 Binary files a/Example3/bin/Debug_Ubuntu/websocket-sharp.dll and /dev/null differ diff --git a/Example3/bin/Release/Example3.exe b/Example3/bin/Release/Example3.exe deleted file mode 100755 index 817d7afd..00000000 Binary files a/Example3/bin/Release/Example3.exe and /dev/null differ diff --git a/Example3/bin/Release/Example3.exe.config b/Example3/bin/Release/Example3.exe.config deleted file mode 100644 index c1a9c3b8..00000000 --- a/Example3/bin/Release/Example3.exe.config +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/Example3/bin/Release/websocket-sharp.dll b/Example3/bin/Release/websocket-sharp.dll deleted file mode 100755 index 6f9c4bc5..00000000 Binary files a/Example3/bin/Release/websocket-sharp.dll and /dev/null differ diff --git a/Example3/bin/Release_Ubuntu/Example3.exe b/Example3/bin/Release_Ubuntu/Example3.exe deleted file mode 100755 index 0d387843..00000000 Binary files a/Example3/bin/Release_Ubuntu/Example3.exe and /dev/null differ diff --git a/Example3/bin/Release_Ubuntu/Example3.exe.config b/Example3/bin/Release_Ubuntu/Example3.exe.config deleted file mode 100644 index c1a9c3b8..00000000 --- a/Example3/bin/Release_Ubuntu/Example3.exe.config +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/Example3/bin/Release_Ubuntu/websocket-sharp.dll b/Example3/bin/Release_Ubuntu/websocket-sharp.dll deleted file mode 100755 index 8a8b6453..00000000 Binary files a/Example3/bin/Release_Ubuntu/websocket-sharp.dll and /dev/null differ diff --git a/websocket-sharp/bin/Debug/websocket-sharp.dll b/websocket-sharp/bin/Debug/websocket-sharp.dll deleted file mode 100755 index 91ce13ec..00000000 Binary files a/websocket-sharp/bin/Debug/websocket-sharp.dll and /dev/null differ diff --git a/websocket-sharp/bin/Debug_Ubuntu/websocket-sharp.dll b/websocket-sharp/bin/Debug_Ubuntu/websocket-sharp.dll deleted file mode 100755 index 0e13d30d..00000000 Binary files a/websocket-sharp/bin/Debug_Ubuntu/websocket-sharp.dll and /dev/null differ diff --git a/websocket-sharp/bin/Release/websocket-sharp.dll b/websocket-sharp/bin/Release/websocket-sharp.dll deleted file mode 100755 index 6f9c4bc5..00000000 Binary files a/websocket-sharp/bin/Release/websocket-sharp.dll and /dev/null differ diff --git a/websocket-sharp/bin/Release_Ubuntu/websocket-sharp.dll b/websocket-sharp/bin/Release_Ubuntu/websocket-sharp.dll deleted file mode 100755 index 8a8b6453..00000000 Binary files a/websocket-sharp/bin/Release_Ubuntu/websocket-sharp.dll and /dev/null differ diff --git a/websocket-sharp/bin/Release_Ubuntu/websocket-sharp.xml b/websocket-sharp/bin/Release_Ubuntu/websocket-sharp.xml deleted file mode 100644 index b56df847..00000000 --- a/websocket-sharp/bin/Release_Ubuntu/websocket-sharp.xml +++ /dev/null @@ -1,5276 +0,0 @@ - - - - /home/starless/Projects/websocket-sharp/websocket-sharp/bin/Release_Ubuntu/websocket-sharp - - - - - Provides a set of static methods for the websocket-sharp. - - - - - Accepts a WebSocket connection by the . - - - A that contains a WebSocket connection. - - - A that provides a TCP connection to accept a WebSocket connection. - - - A that indicates a secure connection or not. (true indicates a secure connection.) - - - is . - - - - - Accepts a WebSocket connection asynchronously by the . - - - A that provides a TCP connection to accept a WebSocket connection. - - - A that indicates a secure connection or not. (true indicates a secure connection.) - - - An Action<TcpListenerWebSocketContext> delegate that contains the method(s) that is called when an asynchronous operation completes. - - - is . - - - - - Determines whether the specified contains any of characters - in the specified array of . - - - true if contains any of ; otherwise, false. - - - A to test. - - - An array of that contains characters to find. - - - - - Determines whether the specified contains the entry - with the specified . - - - true if contains the entry with ; - otherwise, false. - - - A that contains the entries. - - - A that contains the key of the entry to find. - - - - - Determines whether the specified contains the entry - with the specified both and . - - - true if contains the entry with both and ; - otherwise, false. - - - A that contains the entries. - - - A that contains the key of the entry to find. - - - A that contains the value of the entry to find. - - - - - Emit the specified delegate if is not . - - - An to emit. - - - An that emits the . - - - An that contains no event data. - - - - - Emit the specified EventHandler<TEventArgs> delegate if is not . - - - An EventHandler<TEventArgs> to emit. - - - An that emits the . - - - A TEventArgs that contains the event data. - - - The type of the event data generated by the event. - - - - - Determines whether the specified equals the specified as . - And save this specified as to the specified List<byte>. - - - true if the parameter equals the parameter as ; otherwise, false. - - - An to compare. - - - A to compare. - - - A List<byte> to save the as . - - - Is thrown when the parameter passed to a method is invalid because it is outside the allowable range of values as . - - - - - Gets the absolute path from the specified . - - - A that contains the absolute path if got successfully; otherwise, . - - - A that contains the URI to get the absolute path from. - - - - - Gets the collection of cookies from the specified . - - - A that receives a collection of the HTTP Cookies. - - - A that contains a collection of the HTTP Headers. - - - true if gets from the response ; - from the request , false. - - - - - Gets the description of the HTTP status code using the specified . - - - A that contains the description of the HTTP status code. - - - One of values that contains an HTTP status code. - - - - - Gets the name from the specified that contains a pair of name and value - separated by a separator string. - - - A that contains the name if any; otherwise, null. - - - A that contains a pair of name and value separated by a separator string. - - - A that contains a separator string. - - - - - Gets the name and value from the specified that contains a pair of name and value are separated by a separator string. - - - A KeyValuePair<string, string> that contains the name and value if any. - - - A that contains a pair of name and value are separated by a separator string. - - - A that contains a separator string. - - - - - Gets the description of the HTTP status code using the specified . - - - A that contains the description of the HTTP status code. - - - An that contains an HTTP status code. - - - - - Gets the value from the specified that contains a pair of name and value - separated by a separator string. - - - A that contains the value if any; otherwise, null. - - - A that contains a pair of name and value separated by a separator string. - - - A that contains a separator string. - - - - - Determines whether the specified is in the allowable range of - the WebSocket close status code. - - - Not allowable ranges are the followings. - - Numbers in the range 0-999 are not used. - - Numbers which are greater than 4999 are out of the reserved close status code ranges. - - - true if is in the allowable range of the WebSocket close status code; otherwise, false. - - - A to test. - - - - - Determines whether the specified is empty. - - - true if is empty; otherwise, false. - - - A to test. - - - - - Determines whether the specified is enclosed in the specified . - - - true if is enclosed in ; otherwise, false. - - - A to test. - - - A that contains character to find. - - - - - Determines whether the specified is host (this computer architecture) byte order. - - - true if the parameter is host byte order; otherwise, false. - - - A to test. - - - - - Determines whether the specified represents a local IP address. - - - true if represents a local IP address; otherwise, false. - - - A to test. - - - is . - - - - - Determines whether the specified is or empty. - - - true if the parameter is or empty; otherwise, false. - - - A to test. - - - - - Determines whether the specified is predefined scheme. - - - true if the parameter is the predefined scheme; otherwise, false. - - - A to test. - - - - - Determines whether the specified is the HTTP Upgrade request - to switch to the specified . - - - true if the specified is the HTTP Upgrade request - to switch to the specified ; otherwise, false. - - - A that contains an HTTP request information. - - - A that contains a protocol name. - - - - is . - - - -or- - - - is . - - - - is . - - - - - Determines whether the specified is valid absolute path. - - - true if the parameter is valid absolute path; otherwise, false. - - - A to test. - - - A that receives a message if the is invalid. - - - - - Determines whether the specified is a URI string. - - - true if the parameter is maybe a URI string; otherwise, false. - - - A to test. - - - - - Reads a block of bytes from the specified - and returns the read data in an array of . - - - An array of that receives the read data. - - - A that contains the data to read. - - - An that contains the number of bytes to read. - - - - - Reads a block of bytes from the specified - and returns the read data in an array of . - - - An array of that receives the read data. - - - A that contains the data to read. - - - A that contains the number of bytes to read. - - - - - Retrieves a sub-array from the specified . A sub-array starts at the specified element position. - - - An array of T that receives a sub-array, or an empty array of T if any problems with the parameters. - - - An array of T that contains the data to retrieve a sub-array. - - - An that contains the zero-based starting position of a sub-array in the . - - - An that contains the number of elements to retrieve a sub-array. - - - The type of elements in the . - - - - - Executes the specified delegate times. - - - An is the number of times to execute. - - - An delegate that references the method(s) to execute. - - - - - Executes the specified delegate times. - - - A is the number of times to execute. - - - An delegate that references the method(s) to execute. - - - - - Executes the specified delegate times. - - - A is the number of times to execute. - - - An delegate that references the method(s) to execute. - - - - - Executes the specified delegate times. - - - A is the number of times to execute. - - - An delegate that references the method(s) to execute. - - - - - Executes the specified Action<int> delegate times. - - - An is the number of times to execute. - - - An Action<int> delegate that references the method(s) to execute. - An parameter to pass to the method(s) is the zero-based count of iteration. - - - - - Executes the specified Action<long> delegate times. - - - A is the number of times to execute. - - - An Action<long> delegate that references the method(s) to execute. - A parameter to pass to the method(s) is the zero-based count of iteration. - - - - - Executes the specified Action<uint> delegate times. - - - A is the number of times to execute. - - - An Action<uint> delegate that references the method(s) to execute. - A parameter to pass to the method(s) is the zero-based count of iteration. - - - - - Executes the specified Action<ulong> delegate times. - - - A is the number of times to execute. - - - An Action<ulong> delegate that references the method(s) to execute. - A parameter to pass to this method(s) is the zero-based count of iteration. - - - - - Converts the specified array of to the specified type data. - - - A T converted from , or a default value of T - if is an empty array of - or if the type of T isn't , , , - , , , , - , or . - - - An array of to convert. - - - A that indicates the byte order of . - - - The type of the return. The T must be a value type. - - - is . - - - - - Converts the specified to an array of . - - - An array of converted from . - - - A T to convert. - - - A that indicates the byte order of the return. - - - The type of . The T must be a value type. - - - - - Converts the order of the specified array of to the host byte order. - - - An array of converted from . - - - An array of to convert. - - - A that indicates the byte order of . - - - is . - - - - - Converts the specified to a that concatenates - the each element of across the specified . - - - A converted from , or a - if the length of is zero. - - - An array of T to convert. - - - A that contains a separator string. - - - The type of elements in . - - - is . - - - - - Converts the specified to a object. - - - A converted from the parameter, or - if the is or . - - - A to convert. - - - - - Tries to create a new WebSocket using the specified . - - - true if the WebSocket was successfully created; otherwise, false. - - - A that contains a WebSocket URI. - - - When this method returns, contains a created WebSocket if the parameter is valid WebSocket URI; otherwise, . - - - When this method returns, contains a error message if the parameter is invalid WebSocket URI; otherwise, String.Empty. - - - Is thrown when the parameter passed to a method is invalid because it is . - - - - - URL-decodes the specified . - - - A that receives a decoded string, or the parameter - if the is or . - - - A to decode. - - - - - URL-encodes the specified . - - - A that receives a encoded string, or the parameter - if the is or . - - - A to encode. - - - - - Writes the specified content data using the specified . - - - A that contains a network stream to write a content data. - - - An array of that contains a content data to write. - - - Is thrown when the parameter passed to a method is invalid because it is . - - - - - Contains the values of the state of the WebSocket connection. - - - The WsState enumeration contains the values of the state of the WebSocket connection defined in - The WebSocket API. - - - - - Equivalent to numeric value 0. Indicates that the connection has not yet been established. - - - - - Equivalent to numeric value 1. Indicates that the connection is established and communication is possible. - - - - - Equivalent to numeric value 2. Indicates that the connection is going through the closing handshake, or the Close method has been invoked. - - - - - Equivalent to numeric value 3. Indicates that the connection has been closed or could not be opened. - - - - - Contains the event data associated with a event. - - - The event occurs when the WebSocket receives a text or binary data frame. - If you want to get the received data, you should access the or - properties. - - - - - Gets the received data as a . - - - A that contains the received data. - - - - - Gets the received data as an array of . - - - An array of that contains the received data. - - - - - Gets the type of the received data. - - - One of the values that indicates the type of the received data. - - - - - Contains the event data associated with a event. - - - The event occurs when the WebSocket receives a close control frame or - the WebSocket.Close method is called. If you want to get the reason for closure, you should access - the or properties. - - - - - Gets the status code for closure. - - - A that contains a status code for closure. - - - - - Gets the reason for closure. - - - A that contains a reason for closure. - - - - - Indicates whether the WebSocket connection closed cleanly. - - - true if the WebSocket connection closed cleanly; otherwise, false. - - - - - Contains the values that indicate whether the byte order is a Little-endian or Big-endian. - - - - - Indicates a Little-endian. - - - - - Indicates a Big-endian. - - - - - Contains the event data associated with a error event. - - - The error event occurs when this event sender gets an error. - If you want to get the error message, you should access the property. - - - - - Gets the error message. - - - A that contains a error message. - - - - - Implements the WebSocket interface. - - - The WebSocket class provides a set of methods and properties for two-way communication - using the WebSocket protocol (RFC 6455). - - - - - Initializes a new instance of the class with the specified WebSocket URL and subprotocols. - - - A that contains a WebSocket URL to connect. - - - An array of that contains the WebSocket subprotocols if any. - - - is . - - - is not valid WebSocket URL. - - - - - Initializes a new instance of the class with the specified WebSocket URL, - OnOpen, OnMessage, OnError, OnClose event handlers and subprotocols. - - - This constructor initializes a new instance of the class and - establishes a WebSocket connection. - - - A that contains a WebSocket URL to connect. - - - An event handler. - - - An event handler. - - - An event handler. - - - An event handler. - - - An array of that contains the WebSocket subprotocols if any. - - - is . - - - is not valid WebSocket URL. - - - - - Occurs when the receives a Close frame or the Close method is called. - - - - - Occurs when the gets an error. - - - - - Occurs when the receives a data frame. - - - - - Occurs when the WebSocket connection has been established. - - - - - Gets or sets the compression method used to compress the payload data of the WebSocket Data frame. - - - One of the values that indicates the compression method to use. - The default is . - - - - - Gets the cookies used in the WebSocket opening handshake. - - - An IEnumerable<Cookie> interface that provides an enumerator which supports the iteration - over the collection of cookies. - - - - - Gets the credentials for HTTP authentication (Basic/Digest). - - - A that contains the credentials for HTTP authentication. - - - - - Gets the WebSocket extensions selected by the server. - - - A that contains the extensions if any. The default is . - - - - - Gets a value indicating whether the WebSocket connection is alive. - - - true if the WebSocket connection is alive; otherwise, false. - - - - - Gets a value indicating whether the WebSocket connection is secure. - - - true if the connection is secure; otherwise, false. - - - - - Gets or sets the value of the Origin header used in the WebSocket opening handshake. - - - A instance does not send the Origin header in the WebSocket opening handshake - if the value of this property is . - - - - A that contains the value of the HTTP Origin header to send. - The default is . - - - The value of the Origin header has the following syntax: <scheme>://<host>[:<port>] - - - - - Gets the WebSocket subprotocol selected by the server. - - - A that contains the subprotocol if any. The default is . - - - - - Gets the state of the WebSocket connection. - - - One of the values. The default is . - - - - - Gets the WebSocket URL to connect. - - - A that contains the WebSocket URL to connect. - - - - - Closes the WebSocket connection and releases all associated resources. - - - - - Closes the WebSocket connection with the specified and - releases all associated resources. - - - This Close method emits a event if is not - in the allowable range of the WebSocket close status code. - - - A that indicates the status code for closure. - - - - - Closes the WebSocket connection with the specified and - releases all associated resources. - - - One of the values that indicates the status code for closure. - - - - - Closes the WebSocket connection with the specified and - , and releases all associated resources. - - - This Close method emits a event if is not - in the allowable range of the WebSocket close status code. - - - A that indicates the status code for closure. - - - A that contains the reason for closure. - - - - - Closes the WebSocket connection with the specified and - , and releases all associated resources. - - - One of the values that indicates the status code for closure. - - - A that contains the reason for closure. - - - - - Establishes a WebSocket connection. - - - - - Closes the WebSocket connection and releases all associated resources. - - - This method closes the WebSocket connection with the . - - - - - Sends a Ping using the WebSocket connection. - - - true if a instance receives a Pong in a time; otherwise, false. - - - - - Sends a Ping with the specified using the WebSocket connection. - - - A that contains a message to send with a Ping. - - - true if a instance receives a Pong in a time; otherwise, false. - - - - - Sends a binary using the WebSocket connection. - - - An array of that contains a binary data to send. - - - - - Sends a text using the WebSocket connection. - - - A that contains a text data to send. - - - - - Sends a binary data using the WebSocket connection. - - - A that contains a binary data to send. - - - - - Sends a binary asynchronously using the WebSocket connection. - - - An array of that contains a binary data to send. - - - An delegate that references the method(s) called when - the asynchronous operation completes. - - - - - Sends a text asynchronously using the WebSocket connection. - - - A that contains a text data to send. - - - An delegate that references the method(s) called when - the asynchronous operation completes. - - - - - Sends a binary data asynchronously using the WebSocket connection. - - - A that contains a binary data to send. - - - An delegate that references the method(s) called when - the asynchronous operation completes. - - - - - Sets a used in the WebSocket opening handshake. - - - A that contains an HTTP Cookie to set. - - - - - Sets the credentials for HTTP authentication (Basic/Digest). - - - A that contains a user name associated with the credentials. - - - A that contains a password for associated with the credentials. - - - true if sends the credentials as a Basic authorization with the first request handshake; - otherwise, false. - - - - - Provides the functions of the server that receives the WebSocket connection requests. - - - The WebSocketServer class provides the multi WebSocket service. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class that listens for incoming connection attempts - on the specified . - - - An that contains a port number. - - - - - Initializes a new instance of the class that listens for incoming connection attempts - on the specified WebSocket URL. - - - A that contains a WebSocket URL. - - - - - Initializes a new instance of the class that listens for incoming connection attempts - on the specified and . - - - An that contains a port number. - - - A that indicates providing a secure connection or not. (true indicates providing a secure connection.) - - - - - Initializes a new instance of the class that listens for incoming connection attempts - on the specified and . - - - A that contains a local IP address. - - - An that contains a port number. - - - - - Initializes a new instance of the class that listens for incoming connection attempts - on the specified , and . - - - A that contains a local IP address. - - - An that contains a port number. - - - A that indicates providing a secure connection or not. (true indicates providing a secure connection.) - - - - - Gets the collection of paths associated with the every WebSocket services that the server provides. - - - An IEnumerable<string> that contains the collection of paths. - - - - - Gets or sets a value indicating whether the server cleans up the inactive WebSocket service - instances periodically. - - - true if the server cleans up the inactive WebSocket service instances every 60 seconds; - otherwise, false. The default value is true. - - - - - Accepts a WebSocket connection request. - - - A that contains the WebSocket connection request objects. - - - - - Adds the specified type WebSocket service. - - - A that contains an absolute path associated with the WebSocket service. - - - The type of the WebSocket service. The T must inherit the class. - - - - - Broadcasts the specified to all clients. - - - A to broadcast. - - - - - Stops receiving the WebSocket connection requests. - - - - - Provides the basic functions of the WebSocket service. - - - The WebSocketService class is an abstract class. - - - - - Initializes a new instance of the class. - - - - - Gets the collection of query string variables used in the WebSocket opening handshake. - - - A that contains the collection of query string variables. - - - - - Gets the sessions to the . - - - A that contains the sessions to the the . - - - - - Gets the ID of the instance. - - - A that contains an ID. - - - - - Gets a value indicating whether the instance is bound to a . - - - true if the instance is bound to a ; otherwise, false. - - - - - Occurs when the inner receives a Close frame or the Stop method is called. - - - A that contains the event data associated with a event. - - - - - Occurs when the inner gets an error. - - - An that contains the event data associated with a event. - - - - - Occurs when the inner receives a data frame. - - - A that contains the event data associated with a event. - - - - - Occurs when the WebSocket connection has been established. - - - - - Processes the cookies used in the WebSocket opening handshake. - - - true if processing the cookies is successfully; otherwise, false. - - - A that contains a collection of the HTTP Cookies received from the client. - - - A that contains a collection of the HTTP Cookies to send to the client. - - - - - Broadcasts the specified array of to the clients of every instances - in the . - - - An array of to broadcast. - - - - - Broadcasts the specified to the clients of every instances - in the . - - - A to broadcast. - - - - - Pings to the clients of every instances - in the . - - - A Dictionary<string, bool> that contains the collection of IDs and values - indicating whether each instances received a Pong in a time. - - - - - Pings with the specified to the clients of every instances - in the . - - - A Dictionary<string, bool> that contains the collection of IDs and values - indicating whether each instances received a Pong in a time. - - - A that contains a message. - - - - - Pings to the client of the instance. - - - true if the instance receives a Pong in a time; otherwise, false. - - - - - Pings with the specified to the client of the instance. - - - true if the instance receives a Pong in a time; otherwise, false. - - - A that contains a message. - - - - - Pings to the client of the instance - associated with the specified . - - - true if the instance receives a Pong in a time; otherwise, false. - - - A that contains an ID that represents the destination for the Ping. - - - - - Pings with the specified to the client of the instance - associated with the specified . - - - true if the instance receives a Pong in a time; otherwise, false. - - - A that contains an ID that represents the destination for the Ping. - - - A that contains a message. - - - - - Sends a binary data to the client of the instance. - - - An array of that contains a binary data to send. - - - - - Sends a text data to the client of the instance. - - - A that contains a text data to send. - - - - - Sends a binary data to the client of the instance - associated with the specified . - - - A that contains an ID that represents the destination for the data. - - - An array of that contains a binary data to send. - - - - - Sends a text data to the client of the instance - associated with the specified . - - - A that contains an ID that represents the destination for the data. - - - A that contains a text data to send. - - - - - Starts the instance. - - - - - Stops the instance. - - - - - Stops the instance with the specified and . - - - A that contains a status code indicating the reason for stop. - - - A that contains a reason for stop. - - - - - Stops the instance with the specified and . - - - One of the values that contains a status code indicating the reason for stop. - - - A that contains a reason for stop. - - - - - Selects the authentication scheme for a instance. - - - One of the values that indicates the scheme used to authenticate the specified client request. - - - A that contains a client request information. - - - - - Contains the values of the schemes for authentication. - - - - - Indicates that no authentication is allowed. - - - - - Indicates digest authentication. - - - - - Indicates negotiating with the client to determine the authentication scheme. - - - - - Indicates NTLM authentication. - - - - - Indicates Windows authentication. - - - - - Indicates basic authentication. - - - - - Indicates anonymous authentication. - - - - - Provides a set of properties and methods used to manage an HTTP Cookie. - - - - The Cookie class supports the following cookie formats: - Netscape specification, - RFC 2109 and - RFC 2965. - - - The Cookie class cannot be inherited. - - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with the specified and . - - - A that contains the Name of the cookie. - - - A that contains the Value of the cookie. - - - - is or . - - - - or - - - - contains an invalid character. - - - - or - - - - is . - - - - or - - - - contains a string not enclosed in double quotes - that contains an invalid character. - - - - - - Initializes a new instance of the class - with the specified , and . - - - A that contains the Name of the cookie. - - - A that contains the Value of the cookie. - - - A that contains the value of the Path attribute of the cookie. - - - - is or . - - - - or - - - - contains an invalid character. - - - - or - - - - is . - - - - or - - - - contains a string not enclosed in double quotes - that contains an invalid character. - - - - - - Initializes a new instance of the class - with the specified , , - and . - - - A that contains the Name of the cookie. - - - A that contains the Value of the cookie. - - - A that contains the value of the Path attribute of the cookie. - - - A that contains the value of the Domain attribute of the cookie. - - - - is or . - - - - or - - - - contains an invalid character. - - - - or - - - - is . - - - - or - - - - contains a string not enclosed in double quotes - that contains an invalid character. - - - - - - Gets or sets the value of the Comment attribute of the cookie. - - - A that contains a comment to document intended use of the cookie. - - - - - Gets or sets the value of the CommentURL attribute of the cookie. - - - A that contains a URI that provides the comment - to document intended use of the cookie. - - - - - Gets or sets a value indicating whether the client discards the cookie unconditionally - when the client terminates. - - - true if the client discards the cookie unconditionally when the client terminates; - otherwise, false. The default is false. - - - - - Gets or sets the value of the Domain attribute of the cookie. - - - A that contains a URI for which the cookie is valid. - - - - - Gets or sets a value indicating whether the cookie has expired. - - - true if the cookie has expired; otherwise, false. The default is false. - - - - - Gets or sets the value of the Expires attribute of the cookie. - - - A that contains the date and time at which the cookie expires. - The default is . - - - - - Gets or sets a value indicating non-HTTP APIs can access the cookie. - - - true if non-HTTP APIs can not access the cookie; otherwise, false. - - - - - Gets or sets the Name of the cookie. - - - A that contains the Name of the cookie. - - - - The value specified for a set operation is or . - - - - or - - - - The value specified for a set operation contains an invalid character. - - - - - - Gets or sets the value of the Path attribute of the cookie. - - - A that contains a subset of URI on the origin server - to which the cookie applies. - - - - - Gets or sets the value of the Port attribute of the cookie. - - - A that contains a list of the TCP ports to which the cookie applies. - - - The value specified for a set operation is not enclosed in double quotes or could not be parsed. - - - - - Gets or sets a value indicating whether the security level of the cookie is secure. - - - When this property is true, the cookie may be included in the HTTP request - only if the request is transmitted over the HTTPS. - - - true if the security level of the cookie is secure; otherwise, false. - The default is false. - - - - - Gets the time when the cookie was issued. - - - A that contains the time when the cookie was issued. - - - - - Gets or sets the Value of the cookie. - - - A that contains the Value of the cookie. - - - - The value specified for a set operation is . - - - - or - - - - The value specified for a set operation contains a string not enclosed in double quotes - that contains an invalid character. - - - - - - Gets or sets the value of the Version attribute of the cookie. - - - An that contains the version of the HTTP state management - to which the cookie conforms. - - - The value specified for a set operation is not allowed. The value must be 0 or 1. - - - - - Determines whether the specified is equal to the current . - - - An to compare with the current . - - - true if the specified is equal to the current ; - otherwise, false. - - - - - Serves as a hash function for a object. - - - An that contains a hash code for this instance. - - - - - Returns a that represents the current . - - - This method returns a to use to send an HTTP Cookie to an origin server. - - - A that represents the current . - - - - - Provides a collection container for instances of the class. - - - - - Initializes a new instance of the class. - - - - - Gets the with the specified from the . - - - A with the specified in the . - - - An is the zero-based index of the to find. - - - is less than zero or is greater than or - equal to . - - - - - Gets the with the specified from the . - - - A with the specified in the . - - - A is the name of the to find. - - - is . - - - - - Gets the number of cookies contained in the . - - - An that indicates the number of cookies contained in the . - - - - - Gets a value indicating whether the is read-only. - - - true if the is read-only; otherwise, false. - The default is true. - - - - - Gets a value indicating whether access to the is thread safe. - - - true if access to the is thread safe; otherwise, false. - The default is false. - - - - - Gets an object to use to synchronize access to the . - - - An to use to synchronize access to the . - - - - - Add the specified to the . - - - A to add to the . - - - is . - - - - - Add the elements of the specified to the current . - - - A to add to the current . - - - is . - - - - - Copies the elements of the to the specified , - starting at the specified in the . - - - An is the destination of the elements copied from the . - - - An that indicates the zero-based index in at which copying begins. - - - is . - - - is less than zero. - - - - is multidimensional. - - - -or- - - - The number of elements in the is greater than the available space - from index to the end of the destination . - - - - The elements in the cannot be cast automatically - to the type of the destination . - - - - - Copies the elements of the to the specified array of , - starting at the specified in the . - - - An array of is the destination of the elements copied from the . - - - An that indicates the zero-based index in at which copying begins. - - - is . - - - is less than zero. - - - The number of elements in the is greater than the available space - from index to the end of the destination . - - - - - Gets the enumerator to use to iterate through the . - - - An instance of an implementation of the interface - to use to iterate through the . - - - - - The exception that is thrown when a gets an error. - - - - - Initializes a new instance of the class - with the specified and . - - - A that holds the serialized object data. - - - A that contains the contextual information about the source or destination. - - - - - Initializes a new instance of the class. - - - - - Populates the specified with the data needed to serialize the . - - - A that holds the serialized object data. - - - A that specifies the destination for the serialization. - - - - - Populates the specified with the data needed to serialize the . - - - A that holds the serialized object data. - - - A that specifies the destination for the serialization. - - - - - Provides a simple, programmatically controlled HTTP listener. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the scheme used to authenticate the clients. - - - One of the values that indicates the scheme used to - authenticate the clients. The default value is . - - - This object has been closed. - - - - - Gets or sets the delegate called to determine the scheme used to authenticate clients. - - - A delegate that invokes the method(s) used to select - an authentication scheme. The default value is . - - - This object has been closed. - - - - - Gets or sets a value indicating whether the returns exceptions - that occur when sending the response to the client. - - - true if does not return exceptions that occur when sending the response to the client; - otherwise, false. The default value is false. - - - This object has been closed. - - - - - Gets a value indicating whether the has been started. - - - true if the has been started; otherwise, false. - - - - - Gets a value indicating whether the can be used with the current operating system. - - - true. - - - - - Gets the URI prefixes handled by the . - - - A that contains the URI prefixes. - - - This object has been closed. - - - - - Gets or sets the name of the realm associated with the . - - - A that contains the name of the realm. - - - This object has been closed. - - - - - Gets or sets a value indicating whether, when NTLM authentication is used, - the authentication information of first request is used to authenticate - additional requests on the same connection. - - - true if the authentication information of first request is used; - otherwise, false. The default value is false. - - - This object has been closed. - - - - - Releases all resource used by the . - - - - - Shuts down the immediately. - - - - - Begins getting an incoming request information asynchronously. - - - This asynchronous operation must be completed by calling the method. - Typically, the method is invoked by the delegate. - - - An that contains the status of the asynchronous operation. - - - An delegate that references the method(s) - called when the asynchronous operation completes. - - - An that contains a user defined object to pass to the delegate. - - - This object has been closed. - - - The has not been started or is stopped currently. - - - - - Shuts down the . - - - - - Ends an asynchronous operation to get an incoming request information. - - - This method completes an asynchronous operation started by calling the method. - - - A that contains a client's request information. - - - An obtained by calling the method. - - - This object has been closed. - - - is . - - - was not obtained by calling the method. - - - The EndGetContext method was already called for the specified . - - - - - Gets an incoming request information. - - - This method waits for an incoming request and returns the request information - when received the request. - - - A that contains a client's request information. - - - - The does not have any URI prefixes to listen on. - - - -or- - - - The has not been started or is stopped currently. - - - - This object has been closed. - - - - - Starts to receive incoming requests. - - - This object has been closed. - - - - - Stops receiving incoming requests. - - - This object has been closed. - - - - - Provides access to the HTTP request and response objects used by the class. - - - The HttpListenerContext class cannot be inherited. - - - - - Gets the that contains the HTTP request from a client. - - - A that contains the HTTP request objects. - - - - - Gets the that contains the HTTP response to send to - the client in response to the client's request. - - - A that contains the HTTP response objects. - - - - - Gets the client information (identity, authentication information and security roles). - - - A contains the client information. - - - - - Accepts a WebSocket connection by the . - - - A that contains a WebSocket connection. - - - - - The exception that is thrown when an error occurs processing an HTTP request. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with the specified . - - - An that contains an error code. - - - - - Initializes a new instance of the class - with the specified and . - - - An that contains an error code. - - - A that describes the error. - - - - - Initializes a new instance of the class - from the specified and classes. - - - A that contains the information required to deserialize - the new object. - - - A . - - - - - Gets a value that represents the error that occurred. - - - An that contains an error code. - - - - - Provides the collection used to store the URI prefixes for the . - - - - - Gets the number of prefixes contained in the . - - - A that contains the number of prefixes. - - - - - Gets a value indicating whether access to the is read-only. - - - Always returns false. - - - - - Gets a value indicating whether access to the is synchronized. - - - Always returns false. - - - - - Gets an object that can be used to iterate through the . - - - An object that implements the interface and provides access to - the URI prefix strings in the . - - - - - Adds the specified to the . - - - A that contains a URI prefix to add. - - - is . - - - The associated with this is closed. - - - - - Removes all URI prefixes from the . - - - The associated with this is closed. - - - - - Returns a value indicating whether the contains - the specified . - - - true if the contains the specified ; - otherwise, false. - - - A that contains a URI prefix to test. - - - is . - - - The associated with this is closed. - - - - - Copies the contents of the to the specified . - - - An that receives the URI prefix strings in the . - - - An that contains the zero-based index in at which copying begins. - - - The associated with this is closed. - - - - - Copies the contents of the to the specified array of . - - - An array of that receives the URI prefix strings in the . - - - An that contains the zero-based index in at which copying begins. - - - The associated with this is closed. - - - - - Gets an object that can be used to iterate through the . - - - An object that implements the IEnumerator<string> interface and provides access to - the URI prefix strings in the . - - - - - Removes the specified from the list of prefixes in the . - - - true if the was found in the - and removed; otherwise, false. - - - A that contains a URI prefix to remove. - - - is . - - - The associated with this is closed. - - - - - Provides access to a request to a instance. - - - The HttpListenerRequest class cannot be inherited. - - - - - Gets the media types which are acceptable for the response. - - - An array of that contains the media type names in the Accept request-header field - or if the request did not include an Accept header. - - - - - Gets an error code that identifies a problem with the client's certificate. - - - Always returns 0. - - - - - Gets the encoding that can be used with the entity body data included in the request. - - - A that contains the encoding that can be used with the entity body data. - - - - - Gets the size of the entity body data included in the request. - - - A that contains the value of the Content-Length entity-header field. - The value is a number of bytes in the entity body data. -1 if the size is not known. - - - - - Gets the media type of the entity body included in the request. - - - A that contains the value of the Content-Type entity-header field. - - - - - Gets the cookies included in the request. - - - A that contains the cookies included in the request. - - - - - Gets a value indicating whether the request has the entity body. - - - true if the request has the entity body; otherwise, false. - - - - - Gets the HTTP headers used in the request. - - - A that contains the HTTP headers used in the request. - - - - - Gets the HTTP method used in the request. - - - A that contains the HTTP method used in the request. - - - - - Gets a that contains the entity body data included in the request. - - - A that contains the entity body data included in the request. - - - - - Gets a value indicating whether the client that sent the request is authenticated. - - - Always returns false. - - - - - Gets a value indicating whether the request is sent from the local computer. - - - true if the request is sent from the local computer; otherwise, false. - - - - - Gets a value indicating whether the HTTP connection is secured using the SSL protocol. - - - true if the HTTP connection is secured; otherwise, false. - - - - - Gets a value indicating whether the request is a WebSocket connection request. - - - true if the request is a WebSocket connection request; otherwise, false. - - - - - Gets a value indicating whether the client requests a persistent connection. - - - true if the client requests a persistent connection; otherwise, false. - - - - - Gets the server endpoint as an IP address and a port number. - - - A that contains the server endpoint. - - - - - Gets the HTTP version used in the request. - - - A that contains the HTTP version used in the request. - - - - - Gets the collection of query string variables used in the request. - - - A that contains the collection of query string variables used in the request. - - - - - Gets the raw URL (without the scheme, host and port) requested by the client. - - - A that contains the raw URL requested by the client. - - - - - Gets the client endpoint as an IP address and a port number. - - - A that contains the client endpoint. - - - - - Gets the identifier of a request. - - - A that contains the identifier of a request. - - - - - Gets the URL requested by the client. - - - A that contains the URL requested by the client. - - - - - Gets the URL of the resource from which the requested URL was obtained. - - - A that contains the value of the Referer request-header field. - - - - - Gets the information about the user agent originating the request. - - - A that contains the value of the User-Agent request-header field. - - - - - Gets the server endpoint as an IP address and a port number. - - - A that contains the server endpoint. - - - - - Gets the internet host name and port number (if present) of the resource being requested. - - - A that contains the value of the Host request-header field. - - - - - Gets the natural languages that are preferred as a response to the request. - - - An array of that contains the natural language names in the Accept-Language request-header field. - - - - - Begins getting the client's X.509 v.3 certificate asynchronously. - - - This asynchronous operation must be completed by calling the method. - Typically, the method is invoked by the delegate. - - - An that contains the status of the asynchronous operation. - - - An delegate that references the method(s) - called when the asynchronous operation completes. - - - An that contains a user defined object to pass to the delegate. - - - This method is not implemented. - - - - - Ends an asynchronous operation to get the client's X.509 v.3 certificate. - - - This method completes an asynchronous operation started by calling the method. - - - A that contains the client's X.509 v.3 certificate. - - - An obtained by calling the method. - - - This method is not implemented. - - - - - Gets the client's X.509 v.3 certificate. - - - A that contains the client's X.509 v.3 certificate. - - - This method is not implemented. - - - - - Provides access to a response to a request being processed by a instance. - - - The HttpListenerResponse class cannot be inherited. - - - - - Gets or sets the encoding that can be used with the entity body data included in the response. - - - A that contains the encoding that can be used with the entity body data. - - - This object is closed. - - - The response has been sent already. - - - - - Gets or sets the size of the entity body data included in the response. - - - A that contains the value of the Content-Length entity-header field. - The value is a number of bytes in the entity body data. - - - This object is closed. - - - The response has been sent already. - - - The value specified for a set operation is less than zero. - - - - - Gets or sets the media type of the entity body included in the response. - - - The type of the content. - A that contains the value of the Content-Type entity-header field. - - - This object is closed. - - - The response has been sent already. - - - The value specified for a set operation is . - - - The value specified for a set operation is a . - - - - - Gets or sets the cookies returned with the response. - - - A that contains the cookies returned with the response. - - - - - Gets or sets the HTTP headers returned to the client. - - - A that contains the HTTP headers returned to the client. - - - - - Gets or sets a value indicating whether the server requests a persistent connection. - - - true if the server requests a persistent connection; otherwise, false. - The default is true. - - - This object is closed. - - - The response has been sent already. - - - - - Gets a to use to write the entity body data. - - - A to use to write the entity body data. - - - This object is closed. - - - - - Gets or sets the HTTP version used in the response. - - - A that contains the HTTP version used in the response. - - - This object is closed. - - - The response has been sent already. - - - The value specified for a set operation is . - - - The value specified for a set operation does not have its Major property set to 1 or - does not have its Minor property set to either 0 or 1. - - - - - Gets or sets the URL to which the client is redirected to locate a requested resource. - - - A that contains the value of the Location response-header field. - - - This object is closed. - - - The response has been sent already. - - - The value specified for a set operation is a . - - - - - Gets or sets a value indicating whether the response uses the chunked transfer encoding. - - - true if the response uses the chunked transfer encoding; otherwise, false. - - - This object is closed. - - - The response has been sent already. - - - - - Gets or sets the HTTP status code returned to the client. - - - An that indicates the HTTP status code for the response to the request. - The default is . - - - This object is closed. - - - The response has been sent already. - - - The value specified for a set operation is invalid. Valid values are between 100 and 999. - - - - - Gets or sets a description of the HTTP status code returned to the client. - - - A that contains a description of the HTTP status code returned to the client. - - - - - Releases all resource used by the . - - - - - Closes the connection to the client without sending a response. - - - - - Adds the specified HTTP header and to - the headers for this response. - - - A that contains the name of the HTTP header to add. - - - A that contains the value of the HTTP header to add. - - - is or . - - - The length of is greater than 65,535 characters. - - - - - Adds the specified to the sent with the response. - - - A to add to the . - - - is . - - - - - Appends a to the specified HTTP header sent with the response. - - - A that contains the name of the HTTP header to append to. - - - A that contains the value to append to the HTTP header. - - - is or . - - - The length of is greater than 65,535 characters. - - - - - Sends the response to the client and releases the resources associated with - the instance. - - - - - Sends the response with the specified array of to the client and - releases the resources associated with the instance. - - - An array of that contains the response entity body data. - - - true if this method blocks execution while flushing the stream to the client; otherwise, false. - - - is . - - - This object is closed. - - - - - Copies properties from the specified to this response. - - - A to copy. - - - - - Configures the response to redirect the client's request to the specified . - - - A that contains a URL to redirect the client's request to. - - - - - Adds or updates a in the sent with the response. - - - A to set. - - - is . - - - already exists in the and - could not be replaced. - - - - - Decodes an HTML-encoded string and returns the decoded string. - - The HTML string to decode. - The decoded text. - - - - Decodes an HTML-encoded string and sends the resulting output to a TextWriter output stream. - - The HTML string to decode. - The TextWriter output stream containing the decoded string. - - - - HTML-encodes a string and returns the encoded string. - - The text string to encode. - The HTML-encoded text. - - - - HTML-encodes a string and sends the resulting output to a TextWriter output stream. - - The string to encode. - The TextWriter output stream containing the encoded string. - - - - Provides a collection of the HTTP headers associated with a request or response. - - - - - Initializes a new instance of the class - with the specified and . - - - A that contains the data to need to serialize the object. - - - A that contains the source of the serialized stream associated with the new . - - - is . - - - An element with the specified name is not found in . - - - - - Initializes a new instance of the class. - - - - - Gets or sets the specified request in the collection. - - - A that contains the value of the specified request . - - - A that indicates a request header. - - - The current instance does not allow any of values. - - - - is a restricted header. - - - -or- - - - contains invalid characters. - - - - The length of is greater than 65535. - - - - - Gets or sets the specified response in the collection. - - - A that contains the value of the specified response . - - - A that indicates a response header. - - - The current instance does not allow any of values. - - - - is a restricted header. - - - -or- - - - contains invalid characters. - - - - The length of is greater than 65535. - - - - - Gets all header names in the collection. - - - An array of that contains all header names in the collection. - - - - - Gets the number of headers in the collection. - - - An that indicates the number of headers in the collection. - - - - - Gets a collection of header names in the collection. - - - A that contains a collection of header names in the collection. - - - - - Populates the specified with the data to need to - serialize the object. - - - A that holds the data to need to serialize the object. - - - A that specifies the destination for the serialization. - - - is . - - - - - Adds a header to the collection without checking whether the header is on the restricted header list. - - - A that contains the name of the header to add. - - - A that contains the value of the header to add. - - - is or . - - - or contains invalid characters. - - - The length of is greater than 65535. - - - The current instance does not allow the . - - - - - Adds the specified to the collection. - - - A that contains a header with the name and value separated by a colon (:). - - - is , , or - the name part of is . - - - - does not contain a colon. - - - -or- - - - is a restricted header. - - - -or- - - - The name or value part of contains invalid characters. - - - - The length of the value part of is greater than 65535. - - - The current instance does not allow the . - - - - - Adds the specified request with the specified to the collection. - - - A is a request header to add. - - - A that contains the value of the header to add. - - - The current instance does not allow any of values. - - - - is a restricted header. - - - -or- - - - contains invalid characters. - - - - The length of is greater than 65535. - - - - - Adds the specified response with the specified to the collection. - - - A is a response header to add. - - - A that contains the value of the header to add. - - - The current instance does not allow any of values. - - - - is a restricted header. - - - -or- - - - contains invalid characters. - - - - The length of is greater than 65535. - - - - - Adds a header with the specified and to the collection. - - - A that contains the name of the header to add. - - - A that contains the value of the header to add. - - - is or . - - - - or contains invalid characters. - - - -or- - - - is a restricted header name. - - - - The length of is greater than 65535. - - - The current instance does not allow the header . - - - - - Removes all headers from the collection. - - - - - Get the value of the header with the specified in the collection. - - - A that receives the value of the header. - - - An that is the zero-based index of the header to get. - - - - - Get the value of the header with the specified in the collection. - - - A that receives the value of the header. - if there is no header with in the collection. - - - A that contains the name of the header to get. - - - - - Gets the enumerator to use to iterate through the . - - - An instance of an implementation of the interface - to use to iterate through the . - - - - - Get the header name at the specified position in the collection. - - - A that receives the header name. - - - An is the zero-based index of the key to get from the collection. - - - - - Gets an array of header values stored in the specified name. - - - An array of that receives the header values. - - - A that contains a header name. - - - - - Gets an array of header values stored in the specified position of the header collection. - - - An array of that receives the header values. - - - An is the zero-based index of the header in the collection. - - - - - Populates the specified with the data to need to - serialize the object. - - - A that holds the data to need to serialize the object. - - - A that specifies the destination for the serialization. - - - is . - - - - - Determines whether the specified header can be set for the request. - - - true if the header is restricted; otherwise, false. - - - A that contains the name of the header to test. - - - is or . - - - contains invalid characters. - - - - - Determines whether the specified header can be set for the request or the response. - - - true if the header is restricted; otherwise, false. - - - A that contains the name of the header to test. - - - true if does the test for the response; for the request, false. - - - is or . - - - contains invalid characters. - - - - - Implements the interface and raises the deserialization event - when the deserialization is complete. - - - An that contains the source of the deserialization event. - - - - - Removes the specified header from the collection. - - - A to remove from the collection. - - - The current instance does not allow any of values. - - - is a restricted header. - - - - - Removes the specified header from the collection. - - - A to remove from the collection. - - - The current instance does not allow any of values. - - - is a restricted header. - - - - - Removes the specified header from the collection. - - - A that contains the name of the header to remove from the collection. - - - is or . - - - - contains invalid characters. - - - -or- - - - is a restricted header name. - - - - The current instance does not allow the header . - - - - - Sets the specified header to the specified value. - - - A to set. - - - A that contains the value of the header to set. - - - The current instance does not allow any of values. - - - - is a restricted header. - - - -or- - - - contains invalid characters. - - - - The length of is greater than 65535. - - - - - Sets the specified header to the specified value. - - - A to set. - - - A that contains the value of the header to set. - - - The current instance does not allow any of values. - - - - is a restricted header. - - - -or- - - - contains invalid characters. - - - - The length of is greater than 65535. - - - - - Sets the specified header to the specified value. - - - A that contains the name of the header to set. - - - A that contains the value of the header to set. - - - is or . - - - - or contain invalid characters. - - - -or- - - - is a restricted header name. - - - - The length of is greater than 65535. - - - The current instance does not allow the header . - - - - - Converts the current to an array of . - - - An array of that receives the converted current . - - - - - Returns a that represents the current . - - - A that represents the current . - - - - - Provides a simple HTTP server that allows to accept the WebSocket connection requests. - - - - The HttpServer class provides the multi WebSocket service. - - - - The HttpServer class needs the application configuration file to configure the server root path. - - - <?xml version="1.0" encoding="utf-8"?> - <configuration> - <appSettings> - <add key="RootPath" value="./Public" /> - </appSettings> - </configuration> - - - - - - - Initializes a new instance of the class that listens for incoming requests - on port 80. - - - - - Initializes a new instance of the class that listens for incoming requests - on the specified . - - - An that contains a port number. - - - - - Occurs when the server receives an HTTP CONNECT request. - - - - - Occurs when the server receives an HTTP DELETE request. - - - - - Occurs when the server gets an error. - - - - - Occurs when the server receives an HTTP GET request. - - - - - Occurs when the server receives an HTTP HEAD request. - - - - - Occurs when the server receives an HTTP OPTIONS request. - - - - - Occurs when the server receives an HTTP PATCH request. - - - - - Occurs when the server receives an HTTP POST request. - - - - - Occurs when the server receives an HTTP PUT request. - - - - - Occurs when the server receives an HTTP TRACE request. - - - - - Gets the port on which to listen for incoming requests. - - - An that contains a port number. - - - - - Gets the collection of paths associated with the every WebSocket services that the server provides. - - - An IEnumerable<string> that contains the collection of paths. - - - - - Gets or sets a value indicating whether the server cleans up the inactive WebSocket service - instances periodically. - - - true if the server cleans up the inactive WebSocket service instances every 60 seconds; - otherwise, false. The default value is true. - - - - - Adds the specified type WebSocket service. - - - A that contains an absolute path associated with the WebSocket service. - - - The type of the WebSocket service. The T must inherit the class. - - - - - Gets the contents of the specified file. - - - An array of that contains the contents of the file. - - - A that contains a virtual path to the file to get. - - - - - Starts the . - - - - - Shuts down the . - - - - - Provides the HTTP version numbers. - - - - - Initializes a new instance of the class. - - - - - Provides a instance for HTTP 1.0. - - - - - Provides a instance for HTTP 1.1. - - - - - Contains the values of the HTTP status codes. - - - The HttpStatusCode enumeration contains the values of the HTTP status codes defined in - RFC 2616 for HTTP 1.1. - - - - - Equivalent to status code 100. Indicates that the client should continue with its request. - - - - - Equivalent to status code 101. Indicates that the server is switching the HTTP version or protocol on the connection. - - - - - Equivalent to status code 200. Indicates that the client's request has succeeded. - - - - - Equivalent to status code 201. Indicates that the client's request has been fulfilled - and resulted in a new resource being created. - - - - - Equivalent to status code 202. Indicates that the client's request has been accepted for processing, - but the processing has not been completed. - - - - - Equivalent to status code 203. Indicates that the returned metainformation is from a local or a third-party copy instead of the origin server. - - - - - Equivalent to status code 204. Indicates that the server has fulfilled the client's request - but does not need to return an entity-body. - - - - - Equivalent to status code 205. Indicates that the server has fulfilled the client's request - and the user agent should reset the document view which caused the request to be sent. - - - - - Equivalent to status code 206. Indicates that the server has fulfilled the partial GET request for the resource. - - - - - - Equivalent to status code 300. Indicates that the requested resource corresponds to - any one of multiple representations. - - - MultipleChoices is a synonym for Ambiguous. - - - - - - - Equivalent to status code 300. Indicates that the requested resource corresponds to - any one of multiple representations. - - - Ambiguous is a synonym for MultipleChoices. - - - - - - - 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. - - - MovedPermanently is a synonym for Moved. - - - - - - - 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. - - - Moved is a synonym for MovedPermanently. - - - - - - - Equivalent to status code 302. Indicates that the requested resource is located temporarily - under a different URI. - - - Found is a synonym for Redirect. - - - - - - - Equivalent to status code 302. Indicates that the requested resource is located temporarily - under a different URI. - - - Redirect is a synonym for Found. - - - - - - - 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. - - - SeeOther is a synonym for RedirectMethod. - - - - - - - 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. - - - RedirectMethod is a synonym for SeeOther. - - - - - - Equivalent to status code 304. Indicates that the client has performed a conditional GET request - and access is allowed, but the document has not been modified. - - - - - Equivalent to status code 305. Indicates that the requested resource must be accessed - through the proxy given by the Location field. - - - - - Equivalent to status code 306. This code was used in a previous version of the specification, - is no longer used, and is reserved for future use. - - - - - - Equivalent to status code 307. Indicates that the requested resource is located temporarily - under a different URI. - - - TemporaryRedirect is a synonym for RedirectKeepVerb. - - - - - - - Equivalent to status code 307. Indicates that the requested resource is located temporarily - under a different URI. - - - RedirectKeepVerb is a synonym for TemporaryRedirect. - - - - - - Equivalent to status code 400. Indicates that the client's request could not be understood - by the server due to malformed syntax. - - - - - Equivalent to status code 401. Indicates that the client's request requires user authentication. - - - - - Equivalent to status code 402. This code is reserved for future use. - - - - - Equivalent to status code 403. Indicates that the server understood the client's request - but is refusing to fulfill it. - - - - - Equivalent to status code 404. Indicates that the server has not found anything - matching the request URI. - - - - - Equivalent to status code 405. Indicates that the method specified in the request line - is not allowed for the resource identified by the request URI. - - - - - Equivalent to status code 406. Indicates that the server does not have the appropriate resource - to respond to the accept headers in the client's request. - - - - - Equivalent to status code 407. Indicates that the client must first authenticate itself with the proxy. - - - - - Equivalent to status code 408. Indicates that the client did not produce a request - within the time that the server was prepared to wait. - - - - - Equivalent to status code 409. Indicates that the client's request could not be completed - due to a conflict on the server. - - - - - Equivalent to status code 410. Indicates that the requested resource is no longer available - at the server and no forwarding address is known. - - - - - Equivalent to status code 411. Indicates that the server refuses to accept the client's request - without a defined Content-Length. - - - - - Equivalent to status code 412. Indicates that the precondition given in one or more of the request header fields - evaluated to false when it was tested on the server. - - - - - Equivalent to status code 413. Indicates that the client's request entity is larger - than the server is willing or able to process. - - - - - Equivalent to status code 414. Indicates that the request URI is longer - than the server is willing to interpret. - - - - - Equivalent to status code 415. Indicates that the entity of the client's request is in a format - not supported by the requested resource for the requested method. - - - - - Equivalent to status code 416. Indicates that none of the range specifier values in a Range request header field - overlap the current extent of the selected resource. - - - - - Equivalent to status code 417. Indicates that the expectation given in an Expect request header field - could not be met by the server. - - - - - Equivalent to status code 500. Indicates that the server encountered an unexpected condition - which prevented it from fulfilling the client's request. - - - - - Equivalent to status code 501. Indicates that the server does not support the functionality - required to fulfill the client's request. - - - - - Equivalent to status code 502. Indicates that a gateway or proxy server received an invalid response - from the upstream server. - - - - - Equivalent to status code 503. Indicates that the server is currently unable to handle the client's request - due to a temporary overloading or maintenance of the server. - - - - - Equivalent to status code 504. Indicates that a gateway or proxy server did not receive a timely response - from the upstream server or some other auxiliary server. - - - - - Equivalent to status code 505. Indicates that the server does not support the HTTP version - used in the client's request. - - - - - Provides the basic functions of the server that receives the WebSocket connection requests. - - - The WebSocketServerBase class is an abstract class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class that listens for incoming connection attempts - on the specified WebSocket URL. - - - A that contains a WebSocket URL. - - - is . - - - is invalid. - - - - - Initializes a new instance of the class that listens for incoming connection attempts - on the specified , , and . - - - A that contains a local IP address. - - - An that contains a port number. - - - A that contains an absolute path. - - - A that indicates providing a secure connection or not. (true indicates providing a secure connection.) - - - Either or is . - - - - is invalid. - - - -or- - - - Pair of and is invalid. - - - - - - Occurs when the server gets an error. - - - - - Gets or sets the WebSocket URL on which to listen for incoming connection attempts. - - - A that contains a WebSocket URL. - - - - - Gets the local IP address on which to listen for incoming connection attempts. - - - A that contains a local IP address. - - - - - Gets a value indicating whether the server provides secure connection. - - - true if the server provides secure connection; otherwise, false. - - - - - Gets a value indicating whether the server is self host. - - - true if the server is self host; otherwise, false. - - - - - Gets the port on which to listen for incoming connection attempts. - - - An that contains a port number. - - - - - Accepts a WebSocket connection request. - - - A that contains the WebSocket connection request objects. - - - - - Occurs the event with the specified . - - - A that contains an error message. - - - - - Starts to receive the WebSocket connection requests. - - - - - Stops receiving the WebSocket connection requests. - - - - - Exposes the methods and properties for the WebSocket service host. - - - - - - - Gets or sets a value indicating whether the WebSocket service host cleans up the inactive service - instances periodically. - - - true if the WebSocket service host cleans up the inactive service instances periodically; - otherwise, false. - - - - - Binds the specified to a instance. - - - A that contains the WebSocket connection request objects to bind. - - - - - Broadcasts the specified to all service clients. - - - A to broadcast. - - - - - Starts the WebSocket service host. - - - - - Stops the WebSocket service host. - - - - - Provides the functions of the server that receives the WebSocket connection requests. - - - The WebSocketServiceHost<T> class provides the single WebSocket service. - - - The type of the WebSocket service that the server provides. The T must inherit the class. - - - - - Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified . - - - An that contains a port number. - - - - - Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified WebSocket URL. - - - A that contains a WebSocket URL. - - - - - Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified and . - - - An that contains a port number. - - - A that indicates providing a secure connection or not. (true indicates providing a secure connection.) - - - - - Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified and . - - - An that contains a port number. - - - A that contains an absolute path. - - - - - Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified , and . - - - An that contains a port number. - - - A that contains an absolute path. - - - A that indicates providing a secure connection or not. (true indicates providing a secure connection.) - - - - - Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified , and . - - - A that contains a local IP address. - - - An that contains a port number. - - - A that contains an absolute path. - - - - - Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified , , and . - - - A that contains a local IP address. - - - An that contains a port number. - - - A that contains an absolute path. - - - A that indicates providing a secure connection or not. (true indicates providing a secure connection.) - - - - - Gets or sets a value indicating whether the server cleans up the inactive WebSocket service - instances periodically. - - - true if the server cleans up the inactive WebSocket service instances every 60 seconds; - otherwise, false. The default value is true. - - - - - Gets the WebSocket URL on which to listen for incoming connection attempts. - - - A that contains a WebSocket URL. - - - - - Binds the specified to a instance. - - - A that contains the WebSocket connection request objects to bind. - - - - - Accepts a WebSocket connection request. - - - A that contains the WebSocket connection request objects. - - - - - Broadcasts the specified to all clients. - - - A to broadcast. - - - - - Pings with the specified to all clients. - - - A Dictionary<string, bool> that contains the collection of session IDs and values - indicating whether the server received the Pongs from each clients in a time. - - - A that contains a message. - - - - - Stops receiving the WebSocket connection requests. - - - - - Contains the values of the status codes for the WebSocket connection closure. - - - - The CloseStatusCode enumeration contains the values of the status codes for the WebSocket connection closure - defined in RFC 6455 for the WebSocket protocol. - - - "Reserved value" must not be set as a status code in a close control frame by an endpoint. - It is designated for use in applications expecting a status code to indicate that connection - was closed due to a system grounds. - - - - - - Equivalent to close status 1000. Indicates a normal closure. - - - - - Equivalent to close status 1001. Indicates that an endpoint is "going away". - - - - - Equivalent to close status 1002. Indicates that an endpoint is terminating the connection - due to a protocol error. - - - - - Equivalent to close status 1003. Indicates that an endpoint is terminating the connection - because it has received a type of data it cannot accept. - - - - - Equivalent to close status 1004. Still undefined. Reserved value. - - - - - Equivalent to close status 1005. Indicates that no status code was actually present. Reserved value. - - - - - Equivalent to close status 1006. Indicates that the connection was closed abnormally. Reserved value. - - - - - Equivalent to close status 1007. Indicates that an endpoint is terminating the connection - because it has received data within a message that was not consistent with the type of the message. - - - - - Equivalent to close status 1008. Indicates that an endpoint is terminating the connection - because it has received a message that violates its policy. - - - - - Equivalent to close status 1009. Indicates that an endpoint is terminating the connection - because it has received a message that is too big for it to process. - - - - - Equivalent to close status 1010. Indicates that an endpoint (client) is terminating the connection - because it has expected the server to negotiate one or more extension, but the server didn't return - them in the response message of the WebSocket handshake. - - - - - Equivalent to close status 1011. Indicates that a server is terminating the connection because it encountered - an unexpected condition that prevented it from fulfilling the request. - - - - - Equivalent to close status 1015. Indicates that the connection was closed due to a failure to perform - a TLS handshake. Reserved value. - - - - - Contains the values of the opcodes that denotes the frame type of the WebSocket frame. - - - The Opcode enumeration contains the values of the opcodes defined in - RFC 6455 for the WebSocket protocol. - - - - - Equivalent to numeric value 0. Indicates a continuation frame. - - - - - Equivalent to numeric value 1. Indicates a text frame. - - - - - Equivalent to numeric value 2. Indicates a binary frame. - - - - - Equivalent to numeric value 8. Indicates a connection close frame. - - - - - Equivalent to numeric value 9. Indicates a ping frame. - - - - - Equivalent to numeric value 10. Indicates a pong frame. - - - - - Provides access to the WebSocket connection request objects received by the class. - - - - - - - Gets the cookies used in the WebSocket opening handshake. - - - A that contains the cookies. - - - - - Gets the HTTP headers used in the WebSocket opening handshake. - - - A that contains the HTTP headers. - - - - - Gets a value indicating whether the client is authenticated. - - - true if the client is authenticated; otherwise, false. - - - - - Gets a value indicating whether the client connected from the local computer. - - - true if the client connected from the local computer; otherwise, false. - - - - - Gets a value indicating whether the WebSocket connection is secured. - - - true if the WebSocket connection is secured; otherwise, false. - - - - - Gets a value indicating whether the WebSocket connection request is valid. - - - true if the WebSocket connection request is valid; otherwise, false. - - - - - Gets the value of the Origin header field used in the WebSocket opening handshake. - - - A that contains the value of the Origin header field. - - - - - Gets the absolute path of the requested WebSocket URI. - - - A that contains the absolute path of the requested WebSocket URI. - - - - - Gets the collection of query string variables used in the WebSocket opening handshake. - - - A that contains the collection of query string variables. - - - - - Gets the WebSocket URI requested by the client. - - - A that contains the WebSocket URI. - - - - - Gets the value of the Sec-WebSocket-Key header field used in the WebSocket opening handshake. - - - The SecWebSocketKey property provides a part of the information used by the server to prove that it received a valid WebSocket opening handshake. - - - A that contains the value of the Sec-WebSocket-Key header field. - - - - - Gets the values of the Sec-WebSocket-Protocol header field used in the WebSocket opening handshake. - - - The SecWebSocketProtocols property indicates the subprotocols of the WebSocket connection. - - - An IEnumerable<string> that contains the values of the Sec-WebSocket-Protocol header field. - - - - - Gets the value of the Sec-WebSocket-Version header field used in the WebSocket opening handshake. - - - The SecWebSocketVersion property indicates the WebSocket protocol version of the connection. - - - A that contains the value of the Sec-WebSocket-Version header field. - - - - - Gets the server endpoint as an IP address and a port number. - - - A that contains the server endpoint. - - - - - Gets the client information (identity, authentication information and security roles). - - - A that contains the client information. - - - - - Gets the client endpoint as an IP address and a port number. - - - A that contains the client endpoint. - - - - - Gets the WebSocket instance used for two-way communication between client and server. - - - A . - - - - - Provides access to the WebSocket connection request objects received by the class. - - - - - - - Gets the cookies used in the WebSocket opening handshake. - - - A that contains the cookies. - - - - - Gets the HTTP headers used in the WebSocket opening handshake. - - - A that contains the HTTP headers. - - - - - Gets a value indicating whether the client is authenticated. - - - true if the client is authenticated; otherwise, false. - - - This property is not implemented. - - - - - Gets a value indicating whether the client connected from the local computer. - - - true if the client connected from the local computer; otherwise, false. - - - - - Gets a value indicating whether the WebSocket connection is secured. - - - true if the WebSocket connection is secured; otherwise, false. - - - - - Gets a value indicating whether the WebSocket connection request is valid. - - - true if the WebSocket connection request is valid; otherwise, false. - - - - - Gets the value of the Origin header field used in the WebSocket opening handshake. - - - A that contains the value of the Origin header field. - - - - - Gets the absolute path of the requested WebSocket URI. - - - A that contains the absolute path of the requested WebSocket URI. - - - - - Gets the collection of query string variables used in the WebSocket opening handshake. - - - A that contains the collection of query string variables. - - - - - Gets the WebSocket URI requested by the client. - - - A that contains the WebSocket URI. - - - - - Gets the value of the Sec-WebSocket-Key header field used in the WebSocket opening handshake. - - - The SecWebSocketKey property provides a part of the information used by the server to prove that it received a valid WebSocket opening handshake. - - - A that contains the value of the Sec-WebSocket-Key header field. - - - - - Gets the values of the Sec-WebSocket-Protocol header field used in the WebSocket opening handshake. - - - The SecWebSocketProtocols property indicates the subprotocols of the WebSocket connection. - - - An IEnumerable<string> that contains the values of the Sec-WebSocket-Protocol header field. - - - - - Gets the value of the Sec-WebSocket-Version header field used in the WebSocket opening handshake. - - - The SecWebSocketVersion property indicates the WebSocket protocol version of the connection. - - - A that contains the value of the Sec-WebSocket-Version header field. - - - - - Gets the server endpoint as an IP address and a port number. - - - A that contains the server endpoint. - - - - - Gets the client information (identity, authentication information and security roles). - - - A that contains the client information. - - - This property is not implemented. - - - - - Gets the client endpoint as an IP address and a port number. - - - A that contains the client endpoint. - - - - - Gets the WebSocket instance used for two-way communication between client and server. - - - A . - - - - - Provides access to the WebSocket connection request objects. - - - The WebSocketContext class is an abstract class. - - - - - Initializes a new instance of the class. - - - - - Gets the cookies used in the WebSocket opening handshake. - - - A that contains the cookies. - - - - - Gets the HTTP headers used in the WebSocket opening handshake. - - - A that contains the HTTP headers. - - - - - Gets a value indicating whether the client is authenticated. - - - true if the client is authenticated; otherwise, false. - - - - - Gets a value indicating whether the client connected from the local computer. - - - true if the client connected from the local computer; otherwise, false. - - - - - Gets a value indicating whether the WebSocket connection is secured. - - - true if the WebSocket connection is secured; otherwise, false. - - - - - Gets a value indicating whether the WebSocket connection request is valid. - - - true if the WebSocket connection request is valid; otherwise, false. - - - - - Gets the value of the Origin header field used in the WebSocket opening handshake. - - - A that contains the value of the Origin header field. - - - - - Gets the absolute path of the requested WebSocket URI. - - - A that contains the absolute path of the requested WebSocket URI. - - - - - Gets the collection of query string variables used in the WebSocket opening handshake. - - - A that contains the collection of query string variables. - - - - - Gets the WebSocket URI requested by the client. - - - A that contains the WebSocket URI. - - - - - Gets the value of the Sec-WebSocket-Key header field used in the WebSocket opening handshake. - - - The SecWebSocketKey property provides a part of the information used by the server to prove that it received a valid WebSocket opening handshake. - - - A that contains the value of the Sec-WebSocket-Key header field. - - - - - Gets the values of the Sec-WebSocket-Protocol header field used in the WebSocket opening handshake. - - - The SecWebSocketProtocols property indicates the subprotocols of the WebSocket connection. - - - An IEnumerable<string> that contains the values of the Sec-WebSocket-Protocol header field. - - - - - Gets the value of the Sec-WebSocket-Version header field used in the WebSocket opening handshake. - - - The SecWebSocketVersion property indicates the WebSocket protocol version of the connection. - - - A that contains the value of the Sec-WebSocket-Version header field. - - - - - Gets the client information (identity, authentication information and security roles). - - - A that contains the client information. - - - - - Gets the WebSocket instance used for two-way communication between client and server. - - - A . - - - - - Manages the collection of objects. - - - - - Gets the collection of IDs of active objects - managed by the . - - - An IEnumerable<string> that contains the collection of IDs of active objects. - - - - - Gets the number of objects - managed by the . - - - An that contains the number of objects - managed by the . - - - - - Gets the collection of IDs of inactive objects - managed by the . - - - An IEnumerable<string> that contains the collection of IDs of inactive objects. - - - - - Gets the collection of IDs of objects - managed by the . - - - An IEnumerable<string> that contains the collection of IDs of objects. - - - - - Gets a value indicating whether the cleans up - the inactive objects periodically. - - - true if the cleans up the inactive objects - every 60 seconds; otherwise, false. - - - - - Broadcasts the specified array of to the clients of every - managed by the . - - - An array of to broadcast. - - - - - Broadcasts the specified to the clients of every - managed by the . - - - A to broadcast. - - - - - Pings with the specified to the clients of every - managed by the . - - - A Dictionary<string, bool> that contains the collection of IDs and values - indicating whether each received a Pong in a time. - - - A that contains a message. - - - - - Cleans up the inactive objects. - - - - - Tries to get the associated with the specified . - - - true if the manages the with the specified ; otherwise, false. - - - A that contains the ID to find. - - - When this method returns, contains the with the specified , if the is found; otherwise, . - - - - - Contains the event data associated with the HTTP request events of the class. - - - An HTTP request event occurs when a instance receives an HTTP request. - If you want to get the HTTP request objects, you should access the property. - If you want to get the HTTP response objects to send, you should access the property. - - - - - Gets the HTTP request objects sent from a client. - - - A that contains the HTTP request objects. - - - - - Gets the HTTP response objects to send to the client in response to the client's request. - - - A that contains the HTTP response objects. - - - - - Contains the values of the compression methods used to compress the payload data of the WebSocket Data frame. - - - The CompressionMethod enumeration contains the values of the compression methods defined in - Compression Extensions for WebSocket. - - - - - Indicates non compression. - - - - - Indicates using DEFLATE. - - - - - Represents the exception that occurred when attempting to perform an operation on the WebSocket connection. - - - - - Gets the associated with a . - - - One of the values that indicates the cause of the exception. - - - - - Provides the credentials for HTTP authentication (Basic/Digest). - - - - - Gets the name of the user domain associated with the credentials. - - - A that contains the name of the user domain associated with the credentials. - Currently, returns the request uri of a WebSocket opening handshake. - - - - - Gets the password for the user name associated with the credentials. - - - A that contains the password for the user name associated with the credentials. - - - - - Gets the user name associated with the credentials. - - - A that contains the user name associated with the credentials. - - - - diff --git a/websocket-sharp/doc/.gitignore b/websocket-sharp/doc/.gitignore new file mode 100644 index 00000000..7b744c39 --- /dev/null +++ b/websocket-sharp/doc/.gitignore @@ -0,0 +1,4 @@ +## Ignore MonoDevelop build results. + +html +mdoc diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net.WebSockets/HttpListenerWebSocketContext.html b/websocket-sharp/doc/html/WebSocketSharp.Net.WebSockets/HttpListenerWebSocketContext.html deleted file mode 100644 index e01dbcb7..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Net.WebSockets/HttpListenerWebSocketContext.html +++ /dev/null @@ -1,1065 +0,0 @@ - - - WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext - - - - - -
- websocket-sharp : WebSocketSharp.Net.WebSockets Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

HttpListenerWebSocketContext Class

-

- Provides access to the WebSocket connection request objects received by the WebSocketSharp.Net.HttpListener class. -

-
-

Syntax

-
public class HttpListenerWebSocketContext : WebSocketContext
-
-
-

Remarks

-
-
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - WebSocketContext. -

-

Public Properties

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
[read-only]
override
- - CookieCollection - - - - WebSocketSharp.Net.CookieCollection - . - Gets the cookies used in the WebSocket opening handshake. -
[read-only]
abstract
- - CookieCollection - - - - WebSocketSharp.Net.CookieCollection - . - Gets the cookies used in the WebSocket opening handshake. - (Inherited from WebSocketContext.)
[read-only]
override
- - Headers - - - - System.Collections.Specialized.NameValueCollection - . - Gets the HTTP headers used in the WebSocket opening handshake. -
[read-only]
abstract
- - Headers - - - - System.Collections.Specialized.NameValueCollection - . - Gets the HTTP headers used in the WebSocket opening handshake. - (Inherited from WebSocketContext.)
[read-only]
override
- - IsAuthenticated - - - - bool - . - Gets a value indicating whether the client is authenticated. -
[read-only]
abstract
- - IsAuthenticated - - - - bool - . - Gets a value indicating whether the client is authenticated. - (Inherited from WebSocketContext.)
[read-only]
override
- - IsLocal - - - - bool - . - Gets a value indicating whether the client connected from the local computer. -
[read-only]
abstract
- - IsLocal - - - - bool - . - Gets a value indicating whether the client connected from the local computer. - (Inherited from WebSocketContext.)
[read-only]
override
- - IsSecureConnection - - - - bool - . - Gets a value indicating whether the WebSocket connection is secured. -
[read-only]
abstract
- - IsSecureConnection - - - - bool - . - Gets a value indicating whether the WebSocket connection is secured. - (Inherited from WebSocketContext.)
[read-only]
override
- - IsValid - - - - bool - . - Gets a value indicating whether the WebSocket connection request is valid. -
[read-only]
abstract
- - IsValid - - - - bool - . - Gets a value indicating whether the WebSocket connection request is valid. - (Inherited from WebSocketContext.)
[read-only]
override
- - Origin - - - - string - . - Gets the value of the Origin header field used in the WebSocket opening handshake. -
[read-only]
abstract
- - Origin - - - - string - . - Gets the value of the Origin header field used in the WebSocket opening handshake. - (Inherited from WebSocketContext.)
[read-only]
override
- - Path - - - - string - . - Gets the absolute path of the requested WebSocket URI. -
[read-only]
abstract
- - Path - - - - string - . - Gets the absolute path of the requested WebSocket URI. - (Inherited from WebSocketContext.)
[read-only]
override
- - QueryString - - - - System.Collections.Specialized.NameValueCollection - . - Gets the collection of query string variables used in the WebSocket opening handshake. -
[read-only]
abstract
- - QueryString - - - - System.Collections.Specialized.NameValueCollection - . - Gets the collection of query string variables used in the WebSocket opening handshake. - (Inherited from WebSocketContext.)
[read-only]
override
- - RequestUri - - - - Uri - . - Gets the WebSocket URI requested by the client. -
[read-only]
abstract
- - RequestUri - - - - Uri - . - Gets the WebSocket URI requested by the client. - (Inherited from WebSocketContext.)
[read-only]
override
- - SecWebSocketKey - - - - string - . - Gets the value of the Sec-WebSocket-Key header field used in the WebSocket opening handshake. -
[read-only]
abstract
- - SecWebSocketKey - - - - string - . - Gets the value of the Sec-WebSocket-Key header field used in the WebSocket opening handshake. - (Inherited from WebSocketContext.)
[read-only]
override
- - SecWebSocketProtocols - - - - IEnumerable<string> - . - Gets the values of the Sec-WebSocket-Protocol header field used in the WebSocket opening handshake. -
[read-only]
abstract
- - SecWebSocketProtocols - - - - IEnumerable<string> - . - Gets the values of the Sec-WebSocket-Protocol header field used in the WebSocket opening handshake. - (Inherited from WebSocketContext.)
[read-only]
override
- - SecWebSocketVersion - - - - string - . - Gets the value of the Sec-WebSocket-Version header field used in the WebSocket opening handshake. -
[read-only]
abstract
- - SecWebSocketVersion - - - - string - . - Gets the value of the Sec-WebSocket-Version header field used in the WebSocket opening handshake. - (Inherited from WebSocketContext.)
[read-only]
 - - ServerEndPoint - - - - System.Net.IPEndPoint - . - Gets the server endpoint as an IP address and a port number. -
[read-only]
override
- - User - - - - System.Security.Principal.IPrincipal - . - Gets the client information (identity, authentication information and security roles). -
[read-only]
abstract
- - User - - - - System.Security.Principal.IPrincipal - . - Gets the client information (identity, authentication information and security roles). - (Inherited from WebSocketContext.)
[read-only]
 - - UserEndPoint - - - - System.Net.IPEndPoint - . - Gets the client endpoint as an IP address and a port number. -
[read-only]
override
- - WebSocket - - - - WebSocketSharp.WebSocket - . - Gets the WebSocket instance used for two-way communication between client and server. -
[read-only]
abstract
- - WebSocket - - - - WebSocketSharp.WebSocket - . - Gets the WebSocket instance used for two-way communication between client and server. - (Inherited from WebSocketContext.)
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

CookieCollection Property

-
-

- Gets the cookies used in the WebSocket opening handshake. -

-

Syntax

-
public override WebSocketSharp.Net.CookieCollection CookieCollection { get; }
-

Value

-
- A WebSocketSharp.Net.CookieCollection that contains the cookies. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Headers Property

-
-

- Gets the HTTP headers used in the WebSocket opening handshake. -

-

Syntax

-
public override System.Collections.Specialized.NameValueCollection Headers { get; }
-

Value

-
- A System.Collections.Specialized.NameValueCollection that contains the HTTP headers. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsAuthenticated Property

-
-

- Gets a value indicating whether the client is authenticated. -

-

Syntax

-
public override bool IsAuthenticated { get; }
-

Value

-
- true if the client is authenticated; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsLocal Property

-
-

- Gets a value indicating whether the client connected from the local computer. -

-

Syntax

-
public override bool IsLocal { get; }
-

Value

-
- true if the client connected from the local computer; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsSecureConnection Property

-
-

- Gets a value indicating whether the WebSocket connection is secured. -

-

Syntax

-
public override bool IsSecureConnection { get; }
-

Value

-
- true if the WebSocket connection is secured; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsValid Property

-
-

- Gets a value indicating whether the WebSocket connection request is valid. -

-

Syntax

-
public override bool IsValid { get; }
-

Value

-
- true if the WebSocket connection request is valid; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Origin Property

-
-

- Gets the value of the Origin header field used in the WebSocket opening handshake. -

-

Syntax

-
public override string Origin { get; }
-

Value

-
- A string that contains the value of the Origin header field. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Path Property

-
-

- Gets the absolute path of the requested WebSocket URI. -

-

Syntax

-
public override string Path { get; }
-

Value

-
- A string that contains the absolute path of the requested WebSocket URI. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

QueryString Property

-
-

- Gets the collection of query string variables used in the WebSocket opening handshake. -

-

Syntax

-
public override System.Collections.Specialized.NameValueCollection QueryString { get; }
-

Value

-
- A System.Collections.Specialized.NameValueCollection that contains the collection of query string variables. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

RequestUri Property

-
-

- Gets the WebSocket URI requested by the client. -

-

Syntax

-
public override Uri RequestUri { get; }
-

Value

-
- A Uri that contains the WebSocket URI. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

SecWebSocketKey Property

-
-

- Gets the value of the Sec-WebSocket-Key header field used in the WebSocket opening handshake. -

-

Syntax

-
public override string SecWebSocketKey { get; }
-

Value

-
- A string that contains the value of the Sec-WebSocket-Key header field. -
-

Remarks

-
- The SecWebSocketKey property provides a part of the information used by the server to prove that it received a valid WebSocket opening handshake. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

SecWebSocketProtocols Property

-
-

- Gets the values of the Sec-WebSocket-Protocol header field used in the WebSocket opening handshake. -

-

Syntax

-
public override IEnumerable<string> SecWebSocketProtocols { get; }
-

Value

-
- An IEnumerable<string> that contains the values of the Sec-WebSocket-Protocol header field. -
-

Remarks

-
- The SecWebSocketProtocols property indicates the subprotocols of the WebSocket connection. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

SecWebSocketVersion Property

-
-

- Gets the value of the Sec-WebSocket-Version header field used in the WebSocket opening handshake. -

-

Syntax

-
public override string SecWebSocketVersion { get; }
-

Value

-
- A string that contains the value of the Sec-WebSocket-Version header field. -
-

Remarks

-
- The SecWebSocketVersion property indicates the WebSocket protocol version of the connection. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ServerEndPoint Property

-
-

- Gets the server endpoint as an IP address and a port number. -

-

Syntax

-
public virtual System.Net.IPEndPoint ServerEndPoint { get; }
-

Value

-
- A System.Net.IPEndPoint that contains the server endpoint. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

User Property

-
-

- Gets the client information (identity, authentication information and security roles). -

-

Syntax

-
public override System.Security.Principal.IPrincipal User { get; }
-

Value

-
- A System.Security.Principal.IPrincipal that contains the client information. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

UserEndPoint Property

-
-

- Gets the client endpoint as an IP address and a port number. -

-

Syntax

-
public virtual System.Net.IPEndPoint UserEndPoint { get; }
-

Value

-
- A System.Net.IPEndPoint that contains the client endpoint. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

WebSocket Property

-
-

- Gets the WebSocket instance used for two-way communication between client and server. -

-

Syntax

-
public override WebSocketSharp.WebSocket WebSocket { get; }
-

Value

-
- A WebSocketSharp.WebSocket. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html b/websocket-sharp/doc/html/WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html deleted file mode 100644 index fa541b41..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.html +++ /dev/null @@ -1,1133 +0,0 @@ - - - WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext - - - - - -
- websocket-sharp : WebSocketSharp.Net.WebSockets Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

TcpListenerWebSocketContext Class

-

- Provides access to the WebSocket connection request objects received by the System.Net.Sockets.TcpListener class. -

-
-

Syntax

-
public class TcpListenerWebSocketContext : WebSocketContext
-
-
-

Remarks

-
-
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - WebSocketContext. -

-

Public Properties

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
[read-only]
override
- - CookieCollection - - - - WebSocketSharp.Net.CookieCollection - . - Gets the cookies used in the WebSocket opening handshake. -
[read-only]
abstract
- - CookieCollection - - - - WebSocketSharp.Net.CookieCollection - . - Gets the cookies used in the WebSocket opening handshake. - (Inherited from WebSocketContext.)
[read-only]
override
- - Headers - - - - System.Collections.Specialized.NameValueCollection - . - Gets the HTTP headers used in the WebSocket opening handshake. -
[read-only]
abstract
- - Headers - - - - System.Collections.Specialized.NameValueCollection - . - Gets the HTTP headers used in the WebSocket opening handshake. - (Inherited from WebSocketContext.)
[read-only]
override
- - IsAuthenticated - - - - bool - . - Gets a value indicating whether the client is authenticated. -
[read-only]
abstract
- - IsAuthenticated - - - - bool - . - Gets a value indicating whether the client is authenticated. - (Inherited from WebSocketContext.)
[read-only]
override
- - IsLocal - - - - bool - . - Gets a value indicating whether the client connected from the local computer. -
[read-only]
abstract
- - IsLocal - - - - bool - . - Gets a value indicating whether the client connected from the local computer. - (Inherited from WebSocketContext.)
[read-only]
override
- - IsSecureConnection - - - - bool - . - Gets a value indicating whether the WebSocket connection is secured. -
[read-only]
abstract
- - IsSecureConnection - - - - bool - . - Gets a value indicating whether the WebSocket connection is secured. - (Inherited from WebSocketContext.)
[read-only]
override
- - IsValid - - - - bool - . - Gets a value indicating whether the WebSocket connection request is valid. -
[read-only]
abstract
- - IsValid - - - - bool - . - Gets a value indicating whether the WebSocket connection request is valid. - (Inherited from WebSocketContext.)
[read-only]
override
- - Origin - - - - string - . - Gets the value of the Origin header field used in the WebSocket opening handshake. -
[read-only]
abstract
- - Origin - - - - string - . - Gets the value of the Origin header field used in the WebSocket opening handshake. - (Inherited from WebSocketContext.)
[read-only]
override
- - Path - - - - string - . - Gets the absolute path of the requested WebSocket URI. -
[read-only]
abstract
- - Path - - - - string - . - Gets the absolute path of the requested WebSocket URI. - (Inherited from WebSocketContext.)
[read-only]
override
- - QueryString - - - - System.Collections.Specialized.NameValueCollection - . - Gets the collection of query string variables used in the WebSocket opening handshake. -
[read-only]
abstract
- - QueryString - - - - System.Collections.Specialized.NameValueCollection - . - Gets the collection of query string variables used in the WebSocket opening handshake. - (Inherited from WebSocketContext.)
[read-only]
override
- - RequestUri - - - - Uri - . - Gets the WebSocket URI requested by the client. -
[read-only]
abstract
- - RequestUri - - - - Uri - . - Gets the WebSocket URI requested by the client. - (Inherited from WebSocketContext.)
[read-only]
override
- - SecWebSocketKey - - - - string - . - Gets the value of the Sec-WebSocket-Key header field used in the WebSocket opening handshake. -
[read-only]
abstract
- - SecWebSocketKey - - - - string - . - Gets the value of the Sec-WebSocket-Key header field used in the WebSocket opening handshake. - (Inherited from WebSocketContext.)
[read-only]
override
- - SecWebSocketProtocols - - - - IEnumerable<string> - . - Gets the values of the Sec-WebSocket-Protocol header field used in the WebSocket opening handshake. -
[read-only]
abstract
- - SecWebSocketProtocols - - - - IEnumerable<string> - . - Gets the values of the Sec-WebSocket-Protocol header field used in the WebSocket opening handshake. - (Inherited from WebSocketContext.)
[read-only]
override
- - SecWebSocketVersion - - - - string - . - Gets the value of the Sec-WebSocket-Version header field used in the WebSocket opening handshake. -
[read-only]
abstract
- - SecWebSocketVersion - - - - string - . - Gets the value of the Sec-WebSocket-Version header field used in the WebSocket opening handshake. - (Inherited from WebSocketContext.)
[read-only]
 - - ServerEndPoint - - - - System.Net.IPEndPoint - . - Gets the server endpoint as an IP address and a port number. -
[read-only]
override
- - User - - - - System.Security.Principal.IPrincipal - . - Gets the client information (identity, authentication information and security roles). -
[read-only]
abstract
- - User - - - - System.Security.Principal.IPrincipal - . - Gets the client information (identity, authentication information and security roles). - (Inherited from WebSocketContext.)
[read-only]
 - - UserEndPoint - - - - System.Net.IPEndPoint - . - Gets the client endpoint as an IP address and a port number. -
[read-only]
override
- - WebSocket - - - - WebSocketSharp.WebSocket - . - Gets the WebSocket instance used for two-way communication between client and server. -
[read-only]
abstract
- - WebSocket - - - - WebSocketSharp.WebSocket - . - Gets the WebSocket instance used for two-way communication between client and server. - (Inherited from WebSocketContext.)
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

CookieCollection Property

-
-

- Gets the cookies used in the WebSocket opening handshake. -

-

Syntax

-
public override WebSocketSharp.Net.CookieCollection CookieCollection { get; }
-

Value

-
- A WebSocketSharp.Net.CookieCollection that contains the cookies. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- NotImplementedException - - This property is not implemented. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Headers Property

-
-

- Gets the HTTP headers used in the WebSocket opening handshake. -

-

Syntax

-
public override System.Collections.Specialized.NameValueCollection Headers { get; }
-

Value

-
- A System.Collections.Specialized.NameValueCollection that contains the HTTP headers. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsAuthenticated Property

-
-

- Gets a value indicating whether the client is authenticated. -

-

Syntax

-
public override bool IsAuthenticated { get; }
-

Value

-
- true if the client is authenticated; otherwise, false. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- NotImplementedException - - This property is not implemented. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsLocal Property

-
-

- Gets a value indicating whether the client connected from the local computer. -

-

Syntax

-
public override bool IsLocal { get; }
-

Value

-
- true if the client connected from the local computer; otherwise, false. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- NotImplementedException - - This property is not implemented. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsSecureConnection Property

-
-

- Gets a value indicating whether the WebSocket connection is secured. -

-

Syntax

-
public override bool IsSecureConnection { get; }
-

Value

-
- true if the WebSocket connection is secured; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsValid Property

-
-

- Gets a value indicating whether the WebSocket connection request is valid. -

-

Syntax

-
public override bool IsValid { get; }
-

Value

-
- true if the WebSocket connection request is valid; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Origin Property

-
-

- Gets the value of the Origin header field used in the WebSocket opening handshake. -

-

Syntax

-
public override string Origin { get; }
-

Value

-
- A string that contains the value of the Origin header field. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Path Property

-
-

- Gets the absolute path of the requested WebSocket URI. -

-

Syntax

-
public override string Path { get; }
-

Value

-
- A string that contains the absolute path of the requested WebSocket URI. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

QueryString Property

-
-

- Gets the collection of query string variables used in the WebSocket opening handshake. -

-

Syntax

-
public override System.Collections.Specialized.NameValueCollection QueryString { get; }
-

Value

-
- A System.Collections.Specialized.NameValueCollection that contains the collection of query string variables. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

RequestUri Property

-
-

- Gets the WebSocket URI requested by the client. -

-

Syntax

-
public override Uri RequestUri { get; }
-

Value

-
- A Uri that contains the WebSocket URI. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

SecWebSocketKey Property

-
-

- Gets the value of the Sec-WebSocket-Key header field used in the WebSocket opening handshake. -

-

Syntax

-
public override string SecWebSocketKey { get; }
-

Value

-
- A string that contains the value of the Sec-WebSocket-Key header field. -
-

Remarks

-
- The SecWebSocketKey property provides a part of the information used by the server to prove that it received a valid WebSocket opening handshake. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

SecWebSocketProtocols Property

-
-

- Gets the values of the Sec-WebSocket-Protocol header field used in the WebSocket opening handshake. -

-

Syntax

-
public override IEnumerable<string> SecWebSocketProtocols { get; }
-

Value

-
- An IEnumerable<string> that contains the values of the Sec-WebSocket-Protocol header field. -
-

Remarks

-
- The SecWebSocketProtocols property indicates the subprotocols of the WebSocket connection. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

SecWebSocketVersion Property

-
-

- Gets the value of the Sec-WebSocket-Version header field used in the WebSocket opening handshake. -

-

Syntax

-
public override string SecWebSocketVersion { get; }
-

Value

-
- A string that contains the value of the Sec-WebSocket-Version header field. -
-

Remarks

-
- The SecWebSocketVersion property indicates the WebSocket protocol version of the connection. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ServerEndPoint Property

-
-

- Gets the server endpoint as an IP address and a port number. -

-

Syntax

-
public virtual System.Net.IPEndPoint ServerEndPoint { get; }
-

Value

-
- A System.Net.IPEndPoint that contains the server endpoint. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

User Property

-
-

- Gets the client information (identity, authentication information and security roles). -

-

Syntax

-
public override System.Security.Principal.IPrincipal User { get; }
-

Value

-
- A System.Security.Principal.IPrincipal that contains the client information. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- NotImplementedException - - This property is not implemented. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

UserEndPoint Property

-
-

- Gets the client endpoint as an IP address and a port number. -

-

Syntax

-
public virtual System.Net.IPEndPoint UserEndPoint { get; }
-

Value

-
- A System.Net.IPEndPoint that contains the client endpoint. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

WebSocket Property

-
-

- Gets the WebSocket instance used for two-way communication between client and server. -

-

Syntax

-
public override WebSocketSharp.WebSocket WebSocket { get; }
-

Value

-
- A WebSocketSharp.WebSocket. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net.WebSockets/WebSocketContext.html b/websocket-sharp/doc/html/WebSocketSharp.Net.WebSockets/WebSocketContext.html deleted file mode 100644 index 930bbabe..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Net.WebSockets/WebSocketContext.html +++ /dev/null @@ -1,826 +0,0 @@ - - - WebSocketSharp.Net.WebSockets.WebSocketContext - - - - - -
- websocket-sharp : WebSocketSharp.Net.WebSockets Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

WebSocketContext Class

-

- Provides access to the WebSocket connection request objects. -

-
-

Syntax

-
public abstract class WebSocketContext
-
-
-

Remarks

-
- The WebSocketContext class is an abstract class. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - object. -

-

Protected Constructors

-
-
- - - - - - -
-
-
- 		- - - Initializes a new instance of the WebSocketSharp.Net.WebSockets.WebSocketContext class. -
-
-
-

Public Properties

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
[read-only]
abstract
- - CookieCollection - - - - WebSocketSharp.Net.CookieCollection - . - Gets the cookies used in the WebSocket opening handshake. -
[read-only]
abstract
- - Headers - - - - System.Collections.Specialized.NameValueCollection - . - Gets the HTTP headers used in the WebSocket opening handshake. -
[read-only]
abstract
- - IsAuthenticated - - - - bool - . - Gets a value indicating whether the client is authenticated. -
[read-only]
abstract
- - IsLocal - - - - bool - . - Gets a value indicating whether the client connected from the local computer. -
[read-only]
abstract
- - IsSecureConnection - - - - bool - . - Gets a value indicating whether the WebSocket connection is secured. -
[read-only]
abstract
- - IsValid - - - - bool - . - Gets a value indicating whether the WebSocket connection request is valid. -
[read-only]
abstract
- - Origin - - - - string - . - Gets the value of the Origin header field used in the WebSocket opening handshake. -
[read-only]
abstract
- - Path - - - - string - . - Gets the absolute path of the requested WebSocket URI. -
[read-only]
abstract
- - QueryString - - - - System.Collections.Specialized.NameValueCollection - . - Gets the collection of query string variables used in the WebSocket opening handshake. -
[read-only]
abstract
- - RequestUri - - - - Uri - . - Gets the WebSocket URI requested by the client. -
[read-only]
abstract
- - SecWebSocketKey - - - - string - . - Gets the value of the Sec-WebSocket-Key header field used in the WebSocket opening handshake. -
[read-only]
abstract
- - SecWebSocketProtocols - - - - IEnumerable<string> - . - Gets the values of the Sec-WebSocket-Protocol header field used in the WebSocket opening handshake. -
[read-only]
abstract
- - SecWebSocketVersion - - - - string - . - Gets the value of the Sec-WebSocket-Version header field used in the WebSocket opening handshake. -
[read-only]
abstract
- - User - - - - System.Security.Principal.IPrincipal - . - Gets the client information (identity, authentication information and security roles). -
[read-only]
abstract
- - WebSocket - - - - WebSocketSharp.WebSocket - . - Gets the WebSocket instance used for two-way communication between client and server. -
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

WebSocketContext Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Net.WebSockets.WebSocketContext class. -

-

Syntax

-
protected WebSocketContext ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

CookieCollection Property

-
-

- Gets the cookies used in the WebSocket opening handshake. -

-

Syntax

-
public abstract WebSocketSharp.Net.CookieCollection CookieCollection { get; }
-

Value

-
- A WebSocketSharp.Net.CookieCollection that contains the cookies. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Headers Property

-
-

- Gets the HTTP headers used in the WebSocket opening handshake. -

-

Syntax

-
public abstract System.Collections.Specialized.NameValueCollection Headers { get; }
-

Value

-
- A System.Collections.Specialized.NameValueCollection that contains the HTTP headers. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsAuthenticated Property

-
-

- Gets a value indicating whether the client is authenticated. -

-

Syntax

-
public abstract bool IsAuthenticated { get; }
-

Value

-
- true if the client is authenticated; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsLocal Property

-
-

- Gets a value indicating whether the client connected from the local computer. -

-

Syntax

-
public abstract bool IsLocal { get; }
-

Value

-
- true if the client connected from the local computer; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsSecureConnection Property

-
-

- Gets a value indicating whether the WebSocket connection is secured. -

-

Syntax

-
public abstract bool IsSecureConnection { get; }
-

Value

-
- true if the WebSocket connection is secured; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsValid Property

-
-

- Gets a value indicating whether the WebSocket connection request is valid. -

-

Syntax

-
public abstract bool IsValid { get; }
-

Value

-
- true if the WebSocket connection request is valid; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Origin Property

-
-

- Gets the value of the Origin header field used in the WebSocket opening handshake. -

-

Syntax

-
public abstract string Origin { get; }
-

Value

-
- A string that contains the value of the Origin header field. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Path Property

-
-

- Gets the absolute path of the requested WebSocket URI. -

-

Syntax

-
public abstract string Path { get; }
-

Value

-
- A string that contains the absolute path of the requested WebSocket URI. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

QueryString Property

-
-

- Gets the collection of query string variables used in the WebSocket opening handshake. -

-

Syntax

-
public abstract System.Collections.Specialized.NameValueCollection QueryString { get; }
-

Value

-
- A System.Collections.Specialized.NameValueCollection that contains the collection of query string variables. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

RequestUri Property

-
-

- Gets the WebSocket URI requested by the client. -

-

Syntax

-
public abstract Uri RequestUri { get; }
-

Value

-
- A Uri that contains the WebSocket URI. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

SecWebSocketKey Property

-
-

- Gets the value of the Sec-WebSocket-Key header field used in the WebSocket opening handshake. -

-

Syntax

-
public abstract string SecWebSocketKey { get; }
-

Value

-
- A string that contains the value of the Sec-WebSocket-Key header field. -
-

Remarks

-
- The SecWebSocketKey property provides a part of the information used by the server to prove that it received a valid WebSocket opening handshake. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

SecWebSocketProtocols Property

-
-

- Gets the values of the Sec-WebSocket-Protocol header field used in the WebSocket opening handshake. -

-

Syntax

-
public abstract IEnumerable<string> SecWebSocketProtocols { get; }
-

Value

-
- An IEnumerable<string> that contains the values of the Sec-WebSocket-Protocol header field. -
-

Remarks

-
- The SecWebSocketProtocols property indicates the subprotocols of the WebSocket connection. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

SecWebSocketVersion Property

-
-

- Gets the value of the Sec-WebSocket-Version header field used in the WebSocket opening handshake. -

-

Syntax

-
public abstract string SecWebSocketVersion { get; }
-

Value

-
- A string that contains the value of the Sec-WebSocket-Version header field. -
-

Remarks

-
- The SecWebSocketVersion property indicates the WebSocket protocol version of the connection. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

User Property

-
-

- Gets the client information (identity, authentication information and security roles). -

-

Syntax

-
public abstract System.Security.Principal.IPrincipal User { get; }
-

Value

-
- A System.Security.Principal.IPrincipal that contains the client information. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

WebSocket Property

-
-

- Gets the WebSocket instance used for two-way communication between client and server. -

-

Syntax

-
public abstract WebSocketSharp.WebSocket WebSocket { get; }
-

Value

-
- A WebSocketSharp.WebSocket. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net.WebSockets
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net.WebSockets/index.html b/websocket-sharp/doc/html/WebSocketSharp.Net.WebSockets/index.html deleted file mode 100644 index e526b6ba..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Net.WebSockets/index.html +++ /dev/null @@ -1,236 +0,0 @@ - - - websocket-sharp: WebSocketSharp.Net.WebSockets - - - - - -
- websocket-sharp -
-

WebSocketSharp.Net.WebSockets Namespace

-

-

-
-
-
-

Namespace

-

The WebSocketSharp.Net.WebSockets namespace contains classes to access to the WebSocket connection request objects.

- - - - - - - - - - - - - - - - - -
TypeDescription
- HttpListenerWebSocketContext - - Provides access to the WebSocket connection request objects received by the WebSocketSharp.Net.HttpListener class. -
- TcpListenerWebSocketContext - - Provides access to the WebSocket connection request objects received by the System.Net.Sockets.TcpListener class. -
- WebSocketContext - - Provides access to the WebSocket connection request objects. -
-
-
-
-
-
Copyright (c) 2010-2013 sta.blockhead
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net/AuthenticationSchemeSelector.html b/websocket-sharp/doc/html/WebSocketSharp.Net/AuthenticationSchemeSelector.html deleted file mode 100644 index 6a0abf94..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Net/AuthenticationSchemeSelector.html +++ /dev/null @@ -1,246 +0,0 @@ - - - WebSocketSharp.Net.AuthenticationSchemeSelector - - - - - -
- websocket-sharp : WebSocketSharp.Net Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

AuthenticationSchemeSelector Delegate

-

- Selects the authentication scheme for a WebSocketSharp.Net.HttpListener instance. -

-
-

Syntax

-
public delegate AuthenticationSchemes AuthenticationSchemeSelector (HttpListenerRequest httpRequest)
-
-
-

Parameters

-
-
-
- httpRequest -
-
- A WebSocketSharp.Net.HttpListenerRequest that contains a client request information. -
-
-
-

Returns

-
- One of the WebSocketSharp.Net.AuthenticationSchemes values that indicates the scheme used to authenticate the specified client request. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net/AuthenticationSchemes.html b/websocket-sharp/doc/html/WebSocketSharp.Net/AuthenticationSchemes.html deleted file mode 100644 index edacaf47..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Net/AuthenticationSchemes.html +++ /dev/null @@ -1,296 +0,0 @@ - - - WebSocketSharp.Net.AuthenticationSchemes - - - - - -
- websocket-sharp : WebSocketSharp.Net Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

AuthenticationSchemes Enum

-

- Contains the values of the schemes for authentication. -

-
-

Syntax

-
[System.Flags]
public enum AuthenticationSchemes
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Members

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Member NameDescription
- Anonymous - - Indicates anonymous authentication. -
- Basic - - Indicates basic authentication. -
- Digest - - Indicates digest authentication. -
- IntegratedWindowsAuthentication - - Indicates Windows authentication. -
- Negotiate - - Indicates negotiating with the client to determine the authentication scheme. -
- None - - Indicates that no authentication is allowed. -
- Ntlm - - Indicates NTLM authentication. -
-
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net/Cookie.html b/websocket-sharp/doc/html/WebSocketSharp.Net/Cookie.html deleted file mode 100644 index a8d6912a..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Net/Cookie.html +++ /dev/null @@ -1,1329 +0,0 @@ - - - WebSocketSharp.Net.Cookie - - - - - -
- websocket-sharp : WebSocketSharp.Net Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

Cookie Class

-

- Provides a set of properties and methods used to manage an HTTP Cookie. -

-
-

Syntax

-
public sealed class Cookie
-
-
-

Remarks

-
-

- The Cookie class supports the following cookie formats: - Netscape specification, - RFC 2109 and - RFC 2965. -

-

- The Cookie class cannot be inherited. -

-
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - object. -

-

Public Constructors

-
-
- - - - - - - - - - - - - - - - - - - - - -
-
-
- 		-
- - Cookie - ()
- 		- Initializes a new instance of the WebSocketSharp.Net.Cookie class. -
-
-
- 		-
- - Cookie - (string, string)
- 		- Initializes a new instance of the WebSocketSharp.Net.Cookie class - with the specified name and value. -
-
-
- 		- - - Initializes a new instance of the WebSocketSharp.Net.Cookie class - with the specified name, value and path. -
-
-
- 		- - - Initializes a new instance of the WebSocketSharp.Net.Cookie class - with the specified name, value, - path and domain. -
-
-
-

Public Properties

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- 		- - Comment - - - - string - . - Gets or sets the value of the Comment attribute of the cookie. -
-
-
- 		- - CommentUri - - - - Uri - . - Gets or sets the value of the CommentURL attribute of the cookie. -
-
-
- 		- - Discard - - - - bool - . - Gets or sets a value indicating whether the client discards the cookie unconditionally - when the client terminates. -
-
-
- 		- - Domain - - - - string - . - Gets or sets the value of the Domain attribute of the cookie. -
-
-
- 		- - Expired - - - - bool - . - Gets or sets a value indicating whether the cookie has expired. -
-
-
- 		- - Expires - - - - DateTime - . - Gets or sets the value of the Expires attribute of the cookie. -
-
-
- 		- - HttpOnly - - - - bool - . - Gets or sets a value indicating non-HTTP APIs can access the cookie. -
-
-
- 		- - Name - - - - string - . - Gets or sets the Name of the cookie. -
-
-
- 		- - Path - - - - string - . - Gets or sets the value of the Path attribute of the cookie. -
-
-
- 		- - Port - - - - string - . - Gets or sets the value of the Port attribute of the cookie. -
-
-
- 		- - Secure - - - - bool - . - Gets or sets a value indicating whether the security level of the cookie is secure. -
[read-only]
 - - TimeStamp - - - - DateTime - . - Gets the time when the cookie was issued. -
-
-
- 		- - Value - - - - string - . - Gets or sets the Value of the cookie. -
-
-
- 		- - Version - - - - int - . - Gets or sets the value of the Version attribute of the cookie. -
-
-
-

Public Methods

-
-
- - - - - - - - - - - - - -
-
override
- 		- - Equals - (object) : bool
- Determines whether the specified object is equal to the current WebSocketSharp.Net.Cookie. -
-
override
- 		- - GetHashCode - () : int
- Serves as a hash function for a WebSocketSharp.Net.Cookie object. -
-
override
- 		- - ToString - () : string
- Returns a string that represents the current WebSocketSharp.Net.Cookie. -
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

Cookie Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Net.Cookie class. -

-

Syntax

-
public Cookie ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Cookie Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Net.Cookie class - with the specified name and value. -

-

Syntax

-
public Cookie (string name, string value)
-

Parameters

-
-
-
- name -
-
- A string that contains the Name of the cookie. -
-
- value -
-
- A string that contains the Value of the cookie. -
-
-
-

Exceptions

-
- - - - - - - - - -
TypeReason
- WebSocketSharp.Net.CookieException - -

- name is null or string.Empty. -

-

- - or - -

-

- name contains an invalid character. -

-

- - or - -

-

- value is null. -

-

- - or - -

-

- value contains a string not enclosed in double quotes - that contains an invalid character. -

-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Cookie Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Net.Cookie class - with the specified name, value and path. -

-

Syntax

-
public Cookie (string name, string value, string path)
-

Parameters

-
-
-
- name -
-
- A string that contains the Name of the cookie. -
-
- value -
-
- A string that contains the Value of the cookie. -
-
- path -
-
- A string that contains the value of the Path attribute of the cookie. -
-
-
-

Exceptions

-
- - - - - - - - - -
TypeReason
- WebSocketSharp.Net.CookieException - -

- name is null or string.Empty. -

-

- - or - -

-

- name contains an invalid character. -

-

- - or - -

-

- value is null. -

-

- - or - -

-

- value contains a string not enclosed in double quotes - that contains an invalid character. -

-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Cookie Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Net.Cookie class - with the specified name, value, - path and domain. -

-

Syntax

-
public Cookie (string name, string value, string path, string domain)
-

Parameters

-
-
-
- name -
-
- A string that contains the Name of the cookie. -
-
- value -
-
- A string that contains the Value of the cookie. -
-
- path -
-
- A string that contains the value of the Path attribute of the cookie. -
-
- domain -
-
- A string that contains the value of the Domain attribute of the cookie. -
-
-
-

Exceptions

-
- - - - - - - - - -
TypeReason
- WebSocketSharp.Net.CookieException - -

- name is null or string.Empty. -

-

- - or - -

-

- name contains an invalid character. -

-

- - or - -

-

- value is null. -

-

- - or - -

-

- value contains a string not enclosed in double quotes - that contains an invalid character. -

-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Comment Property

-
-

- Gets or sets the value of the Comment attribute of the cookie. -

-

Syntax

-
public string Comment { get; set; }
-

Value

-
- A string that contains a comment to document intended use of the cookie. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

CommentUri Property

-
-

- Gets or sets the value of the CommentURL attribute of the cookie. -

-

Syntax

-
public Uri CommentUri { get; set; }
-

Value

-
- A Uri that contains a URI that provides the comment - to document intended use of the cookie. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Discard Property

-
-

- Gets or sets a value indicating whether the client discards the cookie unconditionally - when the client terminates. -

-

Syntax

-
public bool Discard { get; set; }
-

Value

-
- true if the client discards the cookie unconditionally when the client terminates; - otherwise, false. The default is false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Domain Property

-
-

- Gets or sets the value of the Domain attribute of the cookie. -

-

Syntax

-
public string Domain { get; set; }
-

Value

-
- A string that contains a URI for which the cookie is valid. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Equals Method

-
-

- Determines whether the specified object is equal to the current WebSocketSharp.Net.Cookie. -

-

Syntax

-
public override bool Equals (object comparand)
-

Parameters

-
-
-
- comparand -
-
- An object to compare with the current WebSocketSharp.Net.Cookie. -
-
-
-

Returns

-
- true if the specified object is equal to the current WebSocketSharp.Net.Cookie; - otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Expired Property

-
-

- Gets or sets a value indicating whether the cookie has expired. -

-

Syntax

-
public bool Expired { get; set; }
-

Value

-
- true if the cookie has expired; otherwise, false. The default is false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Expires Property

-
-

- Gets or sets the value of the Expires attribute of the cookie. -

-

Syntax

-
public DateTime Expires { get; set; }
-

Value

-
- A DateTime that contains the date and time at which the cookie expires. - The default is DateTime.MinValue. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

GetHashCode Method

-
-

- Serves as a hash function for a WebSocketSharp.Net.Cookie object. -

-

Syntax

-
public override int GetHashCode ()
-

Returns

-
- An int that contains a hash code for this instance. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

HttpOnly Property

-
-

- Gets or sets a value indicating non-HTTP APIs can access the cookie. -

-

Syntax

-
public bool HttpOnly { get; set; }
-

Value

-
- true if non-HTTP APIs can not access the cookie; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Name Property

-
-

- Gets or sets the Name of the cookie. -

-

Syntax

-
public string Name { get; set; }
-

Value

-
- A string that contains the Name of the cookie. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- WebSocketSharp.Net.CookieException - -

- The value specified for a set operation is null or string.Empty. -

-

- - or - -

-

- The value specified for a set operation contains an invalid character. -

-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Path Property

-
-

- Gets or sets the value of the Path attribute of the cookie. -

-

Syntax

-
public string Path { get; set; }
-

Value

-
- A string that contains a subset of URI on the origin server - to which the cookie applies. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Port Property

-
-

- Gets or sets the value of the Port attribute of the cookie. -

-

Syntax

-
public string Port { get; set; }
-

Value

-
- A string that contains a list of the TCP ports to which the cookie applies. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- WebSocketSharp.Net.CookieException - - The value specified for a set operation is not enclosed in double quotes or could not be parsed. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Secure Property

-
-

- Gets or sets a value indicating whether the security level of the cookie is secure. -

-

Syntax

-
public bool Secure { get; set; }
-

Value

-
- true if the security level of the cookie is secure; otherwise, false. - The default is false. -
-

Remarks

-
- When this property is true, the cookie may be included in the HTTP request - only if the request is transmitted over the HTTPS. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

TimeStamp Property

-
-

- Gets the time when the cookie was issued. -

-

Syntax

-
public DateTime TimeStamp { get; }
-

Value

-
- A DateTime that contains the time when the cookie was issued. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ToString Method

-
-

- Returns a string that represents the current WebSocketSharp.Net.Cookie. -

-

Syntax

-
public override string ToString ()
-

Returns

-
- A string that represents the current WebSocketSharp.Net.Cookie. -
-

Remarks

-
- This method returns a string to use to send an HTTP Cookie to an origin server. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Value Property

-
-

- Gets or sets the Value of the cookie. -

-

Syntax

-
public string Value { get; set; }
-

Value

-
- A string that contains the Value of the cookie. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- WebSocketSharp.Net.CookieException - -

- The value specified for a set operation is null. -

-

- - or - -

-

- The value specified for a set operation contains a string not enclosed in double quotes - that contains an invalid character. -

-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Version Property

-
-

- Gets or sets the value of the Version attribute of the cookie. -

-

Syntax

-
public int Version { get; set; }
-

Value

-
- An int that contains the version of the HTTP state management - to which the cookie conforms. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ArgumentOutOfRangeException - - The value specified for a set operation is not allowed. The value must be 0 or 1. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net/CookieCollection.html b/websocket-sharp/doc/html/WebSocketSharp.Net/CookieCollection.html deleted file mode 100644 index 0e1bae7b..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Net/CookieCollection.html +++ /dev/null @@ -1,914 +0,0 @@ - - - WebSocketSharp.Net.CookieCollection - - - - - -
- websocket-sharp : WebSocketSharp.Net Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

CookieCollection Class

-

- Provides a collection container for instances of the WebSocketSharp.Net.Cookie class. -

-
-

Syntax

-
public class CookieCollection : ICollection
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - object. -

-

Public Constructors

-
-
- - - - - - -
-
-
- 		- - - Initializes a new instance of the WebSocketSharp.Net.CookieCollection class. -
-
-
-

Public Properties

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
[read-only]
 - - Count - - - - int - . - Gets the number of cookies contained in the WebSocketSharp.Net.CookieCollection. -
[read-only]
 - - IsReadOnly - - - - bool - . - Gets a value indicating whether the WebSocketSharp.Net.CookieCollection is read-only. -
[read-only]
 - - IsSynchronized - - - - bool - . - Gets a value indicating whether access to the WebSocketSharp.Net.CookieCollection is thread safe. -
[read-only]
default property
 - - Item - (int) - - Cookie - . - Gets the WebSocketSharp.Net.Cookie with the specified index from the WebSocketSharp.Net.CookieCollection. -
[read-only]
default property
 - - Item - (string) - - Cookie - . - Gets the WebSocketSharp.Net.Cookie with the specified name from the WebSocketSharp.Net.CookieCollection. -
[read-only]
 - - SyncRoot - - - - object - . - Gets an object to use to synchronize access to the WebSocketSharp.Net.CookieCollection. -
-
-
-

Public Methods

-
-
- - - - - - - - - - - - - - - - - - - - - -
-
-
- 		- - Add - (Cookie)
- Add the specified WebSocketSharp.Net.Cookie to the WebSocketSharp.Net.CookieCollection. -
-
-
- 		- - Add - (CookieCollection)
- Add the elements of the specified WebSocketSharp.Net.CookieCollection to the current WebSocketSharp.Net.CookieCollection. -
-
-
- 		- - CopyTo - (Array, int)
- Copies the elements of the WebSocketSharp.Net.CookieCollection to the specified Array, - starting at the specified index in the array. -
-
-
- 		- - CopyTo - (Cookie[], int)
- Copies the elements of the WebSocketSharp.Net.CookieCollection to the specified array of WebSocketSharp.Net.Cookie, - starting at the specified index in the array. -
-
-
- 		- - GetEnumerator - () : IEnumerator
- Gets the enumerator to use to iterate through the WebSocketSharp.Net.CookieCollection. -
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

CookieCollection Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Net.CookieCollection class. -

-

Syntax

-
public CookieCollection ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Add Method

-
-

- Add the specified WebSocketSharp.Net.Cookie to the WebSocketSharp.Net.CookieCollection. -

-

Syntax

-
public void Add (Cookie cookie)
-

Parameters

-
-
-
- cookie -
-
- A WebSocketSharp.Net.Cookie to add to the WebSocketSharp.Net.CookieCollection. -
-
-
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ArgumentNullException - - cookie is null. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Add Method

-
-

- Add the elements of the specified WebSocketSharp.Net.CookieCollection to the current WebSocketSharp.Net.CookieCollection. -

-

Syntax

-
public void Add (CookieCollection cookies)
-

Parameters

-
-
-
- cookies -
-
- A WebSocketSharp.Net.CookieCollection to add to the current WebSocketSharp.Net.CookieCollection. -
-
-
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ArgumentNullException - - cookies is null. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

CopyTo Method

-
-

- Copies the elements of the WebSocketSharp.Net.CookieCollection to the specified Array, - starting at the specified index in the array. -

-

Syntax

-
public void CopyTo (Array array, int index)
-

Parameters

-
-
-
- array -
-
- An Array is the destination of the elements copied from the WebSocketSharp.Net.CookieCollection. -
-
- index -
-
- An int that indicates the zero-based index in array at which copying begins. -
-
-
-

Exceptions

-
- - - - - - - - - - - - - - - - - - - - - -
TypeReason
- ArgumentNullException - - array is null. -
- ArgumentOutOfRangeException - - index is less than zero. -
- ArgumentException - -

- array is multidimensional. -

-

- -or- -

-

- The number of elements in the WebSocketSharp.Net.CookieCollection is greater than the available space - from index to the end of the destination array. -

-
- InvalidCastException - - The elements in the WebSocketSharp.Net.CookieCollection cannot be cast automatically - to the type of the destination array. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

CopyTo Method

-
-

- Copies the elements of the WebSocketSharp.Net.CookieCollection to the specified array of WebSocketSharp.Net.Cookie, - starting at the specified index in the array. -

-

Syntax

-
public void CopyTo (Cookie[] array, int index)
-

Parameters

-
-
-
- array -
-
- An array of WebSocketSharp.Net.Cookie is the destination of the elements copied from the WebSocketSharp.Net.CookieCollection. -
-
- index -
-
- An int that indicates the zero-based index in array at which copying begins. -
-
-
-

Exceptions

-
- - - - - - - - - - - - - - - - - -
TypeReason
- ArgumentNullException - - array is null. -
- ArgumentOutOfRangeException - - index is less than zero. -
- ArgumentException - - The number of elements in the WebSocketSharp.Net.CookieCollection is greater than the available space - from index to the end of the destination array. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Count Property

-
-

- Gets the number of cookies contained in the WebSocketSharp.Net.CookieCollection. -

-

Syntax

-
public int Count { get; }
-

Value

-
- An int that indicates the number of cookies contained in the WebSocketSharp.Net.CookieCollection. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

GetEnumerator Method

-
-

- Gets the enumerator to use to iterate through the WebSocketSharp.Net.CookieCollection. -

-

Syntax

-
public IEnumerator GetEnumerator ()
-

Returns

-
- An instance of an implementation of the IEnumerator interface - to use to iterate through the WebSocketSharp.Net.CookieCollection. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsReadOnly Property

-
-

- Gets a value indicating whether the WebSocketSharp.Net.CookieCollection is read-only. -

-

Syntax

-
public bool IsReadOnly { get; }
-

Value

-
- true if the WebSocketSharp.Net.CookieCollection is read-only; otherwise, false. - The default is true. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsSynchronized Property

-
-

- Gets a value indicating whether access to the WebSocketSharp.Net.CookieCollection is thread safe. -

-

Syntax

-
public bool IsSynchronized { get; }
-

Value

-
- true if access to the WebSocketSharp.Net.CookieCollection is thread safe; otherwise, false. - The default is false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Item Property

-
-

- Gets the WebSocketSharp.Net.Cookie with the specified index from the WebSocketSharp.Net.CookieCollection. -

-

Syntax

-
-

- This is the default property for this class. -

public Cookie this [int index] { get; }
-

Parameters

-
-
-
- index -
-
- An int is the zero-based index of the WebSocketSharp.Net.Cookie to find. -
-
-
-

Value

-
- A WebSocketSharp.Net.Cookie with the specified index in the WebSocketSharp.Net.CookieCollection. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ArgumentOutOfRangeException - - index is less than zero or index is greater than or - equal to CookieCollection.Count. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Item Property

-
-

- Gets the WebSocketSharp.Net.Cookie with the specified name from the WebSocketSharp.Net.CookieCollection. -

-

Syntax

-
-

- This is the default property for this class. -

public Cookie this [string name] { get; }
-

Parameters

-
-
-
- name -
-
- A string is the name of the WebSocketSharp.Net.Cookie to find. -
-
-
-

Value

-
- A WebSocketSharp.Net.Cookie with the specified name in the WebSocketSharp.Net.CookieCollection. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ArgumentNullException - - name is null. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

SyncRoot Property

-
-

- Gets an object to use to synchronize access to the WebSocketSharp.Net.CookieCollection. -

-

Syntax

-
public object SyncRoot { get; }
-

Value

-
- An object to use to synchronize access to the WebSocketSharp.Net.CookieCollection. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net/CookieException.html b/websocket-sharp/doc/html/WebSocketSharp.Net/CookieException.html deleted file mode 100644 index e4dc996c..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Net/CookieException.html +++ /dev/null @@ -1,472 +0,0 @@ - - - WebSocketSharp.Net.CookieException - - - - - -
- websocket-sharp : WebSocketSharp.Net Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

CookieException Class

-

- The exception that is thrown when a WebSocketSharp.Net.Cookie gets an error. -

-
-

Syntax

-
public class CookieException : FormatException
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - FormatException. -

-

Public Constructors

-
-
- - - - - - -
-
-
- 		-
- - CookieException - ()
- 		- Initializes a new instance of the WebSocketSharp.Net.CookieException class. -
-
-
-

Protected Constructors

- -

Public Methods

- -

Explicitly Implemented Interface Members

-
-
- - - - - - -
-
-
- 		- - System.Runtime.Serialization.ISerializable.GetObjectData - - - Populates the specified System.Runtime.Serialization.SerializationInfo with the data needed to serialize the WebSocketSharp.Net.CookieException. -
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

CookieException Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Net.CookieException class. -

-

Syntax

-
public CookieException ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

CookieException Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Net.CookieException class - with the specified System.Runtime.Serialization.SerializationInfo and System.Runtime.Serialization.StreamingContext. -

-

Syntax

-
protected CookieException (System.Runtime.Serialization.SerializationInfo serializationInfo, System.Runtime.Serialization.StreamingContext streamingContext)
-

Parameters

-
-
-
- serializationInfo -
-
- A System.Runtime.Serialization.SerializationInfo that holds the serialized object data. -
-
- streamingContext -
-
- A System.Runtime.Serialization.StreamingContext that contains the contextual information about the source or destination. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

GetObjectData Method

-
-

- Populates the specified System.Runtime.Serialization.SerializationInfo with the data needed to serialize the WebSocketSharp.Net.CookieException. -

-

Syntax

-
public override void GetObjectData (System.Runtime.Serialization.SerializationInfo serializationInfo, System.Runtime.Serialization.StreamingContext streamingContext)
-

Parameters

-
-
-
- serializationInfo -
-
- A System.Runtime.Serialization.SerializationInfo that holds the serialized object data. -
-
- streamingContext -
-
- A System.Runtime.Serialization.StreamingContext that specifies the destination for the serialization. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

System.Runtime.Serialization.ISerializable.GetObjectData Method

-
-

- Populates the specified System.Runtime.Serialization.SerializationInfo with the data needed to serialize the WebSocketSharp.Net.CookieException. -

-

Syntax

-
- void System.Runtime.Serialization.ISerializable.GetObjectData (System.Runtime.Serialization.SerializationInfo serializationInfo, System.Runtime.Serialization.StreamingContext streamingContext)
-

Parameters

-
-
-
- serializationInfo -
-
- A System.Runtime.Serialization.SerializationInfo that holds the serialized object data. -
-
- streamingContext -
-
- A System.Runtime.Serialization.StreamingContext that specifies the destination for the serialization. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net/HttpListener.html b/websocket-sharp/doc/html/WebSocketSharp.Net/HttpListener.html deleted file mode 100644 index db196525..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Net/HttpListener.html +++ /dev/null @@ -1,1132 +0,0 @@ - - - WebSocketSharp.Net.HttpListener - - - - - -
- websocket-sharp : WebSocketSharp.Net Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

HttpListener Class

-

- Provides a simple, programmatically controlled HTTP listener. -

-
-

Syntax

-
public sealed class HttpListener : IDisposable
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - object. -

-

Public Constructors

-
-
- - - - - - -
-
-
- 		-
- - HttpListener - ()
- 		- Initializes a new instance of the WebSocketSharp.Net.HttpListener class. -
-
-
-

Public Properties

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- 		- - AuthenticationSchemes - - - - AuthenticationSchemes - . - Gets or sets the scheme used to authenticate the clients. -
-
-
- 		- - AuthenticationSchemeSelectorDelegate - - - - AuthenticationSchemeSelector - . - Gets or sets the delegate called to determine the scheme used to authenticate clients. -
-
-
- 		- - IgnoreWriteExceptions - - - - bool - . - Gets or sets a value indicating whether the WebSocketSharp.Net.HttpListener returns exceptions - that occur when sending the response to the client. -
[read-only]
 - - IsListening - - - - bool - . - Gets a value indicating whether the WebSocketSharp.Net.HttpListener has been started. -
[read-only]
static
- - IsSupported - - - - bool - . - Gets a value indicating whether the WebSocketSharp.Net.HttpListener can be used with the current operating system. -
[read-only]
 - - Prefixes - - - - HttpListenerPrefixCollection - . - Gets the URI prefixes handled by the WebSocketSharp.Net.HttpListener. -
-
-
- 		- - Realm - - - - string - . - Gets or sets the name of the realm associated with the WebSocketSharp.Net.HttpListener. -
-
-
- 		- - UnsafeConnectionNtlmAuthentication - - - - bool - . - 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. -
-
-
-

Public Methods

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- 		- - Abort - ()
- Shuts down the WebSocketSharp.Net.HttpListener immediately. -
-
-
- 		- - BeginGetContext - (AsyncCallback, object) : IAsyncResult
- Begins getting an incoming request information asynchronously. -
-
-
- 		- - Close - ()
- Shuts down the WebSocketSharp.Net.HttpListener. -
-
-
- 		- - EndGetContext - (IAsyncResult) : HttpListenerContext
- Ends an asynchronous operation to get an incoming request information. -
-
-
- 		- - GetContext - () : HttpListenerContext
- Gets an incoming request information. -
-
-
- 		- - Start - ()
- Starts to receive incoming requests. -
-
-
- 		- - Stop - ()
- Stops receiving incoming requests. -
-
-
-

Explicitly Implemented Interface Members

-
-
- - - - - - -
-
-
- 		- - IDisposable.Dispose - - - Releases all resource used by the WebSocketSharp.Net.HttpListener. -
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

HttpListener Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Net.HttpListener class. -

-

Syntax

-
public HttpListener ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Abort Method

-
-

- Shuts down the WebSocketSharp.Net.HttpListener immediately. -

-

Syntax

-
public void Abort ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

AuthenticationSchemes Property

-
-

- Gets or sets the scheme used to authenticate the clients. -

-

Syntax

-
public AuthenticationSchemes AuthenticationSchemes { get; set; }
-

Value

-
- One of the WebSocketSharp.Net.AuthenticationSchemes values that indicates the scheme used to - authenticate the clients. The default value is AuthenticationSchemes.Anonymous. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ObjectDisposedException - - This object has been closed. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

AuthenticationSchemeSelectorDelegate Property

-
-

- Gets or sets the delegate called to determine the scheme used to authenticate clients. -

-

Syntax

-
public AuthenticationSchemeSelector AuthenticationSchemeSelectorDelegate { get; set; }
-

Value

-
- A WebSocketSharp.Net.AuthenticationSchemeSelector delegate that invokes the method(s) used to select - an authentication scheme. The default value is null. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ObjectDisposedException - - This object has been closed. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

BeginGetContext Method

-
-

- Begins getting an incoming request information asynchronously. -

-

Syntax

-
public IAsyncResult BeginGetContext (AsyncCallback callback, object state)
-

Parameters

-
-
-
- callback -
-
- An AsyncCallback delegate that references the method(s) - called when the asynchronous operation completes. -
-
- state -
-
- An object that contains a user defined object to pass to the callback delegate. -
-
-
-

Returns

-
- An IAsyncResult that contains the status of the asynchronous operation. -
-

Exceptions

-
- - - - - - - - - - - - - -
TypeReason
- InvalidOperationException - - The WebSocketSharp.Net.HttpListener has not been started or is stopped currently. -
- ObjectDisposedException - - This object has been closed. -
-
-

Remarks

-
- This asynchronous operation must be completed by calling the HttpListener.EndGetContext(IAsyncResult) method. - Typically, the method is invoked by the callback delegate. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Close Method

-
-

- Shuts down the WebSocketSharp.Net.HttpListener. -

-

Syntax

-
public void Close ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

EndGetContext Method

-
-

- Ends an asynchronous operation to get an incoming request information. -

-

Syntax

-
public HttpListenerContext EndGetContext (IAsyncResult asyncResult)
-

Parameters

-
-
-
- asyncResult -
-
- An IAsyncResult obtained by calling the HttpListener.BeginGetContext(AsyncCallback, object) method. -
-
-
-

Returns

-
- A WebSocketSharp.Net.HttpListenerContext that contains a client's request information. -
-

Exceptions

-
- - - - - - - - - - - - - - - - - - - - - -
TypeReason
- ArgumentNullException - - asyncResult is null. -
- ArgumentException - - asyncResult was not obtained by calling the HttpListener.BeginGetContext(AsyncCallback, object) method. -
- InvalidOperationException - - The EndGetContext method was already called for the specified asyncResult. -
- ObjectDisposedException - - This object has been closed. -
-
-

Remarks

-
- This method completes an asynchronous operation started by calling the HttpListener.BeginGetContext(AsyncCallback, object) method. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

GetContext Method

-
-

- Gets an incoming request information. -

-

Syntax

-
public HttpListenerContext GetContext ()
-

Returns

-
- A WebSocketSharp.Net.HttpListenerContext that contains a client's request information. -
-

Exceptions

-
- - - - - - - - - - - - - -
TypeReason
- InvalidOperationException - -

- The WebSocketSharp.Net.HttpListener does not have any URI prefixes to listen on. -

-

- -or- -

-

- The WebSocketSharp.Net.HttpListener has not been started or is stopped currently. -

-
- ObjectDisposedException - - This object has been closed. -
-
-

Remarks

-
- This method waits for an incoming request and returns the request information - when received the request. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IgnoreWriteExceptions Property

-
-

- Gets or sets a value indicating whether the WebSocketSharp.Net.HttpListener returns exceptions - that occur when sending the response to the client. -

-

Syntax

-
public bool IgnoreWriteExceptions { get; set; }
-

Value

-
- true if does not return exceptions that occur when sending the response to the client; - otherwise, false. The default value is false. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ObjectDisposedException - - This object has been closed. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsListening Property

-
-

- Gets a value indicating whether the WebSocketSharp.Net.HttpListener has been started. -

-

Syntax

-
public bool IsListening { get; }
-

Value

-
- true if the WebSocketSharp.Net.HttpListener has been started; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsSupported Property

-
-

- Gets a value indicating whether the WebSocketSharp.Net.HttpListener can be used with the current operating system. -

-

Syntax

-
public static bool IsSupported { get; }
-

Value

-
- true. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Prefixes Property

-
-

- Gets the URI prefixes handled by the WebSocketSharp.Net.HttpListener. -

-

Syntax

-
public HttpListenerPrefixCollection Prefixes { get; }
-

Value

-
- A WebSocketSharp.Net.HttpListenerPrefixCollection that contains the URI prefixes. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ObjectDisposedException - - This object has been closed. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Realm Property

-
-

- Gets or sets the name of the realm associated with the WebSocketSharp.Net.HttpListener. -

-

Syntax

-
public string Realm { get; set; }
-

Value

-
- A string that contains the name of the realm. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ObjectDisposedException - - This object has been closed. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Start Method

-
-

- Starts to receive incoming requests. -

-

Syntax

-
public void Start ()
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ObjectDisposedException - - This object has been closed. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Stop Method

-
-

- Stops receiving incoming requests. -

-

Syntax

-
public void Stop ()
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ObjectDisposedException - - This object has been closed. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

System.IDisposable.Dispose Method

-
-

- Releases all resource used by the WebSocketSharp.Net.HttpListener. -

-

Syntax

-
- void System.IDisposable.Dispose ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

UnsafeConnectionNtlmAuthentication Property

-
-

- 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. -

-

Syntax

-
public bool UnsafeConnectionNtlmAuthentication { get; set; }
-

Value

-
- true if the authentication information of first request is used; - otherwise, false. The default value is false. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ObjectDisposedException - - This object has been closed. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net/HttpListenerContext.html b/websocket-sharp/doc/html/WebSocketSharp.Net/HttpListenerContext.html deleted file mode 100644 index 929b6975..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Net/HttpListenerContext.html +++ /dev/null @@ -1,421 +0,0 @@ - - - WebSocketSharp.Net.HttpListenerContext - - - - - -
- websocket-sharp : WebSocketSharp.Net Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

HttpListenerContext Class

-

- Provides access to the HTTP request and response objects used by the WebSocketSharp.Net.HttpListener class. -

-
-

Syntax

-
public sealed class HttpListenerContext
-
-
-

Remarks

-
- The HttpListenerContext class cannot be inherited. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - object. -

-

Public Properties

-
-
- - - - - - - - - - - - - - - - -
[read-only]
 - - Request - - - - HttpListenerRequest - . - Gets the WebSocketSharp.Net.HttpListenerRequest that contains the HTTP request from a client. -
[read-only]
 - - Response - - - - HttpListenerResponse - . - Gets the WebSocketSharp.Net.HttpListenerResponse that contains the HTTP response to send to - the client in response to the client's request. -
[read-only]
 - - User - - - - System.Security.Principal.IPrincipal - . - Gets the client information (identity, authentication information and security roles). -
-
-
-

Public Methods

-
-
- - - - - -
-
-
- 		- - AcceptWebSocket - () : WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext
- Accepts a WebSocket connection by the WebSocketSharp.Net.HttpListener. -
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

AcceptWebSocket Method

-
-

- Accepts a WebSocket connection by the WebSocketSharp.Net.HttpListener. -

-

Syntax

-
public WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext AcceptWebSocket ()
-

Returns

-
- A WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext that contains a WebSocket connection. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Request Property

-
-

- Gets the WebSocketSharp.Net.HttpListenerRequest that contains the HTTP request from a client. -

-

Syntax

-
public HttpListenerRequest Request { get; }
-

Value

-
- A WebSocketSharp.Net.HttpListenerRequest that contains the HTTP request objects. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Response Property

-
-

- Gets the WebSocketSharp.Net.HttpListenerResponse that contains the HTTP response to send to - the client in response to the client's request. -

-

Syntax

-
public HttpListenerResponse Response { get; }
-

Value

-
- A WebSocketSharp.Net.HttpListenerResponse that contains the HTTP response objects. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

User Property

-
-

- Gets the client information (identity, authentication information and security roles). -

-

Syntax

-
public System.Security.Principal.IPrincipal User { get; }
-

Value

-
- A System.Security.Principal.IPrincipal contains the client information. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net/HttpListenerException.html b/websocket-sharp/doc/html/WebSocketSharp.Net/HttpListenerException.html deleted file mode 100644 index 9d964895..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Net/HttpListenerException.html +++ /dev/null @@ -1,502 +0,0 @@ - - - WebSocketSharp.Net.HttpListenerException - - - - - -
- websocket-sharp : WebSocketSharp.Net Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

HttpListenerException Class

-

- The exception that is thrown when an error occurs processing an HTTP request. -

-
-

Syntax

-
public class HttpListenerException : System.ComponentModel.Win32Exception
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - System.ComponentModel.Win32Exception. -

-

Public Constructors

-
-
- - - - - - - - - - - - - - - - -
-
-
- 		- - - Initializes a new instance of the WebSocketSharp.Net.HttpListenerException class. -
-
-
- 		- - - Initializes a new instance of the WebSocketSharp.Net.HttpListenerException class - with the specified errorCode. -
-
-
- 		- - - Initializes a new instance of the WebSocketSharp.Net.HttpListenerException class - with the specified errorCode and message. -
-
-
-

Protected Constructors

- -

Public Properties

-
-
- - - - - - -
[read-only]
override
- - ErrorCode - - - - int - . - Gets a value that represents the error that occurred. -
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

HttpListenerException Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Net.HttpListenerException class. -

-

Syntax

-
public HttpListenerException ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

HttpListenerException Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Net.HttpListenerException class - with the specified errorCode. -

-

Syntax

-
public HttpListenerException (int errorCode)
-

Parameters

-
-
-
- errorCode -
-
- An int that contains an error code. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

HttpListenerException Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Net.HttpListenerException class - with the specified errorCode and message. -

-

Syntax

-
public HttpListenerException (int errorCode, string message)
-

Parameters

-
-
-
- errorCode -
-
- An int that contains an error code. -
-
- message -
-
- A string that describes the error. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

HttpListenerException Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Net.HttpListenerException class - from the specified System.Runtime.Serialization.SerializationInfo and System.Runtime.Serialization.StreamingContext classes. -

-

Syntax

-
protected HttpListenerException (System.Runtime.Serialization.SerializationInfo serializationInfo, System.Runtime.Serialization.StreamingContext streamingContext)
-

Parameters

-
-
-
- serializationInfo -
-
- A System.Runtime.Serialization.SerializationInfo that contains the information required to deserialize - the new WebSocketSharp.Net.HttpListenerException object. -
-
- streamingContext -
-
- A System.Runtime.Serialization.StreamingContext. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ErrorCode Property

-
-

- Gets a value that represents the error that occurred. -

-

Syntax

-
public override int ErrorCode { get; }
-

Value

-
- An int that contains an error code. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net/HttpListenerPrefixCollection.html b/websocket-sharp/doc/html/WebSocketSharp.Net/HttpListenerPrefixCollection.html deleted file mode 100644 index e681f82f..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Net/HttpListenerPrefixCollection.html +++ /dev/null @@ -1,836 +0,0 @@ - - - WebSocketSharp.Net.HttpListenerPrefixCollection - - - - - -
- websocket-sharp : WebSocketSharp.Net Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

HttpListenerPrefixCollection Class

-

- Provides the collection used to store the URI prefixes for the WebSocketSharp.Net.HttpListener. -

-
-

Syntax

-
public class HttpListenerPrefixCollection : ICollection<string>, IEnumerable<string>
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - object. -

-

Public Properties

-
-
- - - - - - - - - - - - - - - - -
[read-only]
 - - Count - - - - int - . - Gets the number of prefixes contained in the WebSocketSharp.Net.HttpListenerPrefixCollection. -
[read-only]
 - - IsReadOnly - - - - bool - . - Gets a value indicating whether access to the WebSocketSharp.Net.HttpListenerPrefixCollection is read-only. -
[read-only]
 - - IsSynchronized - - - - bool - . - Gets a value indicating whether access to the WebSocketSharp.Net.HttpListenerPrefixCollection is synchronized. -
-
-
-

Public Methods

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- 		- - Add - (string)
- Adds the specified uriPrefix to the WebSocketSharp.Net.HttpListenerPrefixCollection. -
-
-
- 		- - Clear - ()
- Removes all URI prefixes from the WebSocketSharp.Net.HttpListenerPrefixCollection. -
-
-
- 		- - Contains - (string) : bool
- Returns a value indicating whether the WebSocketSharp.Net.HttpListenerPrefixCollection contains - the specified uriPrefix. -
-
-
- 		- - CopyTo - (Array, int)
- Copies the contents of the WebSocketSharp.Net.HttpListenerPrefixCollection to the specified Array. -
-
-
- 		- - CopyTo - (string[], int)
- Copies the contents of the WebSocketSharp.Net.HttpListenerPrefixCollection to the specified array of string. -
-
-
- 		- - GetEnumerator - () : IEnumerator<string>
- Gets an object that can be used to iterate through the WebSocketSharp.Net.HttpListenerPrefixCollection. -
-
-
- 		- - Remove - (string) : bool
- Removes the specified uriPrefix from the list of prefixes in the WebSocketSharp.Net.HttpListenerPrefixCollection. -
-
-
-

Explicitly Implemented Interface Members

-
-
- - - - - - -
-
-
- 		- - IEnumerable.GetEnumerator - - - Gets an object that can be used to iterate through the WebSocketSharp.Net.HttpListenerPrefixCollection. -
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

Add Method

-
-

- Adds the specified uriPrefix to the WebSocketSharp.Net.HttpListenerPrefixCollection. -

-

Syntax

-
public void Add (string uriPrefix)
-

Parameters

-
-
-
- uriPrefix -
-
- A string that contains a URI prefix to add. -
-
-
-

Exceptions

-
- - - - - - - - - - - - - -
TypeReason
- ArgumentNullException - - uriPrefix is null. -
- ObjectDisposedException - - The WebSocketSharp.Net.HttpListener associated with this WebSocketSharp.Net.HttpListenerPrefixCollection is closed. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Clear Method

-
-

- Removes all URI prefixes from the WebSocketSharp.Net.HttpListenerPrefixCollection. -

-

Syntax

-
public void Clear ()
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ObjectDisposedException - - The WebSocketSharp.Net.HttpListener associated with this WebSocketSharp.Net.HttpListenerPrefixCollection is closed. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Contains Method

-
-

- Returns a value indicating whether the WebSocketSharp.Net.HttpListenerPrefixCollection contains - the specified uriPrefix. -

-

Syntax

-
public bool Contains (string uriPrefix)
-

Parameters

-
-
-
- uriPrefix -
-
- A string that contains a URI prefix to test. -
-
-
-

Returns

-
- true if the WebSocketSharp.Net.HttpListenerPrefixCollection contains the specified uriPrefix; - otherwise, false. -
-

Exceptions

-
- - - - - - - - - - - - - -
TypeReason
- ArgumentNullException - - uriPrefix is null. -
- ObjectDisposedException - - The WebSocketSharp.Net.HttpListener associated with this WebSocketSharp.Net.HttpListenerPrefixCollection is closed. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

CopyTo Method

-
-

- Copies the contents of the WebSocketSharp.Net.HttpListenerPrefixCollection to the specified Array. -

-

Syntax

-
public void CopyTo (Array array, int offset)
-

Parameters

-
-
-
- array -
-
- An Array that receives the URI prefix strings in the WebSocketSharp.Net.HttpListenerPrefixCollection. -
-
- offset -
-
- An int that contains the zero-based index in array at which copying begins. -
-
-
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ObjectDisposedException - - The WebSocketSharp.Net.HttpListener associated with this WebSocketSharp.Net.HttpListenerPrefixCollection is closed. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

CopyTo Method

-
-

- Copies the contents of the WebSocketSharp.Net.HttpListenerPrefixCollection to the specified array of string. -

-

Syntax

-
public void CopyTo (string[] array, int offset)
-

Parameters

-
-
-
- array -
-
- An array of string that receives the URI prefix strings in the WebSocketSharp.Net.HttpListenerPrefixCollection. -
-
- offset -
-
- An int that contains the zero-based index in array at which copying begins. -
-
-
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ObjectDisposedException - - The WebSocketSharp.Net.HttpListener associated with this WebSocketSharp.Net.HttpListenerPrefixCollection is closed. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Count Property

-
-

- Gets the number of prefixes contained in the WebSocketSharp.Net.HttpListenerPrefixCollection. -

-

Syntax

-
public int Count { get; }
-

Value

-
- A int that contains the number of prefixes. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

GetEnumerator Method

-
-

- Gets an object that can be used to iterate through the WebSocketSharp.Net.HttpListenerPrefixCollection. -

-

Syntax

-
public IEnumerator<string> GetEnumerator ()
-

Returns

-
- An object that implements the IEnumerator<string> interface and provides access to - the URI prefix strings in the WebSocketSharp.Net.HttpListenerPrefixCollection. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsReadOnly Property

-
-

- Gets a value indicating whether access to the WebSocketSharp.Net.HttpListenerPrefixCollection is read-only. -

-

Syntax

-
public bool IsReadOnly { get; }
-

Value

-
- Always returns false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsSynchronized Property

-
-

- Gets a value indicating whether access to the WebSocketSharp.Net.HttpListenerPrefixCollection is synchronized. -

-

Syntax

-
public bool IsSynchronized { get; }
-

Value

-
- Always returns false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Remove Method

-
-

- Removes the specified uriPrefix from the list of prefixes in the WebSocketSharp.Net.HttpListenerPrefixCollection. -

-

Syntax

-
public bool Remove (string uriPrefix)
-

Parameters

-
-
-
- uriPrefix -
-
- A string that contains a URI prefix to remove. -
-
-
-

Returns

-
- true if the uriPrefix was found in the WebSocketSharp.Net.HttpListenerPrefixCollection - and removed; otherwise, false. -
-

Exceptions

-
- - - - - - - - - - - - - -
TypeReason
- ArgumentNullException - - uriPrefix is null. -
- ObjectDisposedException - - The WebSocketSharp.Net.HttpListener associated with this WebSocketSharp.Net.HttpListenerPrefixCollection is closed. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

System.Collections.IEnumerable.GetEnumerator Method

-
-

- Gets an object that can be used to iterate through the WebSocketSharp.Net.HttpListenerPrefixCollection. -

-

Syntax

-
- IEnumerator System.Collections.IEnumerable.GetEnumerator ()
-

Returns

-
- An object that implements the IEnumerator interface and provides access to - the URI prefix strings in the WebSocketSharp.Net.HttpListenerPrefixCollection. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net/HttpListenerRequest.html b/websocket-sharp/doc/html/WebSocketSharp.Net/HttpListenerRequest.html deleted file mode 100644 index 44d1a2ab..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Net/HttpListenerRequest.html +++ /dev/null @@ -1,1392 +0,0 @@ - - - WebSocketSharp.Net.HttpListenerRequest - - - - - -
- websocket-sharp : WebSocketSharp.Net Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

HttpListenerRequest Class

-

- Provides access to a request to a WebSocketSharp.Net.HttpListener instance. -

-
-

Syntax

-
public sealed class HttpListenerRequest
-
-
-

Remarks

-
- The HttpListenerRequest class cannot be inherited. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - object. -

-

Public Properties

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
[read-only]
 - - AcceptTypes - - - - string[]. - Gets the media types which are acceptable for the response. -
[read-only]
 - - ClientCertificateError - - - - int - . - Gets an error code that identifies a problem with the client's certificate. -
[read-only]
 - - ContentEncoding - - - - System.Text.Encoding - . - Gets the encoding that can be used with the entity body data included in the request. -
[read-only]
 - - ContentLength64 - - - - long - . - Gets the size of the entity body data included in the request. -
[read-only]
 - - ContentType - - - - string - . - Gets the media type of the entity body included in the request. -
[read-only]
 - - Cookies - - - - CookieCollection - . - Gets the cookies included in the request. -
[read-only]
 - - HasEntityBody - - - - bool - . - Gets a value indicating whether the request has the entity body. -
[read-only]
 - - Headers - - - - System.Collections.Specialized.NameValueCollection - . - Gets the HTTP headers used in the request. -
[read-only]
 - - HttpMethod - - - - string - . - Gets the HTTP method used in the request. -
[read-only]
 - - InputStream - - - - System.IO.Stream - . - Gets a System.IO.Stream that contains the entity body data included in the request. -
[read-only]
 - - IsAuthenticated - - - - bool - . - Gets a value indicating whether the client that sent the request is authenticated. -
[read-only]
 - - IsLocal - - - - bool - . - Gets a value indicating whether the request is sent from the local computer. -
[read-only]
 - - IsSecureConnection - - - - bool - . - Gets a value indicating whether the HTTP connection is secured using the SSL protocol. -
[read-only]
 - - IsWebSocketRequest - - - - bool - . - Gets a value indicating whether the request is a WebSocket connection request. -
[read-only]
 - - KeepAlive - - - - bool - . - Gets a value indicating whether the client requests a persistent connection. -
[read-only]
 - - LocalEndPoint - - - - System.Net.IPEndPoint - . - Gets the server endpoint as an IP address and a port number. -
[read-only]
 - - ProtocolVersion - - - - Version - . - Gets the HTTP version used in the request. -
[read-only]
 - - QueryString - - - - System.Collections.Specialized.NameValueCollection - . - Gets the collection of query string variables used in the request. -
[read-only]
 - - RawUrl - - - - string - . - Gets the raw URL (without the scheme, host and port) requested by the client. -
[read-only]
 - - RemoteEndPoint - - - - System.Net.IPEndPoint - . - Gets the client endpoint as an IP address and a port number. -
[read-only]
 - - RequestTraceIdentifier - - - - Guid - . - Gets the identifier of a request. -
[read-only]
 - - Url - - - - Uri - . - Gets the URL requested by the client. -
[read-only]
 - - UrlReferrer - - - - Uri - . - Gets the URL of the resource from which the requested URL was obtained. -
[read-only]
 - - UserAgent - - - - string - . - Gets the information about the user agent originating the request. -
[read-only]
 - - UserHostAddress - - - - string - . - Gets the server endpoint as an IP address and a port number. -
[read-only]
 - - UserHostName - - - - string - . - Gets the internet host name and port number (if present) of the resource being requested. -
[read-only]
 - - UserLanguages - - - - string[]. - Gets the natural languages that are preferred as a response to the request. -
-
-
-

Public Methods

-
-
- - - - - - - - - - - - - -
-
-
- 		- - BeginGetClientCertificate - (AsyncCallback, object) : IAsyncResult
- Begins getting the client's X.509 v.3 certificate asynchronously. -
-
-
- 		- - EndGetClientCertificate - (IAsyncResult) : System.Security.Cryptography.X509Certificates.X509Certificate2
- Ends an asynchronous operation to get the client's X.509 v.3 certificate. -
-
-
- 		- - GetClientCertificate - () : System.Security.Cryptography.X509Certificates.X509Certificate2
- Gets the client's X.509 v.3 certificate. -
-
-
-

Extension Methods

-
-
- - - - - - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
static
- 		- - IsUpgradeTo - (this HttpListenerRequest, string) : bool
- Determines whether the specified WebSocketSharp.Net.HttpListenerRequest is the HTTP Upgrade request - to switch to the specified protocol. -
-
-
-
-
-
-

Member Details

-
-

AcceptTypes Property

-
-

- Gets the media types which are acceptable for the response. -

-

Syntax

-
public string[] AcceptTypes { get; }
-

Value

-
- An array of string that contains the media type names in the Accept request-header field - or null if the request did not include an Accept header. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

BeginGetClientCertificate Method

-
-

- Begins getting the client's X.509 v.3 certificate asynchronously. -

-

Syntax

-
public IAsyncResult BeginGetClientCertificate (AsyncCallback requestCallback, object state)
-

Parameters

-
-
-
- requestCallback -
-
- An AsyncCallback delegate that references the method(s) - called when the asynchronous operation completes. -
-
- state -
-
- An object that contains a user defined object to pass to the requestCallback delegate. -
-
-
-

Returns

-
- An IAsyncResult that contains the status of the asynchronous operation. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- NotImplementedException - - This method is not implemented. -
-
-

Remarks

-
- This asynchronous operation must be completed by calling the HttpListenerRequest.EndGetClientCertificate(IAsyncResult) method. - Typically, the method is invoked by the requestCallback delegate. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ClientCertificateError Property

-
-

- Gets an error code that identifies a problem with the client's certificate. -

-

Syntax

-
public int ClientCertificateError { get; }
-

Value

-
- Always returns 0. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ContentEncoding Property

-
-

- Gets the encoding that can be used with the entity body data included in the request. -

-

Syntax

-
public System.Text.Encoding ContentEncoding { get; }
-

Value

-
- A System.Text.Encoding that contains the encoding that can be used with the entity body data. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ContentLength64 Property

-
-

- Gets the size of the entity body data included in the request. -

-

Syntax

-
public long ContentLength64 { get; }
-

Value

-
- A long that contains the value of the Content-Length entity-header field. - The value is a number of bytes in the entity body data. -1 if the size is not known. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ContentType Property

-
-

- Gets the media type of the entity body included in the request. -

-

Syntax

-
public string ContentType { get; }
-

Value

-
- A string that contains the value of the Content-Type entity-header field. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Cookies Property

-
-

- Gets the cookies included in the request. -

-

Syntax

-
public CookieCollection Cookies { get; }
-

Value

-
- A WebSocketSharp.Net.CookieCollection that contains the cookies included in the request. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

EndGetClientCertificate Method

-
-

- Ends an asynchronous operation to get the client's X.509 v.3 certificate. -

-

Syntax

-
public System.Security.Cryptography.X509Certificates.X509Certificate2 EndGetClientCertificate (IAsyncResult asyncResult)
-

Parameters

-
-
-
- asyncResult -
-
- An IAsyncResult obtained by calling the HttpListenerRequest.BeginGetClientCertificate(AsyncCallback, object) method. -
-
-
-

Returns

-
- A System.Security.Cryptography.X509Certificates.X509Certificate2 that contains the client's X.509 v.3 certificate. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- NotImplementedException - - This method is not implemented. -
-
-

Remarks

-
- This method completes an asynchronous operation started by calling the HttpListenerRequest.BeginGetClientCertificate(AsyncCallback, object) method. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

GetClientCertificate Method

-
-

- Gets the client's X.509 v.3 certificate. -

-

Syntax

-
public System.Security.Cryptography.X509Certificates.X509Certificate2 GetClientCertificate ()
-

Returns

-
- A System.Security.Cryptography.X509Certificates.X509Certificate2 that contains the client's X.509 v.3 certificate. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- NotImplementedException - - This method is not implemented. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

HasEntityBody Property

-
-

- Gets a value indicating whether the request has the entity body. -

-

Syntax

-
public bool HasEntityBody { get; }
-

Value

-
- true if the request has the entity body; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Headers Property

-
-

- Gets the HTTP headers used in the request. -

-

Syntax

-
public System.Collections.Specialized.NameValueCollection Headers { get; }
-

Value

-
- A System.Collections.Specialized.NameValueCollection that contains the HTTP headers used in the request. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

HttpMethod Property

-
-

- Gets the HTTP method used in the request. -

-

Syntax

-
public string HttpMethod { get; }
-

Value

-
- A string that contains the HTTP method used in the request. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

InputStream Property

-
-

- Gets a System.IO.Stream that contains the entity body data included in the request. -

-

Syntax

-
public System.IO.Stream InputStream { get; }
-

Value

-
- A System.IO.Stream that contains the entity body data included in the request. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsAuthenticated Property

-
-

- Gets a value indicating whether the client that sent the request is authenticated. -

-

Syntax

-
public bool IsAuthenticated { get; }
-

Value

-
- Always returns false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsLocal Property

-
-

- Gets a value indicating whether the request is sent from the local computer. -

-

Syntax

-
public bool IsLocal { get; }
-

Value

-
- true if the request is sent from the local computer; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsSecureConnection Property

-
-

- Gets a value indicating whether the HTTP connection is secured using the SSL protocol. -

-

Syntax

-
public bool IsSecureConnection { get; }
-

Value

-
- true if the HTTP connection is secured; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsWebSocketRequest Property

-
-

- Gets a value indicating whether the request is a WebSocket connection request. -

-

Syntax

-
public bool IsWebSocketRequest { get; }
-

Value

-
- true if the request is a WebSocket connection request; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

KeepAlive Property

-
-

- Gets a value indicating whether the client requests a persistent connection. -

-

Syntax

-
public bool KeepAlive { get; }
-

Value

-
- true if the client requests a persistent connection; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

LocalEndPoint Property

-
-

- Gets the server endpoint as an IP address and a port number. -

-

Syntax

-
public System.Net.IPEndPoint LocalEndPoint { get; }
-

Value

-
- A System.Net.IPEndPoint that contains the server endpoint. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ProtocolVersion Property

-
-

- Gets the HTTP version used in the request. -

-

Syntax

-
public Version ProtocolVersion { get; }
-

Value

-
- A Version that contains the HTTP version used in the request. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

QueryString Property

-
-

- Gets the collection of query string variables used in the request. -

-

Syntax

-
public System.Collections.Specialized.NameValueCollection QueryString { get; }
-

Value

-
- A System.Collections.Specialized.NameValueCollection that contains the collection of query string variables used in the request. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

RawUrl Property

-
-

- Gets the raw URL (without the scheme, host and port) requested by the client. -

-

Syntax

-
public string RawUrl { get; }
-

Value

-
- A string that contains the raw URL requested by the client. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

RemoteEndPoint Property

-
-

- Gets the client endpoint as an IP address and a port number. -

-

Syntax

-
public System.Net.IPEndPoint RemoteEndPoint { get; }
-

Value

-
- A System.Net.IPEndPoint that contains the client endpoint. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

RequestTraceIdentifier Property

-
-

- Gets the identifier of a request. -

-

Syntax

-
public Guid RequestTraceIdentifier { get; }
-

Value

-
- A Guid that contains the identifier of a request. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Url Property

-
-

- Gets the URL requested by the client. -

-

Syntax

-
public Uri Url { get; }
-

Value

-
- A Uri that contains the URL requested by the client. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

UrlReferrer Property

-
-

- Gets the URL of the resource from which the requested URL was obtained. -

-

Syntax

-
public Uri UrlReferrer { get; }
-

Value

-
- A Uri that contains the value of the Referer request-header field. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

UserAgent Property

-
-

- Gets the information about the user agent originating the request. -

-

Syntax

-
public string UserAgent { get; }
-

Value

-
- A string that contains the value of the User-Agent request-header field. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

UserHostAddress Property

-
-

- Gets the server endpoint as an IP address and a port number. -

-

Syntax

-
public string UserHostAddress { get; }
-

Value

-
- A string that contains the server endpoint. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

UserHostName Property

-
-

- Gets the internet host name and port number (if present) of the resource being requested. -

-

Syntax

-
public string UserHostName { get; }
-

Value

-
- A string that contains the value of the Host request-header field. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

UserLanguages Property

-
-

- Gets the natural languages that are preferred as a response to the request. -

-

Syntax

-
public string[] UserLanguages { get; }
-

Value

-
- An array of string that contains the natural language names in the Accept-Language request-header field. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net/HttpListenerResponse.html b/websocket-sharp/doc/html/WebSocketSharp.Net/HttpListenerResponse.html deleted file mode 100644 index 96f0ed7b..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Net/HttpListenerResponse.html +++ /dev/null @@ -1,1524 +0,0 @@ - - - WebSocketSharp.Net.HttpListenerResponse - - - - - -
- websocket-sharp : WebSocketSharp.Net Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

HttpListenerResponse Class

-

- Provides access to a response to a request being processed by a WebSocketSharp.Net.HttpListener instance. -

-
-

Syntax

-
public sealed class HttpListenerResponse : IDisposable
-
-
-

Remarks

-
- The HttpListenerResponse class cannot be inherited. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - object. -

-

Public Properties

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- 		- - ContentEncoding - - - - System.Text.Encoding - . - Gets or sets the encoding that can be used with the entity body data included in the response. -
-
-
- 		- - ContentLength64 - - - - long - . - Gets or sets the size of the entity body data included in the response. -
-
-
- 		- - ContentType - - - - string - . - Gets or sets the media type of the entity body included in the response. -
-
-
- 		- - Cookies - - - - CookieCollection - . - Gets or sets the cookies returned with the response. -
-
-
- 		- - Headers - - - - WebHeaderCollection - . - Gets or sets the HTTP headers returned to the client. -
-
-
- 		- - KeepAlive - - - - bool - . - Gets or sets a value indicating whether the server requests a persistent connection. -
[read-only]
 - - OutputStream - - - - System.IO.Stream - . - Gets a System.IO.Stream to use to write the entity body data. -
-
-
- 		- - ProtocolVersion - - - - Version - . - Gets or sets the HTTP version used in the response. -
-
-
- 		- - RedirectLocation - - - - string - . - Gets or sets the URL to which the client is redirected to locate a requested resource. -
-
-
- 		- - SendChunked - - - - bool - . - Gets or sets a value indicating whether the response uses the chunked transfer encoding. -
-
-
- 		- - StatusCode - - - - int - . - Gets or sets the HTTP status code returned to the client. -
-
-
- 		- - StatusDescription - - - - string - . - Gets or sets a description of the HTTP status code returned to the client. -
-
-
-

Public Methods

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- 		- - Abort - ()
- Closes the connection to the client without sending a response. -
-
-
- 		- - AddHeader - (string, string)
- Adds the specified HTTP header name and value to - the headers for this response. -
-
-
- 		- - AppendCookie - (Cookie)
- Adds the specified WebSocketSharp.Net.Cookie to the HttpListenerResponse.Cookies sent with the response. -
-
-
- 		- - AppendHeader - (string, string)
- Appends a value to the specified HTTP header sent with the response. -
-
-
- 		- - Close - ()
- Sends the response to the client and releases the resources associated with - the WebSocketSharp.Net.HttpListenerResponse instance. -
-
-
- 		- - Close - (byte[], bool)
- Sends the response with the specified array of byte to the client and - releases the resources associated with the WebSocketSharp.Net.HttpListenerResponse instance. -
-
-
- 		- - CopyFrom - (HttpListenerResponse)
- Copies properties from the specified WebSocketSharp.Net.HttpListenerResponse to this response. -
-
-
- 		- - Redirect - (string)
- Configures the response to redirect the client's request to the specified url. -
-
-
- 		- - SetCookie - (Cookie)
- Adds or updates a WebSocketSharp.Net.Cookie in the HttpListenerResponse.Cookies sent with the response. -
-
-
-

Explicitly Implemented Interface Members

-
-
- - - - - - -
-
-
- 		- - IDisposable.Dispose - - - Releases all resource used by the WebSocketSharp.Net.HttpListenerResponse. -
-
-
-

Extension Methods

-
-
- - - - - - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
static
- 		- - WriteContent - (this HttpListenerResponse, byte[])
- Writes the specified content data using the specified WebSocketSharp.Net.HttpListenerResponse. -
-
-
-
-
-
-

Member Details

-
-

Abort Method

-
-

- Closes the connection to the client without sending a response. -

-

Syntax

-
public void Abort ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

AddHeader Method

-
-

- Adds the specified HTTP header name and value to - the headers for this response. -

-

Syntax

-
public void AddHeader (string name, string value)
-

Parameters

-
-
-
- name -
-
- A string that contains the name of the HTTP header to add. -
-
- value -
-
- A string that contains the value of the HTTP header to add. -
-
-
-

Exceptions

-
- - - - - - - - - - - - - -
TypeReason
- ArgumentNullException - - name is null or string.Empty. -
- ArgumentOutOfRangeException - - The length of value is greater than 65,535 characters. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

AppendCookie Method

-
-

- Adds the specified WebSocketSharp.Net.Cookie to the HttpListenerResponse.Cookies sent with the response. -

-

Syntax

-
public void AppendCookie (Cookie cookie)
-

Parameters

-
-
-
- cookie -
-
- A WebSocketSharp.Net.Cookie to add to the HttpListenerResponse.Cookies. -
-
-
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ArgumentNullException - - cookie is null. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

AppendHeader Method

-
-

- Appends a value to the specified HTTP header sent with the response. -

-

Syntax

-
public void AppendHeader (string name, string value)
-

Parameters

-
-
-
- name -
-
- A string that contains the name of the HTTP header to append value to. -
-
- value -
-
- A string that contains the value to append to the HTTP header. -
-
-
-

Exceptions

-
- - - - - - - - - - - - - -
TypeReason
- ArgumentException - - name is null or string.Empty. -
- ArgumentOutOfRangeException - - The length of value is greater than 65,535 characters. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Close Method

-
-

- Sends the response to the client and releases the resources associated with - the WebSocketSharp.Net.HttpListenerResponse instance. -

-

Syntax

-
public void Close ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Close Method

-
-

- Sends the response with the specified array of byte to the client and - releases the resources associated with the WebSocketSharp.Net.HttpListenerResponse instance. -

-

Syntax

-
public void Close (byte[] responseEntity, bool willBlock)
-

Parameters

-
-
-
- responseEntity -
-
- An array of byte that contains the response entity body data. -
-
- willBlock -
-
- true if this method blocks execution while flushing the stream to the client; otherwise, false. -
-
-
-

Exceptions

-
- - - - - - - - - - - - - -
TypeReason
- ArgumentNullException - - responseEntity is null. -
- ObjectDisposedException - - This object is closed. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ContentEncoding Property

-
-

- Gets or sets the encoding that can be used with the entity body data included in the response. -

-

Syntax

-
public System.Text.Encoding ContentEncoding { get; set; }
-

Value

-
- A System.Text.Encoding that contains the encoding that can be used with the entity body data. -
-

Exceptions

-
- - - - - - - - - - - - - -
TypeReason
- ObjectDisposedException - - This object is closed. -
- InvalidOperationException - - The response has been sent already. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ContentLength64 Property

-
-

- Gets or sets the size of the entity body data included in the response. -

-

Syntax

-
public long ContentLength64 { get; set; }
-

Value

-
- A long that contains the value of the Content-Length entity-header field. - The value is a number of bytes in the entity body data. -
-

Exceptions

-
- - - - - - - - - - - - - - - - - -
TypeReason
- ObjectDisposedException - - This object is closed. -
- InvalidOperationException - - The response has been sent already. -
- ArgumentOutOfRangeException - - The value specified for a set operation is less than zero. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ContentType Property

-
-

- Gets or sets the media type of the entity body included in the response. -

-

Syntax

-
public string ContentType { get; set; }
-

Value

-
- The type of the content. - A string that contains the value of the Content-Type entity-header field. -
-

Exceptions

-
- - - - - - - - - - - - - - - - - - - - - -
TypeReason
- ObjectDisposedException - - This object is closed. -
- InvalidOperationException - - The response has been sent already. -
- ArgumentNullException - - The value specified for a set operation is null. -
- ArgumentException - - The value specified for a set operation is a string.Empty. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Cookies Property

-
-

- Gets or sets the cookies returned with the response. -

-

Syntax

-
public CookieCollection Cookies { get; set; }
-

Value

-
- A WebSocketSharp.Net.CookieCollection that contains the cookies returned with the response. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

CopyFrom Method

-
-

- Copies properties from the specified WebSocketSharp.Net.HttpListenerResponse to this response. -

-

Syntax

-
public void CopyFrom (HttpListenerResponse templateResponse)
-

Parameters

-
-
-
- templateResponse -
-
- A WebSocketSharp.Net.HttpListenerResponse to copy. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Headers Property

-
-

- Gets or sets the HTTP headers returned to the client. -

-

Syntax

-
public WebHeaderCollection Headers { get; set; }
-

Value

-
- A WebSocketSharp.Net.WebHeaderCollection that contains the HTTP headers returned to the client. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

KeepAlive Property

-
-

- Gets or sets a value indicating whether the server requests a persistent connection. -

-

Syntax

-
public bool KeepAlive { get; set; }
-

Value

-
- true if the server requests a persistent connection; otherwise, false. - The default is true. -
-

Exceptions

-
- - - - - - - - - - - - - -
TypeReason
- ObjectDisposedException - - This object is closed. -
- InvalidOperationException - - The response has been sent already. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

OutputStream Property

-
-

- Gets a System.IO.Stream to use to write the entity body data. -

-

Syntax

-
public System.IO.Stream OutputStream { get; }
-

Value

-
- A System.IO.Stream to use to write the entity body data. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ObjectDisposedException - - This object is closed. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ProtocolVersion Property

-
-

- Gets or sets the HTTP version used in the response. -

-

Syntax

-
public Version ProtocolVersion { get; set; }
-

Value

-
- A Version that contains the HTTP version used in the response. -
-

Exceptions

-
- - - - - - - - - - - - - - - - - - - - - -
TypeReason
- ObjectDisposedException - - This object is closed. -
- InvalidOperationException - - The response has been sent already. -
- ArgumentNullException - - The value specified for a set operation is null. -
- ArgumentException - - The value specified for a set operation does not have its Version.Major property set to 1 or - does not have its Version.Minor property set to either 0 or 1. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Redirect Method

-
-

- Configures the response to redirect the client's request to the specified url. -

-

Syntax

-
public void Redirect (string url)
-

Parameters

-
-
-
- url -
-
- A string that contains a URL to redirect the client's request to. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

RedirectLocation Property

-
-

- Gets or sets the URL to which the client is redirected to locate a requested resource. -

-

Syntax

-
public string RedirectLocation { get; set; }
-

Value

-
- A string that contains the value of the Location response-header field. -
-

Exceptions

-
- - - - - - - - - - - - - - - - - -
TypeReason
- ObjectDisposedException - - This object is closed. -
- InvalidOperationException - - The response has been sent already. -
- ArgumentException - - The value specified for a set operation is a string.Empty. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

SendChunked Property

-
-

- Gets or sets a value indicating whether the response uses the chunked transfer encoding. -

-

Syntax

-
public bool SendChunked { get; set; }
-

Value

-
- true if the response uses the chunked transfer encoding; otherwise, false. -
-

Exceptions

-
- - - - - - - - - - - - - -
TypeReason
- ObjectDisposedException - - This object is closed. -
- InvalidOperationException - - The response has been sent already. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

SetCookie Method

-
-

- Adds or updates a WebSocketSharp.Net.Cookie in the HttpListenerResponse.Cookies sent with the response. -

-

Syntax

-
public void SetCookie (Cookie cookie)
-

Parameters

-
-
-
- cookie -
-
- A WebSocketSharp.Net.Cookie to set. -
-
-
-

Exceptions

-
- - - - - - - - - - - - - -
TypeReason
- ArgumentNullException - - cookie is null. -
- ArgumentException - - cookie already exists in the HttpListenerResponse.Cookies and - could not be replaced. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

StatusCode Property

-
-

- Gets or sets the HTTP status code returned to the client. -

-

Syntax

-
public int StatusCode { get; set; }
-

Value

-
- An int that indicates the HTTP status code for the response to the request. - The default is HttpStatusCode.OK. -
-

Exceptions

-
- - - - - - - - - - - - - - - - - -
TypeReason
- ObjectDisposedException - - This object is closed. -
- InvalidOperationException - - The response has been sent already. -
- System.Net.ProtocolViolationException - - The value specified for a set operation is invalid. Valid values are between 100 and 999. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

StatusDescription Property

-
-

- Gets or sets a description of the HTTP status code returned to the client. -

-

Syntax

-
public string StatusDescription { get; set; }
-

Value

-
- A string that contains a description of the HTTP status code returned to the client. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

System.IDisposable.Dispose Method

-
-

- Releases all resource used by the WebSocketSharp.Net.HttpListenerResponse. -

-

Syntax

-
- void System.IDisposable.Dispose ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net/HttpStatusCode.html b/websocket-sharp/doc/html/WebSocketSharp.Net/HttpStatusCode.html deleted file mode 100644 index 751a6994..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Net/HttpStatusCode.html +++ /dev/null @@ -1,697 +0,0 @@ - - - WebSocketSharp.Net.HttpStatusCode - - - - - -
- websocket-sharp : WebSocketSharp.Net Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

HttpStatusCode Enum

-

- Contains the values of the HTTP status codes. -

-
-

Syntax

-
public enum HttpStatusCode
-
-
-

Remarks

-
- The HttpStatusCode enumeration contains the values of the HTTP status codes defined in - RFC 2616 for HTTP 1.1. -
-

Members

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Member NameDescription
- Accepted - - Equivalent to status code 202. Indicates that the client's request has been accepted for processing, - but the processing has not been completed. -
- Ambiguous - -

- Equivalent to status code 300. Indicates that the requested resource corresponds to - any one of multiple representations. -

-

- Ambiguous is a synonym for MultipleChoices. -

-
- BadGateway - - Equivalent to status code 502. Indicates that a gateway or proxy server received an invalid response - from the upstream server. -
- BadRequest - - Equivalent to status code 400. Indicates that the client's request could not be understood - by the server due to malformed syntax. -
- Conflict - - Equivalent to status code 409. Indicates that the client's request could not be completed - due to a conflict on the server. -
- Continue - - Equivalent to status code 100. Indicates that the client should continue with its request. -
- Created - - Equivalent to status code 201. Indicates that the client's request has been fulfilled - and resulted in a new resource being created. -
- ExpectationFailed - - Equivalent to status code 417. Indicates that the expectation given in an Expect request header field - could not be met by the server. -
- Forbidden - - Equivalent to status code 403. Indicates that the server understood the client's request - but is refusing to fulfill it. -
- Found - -

- Equivalent to status code 302. Indicates that the requested resource is located temporarily - under a different URI. -

-

- Found is a synonym for Redirect. -

-
- GatewayTimeout - - Equivalent to status code 504. Indicates that a gateway or proxy server did not receive a timely response - from the upstream server or some other auxiliary server. -
- Gone - - Equivalent to status code 410. Indicates that the requested resource is no longer available - at the server and no forwarding address is known. -
- HttpVersionNotSupported - - Equivalent to status code 505. Indicates that the server does not support the HTTP version - used in the client's request. -
- InternalServerError - - Equivalent to status code 500. Indicates that the server encountered an unexpected condition - which prevented it from fulfilling the client's request. -
- LengthRequired - - Equivalent to status code 411. Indicates that the server refuses to accept the client's request - without a defined Content-Length. -
- MethodNotAllowed - - Equivalent to status code 405. Indicates that the method specified in the request line - is not allowed for the resource identified by the request URI. -
- Moved - -

- 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. -

-

- Moved is a synonym for MovedPermanently. -

-
- MovedPermanently - -

- 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. -

-

- MovedPermanently is a synonym for Moved. -

-
- MultipleChoices - -

- Equivalent to status code 300. Indicates that the requested resource corresponds to - any one of multiple representations. -

-

- MultipleChoices is a synonym for Ambiguous. -

-
- NoContent - - Equivalent to status code 204. Indicates that the server has fulfilled the client's request - but does not need to return an entity-body. -
- NonAuthoritativeInformation - - Equivalent to status code 203. Indicates that the returned metainformation is from a local or a third-party copy instead of the origin server. -
- NotAcceptable - - Equivalent to status code 406. Indicates that the server does not have the appropriate resource - to respond to the accept headers in the client's request. -
- NotFound - - Equivalent to status code 404. Indicates that the server has not found anything - matching the request URI. -
- NotImplemented - - Equivalent to status code 501. Indicates that the server does not support the functionality - required to fulfill the client's request. -
- NotModified - - Equivalent to status code 304. Indicates that the client has performed a conditional GET request - and access is allowed, but the document has not been modified. -
- OK - - Equivalent to status code 200. Indicates that the client's request has succeeded. -
- PartialContent - - Equivalent to status code 206. Indicates that the server has fulfilled the partial GET request for the resource. -
- PaymentRequired - - Equivalent to status code 402. This code is reserved for future use. -
- PreconditionFailed - - Equivalent to status code 412. Indicates that the precondition given in one or more of the request header fields - evaluated to false when it was tested on the server. -
- ProxyAuthenticationRequired - - Equivalent to status code 407. Indicates that the client must first authenticate itself with the proxy. -
- Redirect - -

- Equivalent to status code 302. Indicates that the requested resource is located temporarily - under a different URI. -

-

- Redirect is a synonym for Found. -

-
- RedirectKeepVerb - -

- Equivalent to status code 307. Indicates that the requested resource is located temporarily - under a different URI. -

-

- RedirectKeepVerb is a synonym for TemporaryRedirect. -

-
- RedirectMethod - -

- 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. -

-

- RedirectMethod is a synonym for SeeOther. -

-
- RequestedRangeNotSatisfiable - - Equivalent to status code 416. Indicates that none of the range specifier values in a Range request header field - overlap the current extent of the selected resource. -
- RequestEntityTooLarge - - Equivalent to status code 413. Indicates that the client's request entity is larger - than the server is willing or able to process. -
- RequestTimeout - - Equivalent to status code 408. Indicates that the client did not produce a request - within the time that the server was prepared to wait. -
- RequestUriTooLong - - Equivalent to status code 414. Indicates that the request URI is longer - than the server is willing to interpret. -
- ResetContent - - 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. -
- SeeOther - -

- 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. -

-

- SeeOther is a synonym for RedirectMethod. -

-
- ServiceUnavailable - - 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. -
- SwitchingProtocols - - Equivalent to status code 101. Indicates that the server is switching the HTTP version or protocol on the connection. -
- TemporaryRedirect - -

- Equivalent to status code 307. Indicates that the requested resource is located temporarily - under a different URI. -

-

- TemporaryRedirect is a synonym for RedirectKeepVerb. -

-
- Unauthorized - - Equivalent to status code 401. Indicates that the client's request requires user authentication. -
- UnsupportedMediaType - - 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. -
- Unused - - Equivalent to status code 306. This code was used in a previous version of the specification, - is no longer used, and is reserved for future use. -
- UseProxy - - Equivalent to status code 305. Indicates that the requested resource must be accessed - through the proxy given by the Location field. -
-
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net/HttpVersion.html b/websocket-sharp/doc/html/WebSocketSharp.Net/HttpVersion.html deleted file mode 100644 index 6ee072fe..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Net/HttpVersion.html +++ /dev/null @@ -1,380 +0,0 @@ - - - WebSocketSharp.Net.HttpVersion - - - - - -
- websocket-sharp : WebSocketSharp.Net Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

HttpVersion Class

-

- Provides the HTTP version numbers. -

-
-

Syntax

-
public class HttpVersion
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - object. -

-

Public Constructors

-
-
- - - - - - -
-
-
- 		-
- - HttpVersion - ()
- 		- Initializes a new instance of the WebSocketSharp.Net.HttpVersion class. -
-
-
-

Public Fields

-
-
- - - - - - - - - - - -
-
static readonly
- 		- - Version10 - - - - Version - . - Provides a Version instance for HTTP 1.0. -
-
static readonly
- 		- - Version11 - - - - Version - . - Provides a Version instance for HTTP 1.1. -
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

HttpVersion Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Net.HttpVersion class. -

-

Syntax

-
public HttpVersion ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Version10 Field

-
-

- Provides a Version instance for HTTP 1.0. -

-

Syntax

-
public static readonly Version Version10
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Version11 Field

-
-

- Provides a Version instance for HTTP 1.1. -

-

Syntax

-
public static readonly Version Version11
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net/WebHeaderCollection.html b/websocket-sharp/doc/html/WebSocketSharp.Net/WebHeaderCollection.html deleted file mode 100644 index 5b49fec2..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Net/WebHeaderCollection.html +++ /dev/null @@ -1,2291 +0,0 @@ - - - WebSocketSharp.Net.WebHeaderCollection - - - - - -
- websocket-sharp : WebSocketSharp.Net Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

WebHeaderCollection Class

-

- Provides a collection of the HTTP headers associated with a request or response. -

-
-

Syntax

-
[System.Runtime.InteropServices.ComVisible(true)]
public class WebHeaderCollection : System.Collections.Specialized.NameValueCollection, System.Runtime.Serialization.ISerializable
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - System.Collections.Specialized.NameValueCollection. -

-

Public Constructors

-
-
- - - - - - -
-
-
- 		- - - Initializes a new instance of the WebSocketSharp.Net.WebHeaderCollection class. -
-
-
-

Protected Constructors

- -

Public Properties

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
[read-only]
override
- - AllKeys - - - - string[]. - Gets all header names in the collection. -
[read-only]
override
- - Count - - - - int - . - Gets the number of headers in the collection. -
-
- default property -
-
-
- 		- - Item - (System.Net.HttpRequestHeader) - - string - . - Gets or sets the specified request header in the collection. -
-
- default property -
-
-
- 		- - Item - (System.Net.HttpResponseHeader) - - string - . - Gets or sets the specified response header in the collection. -
[read-only]
override
- - Keys - - - - System.Collections.Specialized.NameObjectCollectionBase.KeysCollection - . - Gets a collection of header names in the collection. -
-
-
-

Public Methods

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- 		- - Add - (string)
- Adds the specified header to the collection. -
-
-
- 		- - Add - (System.Net.HttpRequestHeader, string)
- Adds the specified request header with the specified value to the collection. -
-
-
- 		- - Add - (System.Net.HttpResponseHeader, string)
- Adds the specified response header with the specified value to the collection. -
-
override
- 		- - Add - (string, string)
- Adds a header with the specified name and value to the collection. -
-
override
- 		- - Clear - ()
- Removes all headers from the collection. -
-
override
- 		- - Get - (int) : string
- Get the value of the header with the specified index in the collection. -
-
override
- 		- - Get - (string) : string
- Get the value of the header with the specified name in the collection. -
-
override
- 		- - GetEnumerator - () : IEnumerator
- Gets the enumerator to use to iterate through the WebSocketSharp.Net.WebHeaderCollection. -
-
override
- 		- - GetKey - (int) : string
- Get the header name at the specified index position in the collection. -
-
override
- 		- - GetObjectData - (System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext)
- Populates the specified System.Runtime.Serialization.SerializationInfo with the data to need to - serialize the WebSocketSharp.Net.WebHeaderCollection object. -
-
override
- 		- - GetValues - (int) : string[]
- Gets an array of header values stored in the specified index position of the header collection. -
-
override
- 		- - GetValues - (string) : string[]
- Gets an array of header values stored in the specified header name. -
-
static
- 		- - IsRestricted - (string) : bool
- Determines whether the specified header can be set for the request. -
-
static
- 		- - IsRestricted - (string, bool) : bool
- Determines whether the specified header can be set for the request or the response. -
-
override
- 		- - OnDeserialization - (object)
- Implements the System.Runtime.Serialization.ISerializable interface and raises the deserialization event - when the deserialization is complete. -
-
-
- 		- - Remove - (System.Net.HttpRequestHeader)
- Removes the specified header from the collection. -
-
-
- 		- - Remove - (System.Net.HttpResponseHeader)
- Removes the specified header from the collection. -
-
override
- 		- - Remove - (string)
- Removes the specified header from the collection. -
-
-
- 		- - Set - (System.Net.HttpRequestHeader, string)
- Sets the specified header to the specified value. -
-
-
- 		- - Set - (System.Net.HttpResponseHeader, string)
- Sets the specified header to the specified value. -
-
override
- 		- - Set - (string, string)
- Sets the specified header to the specified value. -
-
-
- 		- - ToByteArray - () : byte[]
- Converts the current WebSocketSharp.Net.WebHeaderCollection to an array of byte. -
-
override
- 		- - ToString - () : string
- Returns a string that represents the current WebSocketSharp.Net.WebHeaderCollection. -
-
-
-

Protected Methods

-
-
- - - - - -
-
-
- 		- - AddWithoutValidate - (string, string)
- Adds a header to the collection without checking whether the header is on the restricted header list. -
-
-
-

Explicitly Implemented Interface Members

-
-
- - - - - - -
-
-
- 		- - System.Runtime.Serialization.ISerializable.GetObjectData - - - Populates the specified System.Runtime.Serialization.SerializationInfo with the data to need to - serialize the WebSocketSharp.Net.WebHeaderCollection object. -
-
-
-

Extension Methods

-
-
- - - - - - - - - - - - - - - - - -
-
static
- 		- - Exists - (this System.Collections.Specialized.NameValueCollection, string) : bool
- Determines whether the entry with the specified key exists in the specified System.Collections.Specialized.NameValueCollection. -
-
static
- 		- - Exists - (this System.Collections.Specialized.NameValueCollection, string, string) : bool
- Determines whether the entry with the specified both key and value exists in the specified System.Collections.Specialized.NameValueCollection. -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

WebHeaderCollection Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Net.WebHeaderCollection class. -

-

Syntax

-
public WebHeaderCollection ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

WebHeaderCollection Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Net.WebHeaderCollection class - with the specified System.Runtime.Serialization.SerializationInfo and System.Runtime.Serialization.StreamingContext. -

-

Syntax

-
protected WebHeaderCollection (System.Runtime.Serialization.SerializationInfo serializationInfo, System.Runtime.Serialization.StreamingContext streamingContext)
-

Parameters

-
-
-
- serializationInfo -
-
- A System.Runtime.Serialization.SerializationInfo that contains the data to need to serialize the WebSocketSharp.Net.WebHeaderCollection object. -
-
- streamingContext -
-
- A System.Runtime.Serialization.StreamingContext that contains the source of the serialized stream associated with the new WebSocketSharp.Net.WebHeaderCollection. -
-
-
-

Exceptions

-
- - - - - - - - - - - - - -
TypeReason
- ArgumentNullException - - serializationInfo is null. -
- ArgumentException - - An element with the specified name is not found in serializationInfo. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Add Method

-
-

- Adds the specified header to the collection. -

-

Syntax

-
public void Add (string header)
-

Parameters

-
-
-
- header -
-
- A string that contains a header with the name and value separated by a colon (:). -
-
-
-

Exceptions

-
- - - - - - - - - - - - - - - - - - - - - -
TypeReason
- ArgumentNullException - - header is null, string.Empty, or - the name part of header is string.Empty. -
- ArgumentException - -

- header does not contain a colon. -

-

- -or- -

-

- header is a restricted header. -

-

- -or- -

-

- The name or value part of header contains invalid characters. -

-
- ArgumentOutOfRangeException - - The length of the value part of header is greater than 65535. -
- InvalidOperationException - - The current WebSocketSharp.Net.WebHeaderCollection instance does not allow the header. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Add Method

-
-

- Adds the specified request header with the specified value to the collection. -

-

Syntax

-
public void Add (System.Net.HttpRequestHeader header, string value)
-

Parameters

-
-
-
- header -
-
- A System.Net.HttpRequestHeader is a request header to add. -
-
- value -
-
- A string that contains the value of the header to add. -
-
-
-

Exceptions

-
- - - - - - - - - - - - - - - - - -
TypeReason
- ArgumentOutOfRangeException - - The length of value is greater than 65535. -
- InvalidOperationException - - The current WebSocketSharp.Net.WebHeaderCollection instance does not allow any of System.Net.HttpRequestHeader values. -
- ArgumentException - -

- header is a restricted header. -

-

- -or- -

-

- value contains invalid characters. -

-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Add Method

-
-

- Adds the specified response header with the specified value to the collection. -

-

Syntax

-
public void Add (System.Net.HttpResponseHeader header, string value)
-

Parameters

-
-
-
- header -
-
- A System.Net.HttpResponseHeader is a response header to add. -
-
- value -
-
- A string that contains the value of the header to add. -
-
-
-

Exceptions

-
- - - - - - - - - - - - - - - - - -
TypeReason
- ArgumentOutOfRangeException - - The length of value is greater than 65535. -
- InvalidOperationException - - The current WebSocketSharp.Net.WebHeaderCollection instance does not allow any of System.Net.HttpResponseHeader values. -
- ArgumentException - -

- header is a restricted header. -

-

- -or- -

-

- value contains invalid characters. -

-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Add Method

-
-

- Adds a header with the specified name and value to the collection. -

-

Syntax

-
public override void Add (string name, string value)
-

Parameters

-
-
-
- name -
-
- A string that contains the name of the header to add. -
-
- value -
-
- A string that contains the value of the header to add. -
-
-
-

Exceptions

-
- - - - - - - - - - - - - - - - - - - - - -
TypeReason
- ArgumentException - -

- name or value contains invalid characters. -

-

- -or- -

-

- name is a restricted header name. -

-
- ArgumentOutOfRangeException - - The length of value is greater than 65535. -
- ArgumentNullException - - name is null or string.Empty. -
- InvalidOperationException - - The current WebSocketSharp.Net.WebHeaderCollection instance does not allow the header name. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

AddWithoutValidate Method

-
-

- Adds a header to the collection without checking whether the header is on the restricted header list. -

-

Syntax

-
protected void AddWithoutValidate (string headerName, string headerValue)
-

Parameters

-
-
-
- headerName -
-
- A string that contains the name of the header to add. -
-
- headerValue -
-
- A string that contains the value of the header to add. -
-
-
-

Exceptions

-
- - - - - - - - - - - - - - - - - - - - - -
TypeReason
- ArgumentException - - headerName or headerValue contains invalid characters. -
- ArgumentNullException - - headerName is null or string.Empty. -
- ArgumentOutOfRangeException - - The length of headerValue is greater than 65535. -
- InvalidOperationException - - The current WebSocketSharp.Net.WebHeaderCollection instance does not allow the headerName. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

AllKeys Property

-
-

- Gets all header names in the collection. -

-

Syntax

-
public override string[] AllKeys { get; }
-

Value

-
- An array of string that contains all header names in the collection. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Clear Method

-
-

- Removes all headers from the collection. -

-

Syntax

-
public override void Clear ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Count Property

-
-

- Gets the number of headers in the collection. -

-

Syntax

-
public override int Count { get; }
-

Value

-
- An int that indicates the number of headers in the collection. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Get Method

-
-

- Get the value of the header with the specified index in the collection. -

-

Syntax

-
public override string Get (int index)
-

Parameters

-
-
-
- index -
-
- An int that is the zero-based index of the header to get. -
-
-
-

Returns

-
- A string that receives the value of the header. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Get Method

-
-

- Get the value of the header with the specified name in the collection. -

-

Syntax

-
public override string Get (string name)
-

Parameters

-
-
-
- name -
-
- A string that contains the name of the header to get. -
-
-
-

Returns

-
- A string that receives the value of the header. - null if there is no header with name in the collection. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

GetEnumerator Method

-
-

- Gets the enumerator to use to iterate through the WebSocketSharp.Net.WebHeaderCollection. -

-

Syntax

-
public override IEnumerator GetEnumerator ()
-

Returns

-
- An instance of an implementation of the IEnumerator interface - to use to iterate through the WebSocketSharp.Net.WebHeaderCollection. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

GetKey Method

-
-

- Get the header name at the specified index position in the collection. -

-

Syntax

-
public override string GetKey (int index)
-

Parameters

-
-
-
- index -
-
- An int is the zero-based index of the key to get from the collection. -
-
-
-

Returns

-
- A string that receives the header name. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

GetObjectData Method

-
-

- Populates the specified System.Runtime.Serialization.SerializationInfo with the data to need to - serialize the WebSocketSharp.Net.WebHeaderCollection object. -

-

Syntax

-
public override void GetObjectData (System.Runtime.Serialization.SerializationInfo serializationInfo, System.Runtime.Serialization.StreamingContext streamingContext)
-

Parameters

-
-
-
- serializationInfo -
-
- A System.Runtime.Serialization.SerializationInfo that holds the data to need to serialize the WebSocketSharp.Net.WebHeaderCollection object. -
-
- streamingContext -
-
- A System.Runtime.Serialization.StreamingContext that specifies the destination for the serialization. -
-
-
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ArgumentNullException - - serializationInfo is null. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

GetValues Method

-
-

- Gets an array of header values stored in the specified index position of the header collection. -

-

Syntax

-
public override string[] GetValues (int index)
-

Parameters

-
-
-
- index -
-
- An int is the zero-based index of the header in the collection. -
-
-
-

Returns

-
- An array of string that receives the header values. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

GetValues Method

-
-

- Gets an array of header values stored in the specified header name. -

-

Syntax

-
public override string[] GetValues (string header)
-

Parameters

-
-
-
- header -
-
- A string that contains a header name. -
-
-
-

Returns

-
- An array of string that receives the header values. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsRestricted Method

-
-

- Determines whether the specified header can be set for the request. -

-

Syntax

-
public static bool IsRestricted (string headerName)
-

Parameters

-
-
-
- headerName -
-
- A string that contains the name of the header to test. -
-
-
-

Returns

-
- true if the header is restricted; otherwise, false. -
-

Exceptions

-
- - - - - - - - - - - - - -
TypeReason
- ArgumentNullException - - headerName is null or string.Empty. -
- ArgumentException - - headerName contains invalid characters. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsRestricted Method

-
-

- Determines whether the specified header can be set for the request or the response. -

-

Syntax

-
public static bool IsRestricted (string headerName, bool response)
-

Parameters

-
-
-
- headerName -
-
- A string that contains the name of the header to test. -
-
- response -
-
- true if does the test for the response; for the request, false. -
-
-
-

Returns

-
- true if the header is restricted; otherwise, false. -
-

Exceptions

-
- - - - - - - - - - - - - -
TypeReason
- ArgumentNullException - - headerName is null or string.Empty. -
- ArgumentException - - headerName contains invalid characters. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Item Property

-
-

- Gets or sets the specified request header in the collection. -

-

Syntax

-
-

- This is the default property for this class. -

public string this [System.Net.HttpRequestHeader header] { get; set; }
-

Parameters

-
-
-
- header -
-
- A System.Net.HttpRequestHeader that indicates a request header. -
-
-
-

Value

-
- A string that contains the value of the specified request header. -
-

Exceptions

-
- - - - - - - - - - - - - - - - - -
TypeReason
- InvalidOperationException - - The current WebSocketSharp.Net.WebHeaderCollection instance does not allow any of System.Net.HttpRequestHeader values. -
- ArgumentException - -

- header is a restricted header. -

-

- -or- -

-

- value contains invalid characters. -

-
- ArgumentOutOfRangeException - - The length of value is greater than 65535. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Item Property

-
-

- Gets or sets the specified response header in the collection. -

-

Syntax

-
-

- This is the default property for this class. -

public string this [System.Net.HttpResponseHeader header] { get; set; }
-

Parameters

-
-
-
- header -
-
- A System.Net.HttpResponseHeader that indicates a response header. -
-
-
-

Value

-
- A string that contains the value of the specified response header. -
-

Exceptions

-
- - - - - - - - - - - - - - - - - -
TypeReason
- InvalidOperationException - - The current WebSocketSharp.Net.WebHeaderCollection instance does not allow any of System.Net.HttpResponseHeader values. -
- ArgumentException - -

- header is a restricted header. -

-

- -or- -

-

- value contains invalid characters. -

-
- ArgumentOutOfRangeException - - The length of value is greater than 65535. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Keys Property

-
-

- Gets a collection of header names in the collection. -

-

Syntax

-
public override System.Collections.Specialized.NameObjectCollectionBase.KeysCollection Keys { get; }
-

Value

-
- A System.Collections.Specialized.NameObjectCollectionBase.KeysCollection that contains a collection of header names in the collection. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

OnDeserialization Method

-
-

- Implements the System.Runtime.Serialization.ISerializable interface and raises the deserialization event - when the deserialization is complete. -

-

Syntax

-
public override void OnDeserialization (object sender)
-

Parameters

-
-
-
- sender -
-
- An object that contains the source of the deserialization event. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Remove Method

-
-

- Removes the specified header from the collection. -

-

Syntax

-
public void Remove (System.Net.HttpRequestHeader header)
-

Parameters

-
-
-
- header -
-
- A System.Net.HttpRequestHeader to remove from the collection. -
-
-
-

Exceptions

-
- - - - - - - - - - - - - -
TypeReason
- InvalidOperationException - - The current WebSocketSharp.Net.WebHeaderCollection instance does not allow any of System.Net.HttpRequestHeader values. -
- ArgumentException - - header is a restricted header. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Remove Method

-
-

- Removes the specified header from the collection. -

-

Syntax

-
public void Remove (System.Net.HttpResponseHeader header)
-

Parameters

-
-
-
- header -
-
- A System.Net.HttpResponseHeader to remove from the collection. -
-
-
-

Exceptions

-
- - - - - - - - - - - - - -
TypeReason
- InvalidOperationException - - The current WebSocketSharp.Net.WebHeaderCollection instance does not allow any of System.Net.HttpResponseHeader values. -
- ArgumentException - - header is a restricted header. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Remove Method

-
-

- Removes the specified header from the collection. -

-

Syntax

-
public override void Remove (string name)
-

Parameters

-
-
-
- name -
-
- A string that contains the name of the header to remove from the collection. -
-
-
-

Exceptions

-
- - - - - - - - - - - - - - - - - -
TypeReason
- ArgumentNullException - - name is null or string.Empty. -
- ArgumentException - -

- name contains invalid characters. -

-

- -or- -

-

- name is a restricted header name. -

-
- InvalidOperationException - - The current WebSocketSharp.Net.WebHeaderCollection instance does not allow the header name. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Set Method

-
-

- Sets the specified header to the specified value. -

-

Syntax

-
public void Set (System.Net.HttpRequestHeader header, string value)
-

Parameters

-
-
-
- header -
-
- A System.Net.HttpRequestHeader to set. -
-
- value -
-
- A string that contains the value of the header to set. -
-
-
-

Exceptions

-
- - - - - - - - - - - - - - - - - -
TypeReason
- InvalidOperationException - - The current WebSocketSharp.Net.WebHeaderCollection instance does not allow any of System.Net.HttpRequestHeader values. -
- ArgumentException - -

- header is a restricted header. -

-

- -or- -

-

- value contains invalid characters. -

-
- ArgumentOutOfRangeException - - The length of value is greater than 65535. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Set Method

-
-

- Sets the specified header to the specified value. -

-

Syntax

-
public void Set (System.Net.HttpResponseHeader header, string value)
-

Parameters

-
-
-
- header -
-
- A System.Net.HttpResponseHeader to set. -
-
- value -
-
- A string that contains the value of the header to set. -
-
-
-

Exceptions

-
- - - - - - - - - - - - - - - - - -
TypeReason
- InvalidOperationException - - The current WebSocketSharp.Net.WebHeaderCollection instance does not allow any of System.Net.HttpResponseHeader values. -
- ArgumentException - -

- header is a restricted header. -

-

- -or- -

-

- value contains invalid characters. -

-
- ArgumentOutOfRangeException - - The length of value is greater than 65535. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Set Method

-
-

- Sets the specified header to the specified value. -

-

Syntax

-
public override void Set (string name, string value)
-

Parameters

-
-
-
- name -
-
- A string that contains the name of the header to set. -
-
- value -
-
- A string that contains the value of the header to set. -
-
-
-

Exceptions

-
- - - - - - - - - - - - - - - - - - - - - -
TypeReason
- ArgumentNullException - - name is null or string.Empty. -
- ArgumentException - -

- name or value contain invalid characters. -

-

- -or- -

-

- name is a restricted header name. -

-
- ArgumentOutOfRangeException - - The length of value is greater than 65535. -
- InvalidOperationException - - The current WebSocketSharp.Net.WebHeaderCollection instance does not allow the header name. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

System.Runtime.Serialization.ISerializable.GetObjectData Method

-
-

- Populates the specified System.Runtime.Serialization.SerializationInfo with the data to need to - serialize the WebSocketSharp.Net.WebHeaderCollection object. -

-

Syntax

-
- void System.Runtime.Serialization.ISerializable.GetObjectData (System.Runtime.Serialization.SerializationInfo serializationInfo, System.Runtime.Serialization.StreamingContext streamingContext)
-

Parameters

-
-
-
- serializationInfo -
-
- A System.Runtime.Serialization.SerializationInfo that holds the data to need to serialize the WebSocketSharp.Net.WebHeaderCollection object. -
-
- streamingContext -
-
- A System.Runtime.Serialization.StreamingContext that specifies the destination for the serialization. -
-
-
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ArgumentNullException - - serializationInfo is null. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ToByteArray Method

-
-

- Converts the current WebSocketSharp.Net.WebHeaderCollection to an array of byte. -

-

Syntax

-
public byte[] ToByteArray ()
-

Returns

-
- An array of byte that receives the converted current WebSocketSharp.Net.WebHeaderCollection. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ToString Method

-
-

- Returns a string that represents the current WebSocketSharp.Net.WebHeaderCollection. -

-

Syntax

-
public override string ToString ()
-

Returns

-
- A string that represents the current WebSocketSharp.Net.WebHeaderCollection. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Net
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Net/index.html b/websocket-sharp/doc/html/WebSocketSharp.Net/index.html deleted file mode 100644 index 4c7b2d29..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Net/index.html +++ /dev/null @@ -1,324 +0,0 @@ - - - websocket-sharp: WebSocketSharp.Net - - - - - -
- websocket-sharp -
-

WebSocketSharp.Net Namespace

-

-

-
-
-
-

Namespace

-

The WebSocketSharp.Net namespace contains some modified classes and enumerations in the System.Net namespace (e.g. System.Net.HttpListenerContext) to accept the WebSocket connection requests.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- AuthenticationSchemes - - Contains the values of the schemes for authentication. -
- AuthenticationSchemeSelector - - Selects the authentication scheme for a WebSocketSharp.Net.HttpListener instance. -
- Cookie - - Provides a set of properties and methods used to manage an HTTP Cookie. -
- CookieCollection - - Provides a collection container for instances of the WebSocketSharp.Net.Cookie class. -
- CookieException - - The exception that is thrown when a WebSocketSharp.Net.Cookie gets an error. -
- HttpListener - - Provides a simple, programmatically controlled HTTP listener. -
- HttpListenerContext - - Provides access to the HTTP request and response objects used by the WebSocketSharp.Net.HttpListener class. -
- HttpListenerException - - The exception that is thrown when an error occurs processing an HTTP request. -
- HttpListenerPrefixCollection - - Provides the collection used to store the URI prefixes for the WebSocketSharp.Net.HttpListener. -
- HttpListenerRequest - - Provides access to a request to a WebSocketSharp.Net.HttpListener instance. -
- HttpListenerResponse - - Provides access to a response to a request being processed by a WebSocketSharp.Net.HttpListener instance. -
- HttpStatusCode - - Contains the values of the HTTP status codes. -
- HttpVersion - - Provides the HTTP version numbers. -
- WebHeaderCollection - - Provides a collection of the HTTP headers associated with a request or response. -
-
-
-
-
-
Copyright (c) 2010-2013 sta.blockhead
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Server/HttpRequestEventArgs.html b/websocket-sharp/doc/html/WebSocketSharp.Server/HttpRequestEventArgs.html deleted file mode 100644 index a108786c..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Server/HttpRequestEventArgs.html +++ /dev/null @@ -1,348 +0,0 @@ - - - WebSocketSharp.Server.HttpRequestEventArgs - - - - - -
- websocket-sharp : WebSocketSharp.Server Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

HttpRequestEventArgs Class

-

- Contains the event data associated with the HTTP request events of the WebSocketSharp.Server.HttpServer class. -

-
-

Syntax

-
public class HttpRequestEventArgs : EventArgs
-
-
-

Remarks

-
- An HTTP request event occurs when a WebSocketSharp.Server.HttpServer instance receives an HTTP request. - If you want to get the HTTP request objects, you should access the HttpRequestEventArgs.Request property. - If you want to get the HTTP response objects to send, you should access the HttpRequestEventArgs.Response property. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - EventArgs. -

-

Public Properties

-
-
- - - - - - - - - - - -
[read-only]
 - - Request - - - - WebSocketSharp.Net.HttpListenerRequest - . - Gets the HTTP request objects sent from a client. -
[read-only]
 - - Response - - - - WebSocketSharp.Net.HttpListenerResponse - . - Gets the HTTP response objects to send to the client in response to the client's request. -
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

Request Property

-
-

- Gets the HTTP request objects sent from a client. -

-

Syntax

-
public WebSocketSharp.Net.HttpListenerRequest Request { get; }
-

Value

-
- A WebSocketSharp.Net.HttpListenerRequest that contains the HTTP request objects. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Response Property

-
-

- Gets the HTTP response objects to send to the client in response to the client's request. -

-

Syntax

-
public WebSocketSharp.Net.HttpListenerResponse Response { get; }
-

Value

-
- A WebSocketSharp.Net.HttpListenerResponse that contains the HTTP response objects. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Server/HttpServer.html b/websocket-sharp/doc/html/WebSocketSharp.Server/HttpServer.html deleted file mode 100644 index 2b4630f4..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Server/HttpServer.html +++ /dev/null @@ -1,931 +0,0 @@ - - - WebSocketSharp.Server.HttpServer - - - - - -
- websocket-sharp : WebSocketSharp.Server Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

HttpServer Class

-

- Provides a simple HTTP server that allows to accept the WebSocket connection requests. -

-
-

Syntax

-
public class HttpServer
-
-
-

Remarks

-
-

- The HttpServer class provides the multi WebSocket service. -

-

-

- The HttpServer class needs the application configuration file to configure the server root path. -

- - - - - - - -
- - xml Example - -
- 
-            <?xml version="1.0" encoding="utf-8"?>
-            <configuration>
-            <appSettings>
-            <add key="RootPath" value="./Public" />
-            </appSettings>
-            </configuration>
-
-
-

-
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - object. -

-

Public Constructors

-
-
- - - - - - - - - - - -
-
-
- 		-
- - HttpServer - ()
- 		- Initializes a new instance of the WebSocketSharp.Server.HttpServer class that listens for incoming requests - on port 80. -
-
-
- 		-
- - HttpServer - (int)
- 		- Initializes a new instance of the WebSocketSharp.Server.HttpServer class that listens for incoming requests - on the specified port. -
-
-
-

Public Properties

-
-
- - - - - - - - - - - - - - - - -
[read-only]
 - - Port - - - - int - . - Gets the port on which to listen for incoming requests. -
[read-only]
 - - ServicePaths - - - - IEnumerable<string> - . - Gets the collection of paths associated with the every WebSocket services that the server provides. -
-
-
- 		- - Sweeping - - - - bool - . - Gets or sets a value indicating whether the server cleans up the inactive WebSocket service - instances periodically. -
-
-
-

Public Methods

-
-
- - - - - - - - - - - - - - - - - -
-
-
- 		- - AddWebSocketService<T> - (string)
- Adds the specified type WebSocket service. -
-
-
- 		- - GetFile - (string) : byte[]
- Gets the contents of the specified file. -
-
-
- 		- - Start - ()
- Starts the WebSocketSharp.Server.HttpServer. -
-
-
- 		- - Stop - ()
- Shuts down the WebSocketSharp.Server.HttpServer. -
-
-
-

Public Events

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- 		- - OnConnect - - - Occurs when the server receives an HTTP CONNECT request. -
-
-
- 		- - OnDelete - - - Occurs when the server receives an HTTP DELETE request. -
-
-
- 		- - OnError - - - Occurs when the server gets an error. -
-
-
- 		- - OnGet - - - Occurs when the server receives an HTTP GET request. -
-
-
- 		- - OnHead - - - Occurs when the server receives an HTTP HEAD request. -
-
-
- 		- - OnOptions - - - Occurs when the server receives an HTTP OPTIONS request. -
-
-
- 		- - OnPatch - - - Occurs when the server receives an HTTP PATCH request. -
-
-
- 		- - OnPost - - - Occurs when the server receives an HTTP POST request. -
-
-
- 		- - OnPut - - - Occurs when the server receives an HTTP PUT request. -
-
-
- 		- - OnTrace - - - Occurs when the server receives an HTTP TRACE request. -
-
-
-
-
-
-

Member Details

-
-

HttpServer Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Server.HttpServer class that listens for incoming requests - on port 80. -

-

Syntax

-
public HttpServer ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

HttpServer Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Server.HttpServer class that listens for incoming requests - on the specified port. -

-

Syntax

-
public HttpServer (int port)
-

Parameters

-
-
-
- port -
-
- An int that contains a port number. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

AddWebSocketService<T> Generic Method

-
-

- Adds the specified type WebSocket service. -

-

Syntax

-
public void AddWebSocketService<T> (string absPath)
where T : WebSocketSharp.Server.WebSocketService, new()
-

Type Parameters

-
-
-
- T -
-
- The type of the WebSocket service. The T must inherit the WebSocketSharp.Server.WebSocketService class. -
-
-
-

Parameters

-
-
-
- absPath -
-
- A string that contains an absolute path associated with the WebSocket service. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

GetFile Method

-
-

- Gets the contents of the specified file. -

-

Syntax

-
public byte[] GetFile (string path)
-

Parameters

-
-
-
- path -
-
- A string that contains a virtual path to the file to get. -
-
-
-

Returns

-
- An array of byte that contains the contents of the file. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

OnConnect Event

-
-

- Occurs when the server receives an HTTP CONNECT request. -

-

Syntax

-
public event EventHandler<HttpRequestEventArgs> OnConnect
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

OnDelete Event

-
-

- Occurs when the server receives an HTTP DELETE request. -

-

Syntax

-
public event EventHandler<HttpRequestEventArgs> OnDelete
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

OnError Event

-
-

- Occurs when the server gets an error. -

-

Syntax

-
public event EventHandler<WebSocketSharp.ErrorEventArgs> OnError
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

OnGet Event

-
-

- Occurs when the server receives an HTTP GET request. -

-

Syntax

-
public event EventHandler<HttpRequestEventArgs> OnGet
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

OnHead Event

-
-

- Occurs when the server receives an HTTP HEAD request. -

-

Syntax

-
public event EventHandler<HttpRequestEventArgs> OnHead
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

OnOptions Event

-
-

- Occurs when the server receives an HTTP OPTIONS request. -

-

Syntax

-
public event EventHandler<HttpRequestEventArgs> OnOptions
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

OnPatch Event

-
-

- Occurs when the server receives an HTTP PATCH request. -

-

Syntax

-
public event EventHandler<HttpRequestEventArgs> OnPatch
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

OnPost Event

-
-

- Occurs when the server receives an HTTP POST request. -

-

Syntax

-
public event EventHandler<HttpRequestEventArgs> OnPost
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

OnPut Event

-
-

- Occurs when the server receives an HTTP PUT request. -

-

Syntax

-
public event EventHandler<HttpRequestEventArgs> OnPut
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

OnTrace Event

-
-

- Occurs when the server receives an HTTP TRACE request. -

-

Syntax

-
public event EventHandler<HttpRequestEventArgs> OnTrace
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Port Property

-
-

- Gets the port on which to listen for incoming requests. -

-

Syntax

-
public int Port { get; }
-

Value

-
- An int that contains a port number. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ServicePaths Property

-
-

- Gets the collection of paths associated with the every WebSocket services that the server provides. -

-

Syntax

-
public IEnumerable<string> ServicePaths { get; }
-

Value

-
- An IEnumerable<string> that contains the collection of paths. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Start Method

-
-

- Starts the WebSocketSharp.Server.HttpServer. -

-

Syntax

-
public void Start ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Stop Method

-
-

- Shuts down the WebSocketSharp.Server.HttpServer. -

-

Syntax

-
public void Stop ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Sweeping Property

-
-

- Gets or sets a value indicating whether the server cleans up the inactive WebSocket service - instances periodically. -

-

Syntax

-
public bool Sweeping { get; set; }
-

Value

-
- true if the server cleans up the inactive WebSocket service instances every 60 seconds; - otherwise, false. The default value is true. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Server/IServiceHost.html b/websocket-sharp/doc/html/WebSocketSharp.Server/IServiceHost.html deleted file mode 100644 index ef3785a3..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Server/IServiceHost.html +++ /dev/null @@ -1,424 +0,0 @@ - - - WebSocketSharp.Server.IServiceHost - - - - - -
- websocket-sharp : WebSocketSharp.Server Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

IServiceHost Interface

-

- Exposes the methods and properties for the WebSocket service host. -

-
-

Syntax

-
public interface IServiceHost
-
-
-

Remarks

-
-
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

Public Properties

-
-
- - - - - - -
-
-
- 		- - Sweeping - - - - bool - . - Gets or sets a value indicating whether the WebSocket service host cleans up the inactive service - instances periodically. -
-
-
-

Public Methods

-
-
- - - - - - - - - - - - - - - - - -
-
-
- 		- - BindWebSocket - (WebSocketSharp.Net.WebSockets.WebSocketContext)
- Binds the specified WebSocketSharp.Net.WebSockets.WebSocketContext to a WebSocketSharp.Server.WebSocketService instance. -
-
-
- 		- - Broadcast - (string)
- Broadcasts the specified string to all service clients. -
-
-
- 		- - Start - ()
- Starts the WebSocket service host. -
-
-
- 		- - Stop - ()
- Stops the WebSocket service host. -
-
-
-
-
-
-

Member Details

-
-

BindWebSocket Method

-
-

- Binds the specified WebSocketSharp.Net.WebSockets.WebSocketContext to a WebSocketSharp.Server.WebSocketService instance. -

-

Syntax

-
public void BindWebSocket (WebSocketSharp.Net.WebSockets.WebSocketContext context)
-

Parameters

-
-
-
- context -
-
- A WebSocketSharp.Net.WebSockets.WebSocketContext that contains the WebSocket connection request objects to bind. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Broadcast Method

-
-

- Broadcasts the specified string to all service clients. -

-

Syntax

-
public void Broadcast (string data)
-

Parameters

-
-
-
- data -
-
- A string to broadcast. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Start Method

-
-

- Starts the WebSocket service host. -

-

Syntax

-
public void Start ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Stop Method

-
-

- Stops the WebSocket service host. -

-

Syntax

-
public void Stop ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Sweeping Property

-
-

- Gets or sets a value indicating whether the WebSocket service host cleans up the inactive service - instances periodically. -

-

Syntax

-
public bool Sweeping { get; set; }
-

Value

-
- true if the WebSocket service host cleans up the inactive service instances periodically; - otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Server/RequestEventArgs.html b/websocket-sharp/doc/html/WebSocketSharp.Server/RequestEventArgs.html deleted file mode 100644 index 78a3f847..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Server/RequestEventArgs.html +++ /dev/null @@ -1,348 +0,0 @@ - - - WebSocketSharp.Server.RequestEventArgs - - - - - -
- websocket-sharp : WebSocketSharp.Server Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

RequestEventArgs Class

-

- Contains the event data associated with the request events of the WebSocketSharp.Server.HttpServer class. -

-
-

Syntax

-
public class RequestEventArgs : EventArgs
-
-
-

Remarks

-
- A request event occurs when a WebSocketSharp.Server.HttpServer instance receives an HTTP request. - If you want to get the HTTP request objects, you should access the ResponseEventArgs.Request property. - If you want to get the HTTP response objects to send, you should access the ResponseEventArgs.Response property. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - EventArgs. -

-

Public Properties

-
-
- - - - - - - - - - - -
[read-only]
 - - Request - - - - WebSocketSharp.Net.HttpListenerRequest - . - Gets the HTTP request objects sent from a client. -
[read-only]
 - - Response - - - - WebSocketSharp.Net.HttpListenerResponse - . - Gets the HTTP response objects to send to the client in response to the client's request. -
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

Request Property

-
-

- Gets the HTTP request objects sent from a client. -

-

Syntax

-
public WebSocketSharp.Net.HttpListenerRequest Request { get; }
-

Value

-
- A WebSocketSharp.Net.HttpListenerRequest that contains the HTTP request objects. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Response Property

-
-

- Gets the HTTP response objects to send to the client in response to the client's request. -

-

Syntax

-
public WebSocketSharp.Net.HttpListenerResponse Response { get; }
-

Value

-
- A WebSocketSharp.Net.HttpListenerResponse that contains the HTTP response objects. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Server/ResponseEventArgs.html b/websocket-sharp/doc/html/WebSocketSharp.Server/ResponseEventArgs.html deleted file mode 100644 index 25fc4a5e..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Server/ResponseEventArgs.html +++ /dev/null @@ -1,348 +0,0 @@ - - - WebSocketSharp.Server.ResponseEventArgs - - - - - -
- websocket-sharp : WebSocketSharp.Server Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

ResponseEventArgs Class

-

- Contains the event data associated with the response events of the WebSocketSharp.Server.HttpServer class. -

-
-

Syntax

-
public class ResponseEventArgs : EventArgs
-
-
-

Remarks

-
- A response event occurs when a WebSocketSharp.Server.HttpServer instance receives an HTTP request. - If you want to get the HTTP request objects, you should access the ResponseEventArgs.Request property. - If you want to get the HTTP response objects to send, you should access the ResponseEventArgs.Response property. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - EventArgs. -

-

Public Properties

-
-
- - - - - - - - - - - -
[read-only]
 - - Request - - - - WebSocketSharp.Net.HttpListenerRequest - . - Gets the HTTP request objects sent from a client. -
[read-only]
 - - Response - - - - WebSocketSharp.Net.HttpListenerResponse - . - Gets the HTTP response objects to send to the client in response to the client's request. -
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

Request Property

-
-

- Gets the HTTP request objects sent from a client. -

-

Syntax

-
public WebSocketSharp.Net.HttpListenerRequest Request { get; }
-

Value

-
- A WebSocketSharp.Net.HttpListenerRequest that contains the HTTP request objects. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Response Property

-
-

- Gets the HTTP response objects to send to the client in response to the client's request. -

-

Syntax

-
public WebSocketSharp.Net.HttpListenerResponse Response { get; }
-

Value

-
- A WebSocketSharp.Net.HttpListenerResponse that contains the HTTP response objects. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Server/ServiceManager.html b/websocket-sharp/doc/html/WebSocketSharp.Server/ServiceManager.html deleted file mode 100644 index 8cdebda8..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Server/ServiceManager.html +++ /dev/null @@ -1,607 +0,0 @@ - - - WebSocketSharp.Server.ServiceManager - - - - - -
- websocket-sharp : WebSocketSharp.Server Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

ServiceManager Class

-

- Documentation for this section has not yet been entered. -

-
-

Syntax

-
public class ServiceManager
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - object. -

-

Public Constructors

-
-
- - - - - - -
-
-
- 		-
- - ServiceManager - ()
- 		- Documentation for this section has not yet been entered. -
-
-
-

Public Properties

-
-
- - - - - - - - - - - - - - - - - - - - - -
[read-only]
 - - Count - - - - int - . Documentation for this section has not yet been entered.
[read-only]
 - - Path - - - - IEnumerable<string> - . Documentation for this section has not yet been entered.
[read-only]
 - - ServiceHost - - - - IEnumerable<IServiceHost> - . Documentation for this section has not yet been entered.
-
-
- 		- - Sweeped - - - - bool - . Documentation for this section has not yet been entered.
-
-
-

Public Methods

-
-
- - - - - - - - - - - - - - - - - -
-
-
- 		- - Add - (string, IServiceHost)
Documentation for this section has not yet been entered.
-
-
- 		- - Broadcast - (string)
Documentation for this section has not yet been entered.
-
-
- 		- - Stop - ()
Documentation for this section has not yet been entered.
-
-
- 		- - TryGetServiceHost - (string, out IServiceHost) : bool
Documentation for this section has not yet been entered.
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

ServiceManager Constructor

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public ServiceManager ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Add Method

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public void Add (string absPath, IServiceHost svcHost)
-

Parameters

-
-
-
- absPath -
-
- Documentation for this section has not yet been entered. -
-
- svcHost -
-
- Documentation for this section has not yet been entered. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Broadcast Method

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public void Broadcast (string data)
-

Parameters

-
-
-
- data -
-
- Documentation for this section has not yet been entered. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Count Property

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public int Count { get; }
-

Value

-
- Documentation for this section has not yet been entered. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Path Property

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public IEnumerable<string> Path { get; }
-

Value

-
- Documentation for this section has not yet been entered. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ServiceHost Property

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public IEnumerable<IServiceHost> ServiceHost { get; }
-

Value

-
- Documentation for this section has not yet been entered. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Stop Method

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public void Stop ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Sweeped Property

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public bool Sweeped { get; set; }
-

Value

-
- Documentation for this section has not yet been entered. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

TryGetServiceHost Method

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public bool TryGetServiceHost (string absPath, out IServiceHost svcHost)
-

Parameters

-
-
-
- absPath -
-
- Documentation for this section has not yet been entered. -
-
- svcHost -
-
- Documentation for this section has not yet been entered. -
-
-
-

Returns

-
- Documentation for this section has not yet been entered. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Server/SessionManager.html b/websocket-sharp/doc/html/WebSocketSharp.Server/SessionManager.html deleted file mode 100644 index c07f51ff..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Server/SessionManager.html +++ /dev/null @@ -1,857 +0,0 @@ - - - WebSocketSharp.Server.SessionManager - - - - - -
- websocket-sharp : WebSocketSharp.Server Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

SessionManager Class

-

- Documentation for this section has not yet been entered. -

-
-

Syntax

-
public class SessionManager
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - object. -

-

Public Constructors

-
-
- - - - - - -
-
-
- 		-
- - SessionManager - ()
- 		- Documentation for this section has not yet been entered. -
-
-
-

Public Properties

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
[read-only]
 - - ActiveID - - - - IEnumerable<string> - . Documentation for this section has not yet been entered.
[read-only]
 - - Count - - - - int - . Documentation for this section has not yet been entered.
[read-only]
 - - ID - - - - IEnumerable<string> - . Documentation for this section has not yet been entered.
[read-only]
 - - InactiveID - - - - IEnumerable<string> - . Documentation for this section has not yet been entered.
-
-
- 		- - Sweeped - - - - bool - . Documentation for this section has not yet been entered.
[read-only]
 - - SyncRoot - - - - object - . Documentation for this section has not yet been entered.
-
-
-

Public Methods

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- 		- - Add - (WebSocketService) : string
Documentation for this section has not yet been entered.
-
-
- 		- - Broadcast - (byte[])
Documentation for this section has not yet been entered.
-
-
- 		- - Broadcast - (string)
Documentation for this section has not yet been entered.
-
-
- 		- - Broadping - (string) : Dictionary<string, bool>
Documentation for this section has not yet been entered.
-
-
- 		- - Remove - (string) : bool
Documentation for this section has not yet been entered.
-
-
- 		- - Stop - ()
Documentation for this section has not yet been entered.
-
-
- 		- - Stop - (WebSocketSharp.CloseStatusCode, string)
Documentation for this section has not yet been entered.
-
-
- 		- - Sweep - ()
Documentation for this section has not yet been entered.
-
-
- 		- - TryGetByID - (string, out WebSocketService) : bool
Documentation for this section has not yet been entered.
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

SessionManager Constructor

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public SessionManager ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ActiveID Property

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public IEnumerable<string> ActiveID { get; }
-

Value

-
- Documentation for this section has not yet been entered. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Add Method

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public string Add (WebSocketService service)
-

Parameters

-
-
-
- service -
-
- Documentation for this section has not yet been entered. -
-
-
-

Returns

-
- Documentation for this section has not yet been entered. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Broadcast Method

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public void Broadcast (byte[] data)
-

Parameters

-
-
-
- data -
-
- Documentation for this section has not yet been entered. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Broadcast Method

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public void Broadcast (string data)
-

Parameters

-
-
-
- data -
-
- Documentation for this section has not yet been entered. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Broadping Method

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public Dictionary<string, bool> Broadping (string message)
-

Parameters

-
-
-
- message -
-
- Documentation for this section has not yet been entered. -
-
-
-

Returns

-
- Documentation for this section has not yet been entered. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Count Property

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public int Count { get; }
-

Value

-
- Documentation for this section has not yet been entered. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ID Property

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public IEnumerable<string> ID { get; }
-

Value

-
- Documentation for this section has not yet been entered. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

InactiveID Property

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public IEnumerable<string> InactiveID { get; }
-

Value

-
- Documentation for this section has not yet been entered. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Remove Method

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public bool Remove (string id)
-

Parameters

-
-
-
- id -
-
- Documentation for this section has not yet been entered. -
-
-
-

Returns

-
- Documentation for this section has not yet been entered. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Stop Method

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public void Stop ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Stop Method

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public void Stop (WebSocketSharp.CloseStatusCode code, string reason)
-

Parameters

-
-
-
- code -
-
- Documentation for this section has not yet been entered. -
-
- reason -
-
- Documentation for this section has not yet been entered. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Sweep Method

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public void Sweep ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Sweeped Property

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public bool Sweeped { get; set; }
-

Value

-
- Documentation for this section has not yet been entered. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

SyncRoot Property

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public object SyncRoot { get; }
-

Value

-
- Documentation for this section has not yet been entered. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

TryGetByID Method

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public bool TryGetByID (string id, out WebSocketService service)
-

Parameters

-
-
-
- id -
-
- Documentation for this section has not yet been entered. -
-
- service -
-
- Documentation for this section has not yet been entered. -
-
-
-

Returns

-
- Documentation for this section has not yet been entered. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Server/WebSocketServer.html b/websocket-sharp/doc/html/WebSocketSharp.Server/WebSocketServer.html deleted file mode 100644 index 344ad7fd..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Server/WebSocketServer.html +++ /dev/null @@ -1,920 +0,0 @@ - - - WebSocketSharp.Server.WebSocketServer - - - - - -
- websocket-sharp : WebSocketSharp.Server Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

WebSocketServer Class

-

- Provides the functions of the server that receives the WebSocket connection requests. -

-
-

Syntax

-
public class WebSocketServer : WebSocketServerBase
-
-
-

Remarks

-
- The WebSocketServer class provides the multi WebSocket service. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - WebSocketServerBase. -

-

Public Constructors

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- 		-
- - WebSocketServer - ()
- 		- Initializes a new instance of the WebSocketSharp.Server.WebSocketServer class. -
-
-
- 		- - - Initializes a new instance of the WebSocketSharp.Server.WebSocketServer class that listens for incoming connection attempts - on the specified port. -
-
-
- 		- - - Initializes a new instance of the WebSocketSharp.Server.WebSocketServer class that listens for incoming connection attempts - on the specified WebSocket URL. -
-
-
- 		- - - Initializes a new instance of the WebSocketSharp.Server.WebSocketServer class that listens for incoming connection attempts - on the specified port and secure. -
-
-
- 		- - - Initializes a new instance of the WebSocketSharp.Server.WebSocketServer class that listens for incoming connection attempts - on the specified address and port. -
-
-
- 		- - - Initializes a new instance of the WebSocketSharp.Server.WebSocketServer class that listens for incoming connection attempts - on the specified address, port and secure. -
-
-
-

Public Properties

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
[read-only]
 - - Address - - - - System.Net.IPAddress - . - Gets the local IP address on which to listen for incoming connection attempts. - (Inherited from WebSocketServerBase.)
[read-only]
 - - IsSecure - - - - bool - . - Gets a value indicating whether the server provides secure connection. - (Inherited from WebSocketServerBase.)
[read-only]
 - - IsSelfHost - - - - bool - . - Gets a value indicating whether the server is self host. - (Inherited from WebSocketServerBase.)
[read-only]
 - - Port - - - - int - . - Gets the port on which to listen for incoming connection attempts. - (Inherited from WebSocketServerBase.)
[read-only]
 - - ServicePaths - - - - IEnumerable<string> - . - Gets the collection of paths associated with the every WebSocket services that the server provides. -
-
-
- 		- - Sweeping - - - - bool - . - Gets or sets a value indicating whether the server cleans up the inactive WebSocket service - instances periodically. -
-
-
-

Protected Properties

-
-
- - - - - - -
-
-
- 		- - BaseUri - - - - Uri - . - Gets or sets the WebSocket URL on which to listen for incoming connection attempts. - (Inherited from WebSocketServerBase.)
-
-
-

Public Methods

-
-
- - - - - - - - - - - - - - - - - - - - - -
-
-
- 		- - AddWebSocketService<T> - (string)
- Adds the specified type WebSocket service. -
-
-
- 		- - Broadcast - (string)
- Broadcasts the specified string to all clients. -
-
-
- 		- - Start - ()
- Starts to receive the WebSocket connection requests. - (Inherited from WebSocketServerBase.)
-
override
- 		- - Stop - ()
- Stops receiving the WebSocket connection requests. -
-
-
- 		- - Stop - ()
- Stops receiving the WebSocket connection requests. - (Inherited from WebSocketServerBase.)
-
-
-

Protected Methods

-
-
- - - - - - - - - - - - - -
-
override
- 		- - AcceptWebSocket - (WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext)
- Accepts a WebSocket connection request. -
-
abstract
- 		- - AcceptWebSocket - (WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext)
- Accepts a WebSocket connection request. - (Inherited from WebSocketServerBase.)
-
-
- 		- - Error - (string)
- Occurs the WebSocketServerBase.OnError event with the specified string. - (Inherited from WebSocketServerBase.)
-
-
-

Public Events

-
-
- - - - - - -
-
-
- 		- - OnError - - - Occurs when the server gets an error. - (Inherited from WebSocketServerBase.)
-
-
-
-
-
-

Member Details

-
-

WebSocketServer Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Server.WebSocketServer class. -

-

Syntax

-
public WebSocketServer ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

WebSocketServer Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Server.WebSocketServer class that listens for incoming connection attempts - on the specified port. -

-

Syntax

-
public WebSocketServer (int port)
-

Parameters

-
-
-
- port -
-
- An int that contains a port number. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

WebSocketServer Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Server.WebSocketServer class that listens for incoming connection attempts - on the specified WebSocket URL. -

-

Syntax

-
public WebSocketServer (string url)
-

Parameters

-
-
-
- url -
-
- A string that contains a WebSocket URL. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

WebSocketServer Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Server.WebSocketServer class that listens for incoming connection attempts - on the specified port and secure. -

-

Syntax

-
public WebSocketServer (int port, bool secure)
-

Parameters

-
-
-
- port -
-
- An int that contains a port number. -
-
- secure -
-
- A bool that indicates providing a secure connection or not. (true indicates providing a secure connection.) -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

WebSocketServer Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Server.WebSocketServer class that listens for incoming connection attempts - on the specified address and port. -

-

Syntax

-
public WebSocketServer (System.Net.IPAddress address, int port)
-

Parameters

-
-
-
- address -
-
- A System.Net.IPAddress that contains a local IP address. -
-
- port -
-
- An int that contains a port number. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

WebSocketServer Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Server.WebSocketServer class that listens for incoming connection attempts - on the specified address, port and secure. -

-

Syntax

-
public WebSocketServer (System.Net.IPAddress address, int port, bool secure)
-

Parameters

-
-
-
- address -
-
- A System.Net.IPAddress that contains a local IP address. -
-
- port -
-
- An int that contains a port number. -
-
- secure -
-
- A bool that indicates providing a secure connection or not. (true indicates providing a secure connection.) -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

AcceptWebSocket Method

-
-

- Accepts a WebSocket connection request. -

-

Syntax

-
protected override void AcceptWebSocket (WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext context)
-

Parameters

-
-
-
- context -
-
- A WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext that contains the WebSocket connection request objects. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

AddWebSocketService<T> Generic Method

-
-

- Adds the specified type WebSocket service. -

-

Syntax

-
public void AddWebSocketService<T> (string absPath)
where T : WebSocketSharp.Server.WebSocketService, new()
-

Type Parameters

-
-
-
- T -
-
- The type of the WebSocket service. The T must inherit the WebSocketSharp.Server.WebSocketService class. -
-
-
-

Parameters

-
-
-
- absPath -
-
- A string that contains an absolute path associated with the WebSocket service. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Broadcast Method

-
-

- Broadcasts the specified string to all clients. -

-

Syntax

-
public void Broadcast (string data)
-

Parameters

-
-
-
- data -
-
- A string to broadcast. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ServicePaths Property

-
-

- Gets the collection of paths associated with the every WebSocket services that the server provides. -

-

Syntax

-
public IEnumerable<string> ServicePaths { get; }
-

Value

-
- An IEnumerable<string> that contains the collection of paths. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Stop Method

-
-

- Stops receiving the WebSocket connection requests. -

-

Syntax

-
public override void Stop ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Sweeping Property

-
-

- Gets or sets a value indicating whether the server cleans up the inactive WebSocket service - instances periodically. -

-

Syntax

-
public bool Sweeping { get; set; }
-

Value

-
- true if the server cleans up the inactive WebSocket service instances every 60 seconds; - otherwise, false. The default value is true. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Server/WebSocketServerBase.html b/websocket-sharp/doc/html/WebSocketSharp.Server/WebSocketServerBase.html deleted file mode 100644 index ad667e68..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Server/WebSocketServerBase.html +++ /dev/null @@ -1,844 +0,0 @@ - - - WebSocketSharp.Server.WebSocketServerBase - - - - - -
- websocket-sharp : WebSocketSharp.Server Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

WebSocketServerBase Class

-

- Provides the basic functions of the server that receives the WebSocket connection requests. -

-
-

Syntax

-
public abstract class WebSocketServerBase
-
-
-

Remarks

-
- The WebSocketServerBase class is an abstract class. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - object. -

-

Protected Constructors

-
-
- - - - - - - - - - - - - - - - -
-
-
- 		- - - Initializes a new instance of the WebSocketSharp.Server.WebSocketServerBase class. -
-
-
- 		- - - Initializes a new instance of the WebSocketSharp.Server.WebSocketServerBase class that listens for incoming connection attempts - on the specified WebSocket URL. -
-
-
- 		- - - Initializes a new instance of the WebSocketSharp.Server.WebSocketServerBase class that listens for incoming connection attempts - on the specified address, port, absPath and secure. -
-
-
-

Public Properties

-
-
- - - - - - - - - - - - - - - - - - - - - -
[read-only]
 - - Address - - - - System.Net.IPAddress - . - Gets the local IP address on which to listen for incoming connection attempts. -
[read-only]
 - - IsSecure - - - - bool - . - Gets a value indicating whether the server provides secure connection. -
[read-only]
 - - IsSelfHost - - - - bool - . - Gets a value indicating whether the server is self host. -
[read-only]
 - - Port - - - - int - . - Gets the port on which to listen for incoming connection attempts. -
-
-
-

Protected Properties

-
-
- - - - - - -
-
-
- 		- - BaseUri - - - - Uri - . - Gets or sets the WebSocket URL on which to listen for incoming connection attempts. -
-
-
-

Public Methods

-
-
- - - - - - - - - -
-
-
- 		- - Start - ()
- Starts to receive the WebSocket connection requests. -
-
-
- 		- - Stop - ()
- Stops receiving the WebSocket connection requests. -
-
-
-

Protected Methods

-
-
- - - - - - - - - -
-
abstract
- 		- - AcceptWebSocket - (WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext)
- Accepts a WebSocket connection request. -
-
-
- 		- - Error - (string)
- Occurs the WebSocketServerBase.OnError event with the specified string. -
-
-
-

Public Events

-
-
- - - - - - -
-
-
- 		- - OnError - - - Occurs when the server gets an error. -
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

WebSocketServerBase Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Server.WebSocketServerBase class. -

-

Syntax

-
protected WebSocketServerBase ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

WebSocketServerBase Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Server.WebSocketServerBase class that listens for incoming connection attempts - on the specified WebSocket URL. -

-

Syntax

-
protected WebSocketServerBase (string url)
-

Parameters

-
-
-
- url -
-
- A string that contains a WebSocket URL. -
-
-
-

Exceptions

-
- - - - - - - - - - - - - -
TypeReason
- ArgumentNullException - - url is null. -
- ArgumentException - - url is invalid. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

WebSocketServerBase Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Server.WebSocketServerBase class that listens for incoming connection attempts - on the specified address, port, absPath and secure. -

-

Syntax

-
protected WebSocketServerBase (System.Net.IPAddress address, int port, string absPath, bool secure)
-

Parameters

-
-
-
- address -
-
- A System.Net.IPAddress that contains a local IP address. -
-
- port -
-
- An int that contains a port number. -
-
- absPath -
-
- A string that contains an absolute path. -
-
- secure -
-
- A bool that indicates providing a secure connection or not. (true indicates providing a secure connection.) -
-
-
-

Exceptions

-
- - - - - - - - - - - - - -
TypeReason
- ArgumentNullException - - Either address or absPath is null. -
- ArgumentException - -

- absPath is invalid. -

-

- -or- -

-

- Pair of port and secure is invalid. -

-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

AcceptWebSocket Method

-
-

- Accepts a WebSocket connection request. -

-

Syntax

-
protected abstract void AcceptWebSocket (WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext context)
-

Parameters

-
-
-
- context -
-
- A WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext that contains the WebSocket connection request objects. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Address Property

-
-

- Gets the local IP address on which to listen for incoming connection attempts. -

-

Syntax

-
public System.Net.IPAddress Address { get; }
-

Value

-
- A System.Net.IPAddress that contains a local IP address. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

BaseUri Property

-
-

- Gets or sets the WebSocket URL on which to listen for incoming connection attempts. -

-

Syntax

-
protected Uri BaseUri { get; set; }
-

Value

-
- A Uri that contains a WebSocket URL. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Error Method

-
-

- Occurs the WebSocketServerBase.OnError event with the specified string. -

-

Syntax

-
protected virtual void Error (string message)
-

Parameters

-
-
-
- message -
-
- A string that contains an error message. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsSecure Property

-
-

- Gets a value indicating whether the server provides secure connection. -

-

Syntax

-
public bool IsSecure { get; }
-

Value

-
- true if the server provides secure connection; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsSelfHost Property

-
-

- Gets a value indicating whether the server is self host. -

-

Syntax

-
public bool IsSelfHost { get; }
-

Value

-
- true if the server is self host; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

OnError Event

-
-

- Occurs when the server gets an error. -

-

Syntax

-
public event EventHandler<WebSocketSharp.ErrorEventArgs> OnError
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Port Property

-
-

- Gets the port on which to listen for incoming connection attempts. -

-

Syntax

-
public int Port { get; }
-

Value

-
- An int that contains a port number. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Start Method

-
-

- Starts to receive the WebSocket connection requests. -

-

Syntax

-
public virtual void Start ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Stop Method

-
-

- Stops receiving the WebSocket connection requests. -

-

Syntax

-
public virtual void Stop ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Server/WebSocketService.html b/websocket-sharp/doc/html/WebSocketSharp.Server/WebSocketService.html deleted file mode 100644 index 69e4f96a..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Server/WebSocketService.html +++ /dev/null @@ -1,1319 +0,0 @@ - - - WebSocketSharp.Server.WebSocketService - - - - - -
- websocket-sharp : WebSocketSharp.Server Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

WebSocketService Class

-

- Provides the basic functions of the WebSocket service. -

-
-

Syntax

-
public abstract class WebSocketService
-
-
-

Remarks

-
- The WebSocketService class is an abstract class. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - object. -

-

Public Constructors

-
-
- - - - - - -
-
-
- 		- - - Initializes a new instance of the WebSocketSharp.Server.WebSocketService class. -
-
-
-

Public Properties

-
-
- - - - - - - - - - - -
[read-only]
 - - ID - - - - string - . - Gets the ID of the WebSocketSharp.Server.WebSocketService instance. -
[read-only]
 - - IsBound - - - - bool - . - Gets a value indicating whether the WebSocketSharp.Server.WebSocketService instance is bound to a WebSocketSharp.WebSocket. -
-
-
-

Protected Properties

-
-
- - - - - - - - - - - -
[read-only]
 - - QueryString - - - - System.Collections.Specialized.NameValueCollection - . - Gets the collection of query string variables used in the WebSocket opening handshake. -
[read-only]
 - - Sessions - - - - WebSocketServiceManager - . - Gets the sessions to the WebSocketSharp.Server.WebSocketService. -
-
-
-

Public Methods

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- 		- - Broadcast - (byte[])
- Broadcasts the specified array of byte to the clients of every WebSocketSharp.Server.WebSocketService instances - in the WebSocketService.Sessions. -
-
-
- 		- - Broadcast - (string)
- Broadcasts the specified string to the clients of every WebSocketSharp.Server.WebSocketService instances - in the WebSocketService.Sessions. -
-
-
- 		- - Broadping - () : Dictionary<string, bool>
- Pings to the clients of every WebSocketSharp.Server.WebSocketService instances - in the WebSocketService.Sessions. -
-
-
- 		- - Broadping - (string) : Dictionary<string, bool>
- Pings with the specified string to the clients of every WebSocketSharp.Server.WebSocketService instances - in the WebSocketService.Sessions. -
-
-
- 		- - Ping - () : bool
- Pings to the client of the WebSocketSharp.Server.WebSocketService instance. -
-
-
- 		- - Ping - (string) : bool
- Pings with the specified string to the client of the WebSocketSharp.Server.WebSocketService instance. -
-
-
- 		- - PingTo - (string) : bool
- Pings to the client of the WebSocketSharp.Server.WebSocketService instance - associated with the specified id. -
-
-
- 		- - PingTo - (string, string) : bool
- Pings with the specified string to the client of the WebSocketSharp.Server.WebSocketService instance - associated with the specified id. -
-
-
- 		- - Send - (byte[])
- Sends a binary data to the client of the WebSocketSharp.Server.WebSocketService instance. -
-
-
- 		- - Send - (string)
- Sends a text data to the client of the WebSocketSharp.Server.WebSocketService instance. -
-
-
- 		- - SendTo - (string, byte[])
- Sends a binary data to the client of the WebSocketSharp.Server.WebSocketService instance - associated with the specified id. -
-
-
- 		- - SendTo - (string, string)
- Sends a text data to the client of the WebSocketSharp.Server.WebSocketService instance - associated with the specified id. -
-
-
- 		- - Start - ()
- Starts the WebSocketSharp.Server.WebSocketService instance. -
-
-
- 		- - Stop - ()
- Stops the WebSocketSharp.Server.WebSocketService instance. -
-
-
- 		- - Stop - (ushort, string)
- Stops the WebSocketSharp.Server.WebSocketService instance with the specified ushort and string. -
-
-
- 		- - Stop - (WebSocketSharp.CloseStatusCode, string)
- Stops the WebSocketSharp.Server.WebSocketService instance with the specified WebSocketSharp.CloseStatusCode and string. -
-
-
-

Protected Methods

-
-
- - - - - - - - - - - - - - - - - - - - - -
-
-
- 		- - OnClose - (WebSocketSharp.CloseEventArgs)
- Occurs when the inner WebSocketSharp.WebSocket receives a Close frame or the Stop method is called. -
-
-
- 		- - OnError - (WebSocketSharp.ErrorEventArgs)
- Occurs when the inner WebSocketSharp.WebSocket gets an error. -
-
-
- 		- - OnMessage - (WebSocketSharp.MessageEventArgs)
- Occurs when the inner WebSocketSharp.WebSocket receives a data frame. -
-
-
- 		- - OnOpen - ()
- Occurs when the WebSocket connection has been established. -
-
-
- 		- - ProcessCookies - (WebSocketSharp.Net.CookieCollection, WebSocketSharp.Net.CookieCollection) : bool
- Processes the cookies used in the WebSocket opening handshake. -
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

WebSocketService Constructor

-
-

- Initializes a new instance of the WebSocketSharp.Server.WebSocketService class. -

-

Syntax

-
public WebSocketService ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Broadcast Method

-
-

- Broadcasts the specified array of byte to the clients of every WebSocketSharp.Server.WebSocketService instances - in the WebSocketService.Sessions. -

-

Syntax

-
public void Broadcast (byte[] data)
-

Parameters

-
-
-
- data -
-
- An array of byte to broadcast. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Broadcast Method

-
-

- Broadcasts the specified string to the clients of every WebSocketSharp.Server.WebSocketService instances - in the WebSocketService.Sessions. -

-

Syntax

-
public void Broadcast (string data)
-

Parameters

-
-
-
- data -
-
- A string to broadcast. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Broadping Method

-
-

- Pings to the clients of every WebSocketSharp.Server.WebSocketService instances - in the WebSocketService.Sessions. -

-

Syntax

-
public Dictionary<string, bool> Broadping ()
-

Returns

-
- A Dictionary<string, bool> that contains the collection of IDs and values - indicating whether each WebSocketSharp.Server.WebSocketService instances received a Pong in a time. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Broadping Method

-
-

- Pings with the specified string to the clients of every WebSocketSharp.Server.WebSocketService instances - in the WebSocketService.Sessions. -

-

Syntax

-
public Dictionary<string, bool> Broadping (string message)
-

Parameters

-
-
-
- message -
-
- A string that contains a message. -
-
-
-

Returns

-
- A Dictionary<string, bool> that contains the collection of IDs and values - indicating whether each WebSocketSharp.Server.WebSocketService instances received a Pong in a time. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ID Property

-
-

- Gets the ID of the WebSocketSharp.Server.WebSocketService instance. -

-

Syntax

-
public string ID { get; }
-

Value

-
- A string that contains an ID. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsBound Property

-
-

- Gets a value indicating whether the WebSocketSharp.Server.WebSocketService instance is bound to a WebSocketSharp.WebSocket. -

-

Syntax

-
public bool IsBound { get; }
-

Value

-
- true if the WebSocketSharp.Server.WebSocketService instance is bound to a WebSocketSharp.WebSocket; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

OnClose Method

-
-

- Occurs when the inner WebSocketSharp.WebSocket receives a Close frame or the Stop method is called. -

-

Syntax

-
protected virtual void OnClose (WebSocketSharp.CloseEventArgs e)
-

Parameters

-
-
-
- e -
-
- A WebSocketSharp.CloseEventArgs that contains the event data associated with a WebSocketSharp.WebSocket.OnClose event. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

OnError Method

-
-

- Occurs when the inner WebSocketSharp.WebSocket gets an error. -

-

Syntax

-
protected virtual void OnError (WebSocketSharp.ErrorEventArgs e)
-

Parameters

-
-
-
- e -
-
- An WebSocketSharp.ErrorEventArgs that contains the event data associated with a WebSocketSharp.WebSocket.OnError event. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

OnMessage Method

-
-

- Occurs when the inner WebSocketSharp.WebSocket receives a data frame. -

-

Syntax

-
protected virtual void OnMessage (WebSocketSharp.MessageEventArgs e)
-

Parameters

-
-
-
- e -
-
- A WebSocketSharp.MessageEventArgs that contains the event data associated with a WebSocketSharp.WebSocket.OnMessage event. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

OnOpen Method

-
-

- Occurs when the WebSocket connection has been established. -

-

Syntax

-
protected virtual void OnOpen ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Ping Method

-
-

- Pings to the client of the WebSocketSharp.Server.WebSocketService instance. -

-

Syntax

-
public bool Ping ()
-

Returns

-
- true if the WebSocketSharp.Server.WebSocketService instance receives a Pong in a time; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Ping Method

-
-

- Pings with the specified string to the client of the WebSocketSharp.Server.WebSocketService instance. -

-

Syntax

-
public bool Ping (string message)
-

Parameters

-
-
-
- message -
-
- A string that contains a message. -
-
-
-

Returns

-
- true if the WebSocketSharp.Server.WebSocketService instance receives a Pong in a time; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

PingTo Method

-
-

- Pings to the client of the WebSocketSharp.Server.WebSocketService instance - associated with the specified id. -

-

Syntax

-
public bool PingTo (string id)
-

Parameters

-
-
-
- id -
-
- A string that contains an ID that represents the destination for the Ping. -
-
-
-

Returns

-
- true if the WebSocketSharp.Server.WebSocketService instance receives a Pong in a time; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

PingTo Method

-
-

- Pings with the specified string to the client of the WebSocketSharp.Server.WebSocketService instance - associated with the specified id. -

-

Syntax

-
public bool PingTo (string id, string message)
-

Parameters

-
-
-
- id -
-
- A string that contains an ID that represents the destination for the Ping. -
-
- message -
-
- A string that contains a message. -
-
-
-

Returns

-
- true if the WebSocketSharp.Server.WebSocketService instance receives a Pong in a time; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ProcessCookies Method

-
-

- Processes the cookies used in the WebSocket opening handshake. -

-

Syntax

-
protected virtual bool ProcessCookies (WebSocketSharp.Net.CookieCollection request, WebSocketSharp.Net.CookieCollection response)
-

Parameters

-
-
-
- request -
-
- A WebSocketSharp.Net.CookieCollection that contains a collection of the HTTP Cookies received from the client. -
-
- response -
-
- A WebSocketSharp.Net.CookieCollection that contains a collection of the HTTP Cookies to send to the client. -
-
-
-

Returns

-
- true if processing the cookies is successfully; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

QueryString Property

-
-

- Gets the collection of query string variables used in the WebSocket opening handshake. -

-

Syntax

-
protected System.Collections.Specialized.NameValueCollection QueryString { get; }
-

Value

-
- A System.Collections.Specialized.NameValueCollection that contains the collection of query string variables. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Send Method

-
-

- Sends a binary data to the client of the WebSocketSharp.Server.WebSocketService instance. -

-

Syntax

-
public void Send (byte[] data)
-

Parameters

-
-
-
- data -
-
- An array of byte that contains a binary data to send. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Send Method

-
-

- Sends a text data to the client of the WebSocketSharp.Server.WebSocketService instance. -

-

Syntax

-
public void Send (string data)
-

Parameters

-
-
-
- data -
-
- A string that contains a text data to send. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

SendTo Method

-
-

- Sends a binary data to the client of the WebSocketSharp.Server.WebSocketService instance - associated with the specified id. -

-

Syntax

-
public void SendTo (string id, byte[] data)
-

Parameters

-
-
-
- id -
-
- A string that contains an ID that represents the destination for the data. -
-
- data -
-
- An array of byte that contains a binary data to send. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

SendTo Method

-
-

- Sends a text data to the client of the WebSocketSharp.Server.WebSocketService instance - associated with the specified id. -

-

Syntax

-
public void SendTo (string id, string data)
-

Parameters

-
-
-
- id -
-
- A string that contains an ID that represents the destination for the data. -
-
- data -
-
- A string that contains a text data to send. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Sessions Property

-
-

- Gets the sessions to the WebSocketSharp.Server.WebSocketService. -

-

Syntax

-
protected WebSocketServiceManager Sessions { get; }
-

Value

-
- A WebSocketSharp.Server.WebSocketServiceManager that contains the sessions to the the WebSocketSharp.Server.WebSocketService. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Start Method

-
-

- Starts the WebSocketSharp.Server.WebSocketService instance. -

-

Syntax

-
public void Start ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Stop Method

-
-

- Stops the WebSocketSharp.Server.WebSocketService instance. -

-

Syntax

-
public void Stop ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Stop Method

-
-

- Stops the WebSocketSharp.Server.WebSocketService instance with the specified ushort and string. -

-

Syntax

-
public void Stop (ushort code, string reason)
-

Parameters

-
-
-
- code -
-
- A ushort that contains a status code indicating the reason for stop. -
-
- reason -
-
- A string that contains a reason for stop. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Stop Method

-
-

- Stops the WebSocketSharp.Server.WebSocketService instance with the specified WebSocketSharp.CloseStatusCode and string. -

-

Syntax

-
public void Stop (WebSocketSharp.CloseStatusCode code, string reason)
-

Parameters

-
-
-
- code -
-
- One of the WebSocketSharp.CloseStatusCode values that contains a status code indicating the reason for stop. -
-
- reason -
-
- A string that contains a reason for stop. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Server/WebSocketServiceHost`1.html b/websocket-sharp/doc/html/WebSocketSharp.Server/WebSocketServiceHost`1.html deleted file mode 100644 index 16496bba..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Server/WebSocketServiceHost`1.html +++ /dev/null @@ -1,1061 +0,0 @@ - - - WebSocketSharp.Server.WebSocketServiceHost<T> - - - - - -
- websocket-sharp : WebSocketSharp.Server Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

WebSocketServiceHost<T> Generic Class

-

- Provides the functions of the server that receives the WebSocket connection requests. -

-
-

Syntax

-
public class WebSocketServiceHost<T> : WebSocketServerBase, IServiceHost
where T : WebSocketSharp.Server.WebSocketService, new()
-
-
-

Type Parameters

-
-
-
- T -
-
- The type of the WebSocket service that the server provides. The T must inherit the WebSocketSharp.Server.WebSocketService class. -
-
-
-

Remarks

-
- The WebSocketServiceHost<T> class provides the single WebSocket service. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - WebSocketServerBase. -

-

Public Constructors

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- 		- - - Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified port. -
-
-
- 		- - - Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified WebSocket URL. -
-
-
- 		- - - Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified port and secure. -
-
-
- 		- - - Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified port and absPath. -
-
-
- 		- - - Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified port, absPath and secure. -
-
-
- 		- - - Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified address, port and absPath. -
-
-
- 		- - - Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified address, port, absPath and secure. -
-
-
-

Public Properties

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
[read-only]
 - - Address - - - - System.Net.IPAddress - . - Gets the local IP address on which to listen for incoming connection attempts. - (Inherited from WebSocketServerBase.)
[read-only]
 - - IsSecure - - - - bool - . - Gets a value indicating whether the server provides secure connection. - (Inherited from WebSocketServerBase.)
[read-only]
 - - IsSelfHost - - - - bool - . - Gets a value indicating whether the server is self host. - (Inherited from WebSocketServerBase.)
[read-only]
 - - Port - - - - int - . - Gets the port on which to listen for incoming connection attempts. - (Inherited from WebSocketServerBase.)
-
-
- 		- - Sweeping - - - - bool - . - Gets or sets a value indicating whether the server cleans up the inactive WebSocket service - instances periodically. -
[read-only]
 - - Uri - - - - Uri - . - Gets the WebSocket URL on which to listen for incoming connection attempts. -
-
-
-

Protected Properties

-
-
- - - - - - -
-
-
- 		- - BaseUri - - - - Uri - . - Gets or sets the WebSocket URL on which to listen for incoming connection attempts. - (Inherited from WebSocketServerBase.)
-
-
-

Public Methods

-
-
- - - - - - - - - - - - - - - - - - - - - -
-
-
- 		- - Broadcast - (string)
- Broadcasts the specified string to all clients. -
-
-
- 		- - Broadping - (string) : Dictionary<string, bool>
- Pings with the specified string to all clients. -
-
-
- 		- - Start - ()
- Starts to receive the WebSocket connection requests. - (Inherited from WebSocketServerBase.)
-
override
- 		- - Stop - ()
- Stops receiving the WebSocket connection requests. -
-
-
- 		- - Stop - ()
- Stops receiving the WebSocket connection requests. - (Inherited from WebSocketServerBase.)
-
-
-

Protected Methods

-
-
- - - - - - - - - - - - - -
-
override
- 		- - AcceptWebSocket - (WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext)
- Accepts a WebSocket connection request. -
-
abstract
- 		- - AcceptWebSocket - (WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext)
- Accepts a WebSocket connection request. - (Inherited from WebSocketServerBase.)
-
-
- 		- - Error - (string)
- Occurs the WebSocketServerBase.OnError event with the specified string. - (Inherited from WebSocketServerBase.)
-
-
-

Public Events

-
-
- - - - - - -
-
-
- 		- - OnError - - - Occurs when the server gets an error. - (Inherited from WebSocketServerBase.)
-
-
-

Explicitly Implemented Interface Members

- -
-
-
-

Member Details

-
-

WebSocketServiceHost Constructor

-
-

- Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified port. -

-

Syntax

-
public WebSocketServiceHost (int port)
-

Parameters

-
-
-
- port -
-
- An int that contains a port number. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

WebSocketServiceHost Constructor

-
-

- Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified WebSocket URL. -

-

Syntax

-
public WebSocketServiceHost (string url)
-

Parameters

-
-
-
- url -
-
- A string that contains a WebSocket URL. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

WebSocketServiceHost Constructor

-
-

- Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified port and secure. -

-

Syntax

-
public WebSocketServiceHost (int port, bool secure)
-

Parameters

-
-
-
- port -
-
- An int that contains a port number. -
-
- secure -
-
- A bool that indicates providing a secure connection or not. (true indicates providing a secure connection.) -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

WebSocketServiceHost Constructor

-
-

- Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified port and absPath. -

-

Syntax

-
public WebSocketServiceHost (int port, string absPath)
-

Parameters

-
-
-
- port -
-
- An int that contains a port number. -
-
- absPath -
-
- A string that contains an absolute path. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

WebSocketServiceHost Constructor

-
-

- Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified port, absPath and secure. -

-

Syntax

-
public WebSocketServiceHost (int port, string absPath, bool secure)
-

Parameters

-
-
-
- port -
-
- An int that contains a port number. -
-
- absPath -
-
- A string that contains an absolute path. -
-
- secure -
-
- A bool that indicates providing a secure connection or not. (true indicates providing a secure connection.) -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

WebSocketServiceHost Constructor

-
-

- Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified address, port and absPath. -

-

Syntax

-
public WebSocketServiceHost (System.Net.IPAddress address, int port, string absPath)
-

Parameters

-
-
-
- address -
-
- A System.Net.IPAddress that contains a local IP address. -
-
- port -
-
- An int that contains a port number. -
-
- absPath -
-
- A string that contains an absolute path. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

WebSocketServiceHost Constructor

-
-

- Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified address, port, absPath and secure. -

-

Syntax

-
public WebSocketServiceHost (System.Net.IPAddress address, int port, string absPath, bool secure)
-

Parameters

-
-
-
- address -
-
- A System.Net.IPAddress that contains a local IP address. -
-
- port -
-
- An int that contains a port number. -
-
- absPath -
-
- A string that contains an absolute path. -
-
- secure -
-
- A bool that indicates providing a secure connection or not. (true indicates providing a secure connection.) -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

AcceptWebSocket Method

-
-

- Accepts a WebSocket connection request. -

-

Syntax

-
protected override void AcceptWebSocket (WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext context)
-

Parameters

-
-
-
- context -
-
- A WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext that contains the WebSocket connection request objects. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Broadcast Method

-
-

- Broadcasts the specified string to all clients. -

-

Syntax

-
public void Broadcast (string data)
-

Parameters

-
-
-
- data -
-
- A string to broadcast. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Broadping Method

-
-

- Pings with the specified string to all clients. -

-

Syntax

-
public Dictionary<string, bool> Broadping (string message)
-

Parameters

-
-
-
- message -
-
- A string that contains a message. -
-
-
-

Returns

-
- A Dictionary<string, bool> that contains the collection of session IDs and values - indicating whether the server received the Pongs from each clients in a time. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Stop Method

-
-

- Stops receiving the WebSocket connection requests. -

-

Syntax

-
public override void Stop ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Sweeping Property

-
-

- Gets or sets a value indicating whether the server cleans up the inactive WebSocket service - instances periodically. -

-

Syntax

-
public bool Sweeping { get; set; }
-

Value

-
- true if the server cleans up the inactive WebSocket service instances every 60 seconds; - otherwise, false. The default value is true. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Uri Property

-
-

- Gets the WebSocket URL on which to listen for incoming connection attempts. -

-

Syntax

-
public Uri Uri { get; }
-

Value

-
- A Uri that contains a WebSocket URL. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

WebSocketSharp.Server.IServiceHost.BindWebSocket Method

-
-

- Binds the specified WebSocketSharp.Net.WebSockets.WebSocketContext to a WebSocketSharp.Server.WebSocketService instance. -

-

Syntax

-
- void WebSocketSharp.Server.IServiceHost.BindWebSocket (WebSocketSharp.Net.WebSockets.WebSocketContext context)
-

Parameters

-
-
-
- context -
-
- A WebSocketSharp.Net.WebSockets.WebSocketContext that contains the WebSocket connection request objects to bind. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Server/WebSocketServiceManager.html b/websocket-sharp/doc/html/WebSocketSharp.Server/WebSocketServiceManager.html deleted file mode 100644 index 59a08f0c..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Server/WebSocketServiceManager.html +++ /dev/null @@ -1,642 +0,0 @@ - - - WebSocketSharp.Server.WebSocketServiceManager - - - - - -
- websocket-sharp : WebSocketSharp.Server Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

WebSocketServiceManager Class

-

- Manages the collection of WebSocketSharp.Server.WebSocketService objects. -

-
-

Syntax

-
public class WebSocketServiceManager
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - object. -

-

Public Properties

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
[read-only]
 - - ActiveIDs - - - - IEnumerable<string> - . - Gets the collection of IDs of active WebSocketSharp.Server.WebSocketService objects - managed by the WebSocketSharp.Server.WebSocketServiceManager. -
[read-only]
 - - Count - - - - int - . - Gets the number of WebSocketSharp.Server.WebSocketService objects - managed by the WebSocketSharp.Server.WebSocketServiceManager. -
[read-only]
 - - IDs - - - - IEnumerable<string> - . - Gets the collection of IDs of WebSocketSharp.Server.WebSocketService objects - managed by the WebSocketSharp.Server.WebSocketServiceManager. -
[read-only]
 - - InactiveIDs - - - - IEnumerable<string> - . - Gets the collection of IDs of inactive WebSocketSharp.Server.WebSocketService objects - managed by the WebSocketSharp.Server.WebSocketServiceManager. -
[read-only]
 - - Sweeping - - - - bool - . - Gets a value indicating whether the WebSocketSharp.Server.WebSocketServiceManager cleans up - the inactive WebSocketSharp.Server.WebSocketService objects periodically. -
-
-
-

Public Methods

-
-
- - - - - - - - - - - - - - - - - - - - - -
-
-
- 		- - Broadcast - (byte[])
- Broadcasts the specified array of byte to the clients of every WebSocketSharp.Server.WebSocketService - managed by the WebSocketSharp.Server.WebSocketServiceManager. -
-
-
- 		- - Broadcast - (string)
- Broadcasts the specified string to the clients of every WebSocketSharp.Server.WebSocketService - managed by the WebSocketSharp.Server.WebSocketServiceManager. -
-
-
- 		- - Broadping - (string) : Dictionary<string, bool>
- Pings with the specified string to the clients of every WebSocketSharp.Server.WebSocketService - managed by the WebSocketSharp.Server.WebSocketServiceManager. -
-
-
- 		- - Sweep - ()
- Cleans up the inactive WebSocketSharp.Server.WebSocketService objects. -
-
-
- 		- - TryGetWebSocketService - (string, out WebSocketService) : bool
- Tries to get the WebSocketSharp.Server.WebSocketService associated with the specified id. -
-
-
-
-
-
-

Member Details

-
-

ActiveIDs Property

-
-

- Gets the collection of IDs of active WebSocketSharp.Server.WebSocketService objects - managed by the WebSocketSharp.Server.WebSocketServiceManager. -

-

Syntax

-
public IEnumerable<string> ActiveIDs { get; }
-

Value

-
- An IEnumerable<string> that contains the collection of IDs of active WebSocketSharp.Server.WebSocketService objects. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Broadcast Method

-
-

- Broadcasts the specified array of byte to the clients of every WebSocketSharp.Server.WebSocketService - managed by the WebSocketSharp.Server.WebSocketServiceManager. -

-

Syntax

-
public void Broadcast (byte[] data)
-

Parameters

-
-
-
- data -
-
- An array of byte to broadcast. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Broadcast Method

-
-

- Broadcasts the specified string to the clients of every WebSocketSharp.Server.WebSocketService - managed by the WebSocketSharp.Server.WebSocketServiceManager. -

-

Syntax

-
public void Broadcast (string data)
-

Parameters

-
-
-
- data -
-
- A string to broadcast. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Broadping Method

-
-

- Pings with the specified string to the clients of every WebSocketSharp.Server.WebSocketService - managed by the WebSocketSharp.Server.WebSocketServiceManager. -

-

Syntax

-
public Dictionary<string, bool> Broadping (string message)
-

Parameters

-
-
-
- message -
-
- A string that contains a message. -
-
-
-

Returns

-
- A Dictionary<string, bool> that contains the collection of IDs and values - indicating whether each WebSocketSharp.Server.WebSocketService received a Pong in a time. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Count Property

-
-

- Gets the number of WebSocketSharp.Server.WebSocketService objects - managed by the WebSocketSharp.Server.WebSocketServiceManager. -

-

Syntax

-
public int Count { get; }
-

Value

-
- An int that contains the number of WebSocketSharp.Server.WebSocketService objects - managed by the WebSocketSharp.Server.WebSocketServiceManager. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IDs Property

-
-

- Gets the collection of IDs of WebSocketSharp.Server.WebSocketService objects - managed by the WebSocketSharp.Server.WebSocketServiceManager. -

-

Syntax

-
public IEnumerable<string> IDs { get; }
-

Value

-
- An IEnumerable<string> that contains the collection of IDs of WebSocketSharp.Server.WebSocketService objects. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

InactiveIDs Property

-
-

- Gets the collection of IDs of inactive WebSocketSharp.Server.WebSocketService objects - managed by the WebSocketSharp.Server.WebSocketServiceManager. -

-

Syntax

-
public IEnumerable<string> InactiveIDs { get; }
-

Value

-
- An IEnumerable<string> that contains the collection of IDs of inactive WebSocketSharp.Server.WebSocketService objects. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Sweep Method

-
-

- Cleans up the inactive WebSocketSharp.Server.WebSocketService objects. -

-

Syntax

-
public void Sweep ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Sweeping Property

-
-

- Gets a value indicating whether the WebSocketSharp.Server.WebSocketServiceManager cleans up - the inactive WebSocketSharp.Server.WebSocketService objects periodically. -

-

Syntax

-
public bool Sweeping { get; }
-

Value

-
- true if the WebSocketSharp.Server.WebSocketServiceManager cleans up the inactive WebSocketSharp.Server.WebSocketService objects - every 60 seconds; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

TryGetWebSocketService Method

-
-

- Tries to get the WebSocketSharp.Server.WebSocketService associated with the specified id. -

-

Syntax

-
public bool TryGetWebSocketService (string id, out WebSocketService service)
-

Parameters

-
-
-
- id -
-
- A string that contains the ID to find. -
-
- service -
-
- When this method returns, contains the WebSocketSharp.Server.WebSocketService with the specified id, if the id is found; otherwise, null. -
-
-
-

Returns

-
- true if the WebSocketSharp.Server.WebSocketServiceManager manages the WebSocketSharp.Server.WebSocketService with the specified id; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp.Server
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp.Server/index.html b/websocket-sharp/doc/html/WebSocketSharp.Server/index.html deleted file mode 100644 index 05d89aa4..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp.Server/index.html +++ /dev/null @@ -1,276 +0,0 @@ - - - websocket-sharp: WebSocketSharp.Server - - - - - -
- websocket-sharp -
-

WebSocketSharp.Server Namespace

-

-

-
-
-
-

Namespace

-

The WebSocketSharp.Server namespace contains classes to implement the server that receives the WebSocket connection requests.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- HttpRequestEventArgs - - Contains the event data associated with the HTTP request events of the WebSocketSharp.Server.HttpServer class. -
- HttpServer - - Provides a simple HTTP server that allows to accept the WebSocket connection requests. -
- IServiceHost - - Exposes the methods and properties for the WebSocket service host. -
- WebSocketServer - - Provides the functions of the server that receives the WebSocket connection requests. -
- WebSocketServerBase - - Provides the basic functions of the server that receives the WebSocket connection requests. -
- WebSocketService - - Provides the basic functions of the WebSocket service. -
- WebSocketServiceHost<T> - - Provides the functions of the server that receives the WebSocket connection requests. -
- WebSocketServiceManager - - Manages the collection of WebSocketSharp.Server.WebSocketService objects. -
-
-
-
-
-
Copyright (c) 2010-2013 sta.blockhead
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp/ByteOrder.html b/websocket-sharp/doc/html/WebSocketSharp/ByteOrder.html deleted file mode 100644 index 5487c844..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp/ByteOrder.html +++ /dev/null @@ -1,256 +0,0 @@ - - - WebSocketSharp.ByteOrder - - - - - -
- websocket-sharp : WebSocketSharp Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

ByteOrder Enum

-

- Contains the values that indicate whether the byte order is a Little-endian or Big-endian. -

-
-

Syntax

-
public enum ByteOrder
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Members

-
- - - - - - - - - - - - - -
Member NameDescription
- BIG - - Indicates a Big-endian. -
- LITTLE - - Indicates a Little-endian. -
-
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp/CloseEventArgs.html b/websocket-sharp/doc/html/WebSocketSharp/CloseEventArgs.html deleted file mode 100644 index 08d5d004..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp/CloseEventArgs.html +++ /dev/null @@ -1,423 +0,0 @@ - - - WebSocketSharp.CloseEventArgs - - - - - -
- websocket-sharp : WebSocketSharp Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

CloseEventArgs Class

-

- Contains the event data associated with a WebSocket.OnClose event. -

-
-

Syntax

-
public class CloseEventArgs : MessageEventArgs
-
-
-

Remarks

-
- The WebSocket.OnClose event occurs when the WebSocket receives a close control frame or - the WebSocket.Close method is called. If you want to get the reason for closure, you should access - the CloseEventArgs.Code or CloseEventArgs.Reason properties. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - MessageEventArgs. -

-

Public Properties

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
[read-only]
 - - Code - - - - ushort - . - Gets the status code for closure. -
[read-only]
 - - Data - - - - string - . - Gets the received data as a string. - (Inherited from MessageEventArgs.)
[read-only]
 - - RawData - - - - byte[]. - Gets the received data as an array of byte. - (Inherited from MessageEventArgs.)
[read-only]
 - - Reason - - - - string - . - Gets the reason for closure. -
[read-only]
 - - Type - - - - Opcode - . - Gets the type of the received data. - (Inherited from MessageEventArgs.)
[read-only]
 - - WasClean - - - - bool - . - Indicates whether the WebSocket connection closed cleanly. -
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

Code Property

-
-

- Gets the status code for closure. -

-

Syntax

-
public ushort Code { get; }
-

Value

-
- A ushort that contains a status code for closure. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Reason Property

-
-

- Gets the reason for closure. -

-

Syntax

-
public string Reason { get; }
-

Value

-
- A string that contains a reason for closure. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

WasClean Property

-
-

- Indicates whether the WebSocket connection closed cleanly. -

-

Syntax

-
public bool WasClean { get; }
-

Value

-
- true if the WebSocket connection closed cleanly; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp/CloseStatusCode.html b/websocket-sharp/doc/html/WebSocketSharp/CloseStatusCode.html deleted file mode 100644 index ab5b8cca..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp/CloseStatusCode.html +++ /dev/null @@ -1,361 +0,0 @@ - - - WebSocketSharp.CloseStatusCode - - - - - -
- websocket-sharp : WebSocketSharp Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

CloseStatusCode Enum

-

- Contains the values of the status codes for the WebSocket connection closure. -

-
-

Syntax

-
public enum CloseStatusCode
-
-
-

Remarks

-
-

- The CloseStatusCode enumeration contains the values of the status codes for the WebSocket connection closure - defined in RFC 6455 for the WebSocket protocol. -

-

- "Reserved value" must not be set as a status code in a close control frame by an endpoint. - It is designated for use in applications expecting a status code to indicate that connection - was closed due to a system grounds. -

-
-

Members

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Member NameDescription
- ABNORMAL - - Equivalent to close status 1006. Indicates that the connection was closed abnormally. Reserved value. -
- AWAY - - Equivalent to close status 1001. Indicates that an endpoint is "going away". -
- IGNORE_EXTENSION - - Equivalent to close status 1010. Indicates that an endpoint (client) is terminating the connection - because it has expected the server to negotiate one or more extension, but the server didn't return - them in the response message of the WebSocket handshake. -
- INCONSISTENT_DATA - - Equivalent to close status 1007. Indicates that an endpoint is terminating the connection - because it has received data within a message that was not consistent with the type of the message. -
- INCORRECT_DATA - - Equivalent to close status 1003. Indicates that an endpoint is terminating the connection - because it has received a type of data it cannot accept. -
- NO_STATUS_CODE - - Equivalent to close status 1005. Indicates that no status code was actually present. Reserved value. -
- NORMAL - - Equivalent to close status 1000. Indicates a normal closure. -
- POLICY_VIOLATION - - Equivalent to close status 1008. Indicates that an endpoint is terminating the connection - because it has received a message that violates its policy. -
- PROTOCOL_ERROR - - Equivalent to close status 1002. Indicates that an endpoint is terminating the connection - due to a protocol error. -
- SERVER_ERROR - - Equivalent to close status 1011. Indicates that a server is terminating the connection because it encountered - an unexpected condition that prevented it from fulfilling the request. -
- TLS_HANDSHAKE_FAILURE - - Equivalent to close status 1015. Indicates that the connection was closed due to a failure to perform - a TLS handshake. Reserved value. -
- TOO_BIG - - Equivalent to close status 1009. Indicates that an endpoint is terminating the connection - because it has received a message that is too big for it to process. -
- UNDEFINED - - Equivalent to close status 1004. Still undefined. Reserved value. -
-
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp/CompressionMethod.html b/websocket-sharp/doc/html/WebSocketSharp/CompressionMethod.html deleted file mode 100644 index 115d0ec5..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp/CompressionMethod.html +++ /dev/null @@ -1,257 +0,0 @@ - - - WebSocketSharp.CompressionMethod - - - - - -
- websocket-sharp : WebSocketSharp Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

CompressionMethod Enum

-

- Contains the values of the compression methods used to compress the payload data of the WebSocket Data frame. -

-
-

Syntax

-
public enum CompressionMethod
-
-
-

Remarks

-
- The CompressionMethod enumeration contains the values of the compression methods defined in - Compression Extensions for WebSocket. -
-

Members

-
- - - - - - - - - - - - - -
Member NameDescription
- DEFLATE - - Indicates using DEFLATE. -
- NONE - - Indicates non compression. -
-
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp/ErrorEventArgs.html b/websocket-sharp/doc/html/WebSocketSharp/ErrorEventArgs.html deleted file mode 100644 index e1f54af0..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp/ErrorEventArgs.html +++ /dev/null @@ -1,313 +0,0 @@ - - - WebSocketSharp.ErrorEventArgs - - - - - -
- websocket-sharp : WebSocketSharp Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

ErrorEventArgs Class

-

- Contains the event data associated with a error event. -

-
-

Syntax

-
public class ErrorEventArgs : EventArgs
-
-
-

Remarks

-
- The error event occurs when this event sender gets an error. - If you want to get the error message, you should access the ErrorEventArgs.Message property. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - EventArgs. -

-

Public Properties

-
-
- - - - - - -
[read-only]
 - - Message - - - - string - . - Gets the error message. -
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

Message Property

-
-

- Gets the error message. -

-

Syntax

-
public string Message { get; }
-

Value

-
- A string that contains a error message. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp/Ext.html b/websocket-sharp/doc/html/WebSocketSharp/Ext.html deleted file mode 100644 index 516e2311..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp/Ext.html +++ /dev/null @@ -1,2607 +0,0 @@ - - - WebSocketSharp.Ext - - - - - -
- websocket-sharp : WebSocketSharp Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

Ext Class

-

- Provides a set of static methods for the websocket-sharp. -

-
-

Syntax

-
public static class Ext
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - object. -

-

Public Methods

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
static
- 		- - AcceptWebSocket - (this System.Net.Sockets.TcpListener, bool) : WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext
- Accepts a WebSocket connection by the System.Net.Sockets.TcpListener. -
-
static
- 		- - AcceptWebSocketAsync - (this System.Net.Sockets.TcpListener, bool, Action<WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext>)
- Accepts a WebSocket connection asynchronously by the System.Net.Sockets.TcpListener. -
-
static
- 		- - Contains - (this System.Collections.Specialized.NameValueCollection, string) : bool
- Determines whether the specified System.Collections.Specialized.NameValueCollection contains the entry - with the specified name. -
-
static
- 		- - Contains - (this string, params char[]) : bool
- Determines whether the specified string contains any of characters - in the specified array of char. -
-
static
- 		- - Contains - (this System.Collections.Specialized.NameValueCollection, string, string) : bool
- Determines whether the specified System.Collections.Specialized.NameValueCollection contains the entry - with the specified both name and value. -
-
static
- 		- - Emit - (this EventHandler, object, EventArgs)
- Emit the specified EventHandler delegate if is not null. -
-
static
- 		- - Emit<TEventArgs> - (this EventHandler<TEventArgs>, object, TEventArgs)
- Emit the specified EventHandler<TEventArgs> delegate if is not null. -
-
static
- 		- - EqualsAndSaveTo - (this int, char, List<byte>) : bool
- Determines whether the specified int equals the specified char as byte. - And save this specified int as byte to the specified List<byte>. -
-
static
- 		- - GetAbsolutePath - (this Uri) : string
- Gets the absolute path from the specified Uri. -
-
static
- 		- - GetCookies - (this System.Collections.Specialized.NameValueCollection, bool) : WebSocketSharp.Net.CookieCollection
- Gets the collection of cookies from the specified System.Collections.Specialized.NameValueCollection. -
-
static
- 		- - GetDescription - (this WebSocketSharp.Net.HttpStatusCode) : string
- Gets the description of the HTTP status code using the specified WebSocketSharp.Net.HttpStatusCode. -
-
static
- 		- - GetName - (this string, string) : string
- Gets the name from the specified string that contains a pair of name and value - separated by a separator string. -
-
static
- 		- - GetNameAndValue - (this string, string) : KeyValuePair<string, string>
- Gets the name and value from the specified string that contains a pair of name and value are separated by a separator string. -
-
static
- 		- - GetStatusDescription - (this int) : string
- Gets the description of the HTTP status code using the specified int. -
-
static
- 		- - GetValue - (this string, string) : string
- Gets the value from the specified string that contains a pair of name and value - separated by a separator string. -
-
static
- 		- - IsCloseStatusCode - (this ushort) : bool
- Determines whether the specified ushort is in the allowable range of - the WebSocket close status code. -
-
static
- 		- - IsEmpty - (this string) : bool
- Determines whether the specified string is empty. -
-
static
- 		- - IsEnclosedIn - (this string, char) : bool
- Determines whether the specified string is enclosed in the specified char. -
-
static
- 		- - IsHostOrder - (this ByteOrder) : bool
- Determines whether the specified WebSocketSharp.ByteOrder is host (this computer architecture) byte order. -
-
static
- 		- - IsLocal - (this System.Net.IPAddress) : bool
- Determines whether the specified System.Net.IPAddress represents a local IP address. -
-
static
- 		- - IsNullOrEmpty - (this string) : bool
- Determines whether the specified string is null or empty. -
-
static
- 		- - IsPredefinedScheme - (this string) : bool
- Determines whether the specified string is predefined scheme. -
-
static
- 		- - IsUpgradeTo - (this WebSocketSharp.Net.HttpListenerRequest, string) : bool
- Determines whether the specified WebSocketSharp.Net.HttpListenerRequest is the HTTP Upgrade request - to switch to the specified protocol. -
-
static
- 		- - IsValidAbsolutePath - (this string, out string) : bool
- Determines whether the specified string is valid absolute path. -
-
static
- 		- - MaybeUri - (this string) : bool
- Determines whether the specified string is a URI string. -
-
static
- 		- - ReadBytes - (this System.IO.Stream, int) : byte[]
- Reads a block of bytes from the specified System.IO.Stream - and returns the read data in an array of byte. -
-
static
- 		- - ReadBytes - (this System.IO.Stream, long) : byte[]
- Reads a block of bytes from the specified System.IO.Stream - and returns the read data in an array of byte. -
-
static
- 		- - SubArray<T> - (this T[], int, int) : T[]
- Retrieves a sub-array from the specified array. A sub-array starts at the specified element position. -
-
static
- 		- - Times - (this int, Action)
- Executes the specified Action delegate n times. -
-
static
- 		- - Times - (this int, Action<int>)
- Executes the specified Action<int> delegate n times. -
-
static
- 		- - Times - (this long, Action)
- Executes the specified Action delegate n times. -
-
static
- 		- - Times - (this long, Action<long>)
- Executes the specified Action<long> delegate n times. -
-
static
- 		- - Times - (this uint, Action)
- Executes the specified Action delegate n times. -
-
static
- 		- - Times - (this uint, Action<uint>)
- Executes the specified Action<uint> delegate n times. -
-
static
- 		- - Times - (this ulong, Action)
- Executes the specified Action delegate n times. -
-
static
- 		- - Times - (this ulong, Action<ulong>)
- Executes the specified Action<ulong> delegate n times. -
-
static
- 		- - To<T> - (this byte[], ByteOrder) : T
- Converts the specified array of byte to the specified type data. -
-
static
- 		- - ToByteArray<T> - (this T, ByteOrder) : byte[]
- Converts the specified value to an array of byte. -
-
static
- 		- - ToHostOrder - (this byte[], ByteOrder) : byte[]
- Converts the order of the specified array of byte to the host byte order. -
-
static
- 		- - ToString<T> - (this T[], string) : string
- Converts the specified array to a string that concatenates - the each element of array across the specified separator. -
-
static
- 		- - ToUri - (this string) : Uri
- Converts the specified string to a Uri object. -
-
static
- 		- - TryCreateWebSocketUri - (this string, out Uri, out string) : bool
- Tries to create a new WebSocket Uri using the specified uriString. -
-
static
- 		- - UrlDecode - (this string) : string
- URL-decodes the specified string. -
-
static
- 		- - UrlEncode - (this string) : string
- URL-encodes the specified string. -
-
static
- 		- - WriteContent - (this WebSocketSharp.Net.HttpListenerResponse, byte[])
- Writes the specified content data using the specified WebSocketSharp.Net.HttpListenerResponse. -
-
-
-
-
-
-

Member Details

-
-

AcceptWebSocket Method

-
-

- Accepts a WebSocket connection by the System.Net.Sockets.TcpListener. -

-

Syntax

-
public static WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext AcceptWebSocket (this System.Net.Sockets.TcpListener listener, bool secure)
-

Parameters

-
-
-
- listener -
-
- A System.Net.Sockets.TcpListener that provides a TCP connection to accept a WebSocket connection. -
-
- secure -
-
- A bool that indicates a secure connection or not. (true indicates a secure connection.) -
-
-
-

Returns

-
- A WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext that contains a WebSocket connection. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ArgumentNullException - - listener is null. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

AcceptWebSocketAsync Method

-
-

- Accepts a WebSocket connection asynchronously by the System.Net.Sockets.TcpListener. -

-

Syntax

-
public static void AcceptWebSocketAsync (this System.Net.Sockets.TcpListener listener, bool secure, Action<WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext> completed)
-

Parameters

-
-
-
- listener -
-
- A System.Net.Sockets.TcpListener that provides a TCP connection to accept a WebSocket connection. -
-
- secure -
-
- A bool that indicates a secure connection or not. (true indicates a secure connection.) -
-
- completed -
-
- An Action<TcpListenerWebSocketContext> delegate that contains the method(s) that is called when an asynchronous operation completes. -
-
-
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ArgumentNullException - - listener is null. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Contains Method

-
-

- Determines whether the specified System.Collections.Specialized.NameValueCollection contains the entry - with the specified name. -

-

Syntax

-
public static bool Contains (this System.Collections.Specialized.NameValueCollection collection, string name)
-

Parameters

-
-
-
- collection -
-
- A System.Collections.Specialized.NameValueCollection that contains the entries. -
-
- name -
-
- A string that contains the key of the entry to find. -
-
-
-

Returns

-
- true if collection contains the entry with name; - otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Contains Method

-
-

- Determines whether the specified string contains any of characters - in the specified array of char. -

-

Syntax

-
public static bool Contains (this string value, params char[] chars)
-

Parameters

-
-
-
- value -
-
- A string to test. -
-
- chars -
-
- An array of char that contains characters to find. -
-
-
-

Returns

-
- true if value contains any of chars; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Contains Method

-
-

- Determines whether the specified System.Collections.Specialized.NameValueCollection contains the entry - with the specified both name and value. -

-

Syntax

-
public static bool Contains (this System.Collections.Specialized.NameValueCollection collection, string name, string value)
-

Parameters

-
-
-
- collection -
-
- A System.Collections.Specialized.NameValueCollection that contains the entries. -
-
- name -
-
- A string that contains the key of the entry to find. -
-
- value -
-
- A string that contains the value of the entry to find. -
-
-
-

Returns

-
- true if collection contains the entry with both name and value; - otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Emit Method

-
-

- Emit the specified EventHandler delegate if is not null. -

-

Syntax

-
public static void Emit (this EventHandler eventHandler, object sender, EventArgs e)
-

Parameters

-
-
-
- eventHandler -
-
- An EventHandler to emit. -
-
- sender -
-
- An object that emits the eventHandler. -
-
- e -
-
- An EventArgs that contains no event data. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Emit<TEventArgs> Generic Method

-
-

- Emit the specified EventHandler<TEventArgs> delegate if is not null. -

-

Syntax

-
public static void Emit<TEventArgs> (this EventHandler<TEventArgs> eventHandler, object sender, TEventArgs e)
where TEventArgs : EventArgs
-

Type Parameters

-
-
-
- TEventArgs -
-
- The type of the event data generated by the event. -
-
-
-

Parameters

-
-
-
- eventHandler -
-
- An EventHandler<TEventArgs> to emit. -
-
- sender -
-
- An object that emits the eventHandler. -
-
- e -
-
- A TEventArgs that contains the event data. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

EqualsAndSaveTo Method

-
-

- Determines whether the specified int equals the specified char as byte. - And save this specified int as byte to the specified List<byte>. -

-

Syntax

-
public static bool EqualsAndSaveTo (this int value, char c, List<byte> dest)
-

Parameters

-
-
-
- value -
-
- An int to compare. -
-
- c -
-
- A char to compare. -
-
- dest -
-
- A List<byte> to save the value as byte. -
-
-
-

Returns

-
- true if the value parameter equals the c parameter as byte; otherwise, false. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ArgumentOutOfRangeException - - Is thrown when the value parameter passed to a method is invalid because it is outside the allowable range of values as byte. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

GetAbsolutePath Method

-
-

- Gets the absolute path from the specified Uri. -

-

Syntax

-
public static string GetAbsolutePath (this Uri uri)
-

Parameters

-
-
-
- uri -
-
- A Uri that contains the URI to get the absolute path from. -
-
-
-

Returns

-
- A string that contains the absolute path if got successfully; otherwise, null. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

GetCookies Method

-
-

- Gets the collection of cookies from the specified System.Collections.Specialized.NameValueCollection. -

-

Syntax

-
public static WebSocketSharp.Net.CookieCollection GetCookies (this System.Collections.Specialized.NameValueCollection headers, bool response)
-

Parameters

-
-
-
- headers -
-
- A System.Collections.Specialized.NameValueCollection that contains a collection of the HTTP Headers. -
-
- response -
-
- true if gets from the response headers; - from the request headers, false. -
-
-
-

Returns

-
- A WebSocketSharp.Net.CookieCollection that receives a collection of the HTTP Cookies. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

GetDescription Method

-
-

- Gets the description of the HTTP status code using the specified WebSocketSharp.Net.HttpStatusCode. -

-

Syntax

-
public static string GetDescription (this WebSocketSharp.Net.HttpStatusCode code)
-

Parameters

-
-
-
- code -
-
- One of WebSocketSharp.Net.HttpStatusCode values that contains an HTTP status code. -
-
-
-

Returns

-
- A string that contains the description of the HTTP status code. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

GetName Method

-
-

- Gets the name from the specified string that contains a pair of name and value - separated by a separator string. -

-

Syntax

-
public static string GetName (this string nameAndValue, string separator)
-

Parameters

-
-
-
- nameAndValue -
-
- A string that contains a pair of name and value separated by a separator string. -
-
- separator -
-
- A string that contains a separator string. -
-
-
-

Returns

-
- A string that contains the name if any; otherwise, null. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

GetNameAndValue Method

-
-

- Gets the name and value from the specified string that contains a pair of name and value are separated by a separator string. -

-

Syntax

-
public static KeyValuePair<string, string> GetNameAndValue (this string nameAndValue, string separator)
-

Parameters

-
-
-
- nameAndValue -
-
- A string that contains a pair of name and value are separated by a separator string. -
-
- separator -
-
- A string that contains a separator string. -
-
-
-

Returns

-
- A KeyValuePair<string, string> that contains the name and value if any. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

GetStatusDescription Method

-
-

- Gets the description of the HTTP status code using the specified int. -

-

Syntax

-
public static string GetStatusDescription (this int code)
-

Parameters

-
-
-
- code -
-
- An int that contains an HTTP status code. -
-
-
-

Returns

-
- A string that contains the description of the HTTP status code. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

GetValue Method

-
-

- Gets the value from the specified string that contains a pair of name and value - separated by a separator string. -

-

Syntax

-
public static string GetValue (this string nameAndValue, string separator)
-

Parameters

-
-
-
- nameAndValue -
-
- A string that contains a pair of name and value separated by a separator string. -
-
- separator -
-
- A string that contains a separator string. -
-
-
-

Returns

-
- A string that contains the value if any; otherwise, null. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsCloseStatusCode Method

-
-

- Determines whether the specified ushort is in the allowable range of - the WebSocket close status code. -

-

Syntax

-
public static bool IsCloseStatusCode (this ushort code)
-

Parameters

-
-
-
- code -
-
- A ushort to test. -
-
-
-

Returns

-
- true if code is in the allowable range of the WebSocket close status code; otherwise, false. -
-

Remarks

-
- Not allowable ranges are the followings. -
  • - Numbers in the range 0-999 are not used. -
  • - Numbers which are greater than 4999 are out of the reserved close status code ranges. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsEmpty Method

-
-

- Determines whether the specified string is empty. -

-

Syntax

-
public static bool IsEmpty (this string value)
-

Parameters

-
-
-
- value -
-
- A string to test. -
-
-
-

Returns

-
- true if value is empty; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsEnclosedIn Method

-
-

- Determines whether the specified string is enclosed in the specified char. -

-

Syntax

-
public static bool IsEnclosedIn (this string value, char c)
-

Parameters

-
-
-
- value -
-
- A string to test. -
-
- c -
-
- A char that contains character to find. -
-
-
-

Returns

-
- true if value is enclosed in c; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsHostOrder Method

-
-

- Determines whether the specified WebSocketSharp.ByteOrder is host (this computer architecture) byte order. -

-

Syntax

-
public static bool IsHostOrder (this ByteOrder order)
-

Parameters

-
-
-
- order -
-
- A WebSocketSharp.ByteOrder to test. -
-
-
-

Returns

-
- true if the order parameter is host byte order; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsLocal Method

-
-

- Determines whether the specified System.Net.IPAddress represents a local IP address. -

-

Syntax

-
public static bool IsLocal (this System.Net.IPAddress address)
-

Parameters

-
-
-
- address -
-
- A System.Net.IPAddress to test. -
-
-
-

Returns

-
- true if address represents a local IP address; otherwise, false. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ArgumentNullException - - address is null. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsNullOrEmpty Method

-
-

- Determines whether the specified string is null or empty. -

-

Syntax

-
public static bool IsNullOrEmpty (this string value)
-

Parameters

-
-
-
- value -
-
- A string to test. -
-
-
-

Returns

-
- true if the value parameter is null or empty; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsPredefinedScheme Method

-
-

- Determines whether the specified string is predefined scheme. -

-

Syntax

-
public static bool IsPredefinedScheme (this string scheme)
-

Parameters

-
-
-
- scheme -
-
- A string to test. -
-
-
-

Returns

-
- true if the scheme parameter is the predefined scheme; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsUpgradeTo Method

-
-

- Determines whether the specified WebSocketSharp.Net.HttpListenerRequest is the HTTP Upgrade request - to switch to the specified protocol. -

-

Syntax

-
public static bool IsUpgradeTo (this WebSocketSharp.Net.HttpListenerRequest request, string protocol)
-

Parameters

-
-
-
- request -
-
- A WebSocketSharp.Net.HttpListenerRequest that contains an HTTP request information. -
-
- protocol -
-
- A string that contains a protocol name. -
-
-
-

Returns

-
- true if the specified WebSocketSharp.Net.HttpListenerRequest is the HTTP Upgrade request - to switch to the specified protocol; otherwise, false. -
-

Exceptions

-
- - - - - - - - - - - - - -
TypeReason
- ArgumentNullException - -

- request is null. -

-

- -or- -

-

- protocol is null. -

-
- ArgumentException - - protocol is string.Empty. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsValidAbsolutePath Method

-
-

- Determines whether the specified string is valid absolute path. -

-

Syntax

-
public static bool IsValidAbsolutePath (this string absPath, out string message)
-

Parameters

-
-
-
- absPath -
-
- A string to test. -
-
- message -
-
- A string that receives a message if the absPath is invalid. -
-
-
-

Returns

-
- true if the absPath parameter is valid absolute path; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

MaybeUri Method

-
-

- Determines whether the specified string is a URI string. -

-

Syntax

-
public static bool MaybeUri (this string uriString)
-

Parameters

-
-
-
- uriString -
-
- A string to test. -
-
-
-

Returns

-
- true if the uriString parameter is maybe a URI string; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ReadBytes Method

-
-

- Reads a block of bytes from the specified System.IO.Stream - and returns the read data in an array of byte. -

-

Syntax

-
public static byte[] ReadBytes (this System.IO.Stream stream, int length)
-

Parameters

-
-
-
- stream -
-
- A System.IO.Stream that contains the data to read. -
-
- length -
-
- An int that contains the number of bytes to read. -
-
-
-

Returns

-
- An array of byte that receives the read data. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ReadBytes Method

-
-

- Reads a block of bytes from the specified System.IO.Stream - and returns the read data in an array of byte. -

-

Syntax

-
public static byte[] ReadBytes (this System.IO.Stream stream, long length)
-

Parameters

-
-
-
- stream -
-
- A System.IO.Stream that contains the data to read. -
-
- length -
-
- A long that contains the number of bytes to read. -
-
-
-

Returns

-
- An array of byte that receives the read data. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

SubArray<T> Generic Method

-
-

- Retrieves a sub-array from the specified array. A sub-array starts at the specified element position. -

-

Syntax

-
public static T[] SubArray<T> (this T[] array, int startIndex, int length)
-

Type Parameters

-
-
-
- T -
-
- The type of elements in the array. -
-
-
-

Parameters

-
-
-
- array -
-
- An array of T that contains the data to retrieve a sub-array. -
-
- startIndex -
-
- An int that contains the zero-based starting position of a sub-array in the array. -
-
- length -
-
- An int that contains the number of elements to retrieve a sub-array. -
-
-
-

Returns

-
- An array of T that receives a sub-array, or an empty array of T if any problems with the parameters. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Times Method

-
-

- Executes the specified Action delegate n times. -

-

Syntax

-
public static void Times (this int n, Action act)
-

Parameters

-
-
-
- n -
-
- An int is the number of times to execute. -
-
- act -
-
- An Action delegate that references the method(s) to execute. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Times Method

-
-

- Executes the specified Action<int> delegate n times. -

-

Syntax

-
public static void Times (this int n, Action<int> act)
-

Parameters

-
-
-
- n -
-
- An int is the number of times to execute. -
-
- act -
-
- An Action<int> delegate that references the method(s) to execute. - An int parameter to pass to the method(s) is the zero-based count of iteration. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Times Method

-
-

- Executes the specified Action delegate n times. -

-

Syntax

-
public static void Times (this long n, Action act)
-

Parameters

-
-
-
- n -
-
- A long is the number of times to execute. -
-
- act -
-
- An Action delegate that references the method(s) to execute. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Times Method

-
-

- Executes the specified Action<long> delegate n times. -

-

Syntax

-
public static void Times (this long n, Action<long> act)
-

Parameters

-
-
-
- n -
-
- A long is the number of times to execute. -
-
- act -
-
- An Action<long> delegate that references the method(s) to execute. - A long parameter to pass to the method(s) is the zero-based count of iteration. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Times Method

-
-

- Executes the specified Action delegate n times. -

-

Syntax

-
public static void Times (this uint n, Action act)
-

Parameters

-
-
-
- n -
-
- A uint is the number of times to execute. -
-
- act -
-
- An Action delegate that references the method(s) to execute. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Times Method

-
-

- Executes the specified Action<uint> delegate n times. -

-

Syntax

-
public static void Times (this uint n, Action<uint> act)
-

Parameters

-
-
-
- n -
-
- A uint is the number of times to execute. -
-
- act -
-
- An Action<uint> delegate that references the method(s) to execute. - A uint parameter to pass to the method(s) is the zero-based count of iteration. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Times Method

-
-

- Executes the specified Action delegate n times. -

-

Syntax

-
public static void Times (this ulong n, Action act)
-

Parameters

-
-
-
- n -
-
- A ulong is the number of times to execute. -
-
- act -
-
- An Action delegate that references the method(s) to execute. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Times Method

-
-

- Executes the specified Action<ulong> delegate n times. -

-

Syntax

-
public static void Times (this ulong n, Action<ulong> act)
-

Parameters

-
-
-
- n -
-
- A ulong is the number of times to execute. -
-
- act -
-
- An Action<ulong> delegate that references the method(s) to execute. - A ulong parameter to pass to this method(s) is the zero-based count of iteration. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

To<T> Generic Method

-
-

- Converts the specified array of byte to the specified type data. -

-

Syntax

-
public static T To<T> (this byte[] src, ByteOrder srcOrder)
where T : struct
-

Type Parameters

-
-
-
- T -
-
- The type of the return. The T must be a value type. -
-
-
-

Parameters

-
-
-
- src -
-
- An array of byte to convert. -
-
- srcOrder -
-
- A WebSocketSharp.ByteOrder that indicates the byte order of src. -
-
-
-

Returns

-
- A T converted from src, or a default value of T - if src is an empty array of byte - or if the type of T isn't bool, char, double, - float, int, long, short, - uint, ulong or ushort. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ArgumentNullException - - src is null. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ToByteArray<T> Generic Method

-
-

- Converts the specified value to an array of byte. -

-

Syntax

-
public static byte[] ToByteArray<T> (this T value, ByteOrder order)
where T : struct
-

Type Parameters

-
-
-
- T -
-
- The type of value. The T must be a value type. -
-
-
-

Parameters

-
-
-
- value -
-
- A T to convert. -
-
- order -
-
- A WebSocketSharp.ByteOrder that indicates the byte order of the return. -
-
-
-

Returns

-
- An array of byte converted from value. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ToHostOrder Method

-
-

- Converts the order of the specified array of byte to the host byte order. -

-

Syntax

-
public static byte[] ToHostOrder (this byte[] src, ByteOrder srcOrder)
-

Parameters

-
-
-
- src -
-
- An array of byte to convert. -
-
- srcOrder -
-
- A WebSocketSharp.ByteOrder that indicates the byte order of src. -
-
-
-

Returns

-
- An array of byte converted from src. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ArgumentNullException - - src is null. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ToString<T> Generic Method

-
-

- Converts the specified array to a string that concatenates - the each element of array across the specified separator. -

-

Syntax

-
public static string ToString<T> (this T[] array, string separator)
-

Type Parameters

-
-
-
- T -
-
- The type of elements in array. -
-
-
-

Parameters

-
-
-
- array -
-
- An array of T to convert. -
-
- separator -
-
- A string that contains a separator string. -
-
-
-

Returns

-
- A string converted from array, or a string.Empty - if the length of array is zero. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ArgumentNullException - - array is null. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ToUri Method

-
-

- Converts the specified string to a Uri object. -

-

Syntax

-
public static Uri ToUri (this string uriString)
-

Parameters

-
-
-
- uriString -
-
- A string to convert. -
-
-
-

Returns

-
- A Uri converted from the uriString parameter, or null - if the uriString is null or string.Empty. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

TryCreateWebSocketUri Method

-
-

- Tries to create a new WebSocket Uri using the specified uriString. -

-

Syntax

-
public static bool TryCreateWebSocketUri (this string uriString, out Uri result, out string message)
-

Parameters

-
-
-
- uriString -
-
- A string that contains a WebSocket URI. -
-
- result -
-
- When this method returns, contains a created WebSocket Uri if the uriString parameter is valid WebSocket URI; otherwise, null. -
-
- message -
-
- When this method returns, contains a error message string if the uriString parameter is invalid WebSocket URI; otherwise, String.Empty. -
-
-
-

Returns

-
- true if the WebSocket Uri was successfully created; otherwise, false. -
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ArgumentNullException - - Is thrown when the uriString parameter passed to a method is invalid because it is null. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

UrlDecode Method

-
-

- URL-decodes the specified string. -

-

Syntax

-
public static string UrlDecode (this string s)
-

Parameters

-
-
-
- s -
-
- A string to decode. -
-
-
-

Returns

-
- A string that receives a decoded string, or the s parameter - if the s is null or string.Empty. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

UrlEncode Method

-
-

- URL-encodes the specified string. -

-

Syntax

-
public static string UrlEncode (this string s)
-

Parameters

-
-
-
- s -
-
- A string to encode. -
-
-
-

Returns

-
- A string that receives a encoded string, or the s parameter - if the s is null or string.Empty. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

WriteContent Method

-
-

- Writes the specified content data using the specified WebSocketSharp.Net.HttpListenerResponse. -

-

Syntax

-
public static void WriteContent (this WebSocketSharp.Net.HttpListenerResponse response, byte[] content)
-

Parameters

-
-
-
- response -
-
- A WebSocketSharp.Net.HttpListenerResponse that contains a network stream to write a content data. -
-
- content -
-
- An array of byte that contains a content data to write. -
-
-
-

Exceptions

-
- - - - - - - - - -
TypeReason
- ArgumentNullException - - Is thrown when the response parameter passed to a method is invalid because it is null. -
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp/MessageEventArgs.html b/websocket-sharp/doc/html/WebSocketSharp/MessageEventArgs.html deleted file mode 100644 index 727bb9f1..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp/MessageEventArgs.html +++ /dev/null @@ -1,381 +0,0 @@ - - - WebSocketSharp.MessageEventArgs - - - - - -
- websocket-sharp : WebSocketSharp Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

MessageEventArgs Class

-

- Contains the event data associated with a WebSocket.OnMessage event. -

-
-

Syntax

-
public class MessageEventArgs : EventArgs
-
-
-

Remarks

-
- The WebSocket.OnMessage event occurs when the WebSocket receives a text or binary data frame. - If you want to get the received data, you should access the MessageEventArgs.Data or - MessageEventArgs.RawData properties. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - EventArgs. -

-

Public Properties

-
-
- - - - - - - - - - - - - - - - -
[read-only]
 - - Data - - - - string - . - Gets the received data as a string. -
[read-only]
 - - RawData - - - - byte[]. - Gets the received data as an array of byte. -
[read-only]
 - - Type - - - - Opcode - . - Gets the type of the received data. -
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

Data Property

-
-

- Gets the received data as a string. -

-

Syntax

-
public string Data { get; }
-

Value

-
- A string that contains the received data. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

RawData Property

-
-

- Gets the received data as an array of byte. -

-

Syntax

-
public byte[] RawData { get; }
-

Value

-
- An array of byte that contains the received data. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Type Property

-
-

- Gets the type of the received data. -

-

Syntax

-
public Opcode Type { get; }
-

Value

-
- One of the WebSocketSharp.Opcode values that indicates the type of the received data. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp/Opcode.html b/websocket-sharp/doc/html/WebSocketSharp/Opcode.html deleted file mode 100644 index 9da6fa39..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp/Opcode.html +++ /dev/null @@ -1,289 +0,0 @@ - - - WebSocketSharp.Opcode - - - - - -
- websocket-sharp : WebSocketSharp Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

Opcode Enum

-

- Contains the values of the opcodes that denotes the frame type of the WebSocket frame. -

-
-

Syntax

-
public enum Opcode
-
-
-

Remarks

-
- The Opcode enumeration contains the values of the opcodes defined in - RFC 6455 for the WebSocket protocol. -
-

Members

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Member NameDescription
- BINARY - - Equivalent to numeric value 2. Indicates a binary frame. -
- CLOSE - - Equivalent to numeric value 8. Indicates a connection close frame. -
- CONT - - Equivalent to numeric value 0. Indicates a continuation frame. -
- PING - - Equivalent to numeric value 9. Indicates a ping frame. -
- PONG - - Equivalent to numeric value 10. Indicates a pong frame. -
- TEXT - - Equivalent to numeric value 1. Indicates a text frame. -
-
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp/WebSocket.html b/websocket-sharp/doc/html/WebSocketSharp/WebSocket.html deleted file mode 100644 index a9eabc48..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp/WebSocket.html +++ /dev/null @@ -1,1599 +0,0 @@ - - - WebSocketSharp.WebSocket - - - - - -
- websocket-sharp : WebSocketSharp Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

WebSocket Class

-

- Implements the WebSocket interface. -

-
-

Syntax

-
public class WebSocket : IDisposable
-
-
-

Remarks

-
- The WebSocket class provides a set of methods and properties for two-way communication - using the WebSocket protocol (RFC 6455). -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - object. -

-

Public Constructors

-
-
- - - - - - - - - - - -
-
-
- 		-
- - WebSocket - (string, params string[])
- 		- Initializes a new instance of the WebSocketSharp.WebSocket class with the specified WebSocket URL and subprotocols. -
-
-
- 		- - - Initializes a new instance of the WebSocketSharp.WebSocket class with the specified WebSocket URL, - OnOpen, OnMessage, OnError, OnClose event handlers and subprotocols. -
-
-
-

Public Properties

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- 		- - Compression - - - - CompressionMethod - . - Gets or sets the compression method used to compress the payload data of the WebSocket Data frame. -
[read-only]
 - - Cookies - - - - IEnumerable<WebSocketSharp.Net.Cookie> - . - Gets the cookies used in the WebSocket opening handshake. -
[read-only]
 - - Credentials - - - - WsCredential - . - Gets the credentials for HTTP authentication (Basic/Digest). -
[read-only]
 - - Extensions - - - - string - . - Gets the WebSocket extensions selected by the server. -
[read-only]
 - - IsAlive - - - - bool - . - Gets a value indicating whether the WebSocket connection is alive. -
[read-only]
 - - IsSecure - - - - bool - . - Gets a value indicating whether the WebSocket connection is secure. -
-
-
- 		- - Origin - - - - string - . - Gets or sets the value of the Origin header used in the WebSocket opening handshake. -
[read-only]
 - - Protocol - - - - string - . - Gets the WebSocket subprotocol selected by the server. -
[read-only]
 - - ReadyState - - - - WsState - . - Gets the state of the WebSocket connection. -
[read-only]
 - - Url - - - - Uri - . - Gets the WebSocket URL to connect. -
-
-
-

Public Methods

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- 		- - Close - ()
- Closes the WebSocket connection and releases all associated resources. -
-
-
- 		- - Close - (ushort)
- Closes the WebSocket connection with the specified code and - releases all associated resources. -
-
-
- 		- - Close - (CloseStatusCode)
- Closes the WebSocket connection with the specified code and - releases all associated resources. -
-
-
- 		- - Close - (ushort, string)
- Closes the WebSocket connection with the specified code and - reason, and releases all associated resources. -
-
-
- 		- - Close - (CloseStatusCode, string)
- Closes the WebSocket connection with the specified code and - reason, and releases all associated resources. -
-
-
- 		- - Connect - ()
- Establishes a WebSocket connection. -
-
-
- 		- - Dispose - ()
- Closes the WebSocket connection and releases all associated resources. -
-
-
- 		- - Ping - () : bool
- Sends a Ping using the WebSocket connection. -
-
-
- 		- - Ping - (string) : bool
- Sends a Ping with the specified message using the WebSocket connection. -
-
-
- 		- - Send - (byte[])
- Sends a binary data using the WebSocket connection. -
-
-
- 		- - Send - (System.IO.FileInfo)
- Sends a binary data using the WebSocket connection. -
-
-
- 		- - Send - (string)
- Sends a text data using the WebSocket connection. -
-
-
- 		- - SendAsync - (byte[], Action)
- Sends a binary data asynchronously using the WebSocket connection. -
-
-
- 		- - SendAsync - (System.IO.FileInfo, Action)
- Sends a binary data asynchronously using the WebSocket connection. -
-
-
- 		- - SendAsync - (string, Action)
- Sends a text data asynchronously using the WebSocket connection. -
-
-
- 		- - SetCookie - (WebSocketSharp.Net.Cookie)
- Sets a WebSocketSharp.Net.Cookie used in the WebSocket opening handshake. -
-
-
- 		- - SetCredentials - (string, string, bool)
- Sets the credentials for HTTP authentication (Basic/Digest). -
-
-
-

Public Events

-
-
- - - - - - - - - - - - - - - - - - - - - -
-
-
- 		- - OnClose - - - Occurs when the WebSocketSharp.WebSocket receives a Close frame or the Close method is called. -
-
-
- 		- - OnError - - - Occurs when the WebSocketSharp.WebSocket gets an error. -
-
-
- 		- - OnMessage - - - Occurs when the WebSocketSharp.WebSocket receives a data frame. -
-
-
- 		- - OnOpen - - - Occurs when the WebSocket connection has been established. -
-
-
-
-
-
-

Member Details

-
-

WebSocket Constructor

-
-

- Initializes a new instance of the WebSocketSharp.WebSocket class with the specified WebSocket URL and subprotocols. -

-

Syntax

-
public WebSocket (string url, params string[] protocols)
-

Parameters

-
-
-
- url -
-
- A string that contains a WebSocket URL to connect. -
-
- protocols -
-
- An array of string that contains the WebSocket subprotocols if any. -
-
-
-

Exceptions

-
- - - - - - - - - - - - - -
TypeReason
- ArgumentNullException - - url is null. -
- ArgumentException - - url is not valid WebSocket URL. -
-
-

Remarks

-
-
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

WebSocket Constructor

-
-

- Initializes a new instance of the WebSocketSharp.WebSocket class with the specified WebSocket URL, - OnOpen, OnMessage, OnError, OnClose event handlers and subprotocols. -

-

Syntax

-
public WebSocket (string url, EventHandler onOpen, EventHandler<MessageEventArgs> onMessage, EventHandler<ErrorEventArgs> onError, EventHandler<CloseEventArgs> onClose, params string[] protocols)
-

Parameters

-
-
-
- url -
-
- A string that contains a WebSocket URL to connect. -
-
- onOpen -
-
- An WebSocket.OnOpen event handler. -
-
- onMessage -
-
- An WebSocket.OnMessage event handler. -
-
- onError -
-
- An WebSocket.OnError event handler. -
-
- onClose -
-
- An WebSocket.OnClose event handler. -
-
- protocols -
-
- An array of string that contains the WebSocket subprotocols if any. -
-
-
-

Exceptions

-
- - - - - - - - - - - - - -
TypeReason
- ArgumentNullException - - url is null. -
- ArgumentException - - url is not valid WebSocket URL. -
-
-

Remarks

-
- This constructor initializes a new instance of the WebSocketSharp.WebSocket class and - establishes a WebSocket connection. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Close Method

-
-

- Closes the WebSocket connection and releases all associated resources. -

-

Syntax

-
public void Close ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Close Method

-
-

- Closes the WebSocket connection with the specified code and - releases all associated resources. -

-

Syntax

-
public void Close (ushort code)
-

Parameters

-
-
-
- code -
-
- A ushort that indicates the status code for closure. -
-
-
-

Remarks

-
- This Close method emits a WebSocket.OnError event if code is not - in the allowable range of the WebSocket close status code. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Close Method

-
-

- Closes the WebSocket connection with the specified code and - releases all associated resources. -

-

Syntax

-
public void Close (CloseStatusCode code)
-

Parameters

-
-
-
- code -
-
- One of the WebSocketSharp.CloseStatusCode values that indicates the status code for closure. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Close Method

-
-

- Closes the WebSocket connection with the specified code and - reason, and releases all associated resources. -

-

Syntax

-
public void Close (ushort code, string reason)
-

Parameters

-
-
-
- code -
-
- A ushort that indicates the status code for closure. -
-
- reason -
-
- A string that contains the reason for closure. -
-
-
-

Remarks

-
- This Close method emits a WebSocket.OnError event if code is not - in the allowable range of the WebSocket close status code. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Close Method

-
-

- Closes the WebSocket connection with the specified code and - reason, and releases all associated resources. -

-

Syntax

-
public void Close (CloseStatusCode code, string reason)
-

Parameters

-
-
-
- code -
-
- One of the WebSocketSharp.CloseStatusCode values that indicates the status code for closure. -
-
- reason -
-
- A string that contains the reason for closure. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Compression Property

-
-

- Gets or sets the compression method used to compress the payload data of the WebSocket Data frame. -

-

Syntax

-
public CompressionMethod Compression { get; set; }
-

Value

-
- One of the WebSocketSharp.CompressionMethod values that indicates the compression method to use. - The default is CompressionMethod.NONE. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Connect Method

-
-

- Establishes a WebSocket connection. -

-

Syntax

-
public void Connect ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Cookies Property

-
-

- Gets the cookies used in the WebSocket opening handshake. -

-

Syntax

-
public IEnumerable<WebSocketSharp.Net.Cookie> Cookies { get; }
-

Value

-
- An IEnumerable<Cookie> interface that provides an enumerator which supports the iteration - over the collection of cookies. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Credentials Property

-
-

- Gets the credentials for HTTP authentication (Basic/Digest). -

-

Syntax

-
public WsCredential Credentials { get; }
-

Value

-
- A WebSocketSharp.WsCredential that contains the credentials for HTTP authentication. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Dispose Method

-
-

- Closes the WebSocket connection and releases all associated resources. -

-

Syntax

-
public void Dispose ()
-

Remarks

-
- This method closes the WebSocket connection with the CloseStatusCode.AWAY. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Extensions Property

-
-

- Gets the WebSocket extensions selected by the server. -

-

Syntax

-
public string Extensions { get; }
-

Value

-
- A string that contains the extensions if any. The default is string.Empty. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsAlive Property

-
-

- Gets a value indicating whether the WebSocket connection is alive. -

-

Syntax

-
public bool IsAlive { get; }
-

Value

-
- true if the WebSocket connection is alive; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

IsSecure Property

-
-

- Gets a value indicating whether the WebSocket connection is secure. -

-

Syntax

-
public bool IsSecure { get; }
-

Value

-
- true if the connection is secure; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

OnClose Event

-
-

- Occurs when the WebSocketSharp.WebSocket receives a Close frame or the Close method is called. -

-

Syntax

-
public event EventHandler<CloseEventArgs> OnClose
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

OnError Event

-
-

- Occurs when the WebSocketSharp.WebSocket gets an error. -

-

Syntax

-
public event EventHandler<ErrorEventArgs> OnError
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

OnMessage Event

-
-

- Occurs when the WebSocketSharp.WebSocket receives a data frame. -

-

Syntax

-
public event EventHandler<MessageEventArgs> OnMessage
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

OnOpen Event

-
-

- Occurs when the WebSocket connection has been established. -

-

Syntax

-
public event EventHandler OnOpen
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Origin Property

-
-

- Gets or sets the value of the Origin header used in the WebSocket opening handshake. -

-

Syntax

-
public string Origin { get; set; }
-

Value

-
-

- A string that contains the value of the HTTP Origin header to send. - The default is string.Empty. -

-

- The value of the Origin header has the following syntax: <scheme>://<host>[:<port>]

-
-

Remarks

-
- A WebSocketSharp.WebSocket instance does not send the Origin header in the WebSocket opening handshake - if the value of this property is string.Empty. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Ping Method

-
-

- Sends a Ping using the WebSocket connection. -

-

Syntax

-
public bool Ping ()
-

Returns

-
- true if a WebSocketSharp.WebSocket instance receives a Pong in a time; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Ping Method

-
-

- Sends a Ping with the specified message using the WebSocket connection. -

-

Syntax

-
public bool Ping (string message)
-

Parameters

-
-
-
- message -
-
- A string that contains a message to send with a Ping. -
-
-
-

Returns

-
- true if a WebSocketSharp.WebSocket instance receives a Pong in a time; otherwise, false. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Protocol Property

-
-

- Gets the WebSocket subprotocol selected by the server. -

-

Syntax

-
public string Protocol { get; }
-

Value

-
- A string that contains the subprotocol if any. The default is string.Empty. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

ReadyState Property

-
-

- Gets the state of the WebSocket connection. -

-

Syntax

-
public WsState ReadyState { get; }
-

Value

-
- One of the WebSocketSharp.WsState values. The default is WsState.CONNECTING. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Send Method

-
-

- Sends a binary data using the WebSocket connection. -

-

Syntax

-
public void Send (byte[] data)
-

Parameters

-
-
-
- data -
-
- An array of byte that contains a binary data to send. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Send Method

-
-

- Sends a binary data using the WebSocket connection. -

-

Syntax

-
public void Send (System.IO.FileInfo file)
-

Parameters

-
-
-
- file -
-
- A System.IO.FileInfo that contains a binary data to send. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Send Method

-
-

- Sends a text data using the WebSocket connection. -

-

Syntax

-
public void Send (string data)
-

Parameters

-
-
-
- data -
-
- A string that contains a text data to send. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

SendAsync Method

-
-

- Sends a binary data asynchronously using the WebSocket connection. -

-

Syntax

-
public void SendAsync (byte[] data, Action completed)
-

Parameters

-
-
-
- data -
-
- An array of byte that contains a binary data to send. -
-
- completed -
-
- An Action delegate that references the method(s) called when - the asynchronous operation completes. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

SendAsync Method

-
-

- Sends a binary data asynchronously using the WebSocket connection. -

-

Syntax

-
public void SendAsync (System.IO.FileInfo file, Action completed)
-

Parameters

-
-
-
- file -
-
- A System.IO.FileInfo that contains a binary data to send. -
-
- completed -
-
- An Action delegate that references the method(s) called when - the asynchronous operation completes. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

SendAsync Method

-
-

- Sends a text data asynchronously using the WebSocket connection. -

-

Syntax

-
public void SendAsync (string data, Action completed)
-

Parameters

-
-
-
- data -
-
- A string that contains a text data to send. -
-
- completed -
-
- An Action delegate that references the method(s) called when - the asynchronous operation completes. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

SetCookie Method

-
-

- Sets a WebSocketSharp.Net.Cookie used in the WebSocket opening handshake. -

-

Syntax

-
public void SetCookie (WebSocketSharp.Net.Cookie cookie)
-

Parameters

-
-
-
- cookie -
-
- A WebSocketSharp.Net.Cookie that contains an HTTP Cookie to set. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

SetCredentials Method

-
-

- Sets the credentials for HTTP authentication (Basic/Digest). -

-

Syntax

-
public void SetCredentials (string userName, string password, bool preAuth)
-

Parameters

-
-
-
- userName -
-
- A string that contains a user name associated with the credentials. -
-
- password -
-
- A string that contains a password for userName associated with the credentials. -
-
- preAuth -
-
- true if sends the credentials as a Basic authorization with the first request handshake; - otherwise, false. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Url Property

-
-

- Gets the WebSocket URL to connect. -

-

Syntax

-
public Uri Url { get; }
-

Value

-
- A Uri that contains the WebSocket URL to connect. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp/WebSocketException.html b/websocket-sharp/doc/html/WebSocketSharp/WebSocketException.html deleted file mode 100644 index 064734ea..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp/WebSocketException.html +++ /dev/null @@ -1,312 +0,0 @@ - - - WebSocketSharp.WebSocketException - - - - - -
- websocket-sharp : WebSocketSharp Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

WebSocketException Class

-

- Represents the exception that occurred when attempting to perform an operation on the WebSocket connection. -

-
-

Syntax

-
public class WebSocketException : Exception
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - Exception. -

-

Public Properties

-
-
- - - - - - -
[read-only]
 - - Code - - - - CloseStatusCode - . - Gets the WebSocketSharp.CloseStatusCode associated with a WebSocketSharp.WebSocketException. -
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

Code Property

-
-

- Gets the WebSocketSharp.CloseStatusCode associated with a WebSocketSharp.WebSocketException. -

-

Syntax

-
public CloseStatusCode Code { get; }
-

Value

-
- One of the WebSocketSharp.CloseStatusCode values that indicates the cause of the exception. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp/WsCredential.html b/websocket-sharp/doc/html/WebSocketSharp/WsCredential.html deleted file mode 100644 index e432ebe5..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp/WsCredential.html +++ /dev/null @@ -1,351 +0,0 @@ - - - WebSocketSharp.WsCredential - - - - - -
- websocket-sharp : WebSocketSharp Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

WsCredential Class

-

- Provides the credentials for HTTP authentication (Basic/Digest). -

-
-

Syntax

-
public class WsCredential
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - object. -

-

Public Properties

-
-
- - - - - - - - - - - - - - - - -
[read-only]
 - - Domain - - - - string - . - Gets the name of the user domain associated with the credentials. -
[read-only]
 - - Password - - - - string - . - Gets the password for the user name associated with the credentials. -
[read-only]
 - - UserName - - - - string - . - Gets the user name associated with the credentials. -
-
-
-
-
-
-

Member Details

-
-

Domain Property

-
-

- Gets the name of the user domain associated with the credentials. -

-

Syntax

-
public string Domain { get; }
-

Value

-
- A string that contains the name of the user domain associated with the credentials. - Currently, returns the request uri of a WebSocket opening handshake. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

Password Property

-
-

- Gets the password for the user name associated with the credentials. -

-

Syntax

-
public string Password { get; }
-

Value

-
- A string that contains the password for the user name associated with the credentials. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

UserName Property

-
-

- Gets the user name associated with the credentials. -

-

Syntax

-
public string UserName { get; }
-

Value

-
- A string that contains the user name associated with the credentials. -
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp/WsReceivedTooBigMessageException.html b/websocket-sharp/doc/html/WebSocketSharp/WsReceivedTooBigMessageException.html deleted file mode 100644 index ea285875..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp/WsReceivedTooBigMessageException.html +++ /dev/null @@ -1,351 +0,0 @@ - - - WebSocketSharp.WsReceivedTooBigMessageException - - - - - -
- websocket-sharp : WebSocketSharp Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

WsReceivedTooBigMessageException Class

-

- Documentation for this section has not yet been entered. -

-
-

Syntax

-
public class WsReceivedTooBigMessageException : Exception
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-

Members

-
-

- See Also: Inherited members from - Exception. -

-

Public Constructors

-
-
- - - - - - - - - - - -
-
-
- 		- - - Documentation for this section has not yet been entered. -
-
-
- 		- - - Documentation for this section has not yet been entered. -
-
-
-

Extension Methods

-
-
- - - - - - - - - -
-
static
- 		- - IsNull<T> - (this T) : bool
- Determines whether the specified object is null. -
-
static
- 		- - IsNullDo<T> - (this T, Action) : bool
- Determines whether the specified object is null. - And invokes the specified Action delegate if the specified object is null. -
-
-
-
-
-
-

Member Details

-
-

WsReceivedTooBigMessageException Constructor

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public WsReceivedTooBigMessageException ()
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-

WsReceivedTooBigMessageException Constructor

-
-

- Documentation for this section has not yet been entered. -

-

Syntax

-
public WsReceivedTooBigMessageException (string message)
-

Parameters

-
-
-
- message -
-
- Documentation for this section has not yet been entered. -
-
-
-

Remarks

-
- Documentation for this section has not yet been entered. -
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp/WsState.html b/websocket-sharp/doc/html/WebSocketSharp/WsState.html deleted file mode 100644 index fb960fb1..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp/WsState.html +++ /dev/null @@ -1,273 +0,0 @@ - - - WebSocketSharp.WsState - - - - - -
- websocket-sharp : WebSocketSharp Namespace
-
-

- Overview -

-

- Signature -

-

- Remarks -

-

- Members -

-

- Member Details -

-
-

WsState Enum

-

- Contains the values of the state of the WebSocket connection. -

-
-

Syntax

-
public enum WsState
-
-
-

Remarks

-
- The WsState enumeration contains the values of the state of the WebSocket connection defined in - The WebSocket API. -
-

Members

-
- - - - - - - - - - - - - - - - - - - - - -
Member NameDescription
- CLOSED - - Equivalent to numeric value 3. Indicates that the connection has been closed or could not be opened. -
- CLOSING - - Equivalent to numeric value 2. Indicates that the connection is going through the closing handshake, or the Close method has been invoked. -
- CONNECTING - - Equivalent to numeric value 0. Indicates that the connection has not yet been established. -
- OPEN - - Equivalent to numeric value 1. Indicates that the connection is established and communication is possible. -
-
-

Requirements

-
- Namespace: WebSocketSharp
Assembly: websocket-sharp (in websocket-sharp.dll)
-
-
-
-
-
-
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/WebSocketSharp/index.html b/websocket-sharp/doc/html/WebSocketSharp/index.html deleted file mode 100644 index 951cb0c0..00000000 --- a/websocket-sharp/doc/html/WebSocketSharp/index.html +++ /dev/null @@ -1,308 +0,0 @@ - - - websocket-sharp: WebSocketSharp - - - - - -
- websocket-sharp -
-

WebSocketSharp Namespace

-

-

-
-
-
-

Namespace

-

The WebSocketSharp namespace contains classes and enumerations to implement the WebSocket interface.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- ByteOrder - - Contains the values that indicate whether the byte order is a Little-endian or Big-endian. -
- CloseEventArgs - - Contains the event data associated with a WebSocketSharp.WebSocket.OnClose event. -
- CloseStatusCode - - Contains the values of the status codes for the WebSocket connection closure. -
- CompressionMethod - - Contains the values of the compression methods used to compress the payload data of the WebSocket Data frame. -
- ErrorEventArgs - - Contains the event data associated with a error event. -
- Ext - - Provides a set of static methods for the websocket-sharp. -
- MessageEventArgs - - Contains the event data associated with a WebSocketSharp.WebSocket.OnMessage event. -
- Opcode - - Contains the values of the opcodes that denotes the frame type of the WebSocket frame. -
- WebSocket - - Implements the WebSocket interface. -
- WebSocketException - - Represents the exception that occurred when attempting to perform an operation on the WebSocket connection. -
- WsCredential - - Provides the credentials for HTTP authentication (Basic/Digest). -
- WsState - - Contains the values of the state of the WebSocket connection. -
-
-
-
-
-
Copyright (c) 2010-2013 sta.blockhead
- - \ No newline at end of file diff --git a/websocket-sharp/doc/html/index.html b/websocket-sharp/doc/html/index.html deleted file mode 100644 index f3eb02a9..00000000 --- a/websocket-sharp/doc/html/index.html +++ /dev/null @@ -1,540 +0,0 @@ - - - websocket-sharp - - - - - -
-
-

websocket-sharp

-

-

A C# implementation of the WebSocket protocol client & server.
-

-
-
-
-

- WebSocketSharp Namespace -

-

The WebSocketSharp namespace contains classes and enumerations to implement the WebSocket interface.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- ByteOrder - - Contains the values that indicate whether the byte order is a Little-endian or Big-endian. -
- CloseEventArgs - - Contains the event data associated with a WebSocketSharp.WebSocket.OnClose event. -
- CloseStatusCode - - Contains the values of the status codes for the WebSocket connection closure. -
- CompressionMethod - - Contains the values of the compression methods used to compress the payload data of the WebSocket Data frame. -
- ErrorEventArgs - - Contains the event data associated with a error event. -
- Ext - - Provides a set of static methods for the websocket-sharp. -
- MessageEventArgs - - Contains the event data associated with a WebSocketSharp.WebSocket.OnMessage event. -
- Opcode - - Contains the values of the opcodes that denotes the frame type of the WebSocket frame. -
- WebSocket - - Implements the WebSocket interface. -
- WebSocketException - - Represents the exception that occurred when attempting to perform an operation on the WebSocket connection. -
- WsCredential - - Provides the credentials for HTTP authentication (Basic/Digest). -
- WsState - - Contains the values of the state of the WebSocket connection. -
-

- WebSocketSharp.Net Namespace -

-

The WebSocketSharp.Net namespace contains some modified classes and enumerations in the System.Net namespace (e.g. System.Net.HttpListenerContext) to accept the WebSocket connection requests.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- AuthenticationSchemes - - Contains the values of the schemes for authentication. -
- AuthenticationSchemeSelector - - Selects the authentication scheme for a WebSocketSharp.Net.HttpListener instance. -
- Cookie - - Provides a set of properties and methods used to manage an HTTP Cookie. -
- CookieCollection - - Provides a collection container for instances of the WebSocketSharp.Net.Cookie class. -
- CookieException - - The exception that is thrown when a WebSocketSharp.Net.Cookie gets an error. -
- HttpListener - - Provides a simple, programmatically controlled HTTP listener. -
- HttpListenerContext - - Provides access to the HTTP request and response objects used by the WebSocketSharp.Net.HttpListener class. -
- HttpListenerException - - The exception that is thrown when an error occurs processing an HTTP request. -
- HttpListenerPrefixCollection - - Provides the collection used to store the URI prefixes for the WebSocketSharp.Net.HttpListener. -
- HttpListenerRequest - - Provides access to a request to a WebSocketSharp.Net.HttpListener instance. -
- HttpListenerResponse - - Provides access to a response to a request being processed by a WebSocketSharp.Net.HttpListener instance. -
- HttpStatusCode - - Contains the values of the HTTP status codes. -
- HttpVersion - - Provides the HTTP version numbers. -
- WebHeaderCollection - - Provides a collection of the HTTP headers associated with a request or response. -
-

- WebSocketSharp.Net.WebSockets Namespace -

-

The WebSocketSharp.Net.WebSockets namespace contains classes to access to the WebSocket connection request objects.

- - - - - - - - - - - - - - - - - -
TypeDescription
- HttpListenerWebSocketContext - - Provides access to the WebSocket connection request objects received by the WebSocketSharp.Net.HttpListener class. -
- TcpListenerWebSocketContext - - Provides access to the WebSocket connection request objects received by the System.Net.Sockets.TcpListener class. -
- WebSocketContext - - Provides access to the WebSocket connection request objects. -
-

- WebSocketSharp.Server Namespace -

-

The WebSocketSharp.Server namespace contains classes to implement the server that receives the WebSocket connection requests.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeDescription
- HttpRequestEventArgs - - Contains the event data associated with the HTTP request events of the WebSocketSharp.Server.HttpServer class. -
- HttpServer - - Provides a simple HTTP server that allows to accept the WebSocket connection requests. -
- IServiceHost - - Exposes the methods and properties for the WebSocket service host. -
- WebSocketServer - - Provides the functions of the server that receives the WebSocket connection requests. -
- WebSocketServerBase - - Provides the basic functions of the server that receives the WebSocket connection requests. -
- WebSocketService - - Provides the basic functions of the WebSocket service. -
- WebSocketServiceHost<T> - - Provides the functions of the server that receives the WebSocket connection requests. -
- WebSocketServiceManager - - Manages the collection of WebSocketSharp.Server.WebSocketService objects. -
-
-
-
-
-
Copyright (c) 2010-2013 sta.blockhead
- - \ No newline at end of file diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Net.WebSockets/HttpListenerWebSocketContext.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Net.WebSockets/HttpListenerWebSocketContext.xml deleted file mode 100644 index 4d7a50fc..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Net.WebSockets/HttpListenerWebSocketContext.xml +++ /dev/null @@ -1,314 +0,0 @@ - - - - - websocket-sharp - - - WebSocketSharp.Net.WebSockets.WebSocketContext - - - - - Provides access to the WebSocket connection request objects received by the class. - - - - - - - - Property - - WebSocketSharp.Net.CookieCollection - - - - Gets the cookies used in the WebSocket opening handshake. - - - A that contains the cookies. - - To be added. - - - - - - Property - - System.Collections.Specialized.NameValueCollection - - - - Gets the HTTP headers used in the WebSocket opening handshake. - - - A that contains the HTTP headers. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the client is authenticated. - - - true if the client is authenticated; otherwise, false. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the client connected from the local computer. - - - true if the client connected from the local computer; otherwise, false. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the WebSocket connection is secured. - - - true if the WebSocket connection is secured; otherwise, false. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the WebSocket connection request is valid. - - - true if the WebSocket connection request is valid; otherwise, false. - - To be added. - - - - - - Property - - System.String - - - - Gets the value of the Origin header field used in the WebSocket opening handshake. - - - A that contains the value of the Origin header field. - - To be added. - - - - - - Property - - System.String - - - - Gets the absolute path of the requested WebSocket URI. - - - A that contains the absolute path of the requested WebSocket URI. - - To be added. - - - - - - Property - - System.Collections.Specialized.NameValueCollection - - - - Gets the collection of query string variables used in the WebSocket opening handshake. - - - A that contains the collection of query string variables. - - To be added. - - - - - - Property - - System.Uri - - - - Gets the WebSocket URI requested by the client. - - - A that contains the WebSocket URI. - - To be added. - - - - - - Property - - System.String - - - - Gets the value of the Sec-WebSocket-Key header field used in the WebSocket opening handshake. - - - A that contains the value of the Sec-WebSocket-Key header field. - - - The SecWebSocketKey property provides a part of the information used by the server to prove that it received a valid WebSocket opening handshake. - - - - - - - Property - - System.Collections.Generic.IEnumerable<System.String> - - - - Gets the values of the Sec-WebSocket-Protocol header field used in the WebSocket opening handshake. - - - An IEnumerable<string> that contains the values of the Sec-WebSocket-Protocol header field. - - - The SecWebSocketProtocols property indicates the subprotocols of the WebSocket connection. - - - - - - - Property - - System.String - - - - Gets the value of the Sec-WebSocket-Version header field used in the WebSocket opening handshake. - - - A that contains the value of the Sec-WebSocket-Version header field. - - - The SecWebSocketVersion property indicates the WebSocket protocol version of the connection. - - - - - - - Property - - System.Net.IPEndPoint - - - - Gets the server endpoint as an IP address and a port number. - - - A that contains the server endpoint. - - To be added. - - - - - - Property - - System.Security.Principal.IPrincipal - - - - Gets the client information (identity, authentication information and security roles). - - - A that contains the client information. - - To be added. - - - - - - Property - - System.Net.IPEndPoint - - - - Gets the client endpoint as an IP address and a port number. - - - A that contains the client endpoint. - - To be added. - - - - - - Property - - WebSocketSharp.WebSocket - - - - Gets the WebSocket instance used for two-way communication between client and server. - - - A . - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.xml deleted file mode 100644 index 192d1ab7..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Net.WebSockets/TcpListenerWebSocketContext.xml +++ /dev/null @@ -1,326 +0,0 @@ - - - - - websocket-sharp - - - WebSocketSharp.Net.WebSockets.WebSocketContext - - - - - Provides access to the WebSocket connection request objects received by the class. - - - - - - - - Property - - WebSocketSharp.Net.CookieCollection - - - - Gets the cookies used in the WebSocket opening handshake. - - - A that contains the cookies. - - To be added. - - This property is not implemented. - - - - - - - Property - - System.Collections.Specialized.NameValueCollection - - - - Gets the HTTP headers used in the WebSocket opening handshake. - - - A that contains the HTTP headers. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the client is authenticated. - - - true if the client is authenticated; otherwise, false. - - To be added. - - This property is not implemented. - - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the client connected from the local computer. - - - true if the client connected from the local computer; otherwise, false. - - To be added. - - This property is not implemented. - - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the WebSocket connection is secured. - - - true if the WebSocket connection is secured; otherwise, false. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the WebSocket connection request is valid. - - - true if the WebSocket connection request is valid; otherwise, false. - - To be added. - - - - - - Property - - System.String - - - - Gets the value of the Origin header field used in the WebSocket opening handshake. - - - A that contains the value of the Origin header field. - - To be added. - - - - - - Property - - System.String - - - - Gets the absolute path of the requested WebSocket URI. - - - A that contains the absolute path of the requested WebSocket URI. - - To be added. - - - - - - Property - - System.Collections.Specialized.NameValueCollection - - - - Gets the collection of query string variables used in the WebSocket opening handshake. - - - A that contains the collection of query string variables. - - To be added. - - - - - - Property - - System.Uri - - - - Gets the WebSocket URI requested by the client. - - - A that contains the WebSocket URI. - - To be added. - - - - - - Property - - System.String - - - - Gets the value of the Sec-WebSocket-Key header field used in the WebSocket opening handshake. - - - A that contains the value of the Sec-WebSocket-Key header field. - - - The SecWebSocketKey property provides a part of the information used by the server to prove that it received a valid WebSocket opening handshake. - - - - - - - Property - - System.Collections.Generic.IEnumerable<System.String> - - - - Gets the values of the Sec-WebSocket-Protocol header field used in the WebSocket opening handshake. - - - An IEnumerable<string> that contains the values of the Sec-WebSocket-Protocol header field. - - - The SecWebSocketProtocols property indicates the subprotocols of the WebSocket connection. - - - - - - - Property - - System.String - - - - Gets the value of the Sec-WebSocket-Version header field used in the WebSocket opening handshake. - - - A that contains the value of the Sec-WebSocket-Version header field. - - - The SecWebSocketVersion property indicates the WebSocket protocol version of the connection. - - - - - - - Property - - System.Net.IPEndPoint - - - - Gets the server endpoint as an IP address and a port number. - - - A that contains the server endpoint. - - To be added. - - - - - - Property - - System.Security.Principal.IPrincipal - - - - Gets the client information (identity, authentication information and security roles). - - - A that contains the client information. - - To be added. - - This property is not implemented. - - - - - - - Property - - System.Net.IPEndPoint - - - - Gets the client endpoint as an IP address and a port number. - - - A that contains the client endpoint. - - To be added. - - - - - - Property - - WebSocketSharp.WebSocket - - - - Gets the WebSocket instance used for two-way communication between client and server. - - - A . - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Net.WebSockets/WebSocketContext.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Net.WebSockets/WebSocketContext.xml deleted file mode 100644 index 8d7bc672..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Net.WebSockets/WebSocketContext.xml +++ /dev/null @@ -1,294 +0,0 @@ - - - - - websocket-sharp - - - System.Object - - - - - Provides access to the WebSocket connection request objects. - - - The WebSocketContext class is an abstract class. - - - - - - - Constructor - - - - Initializes a new instance of the class. - - To be added. - - - - - - Property - - WebSocketSharp.Net.CookieCollection - - - - Gets the cookies used in the WebSocket opening handshake. - - - A that contains the cookies. - - To be added. - - - - - - Property - - System.Collections.Specialized.NameValueCollection - - - - Gets the HTTP headers used in the WebSocket opening handshake. - - - A that contains the HTTP headers. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the client is authenticated. - - - true if the client is authenticated; otherwise, false. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the client connected from the local computer. - - - true if the client connected from the local computer; otherwise, false. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the WebSocket connection is secured. - - - true if the WebSocket connection is secured; otherwise, false. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the WebSocket connection request is valid. - - - true if the WebSocket connection request is valid; otherwise, false. - - To be added. - - - - - - Property - - System.String - - - - Gets the value of the Origin header field used in the WebSocket opening handshake. - - - A that contains the value of the Origin header field. - - To be added. - - - - - - Property - - System.String - - - - Gets the absolute path of the requested WebSocket URI. - - - A that contains the absolute path of the requested WebSocket URI. - - To be added. - - - - - - Property - - System.Collections.Specialized.NameValueCollection - - - - Gets the collection of query string variables used in the WebSocket opening handshake. - - - A that contains the collection of query string variables. - - To be added. - - - - - - Property - - System.Uri - - - - Gets the WebSocket URI requested by the client. - - - A that contains the WebSocket URI. - - To be added. - - - - - - Property - - System.String - - - - Gets the value of the Sec-WebSocket-Key header field used in the WebSocket opening handshake. - - - A that contains the value of the Sec-WebSocket-Key header field. - - - The SecWebSocketKey property provides a part of the information used by the server to prove that it received a valid WebSocket opening handshake. - - - - - - - Property - - System.Collections.Generic.IEnumerable<System.String> - - - - Gets the values of the Sec-WebSocket-Protocol header field used in the WebSocket opening handshake. - - - An IEnumerable<string> that contains the values of the Sec-WebSocket-Protocol header field. - - - The SecWebSocketProtocols property indicates the subprotocols of the WebSocket connection. - - - - - - - Property - - System.String - - - - Gets the value of the Sec-WebSocket-Version header field used in the WebSocket opening handshake. - - - A that contains the value of the Sec-WebSocket-Version header field. - - - The SecWebSocketVersion property indicates the WebSocket protocol version of the connection. - - - - - - - Property - - System.Security.Principal.IPrincipal - - - - Gets the client information (identity, authentication information and security roles). - - - A that contains the client information. - - To be added. - - - - - - Property - - WebSocketSharp.WebSocket - - - - Gets the WebSocket instance used for two-way communication between client and server. - - - A . - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/AuthenticationSchemeSelector.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Net/AuthenticationSchemeSelector.xml deleted file mode 100644 index 2d9ce538..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/AuthenticationSchemeSelector.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - - websocket-sharp - - - System.Delegate - - - - - - WebSocketSharp.Net.AuthenticationSchemes - - - - A that contains a client request information. - - - Selects the authentication scheme for a instance. - - - One of the values that indicates the scheme used to authenticate the specified client request. - - To be added. - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/AuthenticationSchemes.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Net/AuthenticationSchemes.xml deleted file mode 100644 index 1507c035..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/AuthenticationSchemes.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - websocket-sharp - - - System.Enum - - - - System.Flags - - - - - Contains the values of the schemes for authentication. - - To be added. - - - - - - Field - - WebSocketSharp.Net.AuthenticationSchemes - - - - Indicates anonymous authentication. - - - - - - - Field - - WebSocketSharp.Net.AuthenticationSchemes - - - - Indicates basic authentication. - - - - - - - Field - - WebSocketSharp.Net.AuthenticationSchemes - - - - Indicates digest authentication. - - - - - - - Field - - WebSocketSharp.Net.AuthenticationSchemes - - - - Indicates Windows authentication. - - - - - - - Field - - WebSocketSharp.Net.AuthenticationSchemes - - - - Indicates negotiating with the client to determine the authentication scheme. - - - - - - - Field - - WebSocketSharp.Net.AuthenticationSchemes - - - - Indicates that no authentication is allowed. - - - - - - - Field - - WebSocketSharp.Net.AuthenticationSchemes - - - - Indicates NTLM authentication. - - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/Cookie.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Net/Cookie.xml deleted file mode 100644 index 8f877881..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/Cookie.xml +++ /dev/null @@ -1,531 +0,0 @@ - - - - - websocket-sharp - - - System.Object - - - - - Provides a set of properties and methods used to manage an HTTP Cookie. - - - - The Cookie class supports the following cookie formats: - Netscape specification, - RFC 2109 and - RFC 2965. - - - The Cookie class cannot be inherited. - - - - - - - - Constructor - - - - Initializes a new instance of the class. - - To be added. - - - - - - Constructor - - - - - - - A that contains the Name of the cookie. - - - A that contains the Value of the cookie. - - - Initializes a new instance of the class - with the specified and . - - To be added. - - - is or . - - - - or - - - - contains an invalid character. - - - - or - - - - is . - - - - or - - - - contains a string not enclosed in double quotes - that contains an invalid character. - - - - - - - - Constructor - - - - - - - - A that contains the Name of the cookie. - - - A that contains the Value of the cookie. - - - A that contains the value of the Path attribute of the cookie. - - - Initializes a new instance of the class - with the specified , and . - - To be added. - - - is or . - - - - or - - - - contains an invalid character. - - - - or - - - - is . - - - - or - - - - contains a string not enclosed in double quotes - that contains an invalid character. - - - - - - - - Constructor - - - - - - - - - A that contains the Name of the cookie. - - - A that contains the Value of the cookie. - - - A that contains the value of the Path attribute of the cookie. - - - A that contains the value of the Domain attribute of the cookie. - - - Initializes a new instance of the class - with the specified , , - and . - - To be added. - - - is or . - - - - or - - - - contains an invalid character. - - - - or - - - - is . - - - - or - - - - contains a string not enclosed in double quotes - that contains an invalid character. - - - - - - - - Property - - System.String - - - - Gets or sets the value of the Comment attribute of the cookie. - - - A that contains a comment to document intended use of the cookie. - - To be added. - - - - - - Property - - System.Uri - - - - Gets or sets the value of the CommentURL attribute of the cookie. - - - A that contains a URI that provides the comment - to document intended use of the cookie. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets or sets a value indicating whether the client discards the cookie unconditionally - when the client terminates. - - - true if the client discards the cookie unconditionally when the client terminates; - otherwise, false. The default is false. - - To be added. - - - - - - Property - - System.String - - - - Gets or sets the value of the Domain attribute of the cookie. - - - A that contains a URI for which the cookie is valid. - - To be added. - - - - - - Method - - System.Boolean - - - - - - - An to compare with the current . - - - Determines whether the specified is equal to the current . - - - true if the specified is equal to the current ; - otherwise, false. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets or sets a value indicating whether the cookie has expired. - - - true if the cookie has expired; otherwise, false. The default is false. - - To be added. - - - - - - Property - - System.DateTime - - - - Gets or sets the value of the Expires attribute of the cookie. - - - A that contains the date and time at which the cookie expires. - The default is . - - To be added. - - - - - - Method - - System.Int32 - - - - - Serves as a hash function for a object. - - - An that contains a hash code for this instance. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets or sets a value indicating non-HTTP APIs can access the cookie. - - - true if non-HTTP APIs can not access the cookie; otherwise, false. - - To be added. - - - - - - Property - - System.String - - - - Gets or sets the Name of the cookie. - - - A that contains the Name of the cookie. - - To be added. - - - The value specified for a set operation is or . - - - - or - - - - The value specified for a set operation contains an invalid character. - - - - - - - - Property - - System.String - - - - Gets or sets the value of the Path attribute of the cookie. - - - A that contains a subset of URI on the origin server - to which the cookie applies. - - To be added. - - - - - - Property - - System.String - - - - Gets or sets the value of the Port attribute of the cookie. - - - A that contains a list of the TCP ports to which the cookie applies. - - To be added. - - The value specified for a set operation is not enclosed in double quotes or could not be parsed. - - - - - - - Property - - System.Boolean - - - - Gets or sets a value indicating whether the security level of the cookie is secure. - - - true if the security level of the cookie is secure; otherwise, false. - The default is false. - - - When this property is true, the cookie may be included in the HTTP request - only if the request is transmitted over the HTTPS. - - - - - - - Property - - System.DateTime - - - - Gets the time when the cookie was issued. - - - A that contains the time when the cookie was issued. - - To be added. - - - - - - Method - - System.String - - - - - Returns a that represents the current . - - - A that represents the current . - - - This method returns a to use to send an HTTP Cookie to an origin server. - - - - - - - Property - - System.String - - - - Gets or sets the Value of the cookie. - - - A that contains the Value of the cookie. - - To be added. - - - The value specified for a set operation is . - - - - or - - - - The value specified for a set operation contains a string not enclosed in double quotes - that contains an invalid character. - - - - - - - - Property - - System.Int32 - - - - Gets or sets the value of the Version attribute of the cookie. - - - An that contains the version of the HTTP state management - to which the cookie conforms. - - To be added. - - The value specified for a set operation is not allowed. The value must be 0 or 1. - - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/CookieCollection.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Net/CookieCollection.xml deleted file mode 100644 index 32ff69ca..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/CookieCollection.xml +++ /dev/null @@ -1,305 +0,0 @@ - - - - - websocket-sharp - - - System.Object - - - - System.Collections.ICollection - - - - - Provides a collection container for instances of the class. - - To be added. - - - - - - Constructor - - - - Initializes a new instance of the class. - - To be added. - - - - - - Method - - System.Void - - - - - - - A to add to the . - - - Add the specified to the . - - To be added. - - is . - - - - - - - Method - - System.Void - - - - - - - A to add to the current . - - - Add the elements of the specified to the current . - - To be added. - - is . - - - - - - - Method - - System.Void - - - - - - - - An is the destination of the elements copied from the . - - - An that indicates the zero-based index in at which copying begins. - - - Copies the elements of the to the specified , - starting at the specified in the . - - To be added. - - is . - - - is less than zero. - - - - is multidimensional. - - - -or- - - - The number of elements in the is greater than the available space - from index to the end of the destination . - - - - The elements in the cannot be cast automatically - to the type of the destination . - - - - - - - Method - - System.Void - - - - - - - - An array of is the destination of the elements copied from the . - - - An that indicates the zero-based index in at which copying begins. - - - Copies the elements of the to the specified array of , - starting at the specified in the . - - To be added. - - is . - - - is less than zero. - - - The number of elements in the is greater than the available space - from index to the end of the destination . - - - - - - - Property - - System.Int32 - - - - Gets the number of cookies contained in the . - - - An that indicates the number of cookies contained in the . - - To be added. - - - - - - Method - - System.Collections.IEnumerator - - - - - Gets the enumerator to use to iterate through the . - - - An instance of an implementation of the interface - to use to iterate through the . - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the is read-only. - - - true if the is read-only; otherwise, false. - The default is true. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether access to the is thread safe. - - - true if access to the is thread safe; otherwise, false. - The default is false. - - To be added. - - - - - - Property - - WebSocketSharp.Net.Cookie - - - - - - - An is the zero-based index of the to find. - - - Gets the with the specified from the . - - - A with the specified in the . - - To be added. - - is less than zero or is greater than or - equal to . - - - - - - - Property - - WebSocketSharp.Net.Cookie - - - - - - - A is the name of the to find. - - - Gets the with the specified from the . - - - A with the specified in the . - - To be added. - - is . - - - - - - - Property - - System.Object - - - - Gets an object to use to synchronize access to the . - - - An to use to synchronize access to the . - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/CookieException.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Net/CookieException.xml deleted file mode 100644 index 437d195e..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/CookieException.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - websocket-sharp - - - System.FormatException - - - - - The exception that is thrown when a gets an error. - - To be added. - - - - - - Constructor - - - - Initializes a new instance of the class. - - To be added. - - - - - - Constructor - - - - - - - A that holds the serialized object data. - - - A that contains the contextual information about the source or destination. - - - Initializes a new instance of the class - with the specified and . - - To be added. - - - - - - Method - - System.Void - - - - - - - - A that holds the serialized object data. - - - A that specifies the destination for the serialization. - - - Populates the specified with the data needed to serialize the . - - To be added. - - - - - - Method - - System.Void - - - - - - - - A that holds the serialized object data. - - - A that specifies the destination for the serialization. - - - Populates the specified with the data needed to serialize the . - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListener.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListener.xml deleted file mode 100644 index 7b150a77..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListener.xml +++ /dev/null @@ -1,386 +0,0 @@ - - - - - websocket-sharp - - - System.Object - - - - System.IDisposable - - - - - Provides a simple, programmatically controlled HTTP listener. - - To be added. - - - - - - Constructor - - - - Initializes a new instance of the class. - - To be added. - - - - - - Method - - System.Void - - - - - Shuts down the immediately. - - To be added. - - - - - - Property - - WebSocketSharp.Net.AuthenticationSchemes - - - - Gets or sets the scheme used to authenticate the clients. - - - One of the values that indicates the scheme used to - authenticate the clients. The default value is . - - To be added. - - This object has been closed. - - - - - - - Property - - WebSocketSharp.Net.AuthenticationSchemeSelector - - - - Gets or sets the delegate called to determine the scheme used to authenticate clients. - - - A delegate that invokes the method(s) used to select - an authentication scheme. The default value is . - - To be added. - - This object has been closed. - - - - - - - Method - - System.IAsyncResult - - - - - - - - An delegate that references the method(s) - called when the asynchronous operation completes. - - - An that contains a user defined object to pass to the delegate. - - - Begins getting an incoming request information asynchronously. - - - An that contains the status of the asynchronous operation. - - - This asynchronous operation must be completed by calling the method. - Typically, the method is invoked by the delegate. - - - The has not been started or is stopped currently. - - - This object has been closed. - - - - - - - Method - - System.Void - - - - - Shuts down the . - - To be added. - - - - - - Method - - WebSocketSharp.Net.HttpListenerContext - - - - - - - An obtained by calling the method. - - - Ends an asynchronous operation to get an incoming request information. - - - A that contains a client's request information. - - - This method completes an asynchronous operation started by calling the method. - - - is . - - - was not obtained by calling the method. - - - The EndGetContext method was already called for the specified . - - - This object has been closed. - - - - - - - Method - - WebSocketSharp.Net.HttpListenerContext - - - - - Gets an incoming request information. - - - A that contains a client's request information. - - - This method waits for an incoming request and returns the request information - when received the request. - - - - The does not have any URI prefixes to listen on. - - - -or- - - - The has not been started or is stopped currently. - - - - This object has been closed. - - - - - - - Property - - System.Boolean - - - - Gets or sets a value indicating whether the returns exceptions - that occur when sending the response to the client. - - - true if does not return exceptions that occur when sending the response to the client; - otherwise, false. The default value is false. - - To be added. - - This object has been closed. - - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the has been started. - - - true if the has been started; otherwise, false. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the can be used with the current operating system. - - - true. - - To be added. - - - - - - Property - - WebSocketSharp.Net.HttpListenerPrefixCollection - - - - Gets the URI prefixes handled by the . - - - A that contains the URI prefixes. - - To be added. - - This object has been closed. - - - - - - - Property - - System.String - - - - Gets or sets the name of the realm associated with the . - - - A that contains the name of the realm. - - To be added. - - This object has been closed. - - - - - - - Method - - System.Void - - - - - Starts to receive incoming requests. - - To be added. - - This object has been closed. - - - - - - - Method - - System.Void - - - - - Stops receiving incoming requests. - - To be added. - - This object has been closed. - - - - - - - Method - - System.Void - - - - - Releases all resource used by the . - - To be added. - - - - - - Property - - System.Boolean - - - - 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. - - - true if the authentication information of first request is used; - otherwise, false. The default value is false. - - To be added. - - This object has been closed. - - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListenerContext.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListenerContext.xml deleted file mode 100644 index 7fefc6cb..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListenerContext.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - websocket-sharp - - - System.Object - - - - - Provides access to the HTTP request and response objects used by the class. - - - The HttpListenerContext class cannot be inherited. - - - - - - - Method - - WebSocketSharp.Net.WebSockets.HttpListenerWebSocketContext - - - - - Accepts a WebSocket connection by the . - - - A that contains a WebSocket connection. - - To be added. - - - - - - Property - - WebSocketSharp.Net.HttpListenerRequest - - - - Gets the that contains the HTTP request from a client. - - - A that contains the HTTP request objects. - - To be added. - - - - - - Property - - WebSocketSharp.Net.HttpListenerResponse - - - - Gets the that contains the HTTP response to send to - the client in response to the client's request. - - - A that contains the HTTP response objects. - - To be added. - - - - - - Property - - System.Security.Principal.IPrincipal - - - - Gets the client information (identity, authentication information and security roles). - - - A contains the client information. - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListenerException.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListenerException.xml deleted file mode 100644 index 04f00d59..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListenerException.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - websocket-sharp - - - System.ComponentModel.Win32Exception - - - - - The exception that is thrown when an error occurs processing an HTTP request. - - To be added. - - - - - - Constructor - - - - Initializes a new instance of the class. - - To be added. - - - - - - Constructor - - - - - - An that contains an error code. - - - Initializes a new instance of the class - with the specified . - - To be added. - - - - - - Constructor - - - - - - - An that contains an error code. - - - A that describes the error. - - - Initializes a new instance of the class - with the specified and . - - To be added. - - - - - - Constructor - - - - - - - A that contains the information required to deserialize - the new object. - - - A . - - - Initializes a new instance of the class - from the specified and classes. - - To be added. - - - - - - Property - - System.Int32 - - - - Gets a value that represents the error that occurred. - - - An that contains an error code. - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListenerPrefixCollection.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListenerPrefixCollection.xml deleted file mode 100644 index 955557db..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListenerPrefixCollection.xml +++ /dev/null @@ -1,274 +0,0 @@ - - - - - websocket-sharp - - - System.Object - - - - System.Collections.Generic.ICollection<System.String> - - - System.Collections.Generic.IEnumerable<System.String> - - - - - Provides the collection used to store the URI prefixes for the . - - To be added. - - - - - - Method - - System.Void - - - - - - - A that contains a URI prefix to add. - - - Adds the specified to the . - - To be added. - - is . - - - The associated with this is closed. - - - - - - - Method - - System.Void - - - - - Removes all URI prefixes from the . - - To be added. - - The associated with this is closed. - - - - - - - Method - - System.Boolean - - - - - - - A that contains a URI prefix to test. - - - Returns a value indicating whether the contains - the specified . - - - true if the contains the specified ; - otherwise, false. - - To be added. - - is . - - - The associated with this is closed. - - - - - - - Method - - System.Void - - - - - - - - An that receives the URI prefix strings in the . - - - An that contains the zero-based index in at which copying begins. - - - Copies the contents of the to the specified . - - To be added. - - The associated with this is closed. - - - - - - - Method - - System.Void - - - - - - - - An array of that receives the URI prefix strings in the . - - - An that contains the zero-based index in at which copying begins. - - - Copies the contents of the to the specified array of . - - To be added. - - The associated with this is closed. - - - - - - - Property - - System.Int32 - - - - Gets the number of prefixes contained in the . - - - A that contains the number of prefixes. - - To be added. - - - - - - Method - - System.Collections.Generic.IEnumerator<System.String> - - - - - Gets an object that can be used to iterate through the . - - - An object that implements the IEnumerator<string> interface and provides access to - the URI prefix strings in the . - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether access to the is read-only. - - - Always returns false. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether access to the is synchronized. - - - Always returns false. - - To be added. - - - - - - Method - - System.Boolean - - - - - - - A that contains a URI prefix to remove. - - - Removes the specified from the list of prefixes in the . - - - true if the was found in the - and removed; otherwise, false. - - To be added. - - is . - - - The associated with this is closed. - - - - - - - Method - - System.Collections.IEnumerator - - - - - Gets an object that can be used to iterate through the . - - - An object that implements the interface and provides access to - the URI prefix strings in the . - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListenerRequest.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListenerRequest.xml deleted file mode 100644 index 84735b31..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListenerRequest.xml +++ /dev/null @@ -1,565 +0,0 @@ - - - - - websocket-sharp - - - System.Object - - - - - Provides access to a request to a instance. - - - The HttpListenerRequest class cannot be inherited. - - - - - - - Property - - System.String[] - - - - Gets the media types which are acceptable for the response. - - - An array of that contains the media type names in the Accept request-header field - or if the request did not include an Accept header. - - To be added. - - - - - - Method - - System.IAsyncResult - - - - - - - - An delegate that references the method(s) - called when the asynchronous operation completes. - - - An that contains a user defined object to pass to the delegate. - - - Begins getting the client's X.509 v.3 certificate asynchronously. - - - An that contains the status of the asynchronous operation. - - - This asynchronous operation must be completed by calling the method. - Typically, the method is invoked by the delegate. - - - This method is not implemented. - - - - - - - Property - - System.Int32 - - - - Gets an error code that identifies a problem with the client's certificate. - - - Always returns 0. - - To be added. - - - - - - Property - - System.Text.Encoding - - - - Gets the encoding that can be used with the entity body data included in the request. - - - A that contains the encoding that can be used with the entity body data. - - To be added. - - - - - - Property - - System.Int64 - - - - Gets the size of the entity body data included in the request. - - - A that contains the value of the Content-Length entity-header field. - The value is a number of bytes in the entity body data. -1 if the size is not known. - - To be added. - - - - - - Property - - System.String - - - - Gets the media type of the entity body included in the request. - - - A that contains the value of the Content-Type entity-header field. - - To be added. - - - - - - Property - - WebSocketSharp.Net.CookieCollection - - - - Gets the cookies included in the request. - - - A that contains the cookies included in the request. - - To be added. - - - - - - Method - - System.Security.Cryptography.X509Certificates.X509Certificate2 - - - - - - - An obtained by calling the method. - - - Ends an asynchronous operation to get the client's X.509 v.3 certificate. - - - A that contains the client's X.509 v.3 certificate. - - - This method completes an asynchronous operation started by calling the method. - - - This method is not implemented. - - - - - - - Method - - System.Security.Cryptography.X509Certificates.X509Certificate2 - - - - - Gets the client's X.509 v.3 certificate. - - - A that contains the client's X.509 v.3 certificate. - - To be added. - - This method is not implemented. - - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the request has the entity body. - - - true if the request has the entity body; otherwise, false. - - To be added. - - - - - - Property - - System.Collections.Specialized.NameValueCollection - - - - Gets the HTTP headers used in the request. - - - A that contains the HTTP headers used in the request. - - To be added. - - - - - - Property - - System.String - - - - Gets the HTTP method used in the request. - - - A that contains the HTTP method used in the request. - - To be added. - - - - - - Property - - System.IO.Stream - - - - Gets a that contains the entity body data included in the request. - - - A that contains the entity body data included in the request. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the client that sent the request is authenticated. - - - Always returns false. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the request is sent from the local computer. - - - true if the request is sent from the local computer; otherwise, false. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the HTTP connection is secured using the SSL protocol. - - - true if the HTTP connection is secured; otherwise, false. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the request is a WebSocket connection request. - - - true if the request is a WebSocket connection request; otherwise, false. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the client requests a persistent connection. - - - true if the client requests a persistent connection; otherwise, false. - - To be added. - - - - - - Property - - System.Net.IPEndPoint - - - - Gets the server endpoint as an IP address and a port number. - - - A that contains the server endpoint. - - To be added. - - - - - - Property - - System.Version - - - - Gets the HTTP version used in the request. - - - A that contains the HTTP version used in the request. - - To be added. - - - - - - Property - - System.Collections.Specialized.NameValueCollection - - - - Gets the collection of query string variables used in the request. - - - A that contains the collection of query string variables used in the request. - - To be added. - - - - - - Property - - System.String - - - - Gets the raw URL (without the scheme, host and port) requested by the client. - - - A that contains the raw URL requested by the client. - - To be added. - - - - - - Property - - System.Net.IPEndPoint - - - - Gets the client endpoint as an IP address and a port number. - - - A that contains the client endpoint. - - To be added. - - - - - - Property - - System.Guid - - - - Gets the identifier of a request. - - - A that contains the identifier of a request. - - To be added. - - - - - - Property - - System.Uri - - - - Gets the URL requested by the client. - - - A that contains the URL requested by the client. - - To be added. - - - - - - Property - - System.Uri - - - - Gets the URL of the resource from which the requested URL was obtained. - - - A that contains the value of the Referer request-header field. - - To be added. - - - - - - Property - - System.String - - - - Gets the information about the user agent originating the request. - - - A that contains the value of the User-Agent request-header field. - - To be added. - - - - - - Property - - System.String - - - - Gets the server endpoint as an IP address and a port number. - - - A that contains the server endpoint. - - To be added. - - - - - - Property - - System.String - - - - Gets the internet host name and port number (if present) of the resource being requested. - - - A that contains the value of the Host request-header field. - - To be added. - - - - - - Property - - System.String[] - - - - Gets the natural languages that are preferred as a response to the request. - - - An array of that contains the natural language names in the Accept-Language request-header field. - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListenerResponse.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListenerResponse.xml deleted file mode 100644 index 5543f89c..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpListenerResponse.xml +++ /dev/null @@ -1,534 +0,0 @@ - - - - - websocket-sharp - - - System.Object - - - - System.IDisposable - - - - - Provides access to a response to a request being processed by a instance. - - - The HttpListenerResponse class cannot be inherited. - - - - - - - Method - - System.Void - - - - - Closes the connection to the client without sending a response. - - To be added. - - - - - - Method - - System.Void - - - - - - - - A that contains the name of the HTTP header to add. - - - A that contains the value of the HTTP header to add. - - - Adds the specified HTTP header and to - the headers for this response. - - To be added. - - is or . - - - The length of is greater than 65,535 characters. - - - - - - - Method - - System.Void - - - - - - - A to add to the . - - - Adds the specified to the sent with the response. - - To be added. - - is . - - - - - - - Method - - System.Void - - - - - - - - A that contains the name of the HTTP header to append to. - - - A that contains the value to append to the HTTP header. - - - Appends a to the specified HTTP header sent with the response. - - To be added. - - is or . - - - The length of is greater than 65,535 characters. - - - - - - - Method - - System.Void - - - - - Sends the response to the client and releases the resources associated with - the instance. - - To be added. - - - - - - Method - - System.Void - - - - - - - - An array of that contains the response entity body data. - - - true if this method blocks execution while flushing the stream to the client; otherwise, false. - - - Sends the response with the specified array of to the client and - releases the resources associated with the instance. - - To be added. - - is . - - - This object is closed. - - - - - - - Property - - System.Text.Encoding - - - - Gets or sets the encoding that can be used with the entity body data included in the response. - - - A that contains the encoding that can be used with the entity body data. - - To be added. - - This object is closed. - - - The response has been sent already. - - - - - - - Property - - System.Int64 - - - - Gets or sets the size of the entity body data included in the response. - - - A that contains the value of the Content-Length entity-header field. - The value is a number of bytes in the entity body data. - - To be added. - - This object is closed. - - - The response has been sent already. - - - The value specified for a set operation is less than zero. - - - - - - - Property - - System.String - - - - Gets or sets the media type of the entity body included in the response. - - - The type of the content. - A that contains the value of the Content-Type entity-header field. - - To be added. - - This object is closed. - - - The response has been sent already. - - - The value specified for a set operation is . - - - The value specified for a set operation is a . - - - - - - - Property - - WebSocketSharp.Net.CookieCollection - - - - Gets or sets the cookies returned with the response. - - - A that contains the cookies returned with the response. - - To be added. - - - - - - Method - - System.Void - - - - - - - A to copy. - - - Copies properties from the specified to this response. - - To be added. - - - - - - Property - - WebSocketSharp.Net.WebHeaderCollection - - - - Gets or sets the HTTP headers returned to the client. - - - A that contains the HTTP headers returned to the client. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets or sets a value indicating whether the server requests a persistent connection. - - - true if the server requests a persistent connection; otherwise, false. - The default is true. - - To be added. - - This object is closed. - - - The response has been sent already. - - - - - - - Property - - System.IO.Stream - - - - Gets a to use to write the entity body data. - - - A to use to write the entity body data. - - To be added. - - This object is closed. - - - - - - - Property - - System.Version - - - - Gets or sets the HTTP version used in the response. - - - A that contains the HTTP version used in the response. - - To be added. - - This object is closed. - - - The response has been sent already. - - - The value specified for a set operation is . - - - The value specified for a set operation does not have its Major property set to 1 or - does not have its Minor property set to either 0 or 1. - - - - - - - Method - - System.Void - - - - - - - A that contains a URL to redirect the client's request to. - - - Configures the response to redirect the client's request to the specified . - - To be added. - - - - - - Property - - System.String - - - - Gets or sets the URL to which the client is redirected to locate a requested resource. - - - A that contains the value of the Location response-header field. - - To be added. - - This object is closed. - - - The response has been sent already. - - - The value specified for a set operation is a . - - - - - - - Property - - System.Boolean - - - - Gets or sets a value indicating whether the response uses the chunked transfer encoding. - - - true if the response uses the chunked transfer encoding; otherwise, false. - - To be added. - - This object is closed. - - - The response has been sent already. - - - - - - - Method - - System.Void - - - - - - - A to set. - - - Adds or updates a in the sent with the response. - - To be added. - - is . - - - already exists in the and - could not be replaced. - - - - - - - Property - - System.Int32 - - - - Gets or sets the HTTP status code returned to the client. - - - An that indicates the HTTP status code for the response to the request. - The default is . - - To be added. - - This object is closed. - - - The response has been sent already. - - - The value specified for a set operation is invalid. Valid values are between 100 and 999. - - - - - - - Property - - System.String - - - - Gets or sets a description of the HTTP status code returned to the client. - - - A that contains a description of the HTTP status code returned to the client. - - To be added. - - - - - - Method - - System.Void - - - - - Releases all resource used by the . - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpStatusCode.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpStatusCode.xml deleted file mode 100644 index 8c7ad579..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpStatusCode.xml +++ /dev/null @@ -1,707 +0,0 @@ - - - - - websocket-sharp - - - System.Enum - - - - Contains the values of the HTTP status codes. - - - The HttpStatusCode enumeration contains the values of the HTTP status codes defined in - RFC 2616 for HTTP 1.1. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 202. Indicates that the client's request has been accepted for processing, - but the processing has not been completed. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - - Equivalent to status code 300. Indicates that the requested resource corresponds to - any one of multiple representations. - - - Ambiguous is a synonym for MultipleChoices. - - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 502. Indicates that a gateway or proxy server received an invalid response - from the upstream server. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 400. Indicates that the client's request could not be understood - by the server due to malformed syntax. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 409. Indicates that the client's request could not be completed - due to a conflict on the server. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 100. Indicates that the client should continue with its request. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 201. Indicates that the client's request has been fulfilled - and resulted in a new resource being created. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 417. Indicates that the expectation given in an Expect request header field - could not be met by the server. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 403. Indicates that the server understood the client's request - but is refusing to fulfill it. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - - Equivalent to status code 302. Indicates that the requested resource is located temporarily - under a different URI. - - - Found is a synonym for Redirect. - - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 504. Indicates that a gateway or proxy server did not receive a timely response - from the upstream server or some other auxiliary server. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 410. Indicates that the requested resource is no longer available - at the server and no forwarding address is known. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 505. Indicates that the server does not support the HTTP version - used in the client's request. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 500. Indicates that the server encountered an unexpected condition - which prevented it from fulfilling the client's request. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 411. Indicates that the server refuses to accept the client's request - without a defined Content-Length. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 405. Indicates that the method specified in the request line - is not allowed for the resource identified by the request URI. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - - 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. - - - Moved is a synonym for MovedPermanently. - - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - - 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. - - - MovedPermanently is a synonym for Moved. - - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - - Equivalent to status code 300. Indicates that the requested resource corresponds to - any one of multiple representations. - - - MultipleChoices is a synonym for Ambiguous. - - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 204. Indicates that the server has fulfilled the client's request - but does not need to return an entity-body. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 203. Indicates that the returned metainformation is from a local or a third-party copy instead of the origin server. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 406. Indicates that the server does not have the appropriate resource - to respond to the accept headers in the client's request. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 404. Indicates that the server has not found anything - matching the request URI. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 501. Indicates that the server does not support the functionality - required to fulfill the client's request. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 304. Indicates that the client has performed a conditional GET request - and access is allowed, but the document has not been modified. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 200. Indicates that the client's request has succeeded. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 206. Indicates that the server has fulfilled the partial GET request for the resource. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 402. This code is reserved for future use. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 412. Indicates that the precondition given in one or more of the request header fields - evaluated to false when it was tested on the server. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 407. Indicates that the client must first authenticate itself with the proxy. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - - Equivalent to status code 302. Indicates that the requested resource is located temporarily - under a different URI. - - - Redirect is a synonym for Found. - - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - - Equivalent to status code 307. Indicates that the requested resource is located temporarily - under a different URI. - - - RedirectKeepVerb is a synonym for TemporaryRedirect. - - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - - 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. - - - RedirectMethod is a synonym for SeeOther. - - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 416. Indicates that none of the range specifier values in a Range request header field - overlap the current extent of the selected resource. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 413. Indicates that the client's request entity is larger - than the server is willing or able to process. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 408. Indicates that the client did not produce a request - within the time that the server was prepared to wait. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 414. Indicates that the request URI is longer - than the server is willing to interpret. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - 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. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - - 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. - - - SeeOther is a synonym for RedirectMethod. - - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - 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. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 101. Indicates that the server is switching the HTTP version or protocol on the connection. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - - Equivalent to status code 307. Indicates that the requested resource is located temporarily - under a different URI. - - - TemporaryRedirect is a synonym for RedirectKeepVerb. - - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 401. Indicates that the client's request requires user authentication. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - 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. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 306. This code was used in a previous version of the specification, - is no longer used, and is reserved for future use. - - - - - - - Field - - WebSocketSharp.Net.HttpStatusCode - - - - Equivalent to status code 305. Indicates that the requested resource must be accessed - through the proxy given by the Location field. - - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpVersion.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpVersion.xml deleted file mode 100644 index 4ce02876..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/HttpVersion.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - websocket-sharp - - - System.Object - - - - - Provides the HTTP version numbers. - - To be added. - - - - - - Constructor - - - - Initializes a new instance of the class. - - To be added. - - - - - - Field - - System.Version - - - - Provides a instance for HTTP 1.0. - - To be added. - - - - - - Field - - System.Version - - - - Provides a instance for HTTP 1.1. - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/WebHeaderCollection.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Net/WebHeaderCollection.xml deleted file mode 100644 index 8bc83e58..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Net/WebHeaderCollection.xml +++ /dev/null @@ -1,948 +0,0 @@ - - - - - websocket-sharp - - - System.Collections.Specialized.NameValueCollection - - - - System.Runtime.Serialization.ISerializable - - - - - System.Runtime.InteropServices.ComVisible(true) - - - - - Provides a collection of the HTTP headers associated with a request or response. - - To be added. - - - - - - Constructor - - - - Initializes a new instance of the class. - - To be added. - - - - - - Constructor - - - - - - - A that contains the data to need to serialize the object. - - - A that contains the source of the serialized stream associated with the new . - - - Initializes a new instance of the class - with the specified and . - - To be added. - - is . - - - An element with the specified name is not found in . - - - - - - - Method - - System.Void - - - - - - - A that contains a header with the name and value separated by a colon (:). - - - Adds the specified to the collection. - - To be added. - - is , , or - the name part of is . - - - - does not contain a colon. - - - -or- - - - is a restricted header. - - - -or- - - - The name or value part of contains invalid characters. - - - - The length of the value part of is greater than 65535. - - - The current instance does not allow the . - - - - - - - Method - - System.Void - - - - - - - - A is a request header to add. - - - A that contains the value of the header to add. - - - Adds the specified request with the specified to the collection. - - To be added. - - The length of is greater than 65535. - - - The current instance does not allow any of values. - - - - is a restricted header. - - - -or- - - - contains invalid characters. - - - - - - - - Method - - System.Void - - - - - - - - A is a response header to add. - - - A that contains the value of the header to add. - - - Adds the specified response with the specified to the collection. - - To be added. - - The length of is greater than 65535. - - - The current instance does not allow any of values. - - - - is a restricted header. - - - -or- - - - contains invalid characters. - - - - - - - - Method - - System.Void - - - - - - - - A that contains the name of the header to add. - - - A that contains the value of the header to add. - - - Adds a header with the specified and to the collection. - - To be added. - - - or contains invalid characters. - - - -or- - - - is a restricted header name. - - - - The length of is greater than 65535. - - - is or . - - - The current instance does not allow the header . - - - - - - - Method - - System.Void - - - - - - - - A that contains the name of the header to add. - - - A that contains the value of the header to add. - - - Adds a header to the collection without checking whether the header is on the restricted header list. - - To be added. - - or contains invalid characters. - - - is or . - - - The length of is greater than 65535. - - - The current instance does not allow the . - - - - - - - Property - - System.String[] - - - - Gets all header names in the collection. - - - An array of that contains all header names in the collection. - - To be added. - - - - - - Method - - System.Void - - - - - Removes all headers from the collection. - - To be added. - - - - - - Property - - System.Int32 - - - - Gets the number of headers in the collection. - - - An that indicates the number of headers in the collection. - - To be added. - - - - - - Method - - System.String - - - - - - - An that is the zero-based index of the header to get. - - - Get the value of the header with the specified in the collection. - - - A that receives the value of the header. - - To be added. - - - - - - Method - - System.String - - - - - - - A that contains the name of the header to get. - - - Get the value of the header with the specified in the collection. - - - A that receives the value of the header. - if there is no header with in the collection. - - To be added. - - - - - - Method - - System.Collections.IEnumerator - - - - - Gets the enumerator to use to iterate through the . - - - An instance of an implementation of the interface - to use to iterate through the . - - To be added. - - - - - - Method - - System.String - - - - - - - An is the zero-based index of the key to get from the collection. - - - Get the header name at the specified position in the collection. - - - A that receives the header name. - - To be added. - - - - - - Method - - System.Void - - - - - - - - A that holds the data to need to serialize the object. - - - A that specifies the destination for the serialization. - - - Populates the specified with the data to need to - serialize the object. - - To be added. - - is . - - - - - - - Method - - System.String[] - - - - - - - An is the zero-based index of the header in the collection. - - - Gets an array of header values stored in the specified position of the header collection. - - - An array of that receives the header values. - - To be added. - - - - - - Method - - System.String[] - - - - - - - A that contains a header name. - - - Gets an array of header values stored in the specified name. - - - An array of that receives the header values. - - To be added. - - - - - - Method - - System.Boolean - - - - - - - A that contains the name of the header to test. - - - Determines whether the specified header can be set for the request. - - - true if the header is restricted; otherwise, false. - - To be added. - - is or . - - - contains invalid characters. - - - - - - - Method - - System.Boolean - - - - - - - - A that contains the name of the header to test. - - - true if does the test for the response; for the request, false. - - - Determines whether the specified header can be set for the request or the response. - - - true if the header is restricted; otherwise, false. - - To be added. - - is or . - - - contains invalid characters. - - - - - - - Property - - System.String - - - - - - - A that indicates a request header. - - - Gets or sets the specified request in the collection. - - - A that contains the value of the specified request . - - To be added. - - The current instance does not allow any of values. - - - - is a restricted header. - - - -or- - - - contains invalid characters. - - - - The length of is greater than 65535. - - - - - - - Property - - System.String - - - - - - - A that indicates a response header. - - - Gets or sets the specified response in the collection. - - - A that contains the value of the specified response . - - To be added. - - The current instance does not allow any of values. - - - - is a restricted header. - - - -or- - - - contains invalid characters. - - - - The length of is greater than 65535. - - - - - - - Property - - System.Collections.Specialized.NameObjectCollectionBase+KeysCollection - - - - Gets a collection of header names in the collection. - - - A that contains a collection of header names in the collection. - - To be added. - - - - - - Method - - System.Void - - - - - - - An that contains the source of the deserialization event. - - - Implements the interface and raises the deserialization event - when the deserialization is complete. - - To be added. - - - - - - Method - - System.Void - - - - - - - A to remove from the collection. - - - Removes the specified header from the collection. - - To be added. - - The current instance does not allow any of values. - - - is a restricted header. - - - - - - - Method - - System.Void - - - - - - - A to remove from the collection. - - - Removes the specified header from the collection. - - To be added. - - The current instance does not allow any of values. - - - is a restricted header. - - - - - - - Method - - System.Void - - - - - - - A that contains the name of the header to remove from the collection. - - - Removes the specified header from the collection. - - To be added. - - is or . - - - - contains invalid characters. - - - -or- - - - is a restricted header name. - - - - The current instance does not allow the header . - - - - - - - Method - - System.Void - - - - - - - - A to set. - - - A that contains the value of the header to set. - - - Sets the specified header to the specified value. - - To be added. - - The current instance does not allow any of values. - - - - is a restricted header. - - - -or- - - - contains invalid characters. - - - - The length of is greater than 65535. - - - - - - - Method - - System.Void - - - - - - - - A to set. - - - A that contains the value of the header to set. - - - Sets the specified header to the specified value. - - To be added. - - The current instance does not allow any of values. - - - - is a restricted header. - - - -or- - - - contains invalid characters. - - - - The length of is greater than 65535. - - - - - - - Method - - System.Void - - - - - - - - A that contains the name of the header to set. - - - A that contains the value of the header to set. - - - Sets the specified header to the specified value. - - To be added. - - is or . - - - - or contain invalid characters. - - - -or- - - - is a restricted header name. - - - - The length of is greater than 65535. - - - The current instance does not allow the header . - - - - - - - Method - - System.Void - - - - - - - - A that holds the data to need to serialize the object. - - - A that specifies the destination for the serialization. - - - Populates the specified with the data to need to - serialize the object. - - To be added. - - is . - - - - - - - Method - - System.Byte[] - - - - - Converts the current to an array of . - - - An array of that receives the converted current . - - To be added. - - - - - - Method - - System.String - - - - - Returns a that represents the current . - - - A that represents the current . - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/HttpRequestEventArgs.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Server/HttpRequestEventArgs.xml deleted file mode 100644 index 1eade0c0..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/HttpRequestEventArgs.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - websocket-sharp - - - System.EventArgs - - - - - Contains the event data associated with the HTTP request events of the class. - - - An HTTP request event occurs when a instance receives an HTTP request. - If you want to get the HTTP request objects, you should access the property. - If you want to get the HTTP response objects to send, you should access the property. - - - - - - - Property - - WebSocketSharp.Net.HttpListenerRequest - - - - Gets the HTTP request objects sent from a client. - - - A that contains the HTTP request objects. - - To be added. - - - - - - Property - - WebSocketSharp.Net.HttpListenerResponse - - - - Gets the HTTP response objects to send to the client in response to the client's request. - - - A that contains the HTTP response objects. - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/HttpServer.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Server/HttpServer.xml deleted file mode 100644 index acf7cf9f..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/HttpServer.xml +++ /dev/null @@ -1,352 +0,0 @@ - - - - - websocket-sharp - - - System.Object - - - - - Provides a simple HTTP server that allows to accept the WebSocket connection requests. - - - - The HttpServer class provides the multi WebSocket service. - - - - The HttpServer class needs the application configuration file to configure the server root path. - - - <?xml version="1.0" encoding="utf-8"?> - <configuration> - <appSettings> - <add key="RootPath" value="./Public" /> - </appSettings> - </configuration> - - - - - <?xml version="1.0" encoding="utf-8"?> - <configuration> - <appSettings> - <add key="RootPath" value="../../Public" /> - </appSettings> - </configuration> - - - - - - - Constructor - - - - Initializes a new instance of the class that listens for incoming requests - on port 80. - - To be added. - - - - - - Constructor - - - - - - An that contains a port number. - - - Initializes a new instance of the class that listens for incoming requests - on the specified . - - To be added. - - - - - - Method - - System.Void - - - - - DefaultConstructorConstraint - WebSocketSharp.Server.WebSocketService - - - - - - - - - The type of the WebSocket service. The T must inherit the class. - - - A that contains an absolute path associated with the WebSocket service. - - - Adds the specified type WebSocket service. - - To be added. - - - - - - Method - - System.Byte[] - - - - - - - A that contains a virtual path to the file to get. - - - Gets the contents of the specified file. - - - An array of that contains the contents of the file. - - To be added. - - - - - - Event - - System.EventHandler<WebSocketSharp.Server.HttpRequestEventArgs> - - - - Occurs when the server receives an HTTP CONNECT request. - - To be added. - - - - - - Event - - System.EventHandler<WebSocketSharp.Server.HttpRequestEventArgs> - - - - Occurs when the server receives an HTTP DELETE request. - - To be added. - - - - - - Event - - System.EventHandler<WebSocketSharp.ErrorEventArgs> - - - - Occurs when the server gets an error. - - To be added. - - - - - - Event - - System.EventHandler<WebSocketSharp.Server.HttpRequestEventArgs> - - - - Occurs when the server receives an HTTP GET request. - - To be added. - - - - - - Event - - System.EventHandler<WebSocketSharp.Server.HttpRequestEventArgs> - - - - Occurs when the server receives an HTTP HEAD request. - - To be added. - - - - - - Event - - System.EventHandler<WebSocketSharp.Server.HttpRequestEventArgs> - - - - Occurs when the server receives an HTTP OPTIONS request. - - To be added. - - - - - - Event - - System.EventHandler<WebSocketSharp.Server.HttpRequestEventArgs> - - - - Occurs when the server receives an HTTP PATCH request. - - To be added. - - - - - - Event - - System.EventHandler<WebSocketSharp.Server.HttpRequestEventArgs> - - - - Occurs when the server receives an HTTP POST request. - - To be added. - - - - - - Event - - System.EventHandler<WebSocketSharp.Server.HttpRequestEventArgs> - - - - Occurs when the server receives an HTTP PUT request. - - To be added. - - - - - - Event - - System.EventHandler<WebSocketSharp.Server.HttpRequestEventArgs> - - - - Occurs when the server receives an HTTP TRACE request. - - To be added. - - - - - - Property - - System.Int32 - - - - Gets the port on which to listen for incoming requests. - - - An that contains a port number. - - To be added. - - - - - - Property - - System.Collections.Generic.IEnumerable<System.String> - - - - Gets the collection of paths associated with the every WebSocket services that the server provides. - - - An IEnumerable<string> that contains the collection of paths. - - To be added. - - - - - - Method - - System.Void - - - - - Starts the . - - To be added. - - - - - - Method - - System.Void - - - - - Shuts down the . - - To be added. - - - - - - Property - - System.Boolean - - - - Gets or sets a value indicating whether the server cleans up the inactive WebSocket service - instances periodically. - - - true if the server cleans up the inactive WebSocket service instances every 60 seconds; - otherwise, false. The default value is true. - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/IServiceHost.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Server/IServiceHost.xml deleted file mode 100644 index 188b31b4..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/IServiceHost.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - websocket-sharp - - - - - Exposes the methods and properties for the WebSocket service host. - - - - - - - - Method - - System.Void - - - - - - - A that contains the WebSocket connection request objects to bind. - - - Binds the specified to a instance. - - To be added. - - - - - - Method - - System.Void - - - - - - - A to broadcast. - - - Broadcasts the specified to all service clients. - - To be added. - - - - - - Method - - System.Void - - - - - Starts the WebSocket service host. - - To be added. - - - - - - Method - - System.Void - - - - - Stops the WebSocket service host. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets or sets a value indicating whether the WebSocket service host cleans up the inactive service - instances periodically. - - - true if the WebSocket service host cleans up the inactive service instances periodically; - otherwise, false. - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/RequestEventArgs.xml.remove b/websocket-sharp/doc/mdoc/WebSocketSharp.Server/RequestEventArgs.xml.remove deleted file mode 100644 index c3af6eb8..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/RequestEventArgs.xml.remove +++ /dev/null @@ -1,57 +0,0 @@ - - - - - websocket-sharp - - - System.EventArgs - - - - - Contains the event data associated with the request events of the class. - - - A request event occurs when a instance receives an HTTP request. - If you want to get the HTTP request objects, you should access the property. - If you want to get the HTTP response objects to send, you should access the property. - - - - - - - Property - - WebSocketSharp.Net.HttpListenerRequest - - - - Gets the HTTP request objects sent from a client. - - - A that contains the HTTP request objects. - - To be added. - - - - - - Property - - WebSocketSharp.Net.HttpListenerResponse - - - - Gets the HTTP response objects to send to the client in response to the client's request. - - - A that contains the HTTP response objects. - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/ResponseEventArgs.xml.remove b/websocket-sharp/doc/mdoc/WebSocketSharp.Server/ResponseEventArgs.xml.remove deleted file mode 100644 index 2f65587b..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/ResponseEventArgs.xml.remove +++ /dev/null @@ -1,57 +0,0 @@ - - - - - websocket-sharp - - - System.EventArgs - - - - - Contains the event data associated with the response events of the class. - - - A response event occurs when a instance receives an HTTP request. - If you want to get the HTTP request objects, you should access the property. - If you want to get the HTTP response objects to send, you should access the property. - - - - - - - Property - - WebSocketSharp.Net.HttpListenerRequest - - - - Gets the HTTP request objects sent from a client. - - - A that contains the HTTP request objects. - - To be added. - - - - - - Property - - WebSocketSharp.Net.HttpListenerResponse - - - - Gets the HTTP response objects to send to the client in response to the client's request. - - - A that contains the HTTP response objects. - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/ServiceManager.xml.remove b/websocket-sharp/doc/mdoc/WebSocketSharp.Server/ServiceManager.xml.remove deleted file mode 100644 index 9355942d..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/ServiceManager.xml.remove +++ /dev/null @@ -1,145 +0,0 @@ - - - - - websocket-sharp - - - System.Object - - - - To be added. - To be added. - - - - - - Constructor - - - To be added. - To be added. - - - - - - Method - - System.Void - - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - Method - - System.Void - - - - - - To be added. - To be added. - To be added. - - - - - - Property - - System.Int32 - - - To be added. - To be added. - To be added. - - - - - - Property - - System.Collections.Generic.IEnumerable<System.String> - - - To be added. - To be added. - To be added. - - - - - - Property - - System.Collections.Generic.IEnumerable<WebSocketSharp.Server.IServiceHost> - - - To be added. - To be added. - To be added. - - - - - - Method - - System.Void - - - - To be added. - To be added. - - - - - - Property - - System.Boolean - - - To be added. - To be added. - To be added. - - - - - - Method - - System.Boolean - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/SessionManager.xml.remove b/websocket-sharp/doc/mdoc/WebSocketSharp.Server/SessionManager.xml.remove deleted file mode 100644 index a6529f97..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/SessionManager.xml.remove +++ /dev/null @@ -1,251 +0,0 @@ - - - - - websocket-sharp - - - System.Object - - - - To be added. - To be added. - - - - - - Constructor - - - To be added. - To be added. - - - - - - Property - - System.Collections.Generic.IEnumerable<System.String> - - - To be added. - To be added. - To be added. - - - - - - Method - - System.String - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - Method - - System.Void - - - - - - To be added. - To be added. - To be added. - - - - - - Method - - System.Void - - - - - - To be added. - To be added. - To be added. - - - - - - Method - - System.Collections.Generic.Dictionary<System.String,System.Boolean> - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - Property - - System.Int32 - - - To be added. - To be added. - To be added. - - - - - - Property - - System.Collections.Generic.IEnumerable<System.String> - - - To be added. - To be added. - To be added. - - - - - - Property - - System.Collections.Generic.IEnumerable<System.String> - - - To be added. - To be added. - To be added. - - - - - - Method - - System.Boolean - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - Method - - System.Void - - - - To be added. - To be added. - - - - - - Method - - System.Void - - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - Method - - System.Void - - - - To be added. - To be added. - - - - - - Property - - System.Boolean - - - To be added. - To be added. - To be added. - - - - - - Property - - System.Object - - - To be added. - To be added. - To be added. - - - - - - Method - - System.Boolean - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/WebSocketServer.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Server/WebSocketServer.xml deleted file mode 100644 index cfbf0f75..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/WebSocketServer.xml +++ /dev/null @@ -1,261 +0,0 @@ - - - - - websocket-sharp - - - WebSocketSharp.Server.WebSocketServerBase - - - - - Provides the functions of the server that receives the WebSocket connection requests. - - - The WebSocketServer class provides the multi WebSocket service. - - - - - - - Constructor - - - - Initializes a new instance of the class. - - To be added. - - - - - - Constructor - - - - - - An that contains a port number. - - - Initializes a new instance of the class that listens for incoming connection attempts - on the specified . - - To be added. - - - - - - Constructor - - - - - - A that contains a WebSocket URL. - - - Initializes a new instance of the class that listens for incoming connection attempts - on the specified WebSocket URL. - - To be added. - - - - - - Constructor - - - - - - - An that contains a port number. - - - A that indicates providing a secure connection or not. (true indicates providing a secure connection.) - - - Initializes a new instance of the class that listens for incoming connection attempts - on the specified and . - - To be added. - - - - - - Constructor - - - - - - - A that contains a local IP address. - - - An that contains a port number. - - - Initializes a new instance of the class that listens for incoming connection attempts - on the specified and . - - To be added. - - - - - - Constructor - - - - - - - - A that contains a local IP address. - - - An that contains a port number. - - - A that indicates providing a secure connection or not. (true indicates providing a secure connection.) - - - Initializes a new instance of the class that listens for incoming connection attempts - on the specified , and . - - To be added. - - - - - - Method - - System.Void - - - - - - - A that contains the WebSocket connection request objects. - - - Accepts a WebSocket connection request. - - To be added. - - - - - - Method - - System.Void - - - - - DefaultConstructorConstraint - WebSocketSharp.Server.WebSocketService - - - - - - - - - The type of the WebSocket service. The T must inherit the class. - - - A that contains an absolute path associated with the WebSocket service. - - - Adds the specified type WebSocket service. - - To be added. - - - - - - Method - - System.Void - - - - - - - A to broadcast. - - - Broadcasts the specified to all clients. - - To be added. - - - - - - Property - - System.Collections.Generic.IEnumerable<System.String> - - - - Gets the collection of paths associated with the every WebSocket services that the server provides. - - - An IEnumerable<string> that contains the collection of paths. - - To be added. - - - - - - Method - - System.Void - - - - - Stops receiving the WebSocket connection requests. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets or sets a value indicating whether the server cleans up the inactive WebSocket service - instances periodically. - - - true if the server cleans up the inactive WebSocket service instances every 60 seconds; - otherwise, false. The default value is true. - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/WebSocketServerBase.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Server/WebSocketServerBase.xml deleted file mode 100644 index 2f93a71f..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/WebSocketServerBase.xml +++ /dev/null @@ -1,270 +0,0 @@ - - - - - websocket-sharp - - - System.Object - - - - - Provides the basic functions of the server that receives the WebSocket connection requests. - - - The WebSocketServerBase class is an abstract class. - - - - - - - Constructor - - - - Initializes a new instance of the class. - - To be added. - - - - - - Constructor - - - - - - A that contains a WebSocket URL. - - - Initializes a new instance of the class that listens for incoming connection attempts - on the specified WebSocket URL. - - To be added. - - is . - - - is invalid. - - - - - - - Constructor - - - - - - - - - A that contains a local IP address. - - - An that contains a port number. - - - A that contains an absolute path. - - - A that indicates providing a secure connection or not. (true indicates providing a secure connection.) - - - Initializes a new instance of the class that listens for incoming connection attempts - on the specified , , and . - - To be added. - - Either or is . - - - - is invalid. - - - -or- - - - Pair of and is invalid. - - - - - - - - Method - - System.Void - - - - - - - A that contains the WebSocket connection request objects. - - - Accepts a WebSocket connection request. - - To be added. - - - - - - Property - - System.Net.IPAddress - - - - Gets the local IP address on which to listen for incoming connection attempts. - - - A that contains a local IP address. - - To be added. - - - - - - Property - - System.Uri - - - - Gets or sets the WebSocket URL on which to listen for incoming connection attempts. - - - A that contains a WebSocket URL. - - To be added. - - - - - - Method - - System.Void - - - - - - - A that contains an error message. - - - Occurs the event with the specified . - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the server provides secure connection. - - - true if the server provides secure connection; otherwise, false. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the server is self host. - - - true if the server is self host; otherwise, false. - - To be added. - - - - - - Event - - System.EventHandler<WebSocketSharp.ErrorEventArgs> - - - - Occurs when the server gets an error. - - To be added. - - - - - - Property - - System.Int32 - - - - Gets the port on which to listen for incoming connection attempts. - - - An that contains a port number. - - To be added. - - - - - - Method - - System.Void - - - - - Starts to receive the WebSocket connection requests. - - To be added. - - - - - - Method - - System.Void - - - - - Stops receiving the WebSocket connection requests. - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/WebSocketService.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Server/WebSocketService.xml deleted file mode 100644 index b746abb8..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/WebSocketService.xml +++ /dev/null @@ -1,551 +0,0 @@ - - - - - websocket-sharp - - - System.Object - - - - - Provides the basic functions of the WebSocket service. - - - The WebSocketService class is an abstract class. - - - - - - - Constructor - - - - Initializes a new instance of the class. - - To be added. - - - - - - Method - - System.Void - - - - - - - An array of to broadcast. - - - Broadcasts the specified array of to the clients of every instances - in the . - - To be added. - - - - - - Method - - System.Void - - - - - - - A to broadcast. - - - Broadcasts the specified to the clients of every instances - in the . - - To be added. - - - - - - Method - - System.Collections.Generic.Dictionary<System.String,System.Boolean> - - - - - Pings to the clients of every instances - in the . - - - A Dictionary<string, bool> that contains the collection of IDs and values - indicating whether each instances received a Pong in a time. - - To be added. - - - - - - Method - - System.Collections.Generic.Dictionary<System.String,System.Boolean> - - - - - - - A that contains a message. - - - Pings with the specified to the clients of every instances - in the . - - - A Dictionary<string, bool> that contains the collection of IDs and values - indicating whether each instances received a Pong in a time. - - To be added. - - - - - - Property - - System.String - - - - Gets the ID of the instance. - - - A that contains an ID. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the instance is bound to a . - - - true if the instance is bound to a ; otherwise, false. - - To be added. - - - - - - Method - - System.Void - - - - - - - A that contains the event data associated with a event. - - - Occurs when the inner receives a Close frame or the Stop method is called. - - To be added. - - - - - - Method - - System.Void - - - - - - - An that contains the event data associated with a event. - - - Occurs when the inner gets an error. - - To be added. - - - - - - Method - - System.Void - - - - - - - A that contains the event data associated with a event. - - - Occurs when the inner receives a data frame. - - To be added. - - - - - - Method - - System.Void - - - - - Occurs when the WebSocket connection has been established. - - To be added. - - - - - - Method - - System.Boolean - - - - - Pings to the client of the instance. - - - true if the instance receives a Pong in a time; otherwise, false. - - To be added. - - - - - - Method - - System.Boolean - - - - - - - A that contains a message. - - - Pings with the specified to the client of the instance. - - - true if the instance receives a Pong in a time; otherwise, false. - - To be added. - - - - - - Method - - System.Boolean - - - - - - - A that contains an ID that represents the destination for the Ping. - - - Pings to the client of the instance - associated with the specified . - - - true if the instance receives a Pong in a time; otherwise, false. - - To be added. - - - - - - Method - - System.Boolean - - - - - - - - A that contains an ID that represents the destination for the Ping. - - - A that contains a message. - - - Pings with the specified to the client of the instance - associated with the specified . - - - true if the instance receives a Pong in a time; otherwise, false. - - To be added. - - - - - - Method - - System.Boolean - - - - - - - - A that contains a collection of the HTTP Cookies received from the client. - - - A that contains a collection of the HTTP Cookies to send to the client. - - - Processes the cookies used in the WebSocket opening handshake. - - - true if processing the cookies is successfully; otherwise, false. - - To be added. - - - - - - Property - - System.Collections.Specialized.NameValueCollection - - - - Gets the collection of query string variables used in the WebSocket opening handshake. - - - A that contains the collection of query string variables. - - To be added. - - - - - - Method - - System.Void - - - - - - - An array of that contains a binary data to send. - - - Sends a binary data to the client of the instance. - - To be added. - - - - - - Method - - System.Void - - - - - - - A that contains a text data to send. - - - Sends a text data to the client of the instance. - - To be added. - - - - - - Method - - System.Void - - - - - - - - A that contains an ID that represents the destination for the data. - - - An array of that contains a binary data to send. - - - Sends a binary data to the client of the instance - associated with the specified . - - To be added. - - - - - - Method - - System.Void - - - - - - - - A that contains an ID that represents the destination for the data. - - - A that contains a text data to send. - - - Sends a text data to the client of the instance - associated with the specified . - - To be added. - - - - - - Property - - WebSocketSharp.Server.WebSocketServiceManager - - - - Gets the sessions to the . - - - A that contains the sessions to the the . - - To be added. - - - - - - Method - - System.Void - - - - - Starts the instance. - - To be added. - - - - - - Method - - System.Void - - - - - Stops the instance. - - To be added. - - - - - - Method - - System.Void - - - - - - - - A that contains a status code indicating the reason for stop. - - - A that contains a reason for stop. - - - Stops the instance with the specified and . - - To be added. - - - - - - Method - - System.Void - - - - - - - - One of the values that contains a status code indicating the reason for stop. - - - A that contains a reason for stop. - - - Stops the instance with the specified and . - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/WebSocketServiceHost`1.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Server/WebSocketServiceHost`1.xml deleted file mode 100644 index 32150fef..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/WebSocketServiceHost`1.xml +++ /dev/null @@ -1,333 +0,0 @@ - - - - - websocket-sharp - - - - - DefaultConstructorConstraint - WebSocketSharp.Server.WebSocketService - - - - - WebSocketSharp.Server.WebSocketServerBase - - - - WebSocketSharp.Server.IServiceHost - - - - - The type of the WebSocket service that the server provides. The T must inherit the class. - - - Provides the functions of the server that receives the WebSocket connection requests. - - - The WebSocketServiceHost<T> class provides the single WebSocket service. - - - - - - - Constructor - - - - - - An that contains a port number. - - - Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified . - - To be added. - - - - - - Constructor - - - - - - A that contains a WebSocket URL. - - - Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified WebSocket URL. - - To be added. - - - - - - Constructor - - - - - - - An that contains a port number. - - - A that indicates providing a secure connection or not. (true indicates providing a secure connection.) - - - Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified and . - - To be added. - - - - - - Constructor - - - - - - - An that contains a port number. - - - A that contains an absolute path. - - - Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified and . - - To be added. - - - - - - Constructor - - - - - - - - An that contains a port number. - - - A that contains an absolute path. - - - A that indicates providing a secure connection or not. (true indicates providing a secure connection.) - - - Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified , and . - - To be added. - - - - - - Constructor - - - - - - - - A that contains a local IP address. - - - An that contains a port number. - - - A that contains an absolute path. - - - Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified , and . - - To be added. - - - - - - Constructor - - - - - - - - - A that contains a local IP address. - - - An that contains a port number. - - - A that contains an absolute path. - - - A that indicates providing a secure connection or not. (true indicates providing a secure connection.) - - - Initializes a new instance of the WebSocketServiceHost<T> class that listens for incoming connection attempts - on the specified , , and . - - To be added. - - - - - - Method - - System.Void - - - - - - - A that contains the WebSocket connection request objects. - - - Accepts a WebSocket connection request. - - To be added. - - - - - - Method - - System.Void - - - - - - - A to broadcast. - - - Broadcasts the specified to all clients. - - To be added. - - - - - - Method - - System.Collections.Generic.Dictionary<System.String,System.Boolean> - - - - - - - A that contains a message. - - - Pings with the specified to all clients. - - - A Dictionary<string, bool> that contains the collection of session IDs and values - indicating whether the server received the Pongs from each clients in a time. - - To be added. - - - - - - Method - - System.Void - - - - - Stops receiving the WebSocket connection requests. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets or sets a value indicating whether the server cleans up the inactive WebSocket service - instances periodically. - - - true if the server cleans up the inactive WebSocket service instances every 60 seconds; - otherwise, false. The default value is true. - - To be added. - - - - - - Property - - System.Uri - - - - Gets the WebSocket URL on which to listen for incoming connection attempts. - - - A that contains a WebSocket URL. - - To be added. - - - - - - Method - - System.Void - - - - - - - A that contains the WebSocket connection request objects to bind. - - - Binds the specified to a instance. - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/WebSocketServiceManager.xml b/websocket-sharp/doc/mdoc/WebSocketSharp.Server/WebSocketServiceManager.xml deleted file mode 100644 index 6a516904..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp.Server/WebSocketServiceManager.xml +++ /dev/null @@ -1,220 +0,0 @@ - - - - - websocket-sharp - - - System.Object - - - - - Manages the collection of objects. - - To be added. - - - - - - Property - - System.Collections.Generic.IEnumerable<System.String> - - - - Gets the collection of IDs of active objects - managed by the . - - - An IEnumerable<string> that contains the collection of IDs of active objects. - - To be added. - - - - - - Method - - System.Void - - - - - - - An array of to broadcast. - - - Broadcasts the specified array of to the clients of every - managed by the . - - To be added. - - - - - - Method - - System.Void - - - - - - - A to broadcast. - - - Broadcasts the specified to the clients of every - managed by the . - - To be added. - - - - - - Method - - System.Collections.Generic.Dictionary<System.String,System.Boolean> - - - - - - - A that contains a message. - - - Pings with the specified to the clients of every - managed by the . - - - A Dictionary<string, bool> that contains the collection of IDs and values - indicating whether each received a Pong in a time. - - To be added. - - - - - - Property - - System.Int32 - - - - Gets the number of objects - managed by the . - - - An that contains the number of objects - managed by the . - - To be added. - - - - - - Property - - System.Collections.Generic.IEnumerable<System.String> - - - - Gets the collection of IDs of objects - managed by the . - - - An IEnumerable<string> that contains the collection of IDs of objects. - - To be added. - - - - - - Property - - System.Collections.Generic.IEnumerable<System.String> - - - - Gets the collection of IDs of inactive objects - managed by the . - - - An IEnumerable<string> that contains the collection of IDs of inactive objects. - - To be added. - - - - - - Method - - System.Void - - - - - Cleans up the inactive objects. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the cleans up - the inactive objects periodically. - - - true if the cleans up the inactive objects - every 60 seconds; otherwise, false. - - To be added. - - - - - - Method - - System.Boolean - - - - - - - - A that contains the ID to find. - - - When this method returns, contains the with the specified , if the is found; otherwise, . - - - Tries to get the associated with the specified . - - - true if the manages the with the specified ; otherwise, false. - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp/ByteOrder.xml b/websocket-sharp/doc/mdoc/WebSocketSharp/ByteOrder.xml deleted file mode 100644 index 9fb2112e..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp/ByteOrder.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - websocket-sharp - - - System.Enum - - - - Contains the values that indicate whether the byte order is a Little-endian or Big-endian. - - To be added. - - - - - - Field - - WebSocketSharp.ByteOrder - - - - Indicates a Big-endian. - - - - - - - Field - - WebSocketSharp.ByteOrder - - - - Indicates a Little-endian. - - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp/CloseEventArgs.xml b/websocket-sharp/doc/mdoc/WebSocketSharp/CloseEventArgs.xml deleted file mode 100644 index 0a3edf0c..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp/CloseEventArgs.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - websocket-sharp - - - WebSocketSharp.MessageEventArgs - - - - - Contains the event data associated with a event. - - - The event occurs when the WebSocket receives a close control frame or - the WebSocket.Close method is called. If you want to get the reason for closure, you should access - the or properties. - - - - - - - Property - - System.UInt16 - - - - Gets the status code for closure. - - - A that contains a status code for closure. - - To be added. - - - - - - Property - - System.String - - - - Gets the reason for closure. - - - A that contains a reason for closure. - - To be added. - - - - - - Property - - System.Boolean - - - - Indicates whether the WebSocket connection closed cleanly. - - - true if the WebSocket connection closed cleanly; otherwise, false. - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp/CloseStatusCode.xml b/websocket-sharp/doc/mdoc/WebSocketSharp/CloseStatusCode.xml deleted file mode 100644 index d5f2f488..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp/CloseStatusCode.xml +++ /dev/null @@ -1,206 +0,0 @@ - - - - - websocket-sharp - - - System.Enum - - - - Contains the values of the status codes for the WebSocket connection closure. - - - - The CloseStatusCode enumeration contains the values of the status codes for the WebSocket connection closure - defined in RFC 6455 for the WebSocket protocol. - - - "Reserved value" must not be set as a status code in a close control frame by an endpoint. - It is designated for use in applications expecting a status code to indicate that connection - was closed due to a system grounds. - - - - - - - - Field - - WebSocketSharp.CloseStatusCode - - - - Equivalent to close status 1006. Indicates that the connection was closed abnormally. Reserved value. - - - - - - - Field - - WebSocketSharp.CloseStatusCode - - - - Equivalent to close status 1001. Indicates that an endpoint is "going away". - - - - - - - Field - - WebSocketSharp.CloseStatusCode - - - - Equivalent to close status 1010. Indicates that an endpoint (client) is terminating the connection - because it has expected the server to negotiate one or more extension, but the server didn't return - them in the response message of the WebSocket handshake. - - - - - - - Field - - WebSocketSharp.CloseStatusCode - - - - Equivalent to close status 1007. Indicates that an endpoint is terminating the connection - because it has received data within a message that was not consistent with the type of the message. - - - - - - - Field - - WebSocketSharp.CloseStatusCode - - - - Equivalent to close status 1003. Indicates that an endpoint is terminating the connection - because it has received a type of data it cannot accept. - - - - - - - Field - - WebSocketSharp.CloseStatusCode - - - - Equivalent to close status 1005. Indicates that no status code was actually present. Reserved value. - - - - - - - Field - - WebSocketSharp.CloseStatusCode - - - - Equivalent to close status 1000. Indicates a normal closure. - - - - - - - Field - - WebSocketSharp.CloseStatusCode - - - - Equivalent to close status 1008. Indicates that an endpoint is terminating the connection - because it has received a message that violates its policy. - - - - - - - Field - - WebSocketSharp.CloseStatusCode - - - - Equivalent to close status 1002. Indicates that an endpoint is terminating the connection - due to a protocol error. - - - - - - - Field - - WebSocketSharp.CloseStatusCode - - - - Equivalent to close status 1011. Indicates that a server is terminating the connection because it encountered - an unexpected condition that prevented it from fulfilling the request. - - - - - - - Field - - WebSocketSharp.CloseStatusCode - - - - Equivalent to close status 1015. Indicates that the connection was closed due to a failure to perform - a TLS handshake. Reserved value. - - - - - - - Field - - WebSocketSharp.CloseStatusCode - - - - Equivalent to close status 1009. Indicates that an endpoint is terminating the connection - because it has received a message that is too big for it to process. - - - - - - - Field - - WebSocketSharp.CloseStatusCode - - - - Equivalent to close status 1004. Still undefined. Reserved value. - - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp/CompressionMethod.xml b/websocket-sharp/doc/mdoc/WebSocketSharp/CompressionMethod.xml deleted file mode 100644 index cc4edb42..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp/CompressionMethod.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - websocket-sharp - - - System.Enum - - - - Contains the values of the compression methods used to compress the payload data of the WebSocket Data frame. - - - The CompressionMethod enumeration contains the values of the compression methods defined in - Compression Extensions for WebSocket. - - - - - - - Field - - WebSocketSharp.CompressionMethod - - - - Indicates using DEFLATE. - - - - - - - Field - - WebSocketSharp.CompressionMethod - - - - Indicates non compression. - - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp/ErrorEventArgs.xml b/websocket-sharp/doc/mdoc/WebSocketSharp/ErrorEventArgs.xml deleted file mode 100644 index e0205cc9..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp/ErrorEventArgs.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - websocket-sharp - - - System.EventArgs - - - - - Contains the event data associated with a error event. - - - The error event occurs when this event sender gets an error. - If you want to get the error message, you should access the property. - - - - - - - Property - - System.String - - - - Gets the error message. - - - A that contains a error message. - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp/Ext.xml b/websocket-sharp/doc/mdoc/WebSocketSharp/Ext.xml deleted file mode 100644 index 95f968ba..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp/Ext.xml +++ /dev/null @@ -1,1300 +0,0 @@ - - - - - websocket-sharp - - - System.Object - - - - - Provides a set of static methods for the websocket-sharp. - - To be added. - - - - - - Method - - WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext - - - - - - - - A that provides a TCP connection to accept a WebSocket connection. - - - A that indicates a secure connection or not. (true indicates a secure connection.) - - - Accepts a WebSocket connection by the . - - - A that contains a WebSocket connection. - - To be added. - - is . - - - - - - - Method - - System.Void - - - - - - - - - A that provides a TCP connection to accept a WebSocket connection. - - - A that indicates a secure connection or not. (true indicates a secure connection.) - - - An Action<TcpListenerWebSocketContext> delegate that contains the method(s) that is called when an asynchronous operation completes. - - - Accepts a WebSocket connection asynchronously by the . - - To be added. - - is . - - - - - - - Method - - System.Boolean - - - - - - - - A that contains the entries. - - - A that contains the key of the entry to find. - - - Determines whether the specified contains the entry - with the specified . - - - true if contains the entry with ; - otherwise, false. - - To be added. - - - - - - Method - - System.Boolean - - - - - - - System.ParamArray - - - - - - - A to test. - - - An array of that contains characters to find. - - - Determines whether the specified contains any of characters - in the specified array of . - - - true if contains any of ; otherwise, false. - - To be added. - - - - - - Method - - System.Boolean - - - - - - - - - A that contains the entries. - - - A that contains the key of the entry to find. - - - A that contains the value of the entry to find. - - - Determines whether the specified contains the entry - with the specified both and . - - - true if contains the entry with both and ; - otherwise, false. - - To be added. - - - - - - Method - - System.Void - - - - - - - - - An to emit. - - - An that emits the . - - - An that contains no event data. - - - Emit the specified delegate if is not . - - To be added. - - - - - - Method - - System.Void - - - - - System.EventArgs - - - - - - - - - - - The type of the event data generated by the event. - - - An EventHandler<TEventArgs> to emit. - - - An that emits the . - - - A TEventArgs that contains the event data. - - - Emit the specified EventHandler<TEventArgs> delegate if is not . - - To be added. - - - - - - Method - - System.Boolean - - - - - - - - - An to compare. - - - A to compare. - - - A List<byte> to save the as . - - - Determines whether the specified equals the specified as . - And save this specified as to the specified List<byte>. - - - true if the parameter equals the parameter as ; otherwise, false. - - To be added. - - Is thrown when the parameter passed to a method is invalid because it is outside the allowable range of values as . - - - - - - - Method - - System.String - - - - - - - A that contains the URI to get the absolute path from. - - - Gets the absolute path from the specified . - - - A that contains the absolute path if got successfully; otherwise, . - - To be added. - - - - - - Method - - WebSocketSharp.Net.CookieCollection - - - - - - - - A that contains a collection of the HTTP Headers. - - - true if gets from the response ; - from the request , false. - - - Gets the collection of cookies from the specified . - - - A that receives a collection of the HTTP Cookies. - - To be added. - - - - - - Method - - System.String - - - - - - - One of values that contains an HTTP status code. - - - Gets the description of the HTTP status code using the specified . - - - A that contains the description of the HTTP status code. - - To be added. - - - - - - Method - - System.String - - - - - - - - A that contains a pair of name and value separated by a separator string. - - - A that contains a separator string. - - - Gets the name from the specified that contains a pair of name and value - separated by a separator string. - - - A that contains the name if any; otherwise, null. - - To be added. - - - - - - Method - - System.Collections.Generic.KeyValuePair<System.String,System.String> - - - - - - - - A that contains a pair of name and value are separated by a separator string. - - - A that contains a separator string. - - - Gets the name and value from the specified that contains a pair of name and value are separated by a separator string. - - - A KeyValuePair<string, string> that contains the name and value if any. - - To be added. - - - - - - Method - - System.String - - - - - - - An that contains an HTTP status code. - - - Gets the description of the HTTP status code using the specified . - - - A that contains the description of the HTTP status code. - - To be added. - - - - - - Method - - System.String - - - - - - - - A that contains a pair of name and value separated by a separator string. - - - A that contains a separator string. - - - Gets the value from the specified that contains a pair of name and value - separated by a separator string. - - - A that contains the value if any; otherwise, null. - - To be added. - - - - - - Method - - System.Boolean - - - - - - - A to test. - - - Determines whether the specified is in the allowable range of - the WebSocket close status code. - - - true if is in the allowable range of the WebSocket close status code; otherwise, false. - - - Not allowable ranges are the followings. - - Numbers in the range 0-999 are not used. - - Numbers which are greater than 4999 are out of the reserved close status code ranges. - - - - - - - Method - - System.Boolean - - - - - - - A to test. - - - Determines whether the specified is empty. - - - true if is empty; otherwise, false. - - To be added. - - - - - - Method - - System.Boolean - - - - - - - - A to test. - - - A that contains character to find. - - - Determines whether the specified is enclosed in the specified . - - - true if is enclosed in ; otherwise, false. - - To be added. - - - - - - Method - - System.Boolean - - - - - - - A to test. - - - Determines whether the specified is host (this computer architecture) byte order. - - - true if the parameter is host byte order; otherwise, false. - - To be added. - - - - - - Method - - System.Boolean - - - - - - - A to test. - - - Determines whether the specified represents a local IP address. - - - true if represents a local IP address; otherwise, false. - - To be added. - - is . - - - - - - - Method - - System.Boolean - - - - - - - A to test. - - - Determines whether the specified is or empty. - - - true if the parameter is or empty; otherwise, false. - - To be added. - - - - - - Method - - System.Boolean - - - - - - - A to test. - - - Determines whether the specified is predefined scheme. - - - true if the parameter is the predefined scheme; otherwise, false. - - To be added. - - - - - - Method - - System.Boolean - - - - - - - - A that contains an HTTP request information. - - - A that contains a protocol name. - - - Determines whether the specified is the HTTP Upgrade request - to switch to the specified . - - - true if the specified is the HTTP Upgrade request - to switch to the specified ; otherwise, false. - - To be added. - - - is . - - - -or- - - - is . - - - - is . - - - - - - - Method - - System.Boolean - - - - - - - - A to test. - - - A that receives a message if the is invalid. - - - Determines whether the specified is valid absolute path. - - - true if the parameter is valid absolute path; otherwise, false. - - To be added. - - - - - - Method - - System.Boolean - - - - - - - A to test. - - - Determines whether the specified is a URI string. - - - true if the parameter is maybe a URI string; otherwise, false. - - To be added. - - - - - - Method - - System.Byte[] - - - - - - - - A that contains the data to read. - - - An that contains the number of bytes to read. - - - Reads a block of bytes from the specified - and returns the read data in an array of . - - - An array of that receives the read data. - - To be added. - - - - - - Method - - System.Byte[] - - - - - - - - A that contains the data to read. - - - A that contains the number of bytes to read. - - - Reads a block of bytes from the specified - and returns the read data in an array of . - - - An array of that receives the read data. - - To be added. - - - - - - Method - - T[] - - - - - - - - - - - - The type of elements in the . - - - An array of T that contains the data to retrieve a sub-array. - - - An that contains the zero-based starting position of a sub-array in the . - - - An that contains the number of elements to retrieve a sub-array. - - - Retrieves a sub-array from the specified . A sub-array starts at the specified element position. - - - An array of T that receives a sub-array, or an empty array of T if any problems with the parameters. - - To be added. - - - - - - Method - - System.Void - - - - - - - - An is the number of times to execute. - - - An delegate that references the method(s) to execute. - - - Executes the specified delegate times. - - To be added. - - - - - - Method - - System.Void - - - - - - - - An is the number of times to execute. - - - An Action<int> delegate that references the method(s) to execute. - An parameter to pass to the method(s) is the zero-based count of iteration. - - - Executes the specified Action<int> delegate times. - - To be added. - - - - - - Method - - System.Void - - - - - - - - A is the number of times to execute. - - - An delegate that references the method(s) to execute. - - - Executes the specified delegate times. - - To be added. - - - - - - Method - - System.Void - - - - - - - - A is the number of times to execute. - - - An Action<long> delegate that references the method(s) to execute. - A parameter to pass to the method(s) is the zero-based count of iteration. - - - Executes the specified Action<long> delegate times. - - To be added. - - - - - - Method - - System.Void - - - - - - - - A is the number of times to execute. - - - An delegate that references the method(s) to execute. - - - Executes the specified delegate times. - - To be added. - - - - - - Method - - System.Void - - - - - - - - A is the number of times to execute. - - - An Action<uint> delegate that references the method(s) to execute. - A parameter to pass to the method(s) is the zero-based count of iteration. - - - Executes the specified Action<uint> delegate times. - - To be added. - - - - - - Method - - System.Void - - - - - - - - A is the number of times to execute. - - - An delegate that references the method(s) to execute. - - - Executes the specified delegate times. - - To be added. - - - - - - Method - - System.Void - - - - - - - - A is the number of times to execute. - - - An Action<ulong> delegate that references the method(s) to execute. - A parameter to pass to this method(s) is the zero-based count of iteration. - - - Executes the specified Action<ulong> delegate times. - - To be added. - - - - - - Method - - T - - - - - DefaultConstructorConstraint - NotNullableValueTypeConstraint - System.ValueType - - - - - - - - - - The type of the return. The T must be a value type. - - - An array of to convert. - - - A that indicates the byte order of . - - - Converts the specified array of to the specified type data. - - - A T converted from , or a default value of T - if is an empty array of - or if the type of T isn't , , , - , , , , - , or . - - To be added. - - is . - - - - - - - Method - - System.Byte[] - - - - - DefaultConstructorConstraint - NotNullableValueTypeConstraint - System.ValueType - - - - - - - - - - The type of . The T must be a value type. - - - A T to convert. - - - A that indicates the byte order of the return. - - - Converts the specified to an array of . - - - An array of converted from . - - To be added. - - - - - - Method - - System.Byte[] - - - - - - - - An array of to convert. - - - A that indicates the byte order of . - - - Converts the order of the specified array of to the host byte order. - - - An array of converted from . - - To be added. - - is . - - - - - - - Method - - System.String - - - - - - - - - - - The type of elements in . - - - An array of T to convert. - - - A that contains a separator string. - - - Converts the specified to a that concatenates - the each element of across the specified . - - - A converted from , or a - if the length of is zero. - - To be added. - - is . - - - - - - - Method - - System.Uri - - - - - - - A to convert. - - - Converts the specified to a object. - - - A converted from the parameter, or - if the is or . - - To be added. - - - - - - Method - - System.Boolean - - - - - - - - - A that contains a WebSocket URI. - - - When this method returns, contains a created WebSocket if the parameter is valid WebSocket URI; otherwise, . - - - When this method returns, contains a error message if the parameter is invalid WebSocket URI; otherwise, String.Empty. - - - Tries to create a new WebSocket using the specified . - - - true if the WebSocket was successfully created; otherwise, false. - - To be added. - - Is thrown when the parameter passed to a method is invalid because it is . - - - - - - - Method - - System.String - - - - - - - A to decode. - - - URL-decodes the specified . - - - A that receives a decoded string, or the parameter - if the is or . - - To be added. - - - - - - Method - - System.String - - - - - - - A to encode. - - - URL-encodes the specified . - - - A that receives a encoded string, or the parameter - if the is or . - - To be added. - - - - - - Method - - System.Void - - - - - - - - A that contains a network stream to write a content data. - - - An array of that contains a content data to write. - - - Writes the specified content data using the specified . - - To be added. - - Is thrown when the parameter passed to a method is invalid because it is . - - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp/MessageEventArgs.xml b/websocket-sharp/doc/mdoc/WebSocketSharp/MessageEventArgs.xml deleted file mode 100644 index b7ed5f48..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp/MessageEventArgs.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - websocket-sharp - - - System.EventArgs - - - - - Contains the event data associated with a event. - - - The event occurs when the WebSocket receives a text or binary data frame. - If you want to get the received data, you should access the or - properties. - - - - - - - Property - - System.String - - - - Gets the received data as a . - - - A that contains the received data. - - To be added. - - - - - - Property - - System.Byte[] - - - - Gets the received data as an array of . - - - An array of that contains the received data. - - To be added. - - - - - - Property - - WebSocketSharp.Opcode - - - - Gets the type of the received data. - - - One of the values that indicates the type of the received data. - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp/Opcode.xml b/websocket-sharp/doc/mdoc/WebSocketSharp/Opcode.xml deleted file mode 100644 index 84beab99..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp/Opcode.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - websocket-sharp - - - System.Enum - - - - Contains the values of the opcodes that denotes the frame type of the WebSocket frame. - - - The Opcode enumeration contains the values of the opcodes defined in - RFC 6455 for the WebSocket protocol. - - - - - - - Field - - WebSocketSharp.Opcode - - - - Equivalent to numeric value 2. Indicates a binary frame. - - - - - - - Field - - WebSocketSharp.Opcode - - - - Equivalent to numeric value 8. Indicates a connection close frame. - - - - - - - Field - - WebSocketSharp.Opcode - - - - Equivalent to numeric value 0. Indicates a continuation frame. - - - - - - - Field - - WebSocketSharp.Opcode - - - - Equivalent to numeric value 9. Indicates a ping frame. - - - - - - - Field - - WebSocketSharp.Opcode - - - - Equivalent to numeric value 10. Indicates a pong frame. - - - - - - - Field - - WebSocketSharp.Opcode - - - - Equivalent to numeric value 1. Indicates a text frame. - - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp/WebSocket.xml b/websocket-sharp/doc/mdoc/WebSocketSharp/WebSocket.xml deleted file mode 100644 index 44921ce7..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp/WebSocket.xml +++ /dev/null @@ -1,718 +0,0 @@ - - - - - websocket-sharp - - - System.Object - - - - System.IDisposable - - - - - Implements the WebSocket interface. - - - The WebSocket class provides a set of methods and properties for two-way communication - using the WebSocket protocol (RFC 6455). - - - - - - - Constructor - - - - - - System.ParamArray - - - - - - - A that contains a WebSocket URL to connect. - - - An array of that contains the WebSocket subprotocols if any. - - - Initializes a new instance of the class with the specified WebSocket URL and subprotocols. - - - - is . - - - is not valid WebSocket URL. - - - - - - - Constructor - - - - - - - - - - System.ParamArray - - - - - - - A that contains a WebSocket URL to connect. - - - An event handler. - - - An event handler. - - - An event handler. - - - An event handler. - - - An array of that contains the WebSocket subprotocols if any. - - - Initializes a new instance of the class with the specified WebSocket URL, - OnOpen, OnMessage, OnError, OnClose event handlers and subprotocols. - - - This constructor initializes a new instance of the class and - establishes a WebSocket connection. - - - is . - - - is not valid WebSocket URL. - - - - - - - Method - - System.Void - - - - - Closes the WebSocket connection and releases all associated resources. - - To be added. - - - - - - Method - - System.Void - - - - - - - A that indicates the status code for closure. - - - Closes the WebSocket connection with the specified and - releases all associated resources. - - - This Close method emits a event if is not - in the allowable range of the WebSocket close status code. - - - - - - - Method - - System.Void - - - - - - - One of the values that indicates the status code for closure. - - - Closes the WebSocket connection with the specified and - releases all associated resources. - - To be added. - - - - - - Method - - System.Void - - - - - - - - A that indicates the status code for closure. - - - A that contains the reason for closure. - - - Closes the WebSocket connection with the specified and - , and releases all associated resources. - - - This Close method emits a event if is not - in the allowable range of the WebSocket close status code. - - - - - - - Method - - System.Void - - - - - - - - One of the values that indicates the status code for closure. - - - A that contains the reason for closure. - - - Closes the WebSocket connection with the specified and - , and releases all associated resources. - - To be added. - - - - - - Property - - WebSocketSharp.CompressionMethod - - - - Gets or sets the compression method used to compress the payload data of the WebSocket Data frame. - - - One of the values that indicates the compression method to use. - The default is . - - To be added. - - - - - - Method - - System.Void - - - - - Establishes a WebSocket connection. - - To be added. - - - - - - Property - - System.Collections.Generic.IEnumerable<WebSocketSharp.Net.Cookie> - - - - Gets the cookies used in the WebSocket opening handshake. - - - An IEnumerable<Cookie> interface that provides an enumerator which supports the iteration - over the collection of cookies. - - To be added. - - - - - - Property - - WebSocketSharp.WsCredential - - - - Gets the credentials for HTTP authentication (Basic/Digest). - - - A that contains the credentials for HTTP authentication. - - To be added. - - - - - - Method - - System.Void - - - - - Closes the WebSocket connection and releases all associated resources. - - - This method closes the WebSocket connection with the . - - - - - - - Property - - System.String - - - - Gets the WebSocket extensions selected by the server. - - - A that contains the extensions if any. The default is . - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the WebSocket connection is alive. - - - true if the WebSocket connection is alive; otherwise, false. - - To be added. - - - - - - Property - - System.Boolean - - - - Gets a value indicating whether the WebSocket connection is secure. - - - true if the connection is secure; otherwise, false. - - To be added. - - - - - - Event - - System.EventHandler<WebSocketSharp.CloseEventArgs> - - - - Occurs when the receives a Close frame or the Close method is called. - - To be added. - - - - - - Event - - System.EventHandler<WebSocketSharp.ErrorEventArgs> - - - - Occurs when the gets an error. - - To be added. - - - - - - Event - - System.EventHandler<WebSocketSharp.MessageEventArgs> - - - - Occurs when the receives a data frame. - - To be added. - - - - - - Event - - System.EventHandler - - - - Occurs when the WebSocket connection has been established. - - To be added. - - - - - - Property - - System.String - - - - Gets or sets the value of the Origin header used in the WebSocket opening handshake. - - - - A that contains the value of the HTTP Origin header to send. - The default is . - - - The value of the Origin header has the following syntax: <scheme>://<host>[:<port>] - - - A instance does not send the Origin header in the WebSocket opening handshake - if the value of this property is . - - - - - - - Method - - System.Boolean - - - - - Sends a Ping using the WebSocket connection. - - - true if a instance receives a Pong in a time; otherwise, false. - - To be added. - - - - - - Method - - System.Boolean - - - - - - - A that contains a message to send with a Ping. - - - Sends a Ping with the specified using the WebSocket connection. - - - true if a instance receives a Pong in a time; otherwise, false. - - To be added. - - - - - - Property - - System.String - - - - Gets the WebSocket subprotocol selected by the server. - - - A that contains the subprotocol if any. The default is . - - To be added. - - - - - - Property - - WebSocketSharp.WsState - - - - Gets the state of the WebSocket connection. - - - One of the values. The default is . - - To be added. - - - - - - Method - - System.Void - - - - - - - An array of that contains a binary data to send. - - - Sends a binary using the WebSocket connection. - - To be added. - - - - - - Method - - System.Void - - - - - - - A that contains a binary data to send. - - - Sends a binary data using the WebSocket connection. - - To be added. - - - - - - Method - - System.Void - - - - - - - A that contains a text data to send. - - - Sends a text using the WebSocket connection. - - To be added. - - - - - - Method - - System.Void - - - - - - - - An array of that contains a binary data to send. - - - An delegate that references the method(s) called when - the asynchronous operation completes. - - - Sends a binary asynchronously using the WebSocket connection. - - To be added. - - - - - - Method - - System.Void - - - - - - - - A that contains a binary data to send. - - - An delegate that references the method(s) called when - the asynchronous operation completes. - - - Sends a binary data asynchronously using the WebSocket connection. - - To be added. - - - - - - Method - - System.Void - - - - - - - - A that contains a text data to send. - - - An delegate that references the method(s) called when - the asynchronous operation completes. - - - Sends a text asynchronously using the WebSocket connection. - - To be added. - - - - - - Method - - System.Void - - - - - - - A that contains an HTTP Cookie to set. - - - Sets a used in the WebSocket opening handshake. - - To be added. - - - - - - Method - - System.Void - - - - - - - - - A that contains a user name associated with the credentials. - - - A that contains a password for associated with the credentials. - - - true if sends the credentials as a Basic authorization with the first request handshake; - otherwise, false. - - - Sets the credentials for HTTP authentication (Basic/Digest). - - To be added. - - - - - - Property - - System.Uri - - - - Gets the WebSocket URL to connect. - - - A that contains the WebSocket URL to connect. - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp/WebSocketException.xml b/websocket-sharp/doc/mdoc/WebSocketSharp/WebSocketException.xml deleted file mode 100644 index fc3a1edb..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp/WebSocketException.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - websocket-sharp - - - System.Exception - - - - - Represents the exception that occurred when attempting to perform an operation on the WebSocket connection. - - To be added. - - - - - - Property - - WebSocketSharp.CloseStatusCode - - - - Gets the associated with a . - - - One of the values that indicates the cause of the exception. - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp/WsCredential.xml b/websocket-sharp/doc/mdoc/WebSocketSharp/WsCredential.xml deleted file mode 100644 index 7a33a041..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp/WsCredential.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - websocket-sharp - - - System.Object - - - - - Provides the credentials for HTTP authentication (Basic/Digest). - - To be added. - - - - - - Property - - System.String - - - - Gets the name of the user domain associated with the credentials. - - - A that contains the name of the user domain associated with the credentials. - Currently, returns the request uri of a WebSocket opening handshake. - - To be added. - - - - - - Property - - System.String - - - - Gets the password for the user name associated with the credentials. - - - A that contains the password for the user name associated with the credentials. - - To be added. - - - - - - Property - - System.String - - - - Gets the user name associated with the credentials. - - - A that contains the user name associated with the credentials. - - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp/WsReceivedTooBigMessageException.xml.remove b/websocket-sharp/doc/mdoc/WebSocketSharp/WsReceivedTooBigMessageException.xml.remove deleted file mode 100644 index 82a08610..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp/WsReceivedTooBigMessageException.xml.remove +++ /dev/null @@ -1,40 +0,0 @@ - - - - - websocket-sharp - - - System.Exception - - - - To be added. - To be added. - - - - - - Constructor - - - To be added. - To be added. - - - - - - Constructor - - - - - To be added. - To be added. - To be added. - - - - diff --git a/websocket-sharp/doc/mdoc/WebSocketSharp/WsState.xml b/websocket-sharp/doc/mdoc/WebSocketSharp/WsState.xml deleted file mode 100644 index 8da7c792..00000000 --- a/websocket-sharp/doc/mdoc/WebSocketSharp/WsState.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - websocket-sharp - - - System.Enum - - - - Contains the values of the state of the WebSocket connection. - - - The WsState enumeration contains the values of the state of the WebSocket connection defined in - The WebSocket API. - - - - - - - Field - - WebSocketSharp.WsState - - - - Equivalent to numeric value 3. Indicates that the connection has been closed or could not be opened. - - - - - - - Field - - WebSocketSharp.WsState - - - - Equivalent to numeric value 2. Indicates that the connection is going through the closing handshake, or the Close method has been invoked. - - - - - - - Field - - WebSocketSharp.WsState - - - - Equivalent to numeric value 0. Indicates that the connection has not yet been established. - - - - - - - Field - - WebSocketSharp.WsState - - - - Equivalent to numeric value 1. Indicates that the connection is established and communication is possible. - - - - - diff --git a/websocket-sharp/doc/mdoc/index.xml b/websocket-sharp/doc/mdoc/index.xml deleted file mode 100644 index 981a0e9d..00000000 --- a/websocket-sharp/doc/mdoc/index.xml +++ /dev/null @@ -1,1434 +0,0 @@ - - - - [00 24 00 00 04 80 00 00 94 00 00 00 06 02 00 00 00 24 00 00 52 53 41 31 00 04 00 00 11 00 00 00 29 17 fb 89 fe c3 91 f7 2b cb 8b e2 61 d2 3f 05 93 6d 65 a8 9e 63 72 a6 f5 d5 2c f2 9d 20 fa 0b c0 70 6a f6 88 7e 8b 90 3f 39 f5 76 c8 48 e0 bb 7b b2 7b ed d3 10 a7 1a 0f 70 98 0f 7f f4 4b 53 09 d2 a5 ef 36 c3 56 b4 aa f0 91 72 63 25 07 89 e0 93 3e 3f 2e f2 b9 73 0e 12 15 5d 43 56 c3 f4 70 a5 89 fe f7 f6 ac 3e 77 c2 d8 d0 84 91 f4 0c d1 f3 8e dc c3 c3 b8 38 3d 0c bf 17 de 20 78 c1 ] - - - System.Reflection.AssemblyCompany("") - - - System.Reflection.AssemblyConfiguration("") - - - System.Reflection.AssemblyCopyright("sta.blockhead") - - - System.Reflection.AssemblyDescription("A C# implementation of the WebSocket protocol client & server") - - - System.Reflection.AssemblyProduct("websocket-sharp.dll") - - - System.Reflection.AssemblyTitle("websocket-sharp") - - - System.Reflection.AssemblyTrademark("") - - - System.Runtime.CompilerServices.RuntimeCompatibility(WrapNonExceptionThrows=true) - - - - - A C# implementation of the WebSocket protocol client & server. - Copyright (c) 2010-2013 sta.blockhead - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - websocket-sharp - - - - - - - - - ExtensionMethod - - WebSocketSharp.Net.WebSockets.TcpListenerWebSocketContext - - - - - - - - A that provides a TCP connection to accept a WebSocket connection. - - - A that indicates a secure connection or not. (true indicates a secure connection.) - - - Accepts a WebSocket connection by the . - - - - - - - - - - - - - ExtensionMethod - - System.Void - - - - - - - - - A that provides a TCP connection to accept a WebSocket connection. - - - A that indicates a secure connection or not. (true indicates a secure connection.) - - - An Action<TcpListenerWebSocketContext> delegate that contains the method(s) that is called when an asynchronous operation completes. - - - Accepts a WebSocket connection asynchronously by the . - - - - - - - - - - - - - ExtensionMethod - - System.Boolean - - - - - - - - A that contains the entries. - - - A that contains the key of the entry to find. - - - Determines whether the specified contains the entry - with the specified . - - - - - - - - - - - - - ExtensionMethod - - System.Boolean - - - - - - - - - A that contains the entries. - - - A that contains the key of the entry to find. - - - A that contains the value of the entry to find. - - - Determines whether the specified contains the entry - with the specified both and . - - - - - - - - - - - - - ExtensionMethod - - System.Boolean - - - - - - - System.ParamArray - - - - - - - A to test. - - - An array of that contains characters to find. - - - Determines whether the specified contains any of characters - in the specified array of . - - - - - - - - - - - - - ExtensionMethod - - System.Void - - - - - - - - - An to emit. - - - An that emits the . - - - An that contains no event data. - - - Emit the specified delegate if is not . - - - - - - - - - - - - - ExtensionMethod - - System.Void - - - - - System.EventArgs - - - - - - - - - - - The type of the event data generated by the event. - - - An EventHandler<TEventArgs> to emit. - - - An that emits the . - - - A TEventArgs that contains the event data. - - - Emit the specified EventHandler<TEventArgs> delegate if is not . - - - - - - - - - - - - - ExtensionMethod - - System.Boolean - - - - - - - - - An to compare. - - - A to compare. - - - A List<byte> to save the as . - - - Determines whether the specified equals the specified as . - And save this specified as to the specified List<byte>. - - - - - - - - - - - - - ExtensionMethod - - System.String - - - - - - - A that contains the URI to get the absolute path from. - - - Gets the absolute path from the specified . - - - - - - - - - - - - - ExtensionMethod - - WebSocketSharp.Net.CookieCollection - - - - - - - - A that contains a collection of the HTTP Headers. - - - true if gets from the response ; - from the request , false. - - - Gets the collection of cookies from the specified . - - - - - - - - - - - - - ExtensionMethod - - System.String - - - - - - - One of values that contains an HTTP status code. - - - Gets the description of the HTTP status code using the specified . - - - - - - - - - - - - - ExtensionMethod - - System.String - - - - - - - - A that contains a pair of name and value separated by a separator string. - - - A that contains a separator string. - - - Gets the name from the specified that contains a pair of name and value - separated by a separator string. - - - - - - - - - - - - - ExtensionMethod - - System.Collections.Generic.KeyValuePair<System.String,System.String> - - - - - - - - A that contains a pair of name and value are separated by a separator string. - - - A that contains a separator string. - - - Gets the name and value from the specified that contains a pair of name and value are separated by a separator string. - - - - - - - - - - - - - ExtensionMethod - - System.String - - - - - - - An that contains an HTTP status code. - - - Gets the description of the HTTP status code using the specified . - - - - - - - - - - - - - ExtensionMethod - - System.String - - - - - - - - A that contains a pair of name and value separated by a separator string. - - - A that contains a separator string. - - - Gets the value from the specified that contains a pair of name and value - separated by a separator string. - - - - - - - - - - - - - ExtensionMethod - - System.Boolean - - - - - - - A to test. - - - Determines whether the specified is in the allowable range of - the WebSocket close status code. - - - - - - - - - - - - - ExtensionMethod - - System.Boolean - - - - - - - A to test. - - - Determines whether the specified is empty. - - - - - - - - - - - - - ExtensionMethod - - System.Boolean - - - - - - - - A to test. - - - A that contains character to find. - - - Determines whether the specified is enclosed in the specified . - - - - - - - - - - - - - ExtensionMethod - - System.Boolean - - - - - - - A to test. - - - Determines whether the specified is host (this computer architecture) byte order. - - - - - - - - - - - - - ExtensionMethod - - System.Boolean - - - - - - - A to test. - - - Determines whether the specified represents a local IP address. - - - - - - - - - - - - - ExtensionMethod - - System.Boolean - - - - - - - A to test. - - - Determines whether the specified is or empty. - - - - - - - - - - - - - ExtensionMethod - - System.Boolean - - - - - - - A to test. - - - Determines whether the specified is predefined scheme. - - - - - - - - - - - - - ExtensionMethod - - System.Boolean - - - - - - - - A that contains an HTTP request information. - - - A that contains a protocol name. - - - Determines whether the specified is the HTTP Upgrade request - to switch to the specified . - - - - - - - - - - - - - ExtensionMethod - - System.Boolean - - - - - - - - A to test. - - - A that receives a message if the is invalid. - - - Determines whether the specified is valid absolute path. - - - - - - - - - - - - - ExtensionMethod - - System.Boolean - - - - - - - A to test. - - - Determines whether the specified is a URI string. - - - - - - - - - - - - - ExtensionMethod - - System.Byte[] - - - - - - - - A that contains the data to read. - - - An that contains the number of bytes to read. - - - Reads a block of bytes from the specified - and returns the read data in an array of . - - - - - - - - - - - - - ExtensionMethod - - System.Byte[] - - - - - - - - A that contains the data to read. - - - A that contains the number of bytes to read. - - - Reads a block of bytes from the specified - and returns the read data in an array of . - - - - - - - - - - - - - ExtensionMethod - - T[] - - - - - - - - - - - - The type of elements in the . - - - An array of T that contains the data to retrieve a sub-array. - - - An that contains the zero-based starting position of a sub-array in the . - - - An that contains the number of elements to retrieve a sub-array. - - - Retrieves a sub-array from the specified . A sub-array starts at the specified element position. - - - - - - - - - - - - - ExtensionMethod - - System.Void - - - - - - - - An is the number of times to execute. - - - An delegate that references the method(s) to execute. - - - Executes the specified delegate times. - - - - - - - - - - - - - ExtensionMethod - - System.Void - - - - - - - - An is the number of times to execute. - - - An Action<int> delegate that references the method(s) to execute. - An parameter to pass to the method(s) is the zero-based count of iteration. - - - Executes the specified Action<int> delegate times. - - - - - - - - - - - - - ExtensionMethod - - System.Void - - - - - - - - A is the number of times to execute. - - - An delegate that references the method(s) to execute. - - - Executes the specified delegate times. - - - - - - - - - - - - - ExtensionMethod - - System.Void - - - - - - - - A is the number of times to execute. - - - An Action<long> delegate that references the method(s) to execute. - A parameter to pass to the method(s) is the zero-based count of iteration. - - - Executes the specified Action<long> delegate times. - - - - - - - - - - - - - ExtensionMethod - - System.Void - - - - - - - - A is the number of times to execute. - - - An delegate that references the method(s) to execute. - - - Executes the specified delegate times. - - - - - - - - - - - - - ExtensionMethod - - System.Void - - - - - - - - A is the number of times to execute. - - - An Action<uint> delegate that references the method(s) to execute. - A parameter to pass to the method(s) is the zero-based count of iteration. - - - Executes the specified Action<uint> delegate times. - - - - - - - - - - - - - ExtensionMethod - - System.Void - - - - - - - - A is the number of times to execute. - - - An delegate that references the method(s) to execute. - - - Executes the specified delegate times. - - - - - - - - - - - - - ExtensionMethod - - System.Void - - - - - - - - A is the number of times to execute. - - - An Action<ulong> delegate that references the method(s) to execute. - A parameter to pass to this method(s) is the zero-based count of iteration. - - - Executes the specified Action<ulong> delegate times. - - - - - - - - - - - - - ExtensionMethod - - T - - - - - DefaultConstructorConstraint - NotNullableValueTypeConstraint - System.ValueType - - - - - - - - - - The type of the return. The T must be a value type. - - - An array of to convert. - - - A that indicates the byte order of . - - - Converts the specified array of to the specified type data. - - - - - - - - - - - - - ExtensionMethod - - System.Byte[] - - - - - DefaultConstructorConstraint - NotNullableValueTypeConstraint - System.ValueType - - - - - - - - - - The type of . The T must be a value type. - - - A T to convert. - - - A that indicates the byte order of the return. - - - Converts the specified to an array of . - - - - - - - - - - - - - ExtensionMethod - - System.Byte[] - - - - - - - - An array of to convert. - - - A that indicates the byte order of . - - - Converts the order of the specified array of to the host byte order. - - - - - - - - - - - - - ExtensionMethod - - System.String - - - - - - - - - - - The type of elements in . - - - An array of T to convert. - - - A that contains a separator string. - - - Converts the specified to a that concatenates - the each element of across the specified . - - - - - - - - - - - - - ExtensionMethod - - System.Uri - - - - - - - A to convert. - - - Converts the specified to a object. - - - - - - - - - - - - - ExtensionMethod - - System.Boolean - - - - - - - - - A that contains a WebSocket URI. - - - When this method returns, contains a created WebSocket if the parameter is valid WebSocket URI; otherwise, . - - - When this method returns, contains a error message if the parameter is invalid WebSocket URI; otherwise, String.Empty. - - - Tries to create a new WebSocket using the specified . - - - - - - - - - - - - - ExtensionMethod - - System.String - - - - - - - A to decode. - - - URL-decodes the specified . - - - - - - - - - - - - - ExtensionMethod - - System.String - - - - - - - A to encode. - - - URL-encodes the specified . - - - - - - - - - - - - - ExtensionMethod - - System.Void - - - - - - - - A that contains a network stream to write a content data. - - - An array of that contains a content data to write. - - - Writes the specified content data using the specified . - - - - - - - diff --git a/websocket-sharp/doc/mdoc/ns-WebSocketSharp.Net.WebSockets.xml b/websocket-sharp/doc/mdoc/ns-WebSocketSharp.Net.WebSockets.xml deleted file mode 100644 index 603e826b..00000000 --- a/websocket-sharp/doc/mdoc/ns-WebSocketSharp.Net.WebSockets.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - To be added. - The WebSocketSharp.Net.WebSockets namespace contains classes to access to the WebSocket connection request objects. - - diff --git a/websocket-sharp/doc/mdoc/ns-WebSocketSharp.Net.xml b/websocket-sharp/doc/mdoc/ns-WebSocketSharp.Net.xml deleted file mode 100644 index c5a1e31c..00000000 --- a/websocket-sharp/doc/mdoc/ns-WebSocketSharp.Net.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - To be added. - The WebSocketSharp.Net namespace contains some modified classes and enumerations in the System.Net namespace (e.g. ) to accept the WebSocket connection requests. - - diff --git a/websocket-sharp/doc/mdoc/ns-WebSocketSharp.Server.xml b/websocket-sharp/doc/mdoc/ns-WebSocketSharp.Server.xml deleted file mode 100644 index 563ee285..00000000 --- a/websocket-sharp/doc/mdoc/ns-WebSocketSharp.Server.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - To be added. - The WebSocketSharp.Server namespace contains classes to implement the server that receives the WebSocket connection requests. - - diff --git a/websocket-sharp/doc/mdoc/ns-WebSocketSharp.xml b/websocket-sharp/doc/mdoc/ns-WebSocketSharp.xml deleted file mode 100644 index 9c02bf33..00000000 --- a/websocket-sharp/doc/mdoc/ns-WebSocketSharp.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - To be added. - The WebSocketSharp namespace contains classes and enumerations to implement the WebSocket interface. - -