#include <XmppConnection.h>

Inheritance diagram for IXmppConnection:

Public Types
using	FOnXmppLoginChanged = FOnXmppLoginChanged

Public Member Functions
virtual	~IXmppConnection ()

virtual void	SetServer (const FXmppServer &Server)=0

virtual const FXmppServer &	GetServer () const =0

virtual void	Login (const FString &UserId, const FString &Auth)=0

virtual void	Logout ()=0

virtual EXmppLoginStatus::Type	GetLoginStatus () const =0

virtual const FXmppUserJid &	GetUserJid () const =0

	DECLARE_MULTICAST_DELEGATE_ThreeParams (FOnXmppLoginComplete, const FXmppUserJid &, bool, const FString &)

	DECLARE_MULTICAST_DELEGATE_ThreeParams (FOnXmppLogoutComplete, const FXmppUserJid &, bool, const FString &)

	DECLARE_MULTICAST_DELEGATE_TwoParams (FOnXmppLoginChanged, const FXmppUserJid &, EXmppLoginStatus::Type)

	DECLARE_MULTICAST_DELEGATE_OneParam (FOnXmppStanzaReceived, const IXmppStanza &)

	DECLARE_MULTICAST_DELEGATE_OneParam (FOnXmppStanzaSent, const IXmppStanza &)

virtual FOnXmppLoginComplete &	OnLoginComplete ()=0

virtual FOnXmppLoginChanged &	OnLoginChanged ()=0

virtual FOnXmppLogoutComplete &	OnLogoutComplete ()=0

virtual FOnXmppStanzaSent &	OnStanzaSent ()=0

virtual FOnXmppStanzaReceived &	OnStanzaReceived ()=0

virtual IXmppPresencePtr	Presence ()=0

virtual IXmppPubSubPtr	PubSub ()=0

virtual IXmppMessagesPtr	Messages ()=0

virtual IXmppMultiUserChatPtr	MultiUserChat ()=0

virtual IXmppChatPtr	PrivateChat ()=0

virtual void	DumpState () const =0

Public Member Functions inherited from TSharedFromThis< IXmppConnection >
TSharedRef< IXmppConnection, Mode >	AsShared ()

TSharedRef< IXmppConnection const, Mode >	AsShared () const

TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const

TWeakPtr< IXmppConnection, Mode >	AsWeak ()

TWeakPtr< IXmppConnection const, Mode >	AsWeak () const

TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const

void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const InSharedPtr, OtherType InObject) const

void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const InSharedRef, OtherType InObject) const

UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Additional Inherited Members
Protected Member Functions inherited from TSharedFromThis< IXmppConnection >
	TSharedFromThis ()

	TSharedFromThis (TSharedFromThis const &)

UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)

	~TSharedFromThis ()

Static Protected Member Functions inherited from TSharedFromThis< IXmppConnection >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)

static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Detailed Description

Base interface for connecting to Xmpp

Member Typedef Documentation

◆ FOnXmppLoginChanged

using IXmppConnection::FOnXmppLoginChanged = FOnXmppLoginChanged

Constructor & Destructor Documentation

◆ ~IXmppConnection()

virtual IXmppConnection::~IXmppConnection ( )

inlinevirtual

destructor

Member Function Documentation

◆ DECLARE_MULTICAST_DELEGATE_OneParam() [1/2]

IXmppConnection::DECLARE_MULTICAST_DELEGATE_OneParam	(	FOnXmppStanzaReceived	,
		const IXmppStanza &
	)

Delegate called when a message is received (ONLY STROPHE)

Parameters

reference to stanza

◆ DECLARE_MULTICAST_DELEGATE_OneParam() [2/2]

IXmppConnection::DECLARE_MULTICAST_DELEGATE_OneParam	(	FOnXmppStanzaSent	,
		const IXmppStanza &
	)

Delegate called when a message is sent (ONLY STROPHE)

Parameters

reference to stanza

◆ DECLARE_MULTICAST_DELEGATE_ThreeParams() [1/2]

IXmppConnection::DECLARE_MULTICAST_DELEGATE_ThreeParams	(	FOnXmppLoginComplete	,
		const FXmppUserJid &	,
		bool	,
		const FString &
	)

Delegate called when login completes

Parameters

UserJid	jid of user that attempted to login
bWasSuccess	true if successfully logged in user, false otherwise
Error	string representing error or empty if success

◆ DECLARE_MULTICAST_DELEGATE_ThreeParams() [2/2]

IXmppConnection::DECLARE_MULTICAST_DELEGATE_ThreeParams	(	FOnXmppLogoutComplete	,
		const FXmppUserJid &	,
		bool	,
		const FString &
	)

Delegate called when logout completes

Parameters

UserJid	jid of user that logged out
bWasSuccess	true if successfully logged out, false otherwise
Error	string representing error or empty if success

◆ DECLARE_MULTICAST_DELEGATE_TwoParams()

IXmppConnection::DECLARE_MULTICAST_DELEGATE_TwoParams	(	FOnXmppLoginChanged	,
		const FXmppUserJid &	,
		EXmppLoginStatus::Type
	)

Delegate called when login completes

Parameters

UserJid	jid of user that changed login state
LoginState	new login state (see EXmppLoginStatus)

◆ DumpState()

virtual void IXmppConnection::DumpState ( ) const

pure virtual

Debug dump of this connection

Implemented in FXmppConnectionNull.

◆ GetLoginStatus()

virtual EXmppLoginStatus::Type IXmppConnection::GetLoginStatus ( ) const

pure virtual

Obtain currently cached login status

Returns: EXmppLoginStatus based on logged in and socket connection state

Implemented in FXmppConnectionNull.

◆ GetServer()

virtual const FXmppServer & IXmppConnection::GetServer ( ) const

pure virtual

Obtain last server details associated with the connection

Returns: Server server details

Implemented in FXmppConnectionNull.

◆ GetUserJid()

virtual const FXmppUserJid & IXmppConnection::GetUserJid ( ) const

pure virtual

Get the jid of the last user login attempt Note that they may be logged out

Parameters

jid	to identify user

Implemented in FXmppConnectionNull.

◆ Login()

virtual void IXmppConnection::Login	(	const FString &	UserId,
		const FString &	Auth
	)

pure virtual

Login on the connection. No socket connection is created until user attempts to login See OnLoginComplete(), OnLoginChanged() delegates for completion

Parameters

UserId	just the id portion of the jid (domain is in server config)
Auth	plain text auth credentials for user

Implemented in FXmppConnectionNull.

◆ Logout()

virtual void IXmppConnection::Logout ( )

pure virtual

Logout on the connection with a user that has previously logged in. This will close the socket connection and cleanup. See OnLogoutComplete(), OnLoginChanged() delegates for completion

Implemented in FXmppConnectionNull.

◆ Messages()

virtual IXmppMessagesPtr IXmppConnection::Messages ( )

pure virtual

Returns: Messages interface if available. NULL otherwise

Implemented in FXmppConnectionNull.

◆ MultiUserChat()

virtual IXmppMultiUserChatPtr IXmppConnection::MultiUserChat ( )

pure virtual

Returns: MultiUserChat interface if available. NULL otherwise

Implemented in FXmppConnectionNull.

◆ OnLoginChanged()

virtual FOnXmppLoginChanged & IXmppConnection::OnLoginChanged ( )

pure virtual

Returns: login changed delegate

Implemented in FXmppConnectionNull.

◆ OnLoginComplete()

virtual FOnXmppLoginComplete & IXmppConnection::OnLoginComplete ( )

pure virtual

Returns: login complete delegate

Implemented in FXmppConnectionNull.

◆ OnLogoutComplete()

virtual FOnXmppLogoutComplete & IXmppConnection::OnLogoutComplete ( )

pure virtual

Returns: logout complete delegate

Implemented in FXmppConnectionNull.

◆ OnStanzaReceived()

virtual FOnXmppStanzaReceived & IXmppConnection::OnStanzaReceived ( )

pure virtual

Returns: Stanza received delegate

Implemented in FXmppConnectionNull.

◆ OnStanzaSent()

virtual FOnXmppStanzaSent & IXmppConnection::OnStanzaSent ( )

pure virtual

Returns: Stanza sent delegate

Implemented in FXmppConnectionNull.

◆ Presence()

virtual IXmppPresencePtr IXmppConnection::Presence ( )

pure virtual

Returns: Presence interface if available. NULL otherwise

Implemented in FXmppConnectionNull.

◆ PrivateChat()

virtual IXmppChatPtr IXmppConnection::PrivateChat ( )

pure virtual

Returns: PrivateChat interface if available. NULL otherwise

Implemented in FXmppConnectionNull.

◆ PubSub()

virtual IXmppPubSubPtr IXmppConnection::PubSub ( )

pure virtual

Returns: PubSub interface if available. NULL otherwise

Implemented in FXmppConnectionNull.

◆ SetServer()

virtual void IXmppConnection::SetServer ( const FXmppServer & Server )

pure virtual

Configure the connection with server details

Parameters

Server server details

Implemented in FXmppConnectionNull.

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

Engine/Source/Runtime/Online/XMPP/Public/XmppConnection.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ FOnXmppLoginChanged

Constructor & Destructor Documentation

◆ ~IXmppConnection()

Member Function Documentation

◆ DECLARE_MULTICAST_DELEGATE_OneParam() [1/2]

◆ DECLARE_MULTICAST_DELEGATE_OneParam() [2/2]

◆ DECLARE_MULTICAST_DELEGATE_ThreeParams() [1/2]

◆ DECLARE_MULTICAST_DELEGATE_ThreeParams() [2/2]

◆ DECLARE_MULTICAST_DELEGATE_TwoParams()

◆ DumpState()

◆ GetLoginStatus()

◆ GetServer()

◆ GetUserJid()

◆ Login()

◆ Logout()

◆ Messages()

◆ MultiUserChat()

◆ OnLoginChanged()

◆ OnLoginComplete()

◆ OnLogoutComplete()

◆ OnStanzaReceived()

◆ OnStanzaSent()

◆ Presence()

◆ PrivateChat()

◆ PubSub()

◆ SetServer()