mirror of
https://github.com/ppy/osu.git
synced 2024-11-15 18:37:52 +08:00
31 lines
1.4 KiB
C#
31 lines
1.4 KiB
C#
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
|
|
// See the LICENCE file in the repository root for full licence text.
|
|
|
|
using System.Threading.Tasks;
|
|
|
|
namespace osu.Game.Online.Multiplayer
|
|
{
|
|
/// <summary>
|
|
/// Interface for an out-of-room multiplayer server.
|
|
/// </summary>
|
|
public interface IMultiplayerLoungeServer
|
|
{
|
|
/// <summary>
|
|
/// Request to join a multiplayer room.
|
|
/// </summary>
|
|
/// <param name="roomId">The databased room ID.</param>
|
|
/// <exception cref="InvalidStateException">If the user is already in the requested (or another) room.</exception>
|
|
/// <exception cref="InvalidPasswordException">If the room required a password.</exception>
|
|
Task<MultiplayerRoom> JoinRoom(long roomId);
|
|
|
|
/// <summary>
|
|
/// Request to join a multiplayer room with a provided password.
|
|
/// </summary>
|
|
/// <param name="roomId">The databased room ID.</param>
|
|
/// <param name="password">The password for the join request.</param>
|
|
/// <exception cref="InvalidStateException">If the user is already in the requested (or another) room.</exception>
|
|
/// <exception cref="InvalidPasswordException">If the room provided password was incorrect.</exception>
|
|
Task<MultiplayerRoom> JoinRoomWithPassword(long roomId, string password);
|
|
}
|
|
}
|