UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IStompClient.h
Go to the documentation of this file.
1// Copyright Epic Games, Inc. All Rights Reserved.
2
3#pragma once
4
5#include "CoreMinimal.h"
6
7class IStompMessage;
8typedef FString FStompSubscriptionId;
11
13DECLARE_DELEGATE_TwoParams(FStompRequestCompleted, bool /*bSuccess*/, const FString& /*Error*/);
14
16{
17public:
18
19 virtual ~IStompClient()
20 { }
21
28 virtual void Connect(const FStompHeader& Header=FStompHeader()) = 0;
29
35 virtual void Disconnect(const FStompHeader& Header=FStompHeader()) = 0;
36
40 virtual bool IsConnected() const = 0;
41
49 virtual FStompSubscriptionId Subscribe(const FString& Destination, const FStompSubscriptionEvent& EventCallback, const FStompRequestCompleted& CompletionCallback = FStompRequestCompleted()) = 0;
50
58
66 virtual void Send(const FString& Destination, const FString& Body, const FStompHeader& Header=FStompHeader(), const FStompRequestCompleted& CompletionCallback = FStompRequestCompleted())
67 {
68 FTCHARToUTF8 Convert(*Body);
69 FStompBuffer Encoded;
70 Encoded.Append((uint8*)Convert.Get(), Convert.Length());
71 Send(Destination, Encoded, Header, CompletionCallback);
72 }
73
81 virtual void Send(const FString& Destination, const FStompBuffer& Body, const FStompHeader& Header=FStompHeader(), const FStompRequestCompleted& CompletionCallback = FStompRequestCompleted()) = 0;
82
83
84 virtual void Send(const FString& Destination, const FString& Body, const FStompRequestCompleted& CompletionCallback)
85 {
86 Send(Destination, Body, FStompHeader(), CompletionCallback);
87 }
88
89 virtual void Send(const FString& Destination, const FStompBuffer& Body, const FStompRequestCompleted& CompletionCallback)
90 {
91 Send(Destination, Body, FStompHeader(), CompletionCallback);
92 }
93
101 DECLARE_EVENT_ThreeParams(IStompClient, FStompClientConnectedEvent, const FString& /*ProtocolVersion*/, const FString& /*SessionId*/, const FString& /*ServerString*/);
103
110
117
124
125};
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
#define DECLARE_DELEGATE_TwoParams(DelegateName, Param1Type, Param2Type)
Definition DelegateCombinations.h:57
#define DECLARE_DELEGATE_OneParam(DelegateName, Param1Type)
Definition DelegateCombinations.h:48
TArray< uint8 > FStompBuffer
Definition IStompClient.h:10
TMap< FName, FString > FStompHeader
Definition IStompClient.h:9
FString FStompSubscriptionId
Definition IStompClient.h:8
uint8_t uint8
Definition binka_ue_file_header.h:8
Definition IStompClient.h:16
virtual void Send(const FString &Destination, const FStompBuffer &Body, const FStompHeader &Header=FStompHeader(), const FStompRequestCompleted &CompletionCallback=FStompRequestCompleted())=0
virtual ~IStompClient()
Definition IStompClient.h:19
virtual void Disconnect(const FStompHeader &Header=FStompHeader())=0
virtual FStompClientClosedEvent & OnClosed()=0
DECLARE_EVENT_OneParam(IStompClient, FStompClientClosedEvent, const FString &)
virtual void Unsubscribe(FStompSubscriptionId Subscription, const FStompRequestCompleted &CompletionCallback=FStompRequestCompleted())=0
virtual void Send(const FString &Destination, const FString &Body, const FStompRequestCompleted &CompletionCallback)
Definition IStompClient.h:84
DECLARE_EVENT_OneParam(IStompClient, FStompClientErrorEvent, const FString &)
DECLARE_EVENT_OneParam(IStompClient, FStompClientConnectionErrorEvent, const FString &)
virtual void Connect(const FStompHeader &Header=FStompHeader())=0
DECLARE_EVENT_ThreeParams(IStompClient, FStompClientConnectedEvent, const FString &, const FString &, const FString &)
virtual void Send(const FString &Destination, const FString &Body, const FStompHeader &Header=FStompHeader(), const FStompRequestCompleted &CompletionCallback=FStompRequestCompleted())
Definition IStompClient.h:66
virtual FStompClientErrorEvent & OnError()=0
virtual void Send(const FString &Destination, const FStompBuffer &Body, const FStompRequestCompleted &CompletionCallback)
Definition IStompClient.h:89
virtual FStompClientConnectionErrorEvent & OnConnectionError()=0
virtual FStompClientConnectedEvent & OnConnected()=0
virtual FStompSubscriptionId Subscribe(const FString &Destination, const FStompSubscriptionEvent &EventCallback, const FStompRequestCompleted &CompletionCallback=FStompRequestCompleted())=0
virtual bool IsConnected() const =0
Definition Array.h:670
void Append(const TArray< OtherElementType, OtherAllocatorType > &Source)
Definition Array.h:2412
Definition UnrealString.h.inl:34
Definition StringConv.h:671