o3de/Gems/AWSGameLift/Code/AWSGameLiftClient/Include/Request/AWSGameLiftMatchmakingRequestBus.h

/*
 * Copyright (c) Contributors to the Open 3D Engine Project.
 * For complete copyright and license terms please see the LICENSE at the root of this distribution.
 *
 * SPDX-License-Identifier: Apache-2.0 OR MIT
 *
 */

#pragma once

#include <AzCore/EBus/EBus.h>
#include <AzCore/std/string/string.h>
#include <Multiplayer/Session/IMatchmakingRequests.h>

namespace AWSGameLift
{
    // IMatchmakingAsyncRequests EBus wrapper
    class AWSGameLiftMatchmakingAsyncRequests
        : public AZ::EBusTraits
    {
    public:
        using MutexType = AZStd::recursive_mutex;
        static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single;
        static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single;
    };
    using AWSGameLiftMatchmakingAsyncRequestBus = AZ::EBus<Multiplayer::IMatchmakingAsyncRequests, AWSGameLiftMatchmakingAsyncRequests>;

    // IMatchmakingRequests EBus wrapper
    class AWSGameLiftMatchmakingRequests
        : public AZ::EBusTraits
    {
    public:
        using MutexType = AZStd::recursive_mutex;
        static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single;
        static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single;
    };
    using AWSGameLiftMatchmakingRequestBus = AZ::EBus<Multiplayer::IMatchmakingRequests, AWSGameLiftMatchmakingRequests>;

    //! IAWSGameLiftMatchmakingEventRequests
    //! GameLift Gem matchmaking event interfaces which is used to track matchmaking ticket event
    //! Developer should define the way to poll matchmaking ticket event and behavior based on the ticket status
    //! Use AWSGameLiftClientLocalTicketTracker as an example, it uses continuous polling to query matchmaking ticket:
    //! StartPolling - local ticket tracker starts monitor process for matchmaking ticket, and joins player
    //!                to the match once ticket is complete
    //! StopPolling - local ticket tracker cancels ongoing matchmaking ticket and stops monitoring process
    class IAWSGameLiftMatchmakingEventRequests
    {
    public:
        AZ_RTTI(IAWSGameLiftMatchmakingEventRequests, "{C2DA440E-74E0-411E-813D-5880B50B0C9E}");

        IAWSGameLiftMatchmakingEventRequests() = default;
        virtual ~IAWSGameLiftMatchmakingEventRequests() = default;

        //! StartPolling
        //! Request to start process for polling matchmaking ticket based on given ticket id and player Id
        //! @param ticketId The requested matchmaking ticket id
        //! @param playerId The requested matchmaking player id
        virtual void StartPolling(const AZStd::string& ticketId, const AZStd::string& playerId) = 0;

        //! StopPolling
        //! Request to stop process for polling matchmaking ticket
        virtual void StopPolling() = 0;
    };

    // IAWSGameLiftMatchmakingEventRequests EBus wrapper
    class AWSGameLiftMatchmakingEventRequests
        : public AZ::EBusTraits
    {
    public:
        using MutexType = AZStd::recursive_mutex;
        static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single;
        static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single;
    };
    using AWSGameLiftMatchmakingEventRequestBus = AZ::EBus<IAWSGameLiftMatchmakingEventRequests, AWSGameLiftMatchmakingEventRequests>;
} // namespace AWSGameLift