osu/osu.Game/Online/RealtimeMultiplayer/MultiplayerRoom.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.

#nullable enable

using System;
using System.Collections.Generic;

namespace osu.Game.Online.RealtimeMultiplayer
{
    /// <summary>
    /// A multiplayer room.
    /// </summary>
    [Serializable]
    public class MultiplayerRoom
    {
        /// <summary>
        /// The ID of the room, used for database persistence.
        /// </summary>
        public readonly long RoomID;

        /// <summary>
        /// The current state of the room (ie. whether it is in progress or otherwise).
        /// </summary>
        public MultiplayerRoomState State { get; set; }

        /// <summary>
        /// All currently enforced game settings for this room.
        /// </summary>
        public MultiplayerRoomSettings Settings { get; set; } = MultiplayerRoomSettings.Empty();

        /// <summary>
        /// All users currently in this room.
        /// </summary>
        public List<MultiplayerRoomUser> Users { get; set; } = new List<MultiplayerRoomUser>();

        /// <summary>
        /// The host of this room, in control of changing room settings.
        /// </summary>
        public MultiplayerRoomUser? Host { get; set; }

        private object writeLock = new object();

        public MultiplayerRoom(in long roomId)
        {
            RoomID = roomId;
        }

        /// <summary>
        /// Request a lock on this room to perform a thread-safe update.
        /// </summary>
        public LockUntilDisposal LockForUpdate() => new LockUntilDisposal(writeLock);
    }
}