WinHttpConnectionWebSocket.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#if WITH_WEBSOCKETS && WITH_WINHTTPWEBSOCKETS
 
#include "CoreMinimal.h"
#include "WinHttp/Support/WinHttpConnectionHttp.h"
#include "WinHttp/Support/WinHttpWebSocketTypes.h"
#include "Containers/Queue.h"
 
DECLARE_DELEGATE(FWinHttpConnectionWebSocketOnConnected);
DECLARE_DELEGATE_TwoParams(FWinHttpConnectionWebSocketOnMessage, EWebSocketMessageType /*MessageType*/, TArray<uint8>& /*MessagePayload*/);
DECLARE_DELEGATE_ThreeParams(FWinHttpConnectionWebSocketOnClosed, uint16 /*Code*/, const FString& /*Reason*/, bool /*bGracefulDisconnect*/);
 
class FWinHttpConnectionWebSocket
    : public FWinHttpConnectionHttp
{
public:
    static TSharedPtr<FWinHttpConnectionWebSocket, ESPMode::ThreadSafe> CreateWebSocketConnection(
        FWinHttpSession& Session,
        const FString& RequestUrl,
        const TArray<FString>& Protocols,
        const TMap<FString, FString>& UpgradeHeaders);
 
    virtual ~FWinHttpConnectionWebSocket() = default;
    FWinHttpConnectionWebSocket(const FWinHttpConnectionWebSocket& Other) = delete;
    FWinHttpConnectionWebSocket(FWinHttpConnectionWebSocket&& Other) = delete;
    FWinHttpConnectionWebSocket& operator=(const FWinHttpConnectionWebSocket& Other) = delete;
    FWinHttpConnectionWebSocket& operator=(FWinHttpConnectionWebSocket&& Other) = delete;
 
    //~ Begin FWinHttpConnectionHttp Public Interface
    virtual bool IsValid() const override;
    virtual void PumpMessages() override;
    virtual void PumpStates() override;
    //~ End FWinHttpConnectionHttp Public Interface
 
 
    void SetWebSocketConnectedHandler(FWinHttpConnectionWebSocketOnConnected&& Handler);
    void SetWebSocketMessageHandler(FWinHttpConnectionWebSocketOnMessage&& Handler);
    void SetWebSocketClosedHandler(FWinHttpConnectionWebSocketOnClosed&& Handler);
 
 
    bool IsConnected() const;
 
 
    bool SendMessage(EWebSocketMessageType MessageType, TArray<uint8>&& Message);
 
    bool CloseConnection(const uint16 Code, const FString& Reason);
 
protected:
    FWinHttpConnectionWebSocket(
        FWinHttpSession& Session,
        const FString& RequestUrl,
        const bool bIsSecure,
        const FString& Domain,
        const TOptional<uint16> Port,
        const FString& PathAndQuery,
        const TArray<FString>& Protocols,
        const TMap<FString, FString>& UpgradeHeaders);
 
    bool IsReadInProgress() const;
    void ReadData(const int32 MaxMessagesToRead);
    bool IsWriteInProgress() const;
    void WriteData(const int32 MaxMessagesToWrite);
 
    //~ Begin FWinHttpConnectionHttp Protected Interface
    virtual bool FinishRequest(const EHttpRequestStatus::Type FinalState) override;
    virtual void HandleHeadersAvailable() override;
    virtual void HandleHandleClosing() override;
    //~ End FWinHttpConnectionHttp Protected Interface
 
    void HandleWebSocketReadComplete(const uint32 BytesRead, const EWebSocketMessageType MessageType, const bool bIsFragment);
    void HandleWebSocketWriteComplete(const uint32 BytesWritten, const EWebSocketMessageType MessageType);
    void HandleWebSocketCloseComplete();
    void HandleWebSocketRequestError(const int32 WebSocketOperationId, const uint32 ErrorCode);
 
private:
    // Hide HTTP-events from this class's interface
    using FWinHttpConnectionHttp::CreateHttpConnection;
    using FWinHttpConnectionHttp::SetDataTransferredHandler;
    using FWinHttpConnectionHttp::SetHeaderReceivedHandler;
    using FWinHttpConnectionHttp::SetRequestCompletedHandler;
    
    void HandleWebSocketStatusCallback(HINTERNET ResourceHandle, EWinHttpCallbackStatus Status, void* StatusInformation, uint32 StatusInformationLength);
 
    friend void CALLBACK UE_WinHttpWebSocketStatusCallback(HINTERNET, DWORD_PTR, DWORD, LPVOID, DWORD);
 
protected:
    FWinHttpHandle WebSocketHandle;
 
    TOptional<EWebSocketMessageType> ReceiveFragmentMessageType;
    TArray<uint8> ReceiveBuffer;
    int32 ReceiveBufferBytesWritten = 0;
    bool bWebSocketReadInProgress = false;
 
    TQueue<TUniquePtr<FPendingWebSocketMessage>, EQueueMode::Spsc> SentMessagesQueue;
    TUniquePtr<FPendingWebSocketMessage> PendingMessage;
    bool bWebSocketWriteInProgress = false;
 
    FWinHttpConnectionWebSocketOnConnected OnConnectedHandler;
    bool bHasPendingConnectedEvent = false;
 
    FWinHttpConnectionWebSocketOnMessage OnMessageHandler;
    TQueue<FPendingWebSocketMessage, EQueueMode::Spsc> ReceieveMessageQueue;
    
    FWinHttpConnectionWebSocketOnClosed OnClosedHandler;
    TOptional<FWebSocketCloseInfo> SentCloseInfo;
    TOptional<FWebSocketCloseInfo> ReceivedCloseInfo;
};
 
#endif //WITH_WEBSOCKETS && WITH_WINHTTPWEBSOCKETS