Exposes the properties used to access the information in a WebSocket connection request. More...
Protected Member Functions | |
| WebSocketContext () | |
| Initializes a new instance of the WebSocketContext class. | |
Properties | |
| CookieCollection | CookieCollection [get] |
| Gets the HTTP cookies included in the request. | |
| NameValueCollection | Headers [get] |
| Gets the HTTP headers included in the request. | |
| string | Host [get] |
| Gets the value of the Host header included in the request. | |
| bool | IsAuthenticated [get] |
| Gets a value indicating whether the client is authenticated. | |
| bool | IsLocal [get] |
| Gets a value indicating whether the client connected from the local computer. | |
| bool | IsSecureConnection [get] |
| Gets a value indicating whether the WebSocket connection is secured. | |
| bool | IsWebSocketRequest [get] |
| Gets a value indicating whether the request is a WebSocket connection request. | |
| string | Origin [get] |
| Gets the value of the Origin header included in the request. | |
| NameValueCollection | QueryString [get] |
| Gets the query string included in the request. | |
| Uri | RequestUri [get] |
| Gets the URI requested by the client. | |
| string | SecWebSocketKey [get] |
| Gets the value of the Sec-WebSocket-Key header included in the request. | |
| IEnumerable< string > | SecWebSocketProtocols [get] |
| Gets the values of the Sec-WebSocket-Protocol header included in the request. | |
| string | SecWebSocketVersion [get] |
| Gets the value of the Sec-WebSocket-Version header included in the request. | |
| System.Net.IPEndPoint | ServerEndPoint [get] |
| Gets the server endpoint as an IP address and a port number. | |
| IPrincipal | User [get] |
| Gets the client information (identity, authentication, and security roles). | |
| System.Net.IPEndPoint | UserEndPoint [get] |
| Gets the client endpoint as an IP address and a port number. | |
| WebSocket | WebSocket [get] |
| Gets the WebSocketSharp.WebSocket instance used for two-way communication between client and server. | |
Detailed Description
Exposes the properties used to access the information in a WebSocket connection request.
The WebSocketContext class is an abstract class.
Property Documentation
◆ CookieCollection
|
getabstract |
Gets the HTTP cookies included in the request.
A WebSocketSharp.Net.CookieCollection that contains the cookies.
◆ Headers
|
getabstract |
Gets the HTTP headers included in the request.
A NameValueCollection that contains the headers.
◆ Host
|
getabstract |
Gets the value of the Host header included in the request.
A string that represents the value of the Host header.
◆ IsAuthenticated
|
getabstract |
Gets a value indicating whether the client is authenticated.
true if the client is authenticated; otherwise, false.
◆ IsLocal
|
getabstract |
Gets a value indicating whether the client connected from the local computer.
true if the client connected from the local computer; otherwise, false.
◆ IsSecureConnection
|
getabstract |
Gets a value indicating whether the WebSocket connection is secured.
true if the connection is secured; otherwise, false.
◆ IsWebSocketRequest
|
getabstract |
Gets a value indicating whether the request is a WebSocket connection request.
true if the request is a WebSocket connection request; otherwise, false.
◆ Origin
|
getabstract |
Gets the value of the Origin header included in the request.
A string that represents the value of the Origin header.
◆ QueryString
|
getabstract |
Gets the query string included in the request.
A NameValueCollection that contains the query string parameters.
◆ RequestUri
|
getabstract |
Gets the URI requested by the client.
A Uri that represents the requested URI.
◆ SecWebSocketKey
|
getabstract |
Gets the value of the Sec-WebSocket-Key header included in the request.
This property provides a part of the information used by the server to prove that it received a valid WebSocket connection request.
A string that represents the value of the Sec-WebSocket-Key header.
◆ SecWebSocketProtocols
|
getabstract |
Gets the values of the Sec-WebSocket-Protocol header included in the request.
This property represents the subprotocols requested by the client.
An T:System.Collections.Generic.IEnumerable<string> instance that provides an enumerator which supports the iteration over the values of the Sec-WebSocket-Protocol header.
◆ SecWebSocketVersion
|
getabstract |
Gets the value of the Sec-WebSocket-Version header included in the request.
This property represents the WebSocket protocol version.
A string that represents the value of the Sec-WebSocket-Version header.
◆ ServerEndPoint
|
getabstract |
Gets the server endpoint as an IP address and a port number.
A System.Net.IPEndPoint that represents the server endpoint.
◆ User
|
getabstract |
Gets the client information (identity, authentication, and security roles).
A IPrincipal that represents the client information.
◆ UserEndPoint
|
getabstract |
Gets the client endpoint as an IP address and a port number.
A System.Net.IPEndPoint that represents the client endpoint.
◆ WebSocket
|
getabstract |
Gets the WebSocketSharp.WebSocket instance used for two-way communication between client and server.
The documentation for this class was generated from the following file:
- /Users/yiyangshang/egdl2/Assets/eag/Scripts/enablegames/PortalAPI/SocketIO/WebsocketSharp/Net/WebSockets/WebSocketContext.cs
