IWebSocketSession.cs 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. #region License
  2. /*
  3. * IWebSocketSession.cs
  4. *
  5. * The MIT License
  6. *
  7. * Copyright (c) 2013-2022 sta.blockhead
  8. *
  9. * Permission is hereby granted, free of charge, to any person obtaining a copy
  10. * of this software and associated documentation files (the "Software"), to deal
  11. * in the Software without restriction, including without limitation the rights
  12. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13. * copies of the Software, and to permit persons to whom the Software is
  14. * furnished to do so, subject to the following conditions:
  15. *
  16. * The above copyright notice and this permission notice shall be included in
  17. * all copies or substantial portions of the Software.
  18. *
  19. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  25. * THE SOFTWARE.
  26. */
  27. #endregion
  28. using System;
  29. namespace WebSocketSharp.Server
  30. {
  31. /// <summary>
  32. /// Exposes the access to the information in a WebSocket session.
  33. /// </summary>
  34. public interface IWebSocketSession
  35. {
  36. #region Properties
  37. /// <summary>
  38. /// Gets the unique ID of the session.
  39. /// </summary>
  40. /// <value>
  41. /// A <see cref="string"/> that represents the unique ID of the session.
  42. /// </value>
  43. string ID { get; }
  44. /// <summary>
  45. /// Gets the time that the session has started.
  46. /// </summary>
  47. /// <value>
  48. /// A <see cref="DateTime"/> that represents the time that the session
  49. /// has started.
  50. /// </value>
  51. DateTime StartTime { get; }
  52. /// <summary>
  53. /// Gets the WebSocket interface for the session.
  54. /// </summary>
  55. /// <value>
  56. /// A <see cref="WebSocketSharp.WebSocket"/> that represents the interface.
  57. /// </value>
  58. WebSocket WebSocket { get; }
  59. #endregion
  60. }
  61. }