MultiplayerWebSocket.cpp

Go to the documentation of this file.

// Copyright(c) 2023 PixoVR, LLC. All Rights Reserved.
 
#include "MultiplayerWebSocket.h"
#include "WebSocketsModule.h"
 
DEFINE_LOG_CATEGORY_STATIC(LogMultiplayerWebSocket, Log, All);
 
#define Log(pmt, ...) UE_LOG(LogMultiplayerWebSocket, Log, TEXT(pmt), ##__VA_ARGS__)
#define Warn(pmt, ...) UE_LOG(LogMultiplayerWebSocket, Warning, TEXT(pmt), ##__VA_ARGS__)
#define Error(pmt, ...) UE_LOG(LogMultiplayerWebSocket, Error, TEXT(pmt), ##__VA_ARGS__)
#define Fatal(pmt, ...) UE_LOG(LogMultiplayerWebSocket, Fatal, TEXT(pmt), ##__VA_ARGS__)
 
MultiplayerWebSocket::MultiplayerWebSocket() : 
    bShouldRestartOnBadClose(true),
    bShouldReplayLastRequestOnBadClose(true)
{
 
}
 
MultiplayerWebSocket::~MultiplayerWebSocket()
{
    Log("MultiplayerWebSocket destructor.");
    Disconnect();
}
 
void MultiplayerWebSocket::Disconnect()
{
    Log("MultiplayerWebSocket Disconnect.");
    if (WebSocket.IsValid() && WebSocket->IsConnected())
    {
        Log("Disconnecting...");
        // Clear the OnClosed event to prevent some access errors when the app is shutting down.
        WebSocket->OnClosed().Clear();
        WebSocket->OnConnected().Clear();
        WebSocket->OnConnectionError().Clear();
        WebSocket->Close();
    }
 
    WebSocket = nullptr;
}
 
bool MultiplayerWebSocket::AttemptConnect(FString Uri, FString Protocol)
{
    Log("Connecting to websocket at %s", *Uri);
    if (WebSocket.IsValid() && WebSocket->IsConnected())
        return false;
 
    SocketUri = Uri;
    SocketProtocol = Protocol;
 
    PendingWebsocketRequests.Empty();
 
    if (!WebSocket.IsValid())
    {
        Log("Setting up the socket.");
        SetupSocket(WebSocket, Uri, Protocol);
    }
 
    if (WebSocket)
    {
        Log("WebSocket connect called.");
        WebSocket->Connect();
    }
    else
    {
        return false;
    }
 
    return true;
}
 
bool MultiplayerWebSocket::IsWebsocketConnected()
{
    if (WebSocket.IsValid() && WebSocket->IsConnected())
        return true;
 
    return false;
}
 
void MultiplayerWebSocket::RequestMatchMake(int OrgId, int ModuleId)
{
    FString JsonString = FString::Format(TEXT("{ \"OrgId\": {0}, \"ModuleId\": {1}}"), { FStringFormatArg(OrgId), FStringFormatArg(ModuleId) });
    PendingWebsocketRequests.Add(MultiplayerRequestData{ MultiplayerWebSocketRequestType::MatchMake, JsonString });
 
    if (WebSocket.IsValid() && WebSocket->IsConnected())
    {
        ProcessNextRequest();
    }
}
 
void MultiplayerWebSocket::SetupSocket(TSharedPtr<IWebSocket>& Socket, FString Uri, FString Protocol)
{
    if (!&FWebSocketsModule::Get())
    {
        return;
    }
 
    Socket = FWebSocketsModule::Get().CreateWebSocket(Uri, Protocol);
 
    Socket->OnConnected().AddLambda([&]() -> void {
        Log("WebSocket connected.");
        ProcessNextRequest();
        SocketConnectedEvent.Broadcast();
    });
 
    Socket->OnConnectionError().AddLambda([&](const FString& Error) -> void {
        Error("Failed to connect with error: %s", *Error);
        CleanUpRequests();
        SocketConnectFailedEvent.Broadcast(Error);
    });
 
    Socket->OnClosed().AddLambda([&](int32 StatusCode, const FString& Reason, bool bWasClean) -> void {
        Log("Socket closed with status %d, for reason %s", StatusCode, *Reason);
        CleanUpRequests();
        SocketDisconnectedEvent.Broadcast(StatusCode, Reason, bWasClean);
        // Bad close caused by underlying WebSocket implementation. Only happens in the editor.
        if (StatusCode == 1006 && bShouldRestartOnBadClose)
        {
            AttemptConnect(SocketUri, SocketProtocol);
            if (bShouldReplayLastRequestOnBadClose && LastWebSocketRequest.RequestType != MultiplayerWebSocketRequestType::Invalid)
            {
                PendingWebsocketRequests.Add(LastWebSocketRequest);
            }
        }
    });
 
    Socket->OnMessage().AddLambda([&](const FString& Message) -> void {
        Log("Socket received message %s", *Message);
        SocketMessageReceivedEvent.Broadcast(Message);
        LastWebSocketRequest.RequestType = MultiplayerWebSocketRequestType::Invalid;
    });
 
    Socket->OnRawMessage().AddLambda([&](const void* Data, SIZE_T Size, SIZE_T BytesRemaining) -> void {
        // This code will run when we receive a raw (binary) message from the server.
        Log("A raw message was received of size %d.", Size);
    });
 
    Socket->OnMessageSent().AddLambda([&](const FString& MessageString) -> void {
        Log("Apex message sent.");
        ProcessNextRequest();
    });
}
 
void MultiplayerWebSocket::ProcessNextRequest()
{
    if (PendingWebsocketRequests.Num() > 0)
    {
        auto NextRequest = PendingWebsocketRequests.Pop();
 
        switch (NextRequest.RequestType)
        {
        case MultiplayerWebSocketRequestType::MatchMake:
            {
                SendData(NextRequest.Json);
            }
            break;
        default:
            Error("Invalid request type submitted of type %d", NextRequest.RequestType);
        }
 
        LastWebSocketRequest = NextRequest;
    }
}
 
void MultiplayerWebSocket::CleanUpRequests()
{
    PendingWebsocketRequests.Empty();
}
 
void MultiplayerWebSocket::SendData(FString Data)
{
    if (!WebSocket->IsConnected())
    {
        return;
    }
    
    WebSocket->Send(Data);
}
 
#undef Fatal
#undef Error
#undef Warn
#undef Log