StompClient.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "IStompClient.h"
#include "Containers/Ticker.h"
 
#if WITH_STOMP
 
#include "IStompClient.h"
#include "IWebSocket.h"
 
class Error;
 
class FStompClient
    : public IStompClient
    , public FTSTickerObjectBase
    , public TSharedFromThis<FStompClient>
{
public:
 
    virtual ~FStompClient();
 
    // FTSTickerObjectBase
    virtual bool Tick(float DeltaTime) override;
 
    // IStompClient
    
    virtual void Connect(const FStompHeader& Header=FStompHeader()) override;
 
    virtual void Disconnect(const FStompHeader& Header=FStompHeader()) override;
 
    virtual bool IsConnected() const override;
 
    virtual FStompSubscriptionId Subscribe(const FString& Destination, const FStompSubscriptionEvent& EventCallback, const FStompRequestCompleted& CompletionCallback = FStompRequestCompleted()) override;
 
    virtual void Unsubscribe(FStompSubscriptionId Subscription, const FStompRequestCompleted& CompletionCallback = FStompRequestCompleted()) override;
 
    virtual void Send(const FString& Destination, const FStompBuffer& Body, const FStompHeader& Header=FStompHeader(), const FStompRequestCompleted& CompletionCallback = FStompRequestCompleted()) override;
 
    DECLARE_DERIVED_EVENT(FStompClient, IStompClient::FStompClientConnectedEvent, FStompClientConnectedEvent);
    virtual FStompClientConnectedEvent& OnConnected() override
    {
        return ConnectedEvent;
    }
 
    DECLARE_DERIVED_EVENT(FStompClient, IStompClient::FStompClientConnectionErrorEvent, FStompClientConnectionErrorEvent);
    virtual FStompClientConnectionErrorEvent& OnConnectionError() override
    {
        return ConnectionErrorEvent;
    }
 
    DECLARE_DERIVED_EVENT(FStompClient, IStompClient::FStompClientErrorEvent, FStompClientErrorEvent);
    virtual FStompClientErrorEvent& OnError() override
    {
        return ErrorEvent;
    }
 
    DECLARE_DERIVED_EVENT(FStompClient, IStompClient::FStompClientClosedEvent, FStompClientClosedEvent);
    virtual FStompClientClosedEvent& OnClosed() override
    {
        return ClosedEvent;
    }
private:
    FStompClient(const FString& Url, const FTimespan& InPingInterval, const FTimespan& InPongInterval, const FString& OptAuthToken);
 
    FString MakeId(const class FStompFrame& Frame);
    void WriteFrame(class FStompFrame& Frame, const FStompRequestCompleted& CompletionCallback=FStompRequestCompleted());
    void PingServer();
 
    // WS event handlers
    void HandleWebSocketConnected();
    void HandleWebSocketConnectionError(const FString& Error);
    void HandleWebSocketConnectionClosed(int32 Status, const FString& Reason, bool bWasClean);
    void HandleWebSocketData(const void* Data, SIZE_T Length, SIZE_T BytesRemaining);
 
    void HandleIncomingFrame(const uint8* Data, SIZE_T Length);
    void HandleDisconnectCompleted(bool bSuccess, const FString& Error);
 
 
    FStompClientConnectedEvent ConnectedEvent;
    FStompClientConnectionErrorEvent ConnectionErrorEvent;
    FStompClientErrorEvent ErrorEvent;
    FStompClientClosedEvent ClosedEvent;
 
    TSharedPtr<IWebSocket> WebSocket;
    FStompBuffer ReceiveBuffer;
    FStompHeader ConnectHeader;
    uint64 IdCounter;
 
    struct FOutstantdingRequestInfo
    {
        FStompRequestCompleted Delegate;
        FDateTime StartTime;
    };
    TMap<FStompSubscriptionId, FStompSubscriptionEvent> Subscriptions;
    TMap<FString, FOutstantdingRequestInfo> OutstandingRequests;
 
    // "ping" is how often we should send an empty heartbeat packets to the server when inactive
    // "pong" is the minimum how often we should expect activity from the server (counting commands and empty heartbeat frames)
    FTimespan PingInterval, PongInterval;
    FDateTime LastSent;
    FDateTime LastReceivedPacket;
    FDateTime LastReceivedFrame;
 
    bool bReportedNoHeartbeatError;
 
    bool bIsConnected;
    FString SessionId;
    FString ServerString;
    FString ProtocolVersion;
 
    enum class EAuthStrategy
    {
        None,
 
        OnConnectionUpgrade,
 
        OnStompConnect
    };
 
    EAuthStrategy AuthStrategy = EAuthStrategy::None;
 
    friend class FStompModule;
    friend class FStompMessage;
 
};
 
#endif