53 lines
3.1 KiB
C#
53 lines
3.1 KiB
C#
using System.Net;
|
|
|
|
namespace NahidaImpact.Kcp
|
|
{
|
|
/// <summary>
|
|
/// Multiplex many channels or conversations over the same transport.
|
|
/// </summary>
|
|
public interface IKcpMultiplexConnection<T> : IKcpMultiplexConnection
|
|
{
|
|
/// <summary>
|
|
/// Create a raw channel with the specified conversation ID.
|
|
/// </summary>
|
|
/// <param name="id">The conversation ID.</param>
|
|
/// <param name="remoteEndpoint">The remote Endpoint</param>
|
|
/// <param name="state">The user state of this channel.</param>
|
|
/// <param name="options">The options of the <see cref="KcpRawChannel"/>.</param>
|
|
/// <returns>The raw channel created.</returns>
|
|
/// <exception cref="ObjectDisposedException">The current instance is disposed.</exception>
|
|
/// <exception cref="InvalidOperationException">Another channel or conversation with the same ID was already registered.</exception>
|
|
KcpRawChannel CreateRawChannel(long id, IPEndPoint remoteEndpoint, T state, KcpRawChannelOptions options = null);
|
|
|
|
/// <summary>
|
|
/// Create a conversation with the specified conversation ID.
|
|
/// </summary>
|
|
/// <param name="id">The conversation ID.</param>
|
|
/// <param name="remoteEndpoint">The remote Endpoint</param>
|
|
/// <param name="state">The user state of this conversation.</param>
|
|
/// <param name="options">The options of the <see cref="KcpConversation"/>.</param>
|
|
/// <returns>The KCP conversation created.</returns>
|
|
/// <exception cref="ObjectDisposedException">The current instance is disposed.</exception>
|
|
/// <exception cref="InvalidOperationException">Another channel or conversation with the same ID was already registered.</exception>
|
|
KcpConversation CreateConversation(long id, IPEndPoint remoteEndpoint, T state, KcpConversationOptions options = null);
|
|
|
|
/// <summary>
|
|
/// Register a conversation or channel with the specified conversation ID and user state.
|
|
/// </summary>
|
|
/// <param name="conversation">The conversation or channel to register.</param>
|
|
/// <param name="id">The conversation ID.</param>
|
|
/// <param name="state">The user state</param>
|
|
/// <exception cref="ArgumentNullException"><paramref name="conversation"/> is not provided.</exception>
|
|
/// <exception cref="ObjectDisposedException">The current instance is disposed.</exception>
|
|
/// <exception cref="InvalidOperationException">Another channel or conversation with the same ID was already registered.</exception>
|
|
void RegisterConversation(IKcpConversation conversation, long id, T? state);
|
|
|
|
/// <summary>
|
|
/// Unregister a conversation or channel with the specified conversation ID.
|
|
/// </summary>
|
|
/// <param name="id">The conversation ID.</param>
|
|
/// <param name="state">The user state.</param>
|
|
/// <returns>The conversation unregistered with the user state. Returns default when the conversation with the specified ID is not found.</returns>
|
|
IKcpConversation UnregisterConversation(long id, out T? state);
|
|
}
|
|
}
|