Navigation
API > API/Runtime > API/Runtime/XMPP
Inheritance Hierarchy
- IModuleInterface
- FSelfRegisteringExec
- FTSTickerObjectBase
- FXmppModule
References
| Module | XMPP |
| Header | /Engine/Source/Runtime/Online/XMPP/Public/XmppModule.h |
| Include | #include "XmppModule.h" |
Syntax
class FXmppModule :
public IModuleInterface ,
public FSelfRegisteringExec ,
public FTSTickerObjectBase
Remarks
Module for Xmpp connections Use CreateConnection to create a new Xmpp connection
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FOnXmppConnectionAcquired | OnXmppConnectionAcquired | |
 |
FOnXmppConnectionCreated | OnXmppConnectionCreated | |
 |
FOnXmppConnectionRelinquished | OnXmppConnectionRelinquished |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
TSharedRef< class IXmppConnection > | CreateConnection
(
const FString& UserId |
Creates a new Xmpp connection for the current platform and associated it with the user |
  |
FXmppModule & | Get () |
Singleton-like access to this module's interface. |
  |
TSharedPtr< class IXmppConnection > | GetConnection
(
const FString& UserId |
Return an existing Xmpp connection associated with a user |
 |
bool | HandleXmppCommand
(
const TCHAR* Cmd, |
Exec command handlers |
  |
bool | IsAvailable () |
Checks to see if this module is loaded and ready. |
  |
bool | ||
 |
void | Clean up any pending connection removals | |
 |
void | RemoveConnection
(
const FString& UserId |
Remove an existing Xmpp connection associated with a user |
 |
void | RemoveConnection
(
const TSharedRef< class IXmppConnection >& Connection |
Remove an existing Xmpp connection |
Overridden from FExec
| Type | Name | Description | |
|---|---|---|---|
  |
bool | Exec_Runtime
(
UWorld* InWorld, |
Handle exec commands starting with "XMPP" |
Overridden from FTSTickerObjectBase
| Type | Name | Description | |
|---|---|---|---|
  |
bool | Tick
(
float DeltaTime |
FTSTickerObjectBase. |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
FOnXmppConnectionAcquired | Delegate callback when a system acquires ownership over an XMPP connection | |
 |
FOnXmppConnectionRelinquished | Delegate callback when a system relinquishes ownership of an XMPP connection |
Typedefs
| Name | Description |
|---|---|
| FOnXmppConnectionCreated | Delegate fired when an Xmpp connection is created. |
Constants
| Name | Description |
|---|---|
| Singleton | Singleton for the module while loaded and available |