Navigation
API > API/Runtime > API/Runtime/Stomp
| Name | IStompClient |
| Type | class |
| Header File | /Engine/Source/Runtime/Online/Stomp/Public/IStompClient.h |
| Include Path | #include "IStompClient.h" |
Syntax
class IStompClient
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IStompClient() |
IStompClient.h |
Classes
| Name | Remarks |
|---|---|
| FStompClientClosedEvent | Delegate called when a connection has been closed. |
| FStompClientConnectedEvent | Delegate called when a connection been established successfully. |
| FStompClientConnectionErrorEvent | Delegate called when a connection could not be established. |
| FStompClientErrorEvent | Delegate called when an error is received from the server. |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Connect
(
const FStompHeader& Header |
Initiate a client connection to the server. | IStompClient.h | |
void Disconnect
(
const FStompHeader& Header |
Disconnect from the server. | IStompClient.h | |
bool IsConnected() |
Inquire if this instance is connected to a server. | IStompClient.h | |
FStompClientClosedEvent & OnClosed() |
IStompClient.h | ||
FStompClientConnectedEvent & OnConnected() |
IStompClient.h | ||
FStompClientConnectionErrorEvent & OnConnectionError() |
IStompClient.h | ||
FStompClientErrorEvent & OnError() |
IStompClient.h | ||
virtual void Send
(
const FString& Destination, |
IStompClient.h | ||
virtual void Send
(
const FString& Destination, |
IStompClient.h | ||
virtual void Send
(
const FString& Destination, |
Emit an event to a destination | IStompClient.h | |
void Send
(
const FString& Destination, |
Emit an event to a destination | IStompClient.h | |
FStompSubscriptionId Subscribe
(
const FString& Destination, |
Subscribe to an event | IStompClient.h | |
void Unsubscribe
(
FStompSubscriptionId Subscription, |
Unsubscribe from an event | IStompClient.h |