#include <IStompClient.h>

Public Member Functions
virtual	~IStompClient ()

virtual void	Connect (const FStompHeader &Header=FStompHeader())=0

virtual void	Disconnect (const FStompHeader &Header=FStompHeader())=0

virtual bool	IsConnected () const =0

virtual FStompSubscriptionId	Subscribe (const FString &Destination, const FStompSubscriptionEvent &EventCallback, const FStompRequestCompleted &CompletionCallback=FStompRequestCompleted())=0

virtual void	Unsubscribe (FStompSubscriptionId Subscription, const FStompRequestCompleted &CompletionCallback=FStompRequestCompleted())=0

virtual void	Send (const FString &Destination, const FString &Body, const FStompHeader &Header=FStompHeader(), const FStompRequestCompleted &CompletionCallback=FStompRequestCompleted())

virtual void	Send (const FString &Destination, const FStompBuffer &Body, const FStompHeader &Header=FStompHeader(), const FStompRequestCompleted &CompletionCallback=FStompRequestCompleted())=0

virtual void	Send (const FString &Destination, const FString &Body, const FStompRequestCompleted &CompletionCallback)

virtual void	Send (const FString &Destination, const FStompBuffer &Body, const FStompRequestCompleted &CompletionCallback)

	DECLARE_EVENT_ThreeParams (IStompClient, FStompClientConnectedEvent, const FString &, const FString &, const FString &)

virtual FStompClientConnectedEvent &	OnConnected ()=0

	DECLARE_EVENT_OneParam (IStompClient, FStompClientConnectionErrorEvent, const FString &)

virtual FStompClientConnectionErrorEvent &	OnConnectionError ()=0

	DECLARE_EVENT_OneParam (IStompClient, FStompClientErrorEvent, const FString &)

virtual FStompClientErrorEvent &	OnError ()=0

	DECLARE_EVENT_OneParam (IStompClient, FStompClientClosedEvent, const FString &)

virtual FStompClientClosedEvent &	OnClosed ()=0

Constructor & Destructor Documentation

◆ ~IStompClient()

virtual IStompClient::~IStompClient ( )

inlinevirtual

Member Function Documentation

◆ Connect()

virtual void IStompClient::Connect ( const FStompHeader & Header = FStompHeader() )

pure virtual

Initiate a client connection to the server. Use this after setting up event handlers or to reconnect after connection errors.

Parameters

Header custom headers to send with the initial CONNECT command.

◆ DECLARE_EVENT_OneParam() [1/3]

IStompClient::DECLARE_EVENT_OneParam	(	IStompClient	,
		FStompClientClosedEvent	,
		const FString &
	)

Delegate called when a connection has been closed.

◆ DECLARE_EVENT_OneParam() [2/3]

IStompClient::DECLARE_EVENT_OneParam	(	IStompClient	,
		FStompClientConnectionErrorEvent	,
		const FString &
	)

Delegate called when a connection could not be established.

◆ DECLARE_EVENT_OneParam() [3/3]

IStompClient::DECLARE_EVENT_OneParam	(	IStompClient	,
		FStompClientErrorEvent	,
		const FString &
	)

Delegate called when an error is received from the server.

◆ DECLARE_EVENT_ThreeParams()

IStompClient::DECLARE_EVENT_ThreeParams	(	IStompClient	,
		FStompClientConnectedEvent	,
		const FString &	,
		const FString &	,
		const FString &
	)

Delegate called when a connection been established successfully.

Parameters

ProtocoVersion	The protocol version supported by the server
SessionId	A unique connection identifier. Can be empty depending on the server implementation.
ServerString	A server version string if returned from the server, otherwise empty string.

◆ Disconnect()

virtual void IStompClient::Disconnect ( const FStompHeader & Header = FStompHeader() )

pure virtual

Disconnect from the server.

Parameters

Header custom headers to send with the DISCONNECT command.

◆ IsConnected()

virtual bool IStompClient::IsConnected ( ) const

pure virtual

Inquire if this instance is connected to a server.

◆ OnClosed()

virtual FStompClientClosedEvent & IStompClient::OnClosed ( )

pure virtual

◆ OnConnected()

virtual FStompClientConnectedEvent & IStompClient::OnConnected ( )

pure virtual

◆ OnConnectionError()

virtual FStompClientConnectionErrorEvent & IStompClient::OnConnectionError ( )

pure virtual

◆ OnError()

virtual FStompClientErrorEvent & IStompClient::OnError ( )

pure virtual

◆ Send() [1/4]

virtual void IStompClient::Send	(	const FString &	Destination,
		const FStompBuffer &	Body,
		const FStompHeader &	Header = `FStompHeader()`,
		const FStompRequestCompleted &	CompletionCallback = `FStompRequestCompleted()`
	)

pure virtual

Emit an event to a destination

Parameters

Destination	The destination endoint of the event.
Body	The event body as a binary blob.
Header	Custom header values to send along with the data.
CompletionCallback	Delegate called when the request has been acknowledged by the server or if there is an error.

◆ Send() [2/4]

virtual void IStompClient::Send	(	const FString &	Destination,
		const FStompBuffer &	Body,
		const FStompRequestCompleted &	CompletionCallback
	)

inlinevirtual

◆ Send() [3/4]

virtual void IStompClient::Send	(	const FString &	Destination,
		const FString &	Body,
		const FStompHeader &	Header = `FStompHeader()`,
		const FStompRequestCompleted &	CompletionCallback = `FStompRequestCompleted()`
	)

inlinevirtual

Emit an event to a destination

Parameters

Destination	The destination endoint of the event.
Body	The event body as string. It will be encoded as UTF8 before sending to the Stomp server.
Header	Custom header values to send along with the data.
CompletionCallback	Delegate called when the request has been acknowledged by the server or if there is an error.

◆ Send() [4/4]

virtual void IStompClient::Send	(	const FString &	Destination,
		const FString &	Body,
		const FStompRequestCompleted &	CompletionCallback
	)

inlinevirtual

◆ Subscribe()

virtual FStompSubscriptionId IStompClient::Subscribe	(	const FString &	Destination,
		const FStompSubscriptionEvent &	EventCallback,
		const FStompRequestCompleted &	CompletionCallback = `FStompRequestCompleted()`
	)

pure virtual

Subscribe to an event

Parameters

Destination	Destination endpoint to subscribe to.
EventCallback	Delegate called when events arrive on this subscription.
CompletionCallback	Delegate called when the request has been acknowledged by the server or if there is an error.

Returns: a handle to the active subscription. Can be passed to Unsubscribe to unsubscribe from the end point.

◆ Unsubscribe()

virtual void IStompClient::Unsubscribe	(	FStompSubscriptionId	Subscription,
		const FStompRequestCompleted &	CompletionCallback = `FStompRequestCompleted()`
	)

pure virtual

Unsubscribe from an event

Parameters

Subscription	The id returned from the call to Subscribe.
CompletionCallback	Delegate called when the request has been acknowledged by the server or if there is an error.
ResponseCallback	Delegate called when the request has been completed.

The documentation for this class was generated from the following file:

Engine/Source/Runtime/Online/Stomp/Public/IStompClient.h

Public Member Functions

Constructor & Destructor Documentation

◆ ~IStompClient()

Member Function Documentation

◆ Connect()

◆ DECLARE_EVENT_OneParam() [1/3]

◆ DECLARE_EVENT_OneParam() [2/3]

◆ DECLARE_EVENT_OneParam() [3/3]

◆ DECLARE_EVENT_ThreeParams()

◆ Disconnect()

◆ IsConnected()

◆ OnClosed()

◆ OnConnected()

◆ OnConnectionError()

◆ OnError()

◆ Send() [1/4]

◆ Send() [2/4]

◆ Send() [3/4]

◆ Send() [4/4]

◆ Subscribe()

◆ Unsubscribe()