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

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 .

Determines whether the entry with the specified key exists in the specified .

true if the entry with the exists in the ; otherwise, false. A that contains the entries. A that contains the key of the entry to find.

Determines whether the entry with the specified both key and value exists in the specified .

true if the entry with the both and exists in the ; 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.

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 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 are separated by a separator string.

A that contains the name if any; otherwise, null. 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. 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 are separated by a separator string.

A that contains the value if any; otherwise, null. A that contains a pair of name and value are separated by a separator string. A that contains a separator string.

Determines whether the specified is a .

true if the parameter is a ; otherwise, false. A to test.

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

true if the parameter is ; otherwise, false. A class to test. The type of the parameter.

Determines whether the specified object is . And invokes the specified delegate if the specified object is .

true if the parameter is ; otherwise, false. A class to test. An delegate that contains the method(s) called if the is . The type of the parameter.

Determines whether the specified is or .

true if the parameter is or ; 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 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.

Determines whether two specified objects don't have the same value.

true if the value of parameter isn't the same as the value of parameter; otherwise, false. The first to compare. The second to compare. A that indicates a case-sensitive or insensitive comparison. (true indicates a case-insensitive comparison.)

Reads a block of bytes from the specified stream 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 stream 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.

Reads a block of bytes from the specified stream 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. An that contains the buffer size in bytes of each internal 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 that contains the number of times to execute. An delegate that contains the method(s) to execute.

Executes the specified delegate times.

A that contains the number of times to execute. An delegate that contains the method(s) to execute.

Executes the specified delegate times.

A that contains the number of times to execute. An delegate that contains the method(s) to execute.

Executes the specified delegate times.

A that contains the number of times to execute. An delegate that contains the method(s) to execute.

Executes the specified Action<ulong> delegate times.

An that contains the number of times to execute. An Action<ulong> delegate that contains the method(s) to execute. A parameter to pass to this method(s) contains the zero-based count of iteration.

Executes the specified Action<ulong> delegate times.

A that contains the number of times to execute. An Action<ulong> delegate that contains the method(s) to execute. A parameter to pass to this method(s) contains the zero-based count of iteration.

Executes the specified Action<ulong> delegate times.

A that contains the number of times to execute. An Action<ulong> delegate that contains the method(s) to execute. A parameter to pass to this method(s) contains the zero-based count of iteration.

Executes the specified Action<ulong> delegate times.

A that contains the number of times to execute. An Action<ulong> delegate that contains the method(s) to execute. A parameter to pass to this method(s) contains the zero-based count of iteration.

Converts the specified array of to the specified type data.

A T converted from the , or a default value of T if the is an empty array of or if the types of T aren't the , , , , , , , , , . An array of to convert. A that indicates the byte order of the . The type of the return value. The T must be a value type. Is thrown when the parameter passed to a method is invalid because it is .

Converts the specified data to an array of .

An array of converted from the . A T to convert. A that indicates the byte order of the return. The type of the . 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 the . An array of to convert. A that indicates the byte order of the . Is thrown when the parameter passed to a method is invalid because it is .

Converts the specified array to a concatenated the specified separator string between each element of this array.

A converted from the parameter, or a if the length of the is zero. An array of T to convert. A that contains a separator string. The type of elements in the . Is thrown when the parameter passed to a method is invalid because it 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 a received data.

Gets the received data as an array of .

An array of that contains a received data.

Gets the type of received data.

One of the that indicates the type of 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 connection closed cleanly or not.

true if the 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 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 the WebSocket URL. 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.

A that contains the WebSocket URL. An OnOpen event handler. An OnMessage event handler. An OnError event handler. An OnClose event handler. An array of that contains the WebSocket subprotocols if any. is . is not valid WebSocket URL.

Occurs when the WebSocket receives a Close frame or the Close method is called.

Occurs when the WebSocket gets an error.

Occurs when the WebSocket receives a data frame.

Occurs when the WebSocket connection has been established.

Gets the extensions selected by the server.

A that contains the extensions if any. By default, String.Empty. (Currently this will only ever be the String.Empty.)

Gets a value indicating whether a connection is alive.

true if the connection is alive; otherwise, false.

Gets a value indicating whether a connection is secure.

true if the connection is secure; otherwise, false.

Gets the subprotocol selected by the server.

A that contains the subprotocol if any. By default, String.Empty.

Gets the state of the connection.

One of the . By default, WsState.CONNECTING.

Gets the WebSocket URL.

A that contains the WebSocket URL.

Closes the connection and releases all associated resources after sends a Close control frame.

A that contains a status code indicating a reason for closure.

Closes the connection and releases all associated resources after sends a Close control frame.

A that contains a status code indicating a reason for closure.

Closes the connection and releases all associated resources after sends a Close control frame.

A that contains a status code indicating a reason for closure. A that contains a reason for closure.

Closes the connection and releases all associated resources after sends a Close control frame.

A that contains a status code indicating a reason for closure. A that contains a reason for closure.

Establishes a connection.

Closes the connection and releases all associated resources after sends a Close control frame.

Call when you are finished using the . The method leaves the in an unusable state. After calling , you must release all references to the so the garbage collector can reclaim the memory that the was occupying.

Sends a Ping frame using the connection.

true if the WebSocket receives a Pong frame in a time; otherwise, false.

Sends a Ping frame with a message using the connection.

A that contains the message to be sent. true if the WebSocket receives a Pong frame in a time; otherwise, false.

Sends a binary data using the connection.

An array of that contains a binary data to send.

Sends a text data using the connection.

A that contains a text data to send.

Sends a binary data using the connection.

A that contains a binary data to send.

Sends a binary data asynchronously using the connection.

An array of that contains a binary data to send. An delegate that contains the method(s) that is called when an asynchronous operation completes.

Sends a text data asynchronously using the connection.

A that contains a text data to send. An delegate that contains the method(s) that is called when an asynchronous operation completes.

Sends a binary data asynchronously using the connection.

A that contains a binary data to send. An delegate that contains the method(s) that is called when an asynchronous operation completes.

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

true if the server cleans up the inactive clients every 60 seconds; otherwise, false. The default value is true.

Accepts a WebSocket connection.

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 HTTP query string variables used in the WebSocket opening handshake.

A that contains the query string variables.

Gets the sessions to the WebSocket service.

A that contains the sessions to the WebSocket service.

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.

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.

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 the functions of 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 gets an error.

Occurs when the server receives an HTTP CONNECT request.

Occurs when the server receives an HTTP DELETE request.

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 to receive incoming requests.

Stops receiving incoming requests.

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.

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.

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

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 property for the WebSocket service host.

Gets or sets a value indicating whether the WebSocket service host cleans up the inactive service clients periodically.

true if the WebSocket service host cleans up the inactive service clients periodically; otherwise, false.

Binds the specified to the WebSocket service instance.

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

Gets or sets a value indicating whether the server cleans up the inactive clients periodically.

true if the server cleans up the inactive clients 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 the WebSocket service instance.

A to bind.

Accepts a WebSocket connection.

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

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

An 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. This property is not implemented.

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. This property is not implemented.

Gets a value indicating whether the WebSocket connection is secured.

true if the WebSocket connection is secured; 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.

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.

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

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

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

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