UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
IXmppPubSub Class Referenceabstract

#include <XmppPubSub.h>

Public Member Functions

virtual ~IXmppPubSub ()
 
virtual bool CreateNode (const FXmppPubSubId &NodeId, const FXmppPubSubConfig &NodeConfig)=0
 
virtual bool ConfigureNode (const FXmppPubSubId &NodeId, const FXmppPubSubConfig &NodeConfig)=0
 
virtual bool DestroyNode (const FXmppPubSubId &NodeId)=0
 
virtual bool QueryNode (const FXmppPubSubId &NodeId)=0
 
virtual bool QuerySubscriptions ()=0
 
virtual bool Subscribe (const FXmppPubSubId &NodeId)=0
 
virtual bool Unsubscribe (const FXmppPubSubId &NodeId)=0
 
virtual bool PublishMessage (const FXmppPubSubId &NodeId, const FXmppPubSubMessage &Message)=0
 
virtual TArray< FXmppPubSubId > GetOwnedNodes () const =0
 
virtual TArray< FXmppPubSubId > GetSubscribedNodes () const =0
 
virtual TSharedPtr< FXmppPubSubNode > GetNodeInfo (const FXmppPubSubId &NodeId) const =0
 
virtual bool GetLastMessages (const FXmppPubSubId &NodeId, int32 NumMessages, TArray< TSharedRef< FXmppPubSubMessage > > &OutMessages) const =0
 
 DECLARE_MULTICAST_DELEGATE_FourParams (FOnXmppPubSubCreateNodeComplete, const TSharedRef< IXmppConnection > &, bool, const FXmppPubSubId &, const FString &)
 
virtual FOnXmppPubSubCreateNodeComplete & OnCreateNodeComplete ()=0
 
 DECLARE_MULTICAST_DELEGATE_FourParams (FOnXmppPubSubConfigureNodeComplete, const TSharedRef< IXmppConnection > &, bool, const FXmppPubSubId &, const FString &)
 
virtual FOnXmppPubSubConfigureNodeComplete & OnConfigureNodeComplete ()=0
 
 DECLARE_MULTICAST_DELEGATE_FourParams (FOnXmppPubSubDestroyNodeComplete, const TSharedRef< IXmppConnection > &, bool, const FXmppPubSubId &, const FString &)
 
virtual FOnXmppPubSubDestroyNodeComplete & OnDestroyNodeComplete ()=0
 
 DECLARE_MULTICAST_DELEGATE_FourParams (FOnXmppPubSubQueryNodeComplete, const TSharedRef< IXmppConnection > &, bool, const FXmppPubSubId &, const FString &)
 
virtual FOnXmppPubSubQueryNodeComplete & OnQueryNodeComplete ()=0
 
 DECLARE_MULTICAST_DELEGATE_FourParams (FOnXmppPubSubQuerySubscriptionsComplete, const TSharedRef< IXmppConnection > &, bool, const FXmppPubSubId &, const FString &)
 
virtual FOnXmppPubSubQuerySubscriptionsComplete & OnQuerySubscriptionsComplete ()=0
 
 DECLARE_MULTICAST_DELEGATE_ThreeParams (FOnXmppPubSubSubscribed, const TSharedRef< IXmppConnection > &, FXmppPubSubId &, const FXmppUserJid &)
 
virtual FOnXmppPubSubSubscribed & OnSubscribed ()=0
 
 DECLARE_MULTICAST_DELEGATE_ThreeParams (FOnXmppPubSubUnsubscribed, const TSharedRef< IXmppConnection > &, FXmppPubSubId &, const FXmppUserJid &)
 
virtual FOnXmppPubSubUnsubscribed & OnUnsubscribed ()=0
 
 DECLARE_MULTICAST_DELEGATE_FourParams (FOnXmppPubSubMessageReceived, const TSharedRef< IXmppConnection > &, FXmppPubSubId &, const FXmppUserJid &, const TSharedRef< FXmppPubSubMessage > &)
 
virtual FOnXmppPubSubMessageReceived & OnMessageReceived ()=0
 

Detailed Description

Interface for publishing/subscribing to events

Constructor & Destructor Documentation

◆ ~IXmppPubSub()

virtual IXmppPubSub::~IXmppPubSub ( )
inlinevirtual

Member Function Documentation

◆ ConfigureNode()

virtual bool IXmppPubSub::ConfigureNode ( const FXmppPubSubId &  NodeId,
const FXmppPubSubConfig &  NodeConfig 
)
pure virtual

◆ CreateNode()

virtual bool IXmppPubSub::CreateNode ( const FXmppPubSubId &  NodeId,
const FXmppPubSubConfig &  NodeConfig 
)
pure virtual

◆ DECLARE_MULTICAST_DELEGATE_FourParams() [1/6]

IXmppPubSub::DECLARE_MULTICAST_DELEGATE_FourParams ( FOnXmppPubSubConfigureNodeComplete  ,
const TSharedRef< IXmppConnection > &  ,
bool  ,
const FXmppPubSubId &  ,
const FString &   
)

◆ DECLARE_MULTICAST_DELEGATE_FourParams() [2/6]

IXmppPubSub::DECLARE_MULTICAST_DELEGATE_FourParams ( FOnXmppPubSubCreateNodeComplete  ,
const TSharedRef< IXmppConnection > &  ,
bool  ,
const FXmppPubSubId &  ,
const FString &   
)

◆ DECLARE_MULTICAST_DELEGATE_FourParams() [3/6]

IXmppPubSub::DECLARE_MULTICAST_DELEGATE_FourParams ( FOnXmppPubSubDestroyNodeComplete  ,
const TSharedRef< IXmppConnection > &  ,
bool  ,
const FXmppPubSubId &  ,
const FString &   
)

◆ DECLARE_MULTICAST_DELEGATE_FourParams() [4/6]

IXmppPubSub::DECLARE_MULTICAST_DELEGATE_FourParams ( FOnXmppPubSubMessageReceived  ,
const TSharedRef< IXmppConnection > &  ,
FXmppPubSubId &  ,
const FXmppUserJid &  ,
const TSharedRef< FXmppPubSubMessage > &   
)

◆ DECLARE_MULTICAST_DELEGATE_FourParams() [5/6]

IXmppPubSub::DECLARE_MULTICAST_DELEGATE_FourParams ( FOnXmppPubSubQueryNodeComplete  ,
const TSharedRef< IXmppConnection > &  ,
bool  ,
const FXmppPubSubId &  ,
const FString &   
)

◆ DECLARE_MULTICAST_DELEGATE_FourParams() [6/6]

IXmppPubSub::DECLARE_MULTICAST_DELEGATE_FourParams ( FOnXmppPubSubQuerySubscriptionsComplete  ,
const TSharedRef< IXmppConnection > &  ,
bool  ,
const FXmppPubSubId &  ,
const FString &   
)

◆ DECLARE_MULTICAST_DELEGATE_ThreeParams() [1/2]

IXmppPubSub::DECLARE_MULTICAST_DELEGATE_ThreeParams ( FOnXmppPubSubSubscribed  ,
const TSharedRef< IXmppConnection > &  ,
FXmppPubSubId &  ,
const FXmppUserJid &   
)

◆ DECLARE_MULTICAST_DELEGATE_ThreeParams() [2/2]

IXmppPubSub::DECLARE_MULTICAST_DELEGATE_ThreeParams ( FOnXmppPubSubUnsubscribed  ,
const TSharedRef< IXmppConnection > &  ,
FXmppPubSubId &  ,
const FXmppUserJid &   
)

◆ DestroyNode()

virtual bool IXmppPubSub::DestroyNode ( const FXmppPubSubId &  NodeId)
pure virtual

◆ GetLastMessages()

virtual bool IXmppPubSub::GetLastMessages ( const FXmppPubSubId &  NodeId,
int32  NumMessages,
TArray< TSharedRef< FXmppPubSubMessage > > &  OutMessages 
) const
pure virtual

◆ GetNodeInfo()

virtual TSharedPtr< FXmppPubSubNode > IXmppPubSub::GetNodeInfo ( const FXmppPubSubId &  NodeId) const
pure virtual

◆ GetOwnedNodes()

virtual TArray< FXmppPubSubId > IXmppPubSub::GetOwnedNodes ( ) const
pure virtual

◆ GetSubscribedNodes()

virtual TArray< FXmppPubSubId > IXmppPubSub::GetSubscribedNodes ( ) const
pure virtual

◆ OnConfigureNodeComplete()

virtual FOnXmppPubSubConfigureNodeComplete & IXmppPubSub::OnConfigureNodeComplete ( )
pure virtual
Returns
pubsub node configured delegate

◆ OnCreateNodeComplete()

virtual FOnXmppPubSubCreateNodeComplete & IXmppPubSub::OnCreateNodeComplete ( )
pure virtual
Returns
pubsub node created delegate

◆ OnDestroyNodeComplete()

virtual FOnXmppPubSubDestroyNodeComplete & IXmppPubSub::OnDestroyNodeComplete ( )
pure virtual
Returns
pubsub node destroyed delegate

◆ OnMessageReceived()

virtual FOnXmppPubSubMessageReceived & IXmppPubSub::OnMessageReceived ( )
pure virtual
Returns
pubsub message received delegate

◆ OnQueryNodeComplete()

virtual FOnXmppPubSubQueryNodeComplete & IXmppPubSub::OnQueryNodeComplete ( )
pure virtual
Returns
pubsub node query delegate

◆ OnQuerySubscriptionsComplete()

virtual FOnXmppPubSubQuerySubscriptionsComplete & IXmppPubSub::OnQuerySubscriptionsComplete ( )
pure virtual
Returns
pubsub node created delegate

◆ OnSubscribed()

virtual FOnXmppPubSubSubscribed & IXmppPubSub::OnSubscribed ( )
pure virtual
Returns
pubsub node subscription delegate

◆ OnUnsubscribed()

virtual FOnXmppPubSubUnsubscribed & IXmppPubSub::OnUnsubscribed ( )
pure virtual
Returns
pubsub node unsubscribe delegate

◆ PublishMessage()

virtual bool IXmppPubSub::PublishMessage ( const FXmppPubSubId &  NodeId,
const FXmppPubSubMessage &  Message 
)
pure virtual

◆ QueryNode()

virtual bool IXmppPubSub::QueryNode ( const FXmppPubSubId &  NodeId)
pure virtual

◆ QuerySubscriptions()

virtual bool IXmppPubSub::QuerySubscriptions ( )
pure virtual

◆ Subscribe()

virtual bool IXmppPubSub::Subscribe ( const FXmppPubSubId &  NodeId)
pure virtual

◆ Unsubscribe()

virtual bool IXmppPubSub::Unsubscribe ( const FXmppPubSubId &  NodeId)
pure virtual
The documentation for this class was generated from the following file: