123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224 |
- #region License
- /*
- * WebSocketContext.cs
- *
- * The MIT License
- *
- * Copyright (c) 2012-2022 sta.blockhead
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- */
- #endregion
- using System;
- using System.Collections.Generic;
- using System.Collections.Specialized;
- using System.Security.Principal;
- namespace WebSocketSharp.Net.WebSockets
- {
- /// <summary>
- /// Exposes the access to the information in a WebSocket handshake request.
- /// </summary>
- /// <remarks>
- /// This class is an abstract class.
- /// </remarks>
- public abstract class WebSocketContext
- {
- #region Protected Constructors
- /// <summary>
- /// Initializes a new instance of the <see cref="WebSocketContext"/> class.
- /// </summary>
- protected WebSocketContext ()
- {
- }
- #endregion
- #region Public Properties
- /// <summary>
- /// Gets the HTTP cookies included in the handshake request.
- /// </summary>
- /// <value>
- /// A <see cref="WebSocketSharp.Net.CookieCollection"/> that contains
- /// the cookies.
- /// </value>
- public abstract CookieCollection CookieCollection { get; }
- /// <summary>
- /// Gets the HTTP headers included in the handshake request.
- /// </summary>
- /// <value>
- /// A <see cref="NameValueCollection"/> that contains the headers.
- /// </value>
- public abstract NameValueCollection Headers { get; }
- /// <summary>
- /// Gets the value of the Host header included in the handshake request.
- /// </summary>
- /// <value>
- /// A <see cref="string"/> that represents the server host name requested
- /// by the client.
- /// </value>
- public abstract string Host { get; }
- /// <summary>
- /// Gets a value indicating whether the client is authenticated.
- /// </summary>
- /// <value>
- /// <c>true</c> if the client is authenticated; otherwise, <c>false</c>.
- /// </value>
- public abstract bool IsAuthenticated { get; }
- /// <summary>
- /// Gets a value indicating whether the handshake request is sent from
- /// the local computer.
- /// </summary>
- /// <value>
- /// <c>true</c> if the handshake request is sent from the same computer
- /// as the server; otherwise, <c>false</c>.
- /// </value>
- public abstract bool IsLocal { get; }
- /// <summary>
- /// Gets a value indicating whether a secure connection is used to send
- /// the handshake request.
- /// </summary>
- /// <value>
- /// <c>true</c> if the connection is secure; otherwise, <c>false</c>.
- /// </value>
- public abstract bool IsSecureConnection { get; }
- /// <summary>
- /// Gets a value indicating whether the request is a WebSocket handshake
- /// request.
- /// </summary>
- /// <value>
- /// <c>true</c> if the request is a WebSocket handshake request; otherwise,
- /// <c>false</c>.
- /// </value>
- public abstract bool IsWebSocketRequest { get; }
- /// <summary>
- /// Gets the value of the Origin header included in the handshake request.
- /// </summary>
- /// <value>
- /// A <see cref="string"/> that represents the value of the Origin header.
- /// </value>
- public abstract string Origin { get; }
- /// <summary>
- /// Gets the query string included in the handshake request.
- /// </summary>
- /// <value>
- /// A <see cref="NameValueCollection"/> that contains the query parameters.
- /// </value>
- public abstract NameValueCollection QueryString { get; }
- /// <summary>
- /// Gets the URI requested by the client.
- /// </summary>
- /// <value>
- /// A <see cref="Uri"/> that represents the URI parsed from the request.
- /// </value>
- public abstract Uri RequestUri { get; }
- /// <summary>
- /// Gets the value of the Sec-WebSocket-Key header included in
- /// the handshake request.
- /// </summary>
- /// <value>
- /// <para>
- /// A <see cref="string"/> that represents the value of
- /// the Sec-WebSocket-Key header.
- /// </para>
- /// <para>
- /// The value is used to prove that the server received
- /// a valid WebSocket handshake request.
- /// </para>
- /// </value>
- public abstract string SecWebSocketKey { get; }
- /// <summary>
- /// Gets the names of the subprotocols from the Sec-WebSocket-Protocol
- /// header included in the handshake request.
- /// </summary>
- /// <value>
- /// <para>
- /// An <see cref="T:System.Collections.Generic.IEnumerable{string}"/>
- /// instance.
- /// </para>
- /// <para>
- /// It provides an enumerator which supports the iteration over
- /// the collection of the names of the subprotocols.
- /// </para>
- /// </value>
- public abstract IEnumerable<string> SecWebSocketProtocols { get; }
- /// <summary>
- /// Gets the value of the Sec-WebSocket-Version header included in
- /// the handshake request.
- /// </summary>
- /// <value>
- /// A <see cref="string"/> that represents the WebSocket protocol
- /// version specified by the client.
- /// </value>
- public abstract string SecWebSocketVersion { get; }
- /// <summary>
- /// Gets the endpoint to which the handshake request is sent.
- /// </summary>
- /// <value>
- /// A <see cref="System.Net.IPEndPoint"/> that represents the server
- /// IP address and port number.
- /// </value>
- public abstract System.Net.IPEndPoint ServerEndPoint { get; }
- /// <summary>
- /// Gets the client information.
- /// </summary>
- /// <value>
- /// A <see cref="IPrincipal"/> instance that represents identity,
- /// authentication, and security roles for the client.
- /// </value>
- public abstract IPrincipal User { get; }
- /// <summary>
- /// Gets the endpoint from which the handshake request is sent.
- /// </summary>
- /// <value>
- /// A <see cref="System.Net.IPEndPoint"/> that represents the client
- /// IP address and port number.
- /// </value>
- public abstract System.Net.IPEndPoint UserEndPoint { get; }
- /// <summary>
- /// Gets the WebSocket interface used for two-way communication between
- /// the client and server.
- /// </summary>
- /// <value>
- /// A <see cref="WebSocketSharp.WebSocket"/> that represents the interface.
- /// </value>
- public abstract WebSocket WebSocket { get; }
- #endregion
- }
- }
|