FXmppModule | Unreal Engine 5.6 Documentation

Module for Xmpp connections Use CreateConnection to create a new Xmpp connection


Name	FXmppModule
Type	class
Header File	/Engine/Source/Runtime/Online/XMPP/Public/XmppModule.h
Include Path	#include "XmppModule.h"

Syntax

class FXmppModule :  
    public IModuleInterface,  
    public FSelfRegisteringExec,  
    public FTSTickerObjectBase

Name	Remarks
FOnXmppConnectionAcquired	Delegate callback when a system acquires ownership over an XMPP connection
FOnXmppConnectionRelinquished	Delegate callback when a system relinquishes ownership of an XMPP connection

Name	Type	Remarks	Include Path
FOnXmppConnectionCreated	TMulticastDelegate_OneParam< void, const TSharedRef< IXmppConnection > & >	Delegate fired when an Xmpp connection is created.	XmppModule.h

Name	Type	Remarks	Include Path
Singleton	FXmppModule *	Singleton for the module while loaded and available	XmppModule.h

Name	Type	Include Path
OnXmppConnectionAcquired	FOnXmppConnectionAcquired	XmppModule.h
OnXmppConnectionCreated	FOnXmppConnectionCreated	XmppModule.h
OnXmppConnectionRelinquished	FOnXmppConnectionRelinquished	XmppModule.h

Name	Type	Remarks	Include Path
ActiveConnections	TMap< FString, TSharedRef< class IXmppConnection > >	Active Xmpp server connections mapped by user id	XmppModule.h
bEnabled	bool	Toggles Xmpp requests	XmppModule.h
PendingDeleteConnections	TArray< TSharedRef< class IXmppConnection > >	Keep track of removed connections pending cleanup	XmppModule.h
PendingRemovals	TSet< TSharedPtr< IXmppConnection > >	Xmpp connections pending removal on next tick	XmppModule.h

Name	Remarks	Include Path
TSharedRef< class IXmppConnection > CreateConnection ( const FString& UserId )	Creates a new Xmpp connection for the current platform and associated it with the user	XmppModule.h
TSharedPtr< class IXmppConnection > GetConnection ( const FString& UserId ) const	Return an existing Xmpp connection associated with a user	XmppModule.h
bool HandleXmppCommand ( const TCHAR* Cmd, FOutputDevice& Ar )	Exec command handlers	XmppModule.h
bool IsXmppEnabled()		XmppModule.h
void ProcessPendingRemovals()	Clean up any pending connection removals	XmppModule.h
void RemoveConnection ( const FString& UserId )	Remove an existing Xmpp connection associated with a user	XmppModule.h
void RemoveConnection ( const TSharedRef< class IXmppConnection >& Connection )	Remove an existing Xmpp connection	XmppModule.h
virtual bool Tick ( float DeltaTime )	FTSTickerObjectBase.	XmppModule.h

Name	Remarks	Include Path	Unreal Specifiers
virtual bool Exec_Runtime ( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar )	Handle exec commands starting with "XMPP"	XmppModule.h

Name	Remarks	Include Path	Unreal Specifiers
static FXmppModule & Get ()	Singleton-like access to this module's interface.	XmppModule.h
static bool IsAvailable()	Checks to see if this module is loaded and ready.	XmppModule.h