1. Epic GamesDeveloper
  3. IStompClient

IStompClient

API > API/Runtime > API/Runtime/Stomp

References

   
Module Stomp
Header /Engine/Source/Runtime/Online/Stomp/Public/IStompClient.h
Include #include "IStompClient.h"

Syntax

class IStompClient

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

Connect ( const FStompHeader& Header
)

 Initiate a client connection to the server.
Public function void

Disconnect ( const FStompHeader& Header
)

 Disconnect from the server.
Public function Const bool Inquire if this instance is connected to a server.
Public function FStompClientClosedEvent &  
Public function FStompClientConnectedEvent &  
Public function FStompClientConnectionErrorEvent &  
Public function FStompClientErrorEvent &

OnError ()

  
Public function Virtual void

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

  
Public function Virtual void

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

  
Public function Virtual void

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

 Emit an event to a destination
Public function void

Send ( const FString& Destination,
const FStompBuffer& Body,
const FStompHeader& Header,
const FStompRequestCompleted& CompletionCallback
)

 Emit an event to a destination
Public function FStompSubscriptionId

Subscribe ( const FString& Destination,
const FStompSubscriptionEvent& EventCallback,
const FStompRequestCompleted& CompletionCallback
)

 Subscribe to an event
Public function void

Unsubscribe ( FStompSubscriptionId Subscription,
const FStompRequestCompleted& CompletionCallback
)

 Unsubscribe from an event

Classes

  Type Name Description
Public class FStompClientClosedEvent Delegate called when a connection has been closed.  
Public class FStompClientConnectedEvent Delegate called when a connection been established successfully.  
Public class FStompClientConnectionErrorEvent Delegate called when a connection could not be established.  
Public class FStompClientErrorEvent Delegate called when an error is received from the server.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page