UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
XmppModule.h
Go to the documentation of this file.
1// Copyright Epic Games, Inc. All Rights Reserved.
2
3#pragma once
4
5#include "Containers/Array.h"
6#include "Containers/Map.h"
7#include "Containers/Set.h"
8#include "Containers/Ticker.h"
10#include "CoreMinimal.h"
11#include "Delegates/Delegate.h"
12#include "HAL/Platform.h"
13#include "Misc/CoreMisc.h"
16#include "XmppConnection.h"
17#include "XmppMultiUserChat.h"
18
19class Error;
20class FOutputDevice;
21class IXmppConnection;
22class UWorld;
23
30{
31
32protected:
33
34 // FSelfRegisteringExec
35
45 XMPP_API virtual bool Exec_Runtime(UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar) override;
46
47public:
48
52 XMPP_API bool HandleXmppCommand( const TCHAR* Cmd, FOutputDevice& Ar );
53
54 // FXmppModule
55
62 static XMPP_API FXmppModule& Get();
63
69 static XMPP_API bool IsAvailable();
70
77
83 XMPP_API TSharedPtr<class IXmppConnection> GetConnection(const FString& UserId) const;
84
90 XMPP_API void RemoveConnection(const FString& UserId);
91
96
103
107 inline bool IsXmppEnabled() const
108 {
109 return bEnabled;
110 }
111
112 // FTSTickerObjectBase
113 XMPP_API virtual bool Tick(float DeltaTime) override;
114
121 DECLARE_EVENT_TwoParams(FXmppModule, FOnXmppConnectionAcquired, const TSharedRef<IXmppConnection>& /*XmppConnection*/, const FString& /*SystemName*/);
123
130 DECLARE_EVENT_TwoParams(FXmppModule, FOnXmppConnectionRelinquished, const TSharedRef<IXmppConnection>& /*XmppConnection*/, const FString& /*SystemName*/);
132
141
142
143private:
144
145 // IModuleInterface
146
147 XMPP_API void OnXmppRoomCreated(const TSharedRef<IXmppConnection>& Connection, bool bSuccess, const FXmppRoomId& RoomId, const FString& Error);
148 XMPP_API void OnXmppRoomConfigured(const TSharedRef<IXmppConnection>& Connection, bool bSuccess, const FXmppRoomId& RoomId, const FString& Error);
149
154 XMPP_API virtual void StartupModule() override;
155
160 XMPP_API virtual void ShutdownModule() override;
161
165 XMPP_API void CleanupConnection(const TSharedRef<class IXmppConnection>& Connection);
166
168 bool bEnabled;
170 static XMPP_API FXmppModule* Singleton;
171
175 TSet<TSharedPtr<IXmppConnection>> PendingRemovals;
177 TArray<TSharedRef<class IXmppConnection>> PendingDeleteConnections;
178};
bool bSuccess
Definition ConvexDecomposition3.cpp:819
FPlatformTypes::TCHAR TCHAR
Either ANSICHAR or WIDECHAR, depending on whether the platform supports wide characters or the requir...
Definition Platform.h:1135
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
FString FXmppRoomId
Definition XmppMultiUserChat.h:13
Definition OutputDevice.h:133
Definition CoreMisc.h:28
Definition Ticker.h:137
Definition XmppModule.h:30
FOnXmppConnectionRelinquished OnXmppConnectionRelinquished
Definition XmppModule.h:131
XMPP_API void ProcessPendingRemovals()
Definition XmppModule.cpp:744
FOnXmppConnectionAcquired OnXmppConnectionAcquired
Definition XmppModule.h:122
virtual XMPP_API bool Exec_Runtime(UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Ar) override
Definition XmppModule.cpp:657
static XMPP_API FXmppModule & Get()
Definition XmppModule.cpp:667
XMPP_API TSharedRef< class IXmppConnection > CreateConnection(const FString &UserId)
Definition XmppModule.cpp:683
FOnXmppConnectionCreated OnXmppConnectionCreated
Definition XmppModule.h:140
XMPP_API bool HandleXmppCommand(const TCHAR *Cmd, FOutputDevice &Ar)
Definition XmppModule.cpp:59
XMPP_API TSharedPtr< class IXmppConnection > GetConnection(const FString &UserId) const
Definition XmppModule.cpp:711
bool IsXmppEnabled() const
Definition XmppModule.h:107
DECLARE_EVENT_TwoParams(FXmppModule, FOnXmppConnectionAcquired, const TSharedRef< IXmppConnection > &, const FString &)
DECLARE_MULTICAST_DELEGATE_OneParam(FOnXmppConnectionCreated, const TSharedRef< IXmppConnection > &)
static XMPP_API bool IsAvailable()
Definition XmppModule.cpp:678
XMPP_API void RemoveConnection(const FString &UserId)
Definition XmppModule.cpp:724
DECLARE_EVENT_TwoParams(FXmppModule, FOnXmppConnectionRelinquished, const TSharedRef< IXmppConnection > &, const FString &)
Definition ModuleInterface.h:14
Definition XmppConnection.h:219
Definition Array.h:670
Definition UnrealString.h.inl:34
Definition SharedPointer.h:692
Definition SharedPointer.h:153
Definition World.h:918