osu-lazer/osu.Game/Online/Multiplayer/IMultiplayerLoungeServer.cs

// 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 create a multiplayer room.
        /// </summary>
        /// <param name="room">The room to create.</param>
        /// <returns>The created multiplayer room.</returns>
        Task<MultiplayerRoom> CreateRoom(MultiplayerRoom room);

        /// <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);
    }
}