FXmppModule Class Reference

#include <XmppModule.h>

Inheritance diagram for FXmppModule:

Public Member Functions
XMPP_API bool	HandleXmppCommand (const TCHAR *Cmd, FOutputDevice &Ar)
XMPP_API TSharedRef< class IXmppConnection >	CreateConnection (const FString &UserId)
XMPP_API TSharedPtr< class IXmppConnection >	GetConnection (const FString &UserId) const
XMPP_API void	RemoveConnection (const FString &UserId)
XMPP_API void	ProcessPendingRemovals ()
XMPP_API void	RemoveConnection (const TSharedRef< class IXmppConnection > &Connection)
bool	IsXmppEnabled () const
virtual XMPP_API bool	Tick (float DeltaTime) override
	DECLARE_EVENT_TwoParams (FXmppModule, FOnXmppConnectionAcquired, const TSharedRef< IXmppConnection > &, const FString &)
	DECLARE_EVENT_TwoParams (FXmppModule, FOnXmppConnectionRelinquished, const TSharedRef< IXmppConnection > &, const FString &)
	DECLARE_MULTICAST_DELEGATE_OneParam (FOnXmppConnectionCreated, const TSharedRef< IXmppConnection > &)
Public Member Functions inherited from IModuleInterface
virtual	~IModuleInterface ()
virtual void	PreUnloadCallback ()
virtual void	PostLoadCallback ()
virtual bool	SupportsDynamicReloading ()
virtual bool	SupportsAutomaticShutdown ()
virtual bool	IsGameModule () const
Public Member Functions inherited from FSelfRegisteringExec
CORE_API	FSelfRegisteringExec ()
virtual CORE_API	~FSelfRegisteringExec ()
Public Member Functions inherited from FExec
virtual CORE_API	~FExec ()
virtual CORE_API bool	Exec (UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Ar)
Public Member Functions inherited from FTSTickerObjectBase
	UE_NONCOPYABLE (FTSTickerObjectBase)
CORE_API	FTSTickerObjectBase (float InDelay=0.0f, FTSTicker &Ticker=FTSTicker::GetCoreTicker())
virtual CORE_API	~FTSTickerObjectBase ()

Static Public Member Functions
static XMPP_API FXmppModule &	Get ()
static XMPP_API bool	IsAvailable ()
Static Public Member Functions inherited from FSelfRegisteringExec
static CORE_API bool	StaticExec (UWorld *Inworld, const TCHAR *Cmd, FOutputDevice &Ar)

Public Attributes
FOnXmppConnectionAcquired	OnXmppConnectionAcquired
FOnXmppConnectionRelinquished	OnXmppConnectionRelinquished
FOnXmppConnectionCreated	OnXmppConnectionCreated

Protected Member Functions
virtual XMPP_API bool	Exec_Runtime (UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Ar) override
Protected Member Functions inherited from FExec
virtual bool	Exec_Dev (UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Ar)
virtual bool	Exec_Editor (UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Ar)

Detailed Description

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

Member Function Documentation

CreateConnection()

TSharedRef< IXmppConnection > FXmppModule::CreateConnection

(

const FString &

UserId

)

Creates a new Xmpp connection for the current platform and associated it with the user

Returns

new Xmpp connection instance

DECLARE_EVENT_TwoParams() [1/2]

FXmppModule::DECLARE_EVENT_TwoParams	(	FXmppModule	,
		FOnXmppConnectionAcquired	,
		const TSharedRef< IXmppConnection > &	,
		const FString &
	)

Delegate callback when a system acquires ownership over an XMPP connection

Parameters

XmppConnection	The connection that is acquired
SystemName	The name of the system initiating this request

DECLARE_EVENT_TwoParams() [2/2]

FXmppModule::DECLARE_EVENT_TwoParams	(	FXmppModule	,
		FOnXmppConnectionRelinquished	,
		const TSharedRef< IXmppConnection > &	,
		const FString &
	)

Delegate callback when a system relinquishes ownership of an XMPP connection

Parameters

XmppConnection	The connection that is relinquished
SystemName	The name of the system initiating this request

DECLARE_MULTICAST_DELEGATE_OneParam()

FXmppModule::DECLARE_MULTICAST_DELEGATE_OneParam	(	FOnXmppConnectionCreated	,
		const TSharedRef< IXmppConnection > &
	)

Delegate fired when an Xmpp connection is created.

Parameters

NewConnection

Reference to newly created Xmpp connection

Exec_Runtime()

bool FXmppModule::Exec_Runtime ( UWorld *  InWorld, const TCHAR *  Cmd, FOutputDevice &  Ar  )

overrideprotectedvirtual

Handle exec commands starting with "XMPP"

Parameters

InWorld	the world context
Cmd	the exec command being executed
Ar	the archive to log results to

Returns

true if the handler consumed the input, false to continue searching handlers

Reimplemented from FExec.

Get()

FXmppModule & FXmppModule::Get ( )

static

Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.

Returns

Returns singleton instance, loading the module on demand if needed

GetConnection()

TSharedPtr< IXmppConnection > FXmppModule::GetConnection

(

const FString &

UserId

)

const

Return an existing Xmpp connection associated with a user

Returns

new Xmpp connection instance

HandleXmppCommand()

bool FXmppModule::HandleXmppCommand	(	const TCHAR *	Cmd,
		FOutputDevice &	Ar
	)

Exec command handlers

IsAvailable()

bool FXmppModule::IsAvailable ( )

static

Checks to see if this module is loaded and ready.

Returns

True if the module is loaded and ready to use

IsXmppEnabled()

bool FXmppModule::IsXmppEnabled ( ) const

inline

Returns

true if Xmpp requests are globally enabled

ProcessPendingRemovals()

void FXmppModule::ProcessPendingRemovals

(

)

Clean up any pending connection removals

RemoveConnection() [1/2]

void FXmppModule::RemoveConnection

(

const FString &

UserId

)

Remove an existing Xmpp connection associated with a user

Parameters

UserId

user to find connection for

RemoveConnection() [2/2]

void FXmppModule::RemoveConnection

(

const TSharedRef< class IXmppConnection > &

Connection

)

Remove an existing Xmpp connection

Parameters

Connection

reference to find/remove

Tick()

bool FXmppModule::Tick ( float  DeltaTime )

overridevirtual

Pure virtual that must be overloaded by the inheriting class.

Parameters

DeltaTime

time passed since the last call.

Returns

true if should continue ticking

Implements FTSTickerObjectBase.

Member Data Documentation

OnXmppConnectionAcquired

FOnXmppConnectionAcquired FXmppModule::OnXmppConnectionAcquired

OnXmppConnectionCreated

FOnXmppConnectionCreated FXmppModule::OnXmppConnectionCreated

OnXmppConnectionRelinquished

FOnXmppConnectionRelinquished FXmppModule::OnXmppConnectionRelinquished

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Online/XMPP/Public/XmppModule.h
• Engine/Source/Runtime/Online/XMPP/Private/XmppModule.cpp