OnlineSessionInterfacePico.h

// Copyright 2022 Pico Technology Co., Ltd.All rights reserved.
// This plugin incorporates portions of the Unreal® Engine. Unreal® is a trademark or registered trademark of Epic Games, Inc.In the United States of America and elsewhere.
// Unreal® Engine, Copyright 1998 – 2022, Epic Games, Inc.All rights reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "OnlineSubsystemPico.h"
#include "Interfaces/OnlineSessionInterface.h"
#include "OnlineSubsystemPicoPackage.h"
 
 
// @brief Used to set the matchmaking pool name.
#define SETTING_PICO_POOL FName(TEXT("PICOPOOL"))
// @brief Used to set the pico build unique ID.
#define SETTING_PICO_BUILD_UNIQUE_ID FName(TEXT("PICOSESSIONBUILDUNIQUEID"))
// @brief Used to set whether to search for moderated rooms.
#define SEARCH_PICO_MODERATED_ROOMS_ONLY FName(TEXT("PICOMODERATEDROOMSONLY"))
// @brief Used to set the page index when searching for moderated rooms.
#define GET_MODERATEDROOMS_PAGEINDEX FName(TEXT("GETMODERATEDROOMSPAGEINDEX"))
// @brief Used to set the page size when searching for moderated rooms.
#define GET_MODERATEDROOMS_PAGESIZE FName(TEXT("GETMODERATEDROOMSPAGESIZE"))
 
class FUniqueNetIdPico;
class FOnlineSessionInfoPico;
 
 
// Notifications
DECLARE_MULTICAST_DELEGATE_TwoParams(FOnGameConnectionComplete, int /*Result*/, bool /*bWasSuccessful*/);
DECLARE_MULTICAST_DELEGATE_TwoParams(FOnGameRequestFailedComplete, int /*Result*/, bool /*bWasSuccessful*/);
DECLARE_MULTICAST_DELEGATE_OneParam(FOnGameStateResetComplete, bool /*bWasSuccessful*/);
DECLARE_MULTICAST_DELEGATE_OneParam(FOnMatchmakingCancel2Complete, bool /*bWasSuccessful*/);
DECLARE_MULTICAST_DELEGATE_TwoParams(FOnRoomLeaveComplete, const FString& /*RoomID*/, bool /*bWasSuccessful*/);
DECLARE_MULTICAST_DELEGATE_TwoParams(FOnRoomJoin2Complete, const FString& /*RoomID*/, bool /*bWasSuccessful*/);
DECLARE_MULTICAST_DELEGATE_TwoParams(FOnRoomSetDescriptionComplete, const FString& /*RoomID*/, bool /*bWasSuccessful*/);
DECLARE_MULTICAST_DELEGATE_TwoParams(FOnRoomKickUserComplete, const FString& /*RoomID*/, bool /*bWasSuccessful*/);
DECLARE_MULTICAST_DELEGATE_OneParam(FOnRoomUpdateOwnerComplete, bool /*bWasSuccessful*/);
DECLARE_MULTICAST_DELEGATE_TwoParams(FOnRoomUpdateDataStoreComplete, const FString& /*RoomID*/, bool /*bWasSuccessful*/);
DECLARE_MULTICAST_DELEGATE_TwoParams(FOnRoomUpdateMembershipLockStatusComplete, const FString& /*RoomID*/, bool /*bWasSuccessful*/);
DECLARE_MULTICAST_DELEGATE_TwoParams(FOnRoomUpdateComplete, const FString& /*RoomID*/, bool /*bWasSuccessful*/);
DECLARE_MULTICAST_DELEGATE_TwoParams(FOnRoomInviteAcceptedComplete, const FString& /*RoomID*/, bool /*bWasSuccessful*/);
DECLARE_MULTICAST_DELEGATE_FourParams(FOnPicoSessionUserInviteAcceptedComplete, const bool /*bWasSuccessful*/, const int32 /*ControllerId*/, const FString& /*UserId*/, const FPicoOnlineSessionSearchResult& /*InviteResult*/);
 
 
 
class FOnlineSessionPico : public IOnlineSession
{
private:
 
    // <summary>Reference to the main Pico subsystem.</summary>
    FOnlineSubsystemPico& PicoSubsystem;
 
    // <summary>Current sessions map.</summary>
    TMap<FName, TSharedPtr<FNamedOnlineSession>> Sessions;
 
    // <summary>The SearchSettings for matchmaking.</summary>
    TSharedPtr<FOnlineSessionSearch> InProgressMatchmakingSearch;
 
    // <summary>The SessionName when in matchmaking.</summary>
    FName InProgressMatchmakingSearchName;
 
    ppfID GetRoomIDOfSession(const FNamedOnlineSession& Session) const;
    
    // <summary>Returns the search results of the sessions where the invitation has been accepted. Supported version: 4.8.0 or later.</summary>
    TArray<TSharedRef<const FOnlineSessionSearchResult>> InviteAcceptedSessions;
    
    
    TArray<TSharedRef<const FOnlineSessionSearchResult>> PendingInviteAcceptedSessions;
    ppfID InviteAcceptedRoomID;
    
    int32 GetRoomBuildUniqueId(const ppfRoomHandle Room);
 
    static void SaveLog(const ELogVerbosity::Type Verbosity, const FString& Log);
 
PACKAGE_SCOPE:
 
    FDelegateHandle OnRoomNotificationUpdateHandle;
    void OnRoomNotificationUpdate(ppfMessageHandle Message, bool bIsError);
 
    FDelegateHandle OnRoomNotificationInviteAcceptedHandle;
    void OnRoomInviteAccepted(ppfMessageHandle Message, bool bIsError);
 
    FDelegateHandle OnMatchmakingNotificationMatchFoundHandle;
    void OnMatchmakingNotificationMatchFound(ppfMessageHandle Message, bool bIsError);
 
    TSharedRef<FOnlineSession> CreateSessionFromRoom(ppfRoomHandle Room) const;
 
    void UpdateSessionFromRoom(FNamedOnlineSession& Session, ppfRoomHandle Room) const;
    void UpdateSessionSettingsFromDataStore(FOnlineSessionSettings& SessionSettings, ppfDataStoreHandle DataStore) const;
 
    void TickPendingInvites(float DeltaTime);
 
    bool CreateRoomSession(FNamedOnlineSession& Session, ppfRoomJoinPolicy JoinPolicy);
    bool CreateMatchmakingSession(FNamedOnlineSession& Session, ppfRoomJoinPolicy JoinPolicy);
    void OnCreateRoomComplete(ppfMessageHandle Message, bool bIsError, FName SessionName);
    
    bool FindModeratedRoomSessions(const TSharedRef<FOnlineSessionSearch>& SearchSettings);
    
    bool FindMatchmakingSessions(const FString Pool, const TSharedRef<FOnlineSessionSearch>& SearchSettings);
    
    bool UpdateRoomDataStore(FName SessionName, FOnlineSessionSettings& UpdatedSessionSettings);
 
 
public:
 
    // <summary>The constructor.</summary>
    // <param name="InSubsystem">A reference to the online subsystem.</param>
    FOnlineSessionPico(FOnlineSubsystemPico& InSubsystem);
    
    virtual ~FOnlineSessionPico();
 
 
    // Begin IOnlineSession interface
 
    virtual bool CreateSession(int32 HostingPlayerNum, FName SessionName, const FOnlineSessionSettings& NewSessionSettings) override;
    virtual bool CreateSession(const FUniqueNetId& HostingPlayerId, FName SessionName, const FOnlineSessionSettings& NewSessionSettings) override;
    
    virtual bool StartSession(FName SessionName) override;
 
    virtual bool UpdateSession(FName SessionName, FOnlineSessionSettings& UpdatedSessionSettings, bool bShouldRefreshOnlineData = true) override;
 
    virtual bool EndSession(FName SessionName) override;
 
    virtual bool DestroySession(FName SessionName, const FOnDestroySessionCompleteDelegate& CompletionDelegate = FOnDestroySessionCompleteDelegate()) override;
 
    virtual bool IsPlayerInSession(FName SessionName, const FUniqueNetId& UniqueId) override;
 
    virtual bool StartMatchmaking(const TArray< TSharedRef<const FUniqueNetId> >& LocalPlayers, FName SessionName, const FOnlineSessionSettings& NewSessionSettings, TSharedRef<FOnlineSessionSearch>& SearchSettings) override;
 
    virtual bool CancelMatchmaking(int32 SearchingPlayerNum, FName SessionName) override;
    virtual bool CancelMatchmaking(const FUniqueNetId& SearchingPlayerId, FName SessionName) override;
 
    virtual bool FindSessions(int32 SearchingPlayerNum, const TSharedRef<FOnlineSessionSearch>& SearchSettings) override;
    virtual bool FindSessions(const FUniqueNetId& SearchingPlayerId, const TSharedRef<FOnlineSessionSearch>& SearchSettings) override;
 
    virtual bool FindSessionById(const FUniqueNetId& SearchingUserId, const FUniqueNetId& SessionId, const FUniqueNetId& FriendId, const FOnSingleSessionResultCompleteDelegate& CompletionDelegate) override;
    virtual bool CancelFindSessions() override;
    virtual bool PingSearchResults(const FOnlineSessionSearchResult& SearchResult) override;
 
    virtual bool JoinSession(int32 PlayerNum, FName SessionName, const FOnlineSessionSearchResult& DesiredSession) override;
    virtual bool JoinSession(const FUniqueNetId& PlayerId, FName SessionName, const FOnlineSessionSearchResult& DesiredSession) override;
 
    virtual bool FindFriendSession(int32 LocalUserNum, const FUniqueNetId& Friend) override;
    virtual bool FindFriendSession(const FUniqueNetId& LocalUserId, const FUniqueNetId& Friend) override;
    virtual bool FindFriendSession(const FUniqueNetId& LocalUserId, const TArray<TSharedRef<const FUniqueNetId>>& FriendList) override;
    
    virtual bool SendSessionInviteToFriend(int32 LocalUserNum, FName SessionName, const FUniqueNetId& Friend) override;
    virtual bool SendSessionInviteToFriend(const FUniqueNetId& LocalUserId, FName SessionName, const FUniqueNetId& Friend) override;
    virtual bool SendSessionInviteToFriends(int32 LocalUserNum, FName SessionName, const TArray< TSharedRef<const FUniqueNetId> >& Friends) override;
    virtual bool SendSessionInviteToFriends(const FUniqueNetId& LocalUserId, FName SessionName, const TArray< TSharedRef<const FUniqueNetId> >& Friends) override;
    virtual bool GetResolvedConnectString(FName SessionName, FString& ConnectInfo, FName PortType = NAME_GamePort) override;
    virtual bool GetResolvedConnectString(const class FOnlineSessionSearchResult& SearchResult, FName PortType, FString& ConnectInfo) override;
    virtual FOnlineSessionSettings* GetSessionSettings(FName SessionName) override;
    virtual bool RegisterPlayer(FName SessionName, const FUniqueNetId& PlayerId, bool bWasInvited) override;
    virtual bool RegisterPlayers(FName SessionName, const TArray< TSharedRef<const FUniqueNetId> >& Players, bool bWasInvited = false) override;
    virtual bool UnregisterPlayer(FName SessionName, const FUniqueNetId& PlayerId) override;
    virtual bool UnregisterPlayers(FName SessionName, const TArray< TSharedRef<const FUniqueNetId> >& Players) override;
    virtual void RegisterLocalPlayer(const FUniqueNetId& PlayerId, FName SessionName, const FOnRegisterLocalPlayerCompleteDelegate& Delegate) override;
    virtual void UnregisterLocalPlayer(const FUniqueNetId& PlayerId, FName SessionName, const FOnUnregisterLocalPlayerCompleteDelegate& Delegate) override;
    virtual int32 GetNumSessions() override;
    virtual void DumpSessionState() override;
 
    virtual TSharedPtr<const FUniqueNetId> CreateSessionIdFromString(const FString& SessionIdStr) override;
    FNamedOnlineSession* GetNamedSession(FName SessionName) override;
    virtual void RemoveNamedSession(FName SessionName) override;
    virtual EOnlineSessionState::Type GetSessionState(FName SessionName) const override;
    virtual bool HasPresenceSession() override;
    class FNamedOnlineSession* AddNamedSession(FName SessionName, const FOnlineSessionSettings& SessionSettings) override;
    class FNamedOnlineSession* AddNamedSession(FName SessionName, const FOnlineSession& Session) override;
 
 
private:
    FString InitStateErrorMessage = FString("Error: InitSuccess is false");
    bool InitSuccess = false;
    bool OnUpdateRoomData(ppfRoomHandle Room, ppfID RoomId);
    void OnRoomInviteAccepted(ppfID RoomId);
PACKAGE_SCOPE:
 
    void OnGetAccessTokenComplete(ppfMessageHandle Message, bool bIsError);
    void OnGameInitializeComplete(ppfMessageHandle Message, bool bIsError);
 
    // todo 这些是否可删
    FDelegateHandle OnNetNotificationConnectionHandle;
    void OnNetNotificationConnection(ppfMessageHandle Message, bool bIsError);
 
    FDelegateHandle OnNetNotificationRequestFailedHandle;
    void OnNetNotificationRequestFailed(ppfMessageHandle Message, bool bIsError);
 
    FDelegateHandle OnNetNotificationGameStateResetHandle;
    void OnNetNotificationGameStateReset(ppfMessageHandle Message, bool bIsError);
 
    FDelegateHandle OnMatchmakingNotificationCancel2Handle;
    void OnMatchmakingNotificationCancel2(ppfMessageHandle Message, bool bIsError);
 
    FDelegateHandle OnRoomNotificationLeaveHandle;
    void OnRoomNotificationLeave(ppfMessageHandle Message, bool bIsError);
 
    FDelegateHandle OnRoomNotificationJoin2Handle;
    void OnRoomNotificationJoin2(ppfMessageHandle Message, bool bIsError);
 
    FDelegateHandle OnRoomNotificationSetDescriptionHandle;
    void OnRoomNotificationSetDescription(ppfMessageHandle Message, bool bIsError);
 
    FDelegateHandle OnRoomNotificationKickUserHandle;
    void OnRoomNotificationKickUser(ppfMessageHandle Message, bool bIsError);
 
    FDelegateHandle OnRoomNotificationUpdateOwnerHandle;
    void OnRoomNotificationUpdateOwner(ppfMessageHandle Message, bool bIsError);
 
    FDelegateHandle OnRoomNotificationUpdateDataStoreHandle;
    void OnRoomNotificationUpdateDataStore(ppfMessageHandle Message, bool bIsError);
 
    FDelegateHandle OnRoomNotificationUpdateMembershipLockStatusHandle;
    void OnRoomNotificationUpdateMembershipLockStatus(ppfMessageHandle Message, bool bIsError);
 
    void LogRoomData(ppfRoomHandle Room) const;
 
public:
    void Initialize();
 
    bool Uninitialize();
 
    void SetInitState(bool State);
 
    bool IsInitSuccess() const;
 
    void OnForcedCancelMatchmaking();
 
    void OnForcedLeaveRoom(ppfID RoomID);
 
    bool IsInMatchmakingProgress();
 
    FOnRoomUpdateComplete RoomUpdateCallback;
    FOnRoomInviteAcceptedComplete RoomInviteAcceptedCallback; // todo 可删
    FOnPicoSessionUserInviteAcceptedComplete PicoSessionUserInviteAcceptedCallback; // todo 用这个还是用 RoomInviteAcceptedCallback
 
    FOnGameConnectionComplete GameConnectionCallback;
    FOnGameRequestFailedComplete GameRequestFailedCallback;
    FOnGameStateResetComplete GameStateResetCallback;
    FOnMatchmakingCancel2Complete MatchmakingCancel2Callback;
    FOnRoomLeaveComplete RoomLeaveCallback;
    FOnRoomJoin2Complete RoomJoin2Callback;
    FOnRoomSetDescriptionComplete RoomSetDescriptionCallback;
    FOnRoomKickUserComplete RoomKickUserCallback;
    FOnRoomUpdateOwnerComplete RoomUpdateOwnerCallback;
    FOnRoomUpdateDataStoreComplete RoomUpdateDataStoreCallback;
    FOnRoomUpdateMembershipLockStatusComplete RoomUpdateMembershipLockStatusCallback;
 
    const char* JoinPolicyNames[6] = { "None", "Everyone", "FriendsOfMembers", "FriendsOfOwner", "InvitedUsers", "Unknown" };
    const char* RoomTypeNames[4] = { "Unknown", "Matchmaking", "Moderated", "Private" };
    const char* ConnectionResultNames[8] = { "Connected", "Closed", "Lost", "Resumed", "KickedByRelogin", "KickedByGameServer", "GameLogicError", "Unknown" };
    const char* JoinabilityNames[7] = { "Unknown", "AreIn", "AreKicked", "CanJoin", "IsFull", "NoViewer", "PolicyPrevents" };
    
    void TestDumpNamedSession(const FNamedOnlineSession* NamedSession) const;
    void TestDumpSession(const FOnlineSession* Session) const;
    void TestDumpSessionSettings(const FOnlineSessionSettings* SessionSettings) const;
}; // end of Session(OnlineSub) // end of Function
typedef TSharedPtr<FOnlineSessionPico, ESPMode::ThreadSafe> FOnlineSessionPicoPtr;