You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
75 lines
2.6 KiB
C#
75 lines
2.6 KiB
C#
#region License
|
|
/*
|
|
* IWebSocketServiceHost.cs
|
|
*
|
|
* The MIT License
|
|
*
|
|
* Copyright (c) 2012-2013 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 WebSocketSharp.Net.WebSockets;
|
|
|
|
namespace WebSocketSharp.Server
|
|
{
|
|
/// <summary>
|
|
/// Exposes the methods and properties for the WebSocket service host.
|
|
/// </summary>
|
|
public interface IWebSocketServiceHost
|
|
{
|
|
/// <summary>
|
|
/// Gets the connection count to the WebSocket service host.
|
|
/// </summary>
|
|
/// <value>
|
|
/// An <see cref="int"/> that contains the connection count.
|
|
/// </value>
|
|
int ConnectionCount { get; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets a value indicating whether the WebSocket service host cleans up
|
|
/// the inactive sessions periodically.
|
|
/// </summary>
|
|
/// <value>
|
|
/// <c>true</c> if the WebSocket service host cleans up the inactive sessions periodically;
|
|
/// otherwise, <c>false</c>.
|
|
/// </value>
|
|
bool KeepClean { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets the manager of the sessions to the WebSocket service host.
|
|
/// </summary>
|
|
/// <value>
|
|
/// A <see cref="WebSocketSessionManager"/> that manages the sessions.
|
|
/// </value>
|
|
WebSocketSessionManager Sessions { get; }
|
|
|
|
/// <summary>
|
|
/// Binds the specified <see cref="WebSocketContext"/> to a <see cref="WebSocketService"/> instance.
|
|
/// </summary>
|
|
/// <param name="context">
|
|
/// A <see cref="WebSocketContext"/> that contains the WebSocket connection request objects to bind.
|
|
/// </param>
|
|
void BindWebSocket (WebSocketContext context);
|
|
}
|
|
}
|