UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FXmppConnectionNull Class Reference
+ Inheritance diagram for FXmppConnectionNull:

Public Member Functions

virtual void SetServer (const FXmppServer &Server) override
 
virtual const FXmppServerGetServer () const override
 
virtual void Login (const FString &UserId, const FString &Auth) override
 
virtual void Logout () override
 
virtual EXmppLoginStatus::Type GetLoginStatus () const override
 
virtual const FXmppUserJidGetUserJid () const override
 
virtual FOnXmppLoginCompleteOnLoginComplete () override
 
virtual FOnXmppLoginChangedOnLoginChanged () override
 
virtual FOnXmppLogoutCompleteOnLogoutComplete () override
 
virtual FOnXmppStanzaSentOnStanzaSent () override
 
virtual FOnXmppStanzaReceivedOnStanzaReceived () override
 
virtual IXmppPresencePtr Presence () override
 
virtual IXmppPubSubPtr PubSub () override
 
virtual IXmppMessagesPtr Messages () override
 
virtual IXmppMultiUserChatPtr MultiUserChat () override
 
virtual IXmppChatPtr PrivateChat () override
 
virtual void DumpState () const override
 
 FXmppConnectionNull ()
 
virtual ~FXmppConnectionNull ()
 
- Public Member Functions inherited from IXmppConnection
virtual ~IXmppConnection ()
 
 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 &)
 
- 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

- Public Types inherited from IXmppConnection
using FOnXmppLoginChanged = FOnXmppLoginChanged
 
- Protected Member Functions inherited from TSharedFromThis< IXmppConnection >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (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)
 

Constructor & Destructor Documentation

◆ FXmppConnectionNull()

FXmppConnectionNull::FXmppConnectionNull ( )
inline

◆ ~FXmppConnectionNull()

virtual FXmppConnectionNull::~FXmppConnectionNull ( )
inlinevirtual

Member Function Documentation

◆ DumpState()

virtual void FXmppConnectionNull::DumpState ( ) const
inlineoverridevirtual

Debug dump of this connection

Implements IXmppConnection.

◆ GetLoginStatus()

virtual EXmppLoginStatus::Type FXmppConnectionNull::GetLoginStatus ( ) const
inlineoverridevirtual

Obtain currently cached login status

Returns
EXmppLoginStatus based on logged in and socket connection state

Implements IXmppConnection.

◆ GetServer()

virtual const FXmppServer & FXmppConnectionNull::GetServer ( ) const
inlineoverridevirtual

Obtain last server details associated with the connection

Returns
Server server details

Implements IXmppConnection.

◆ GetUserJid()

virtual const FXmppUserJid & FXmppConnectionNull::GetUserJid ( ) const
inlineoverridevirtual

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

Parameters
jidto identify user

Implements IXmppConnection.

◆ Login()

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

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

Parameters
UserIdjust the id portion of the jid (domain is in server config)
Authplain text auth credentials for user

Implements IXmppConnection.

◆ Logout()

virtual void FXmppConnectionNull::Logout ( )
inlineoverridevirtual

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

Implements IXmppConnection.

◆ Messages()

virtual IXmppMessagesPtr FXmppConnectionNull::Messages ( )
inlineoverridevirtual
Returns
Messages interface if available. NULL otherwise

Implements IXmppConnection.

◆ MultiUserChat()

virtual IXmppMultiUserChatPtr FXmppConnectionNull::MultiUserChat ( )
inlineoverridevirtual
Returns
MultiUserChat interface if available. NULL otherwise

Implements IXmppConnection.

◆ OnLoginChanged()

virtual FOnXmppLoginChanged & FXmppConnectionNull::OnLoginChanged ( )
inlineoverridevirtual
Returns
login changed delegate

Implements IXmppConnection.

◆ OnLoginComplete()

virtual FOnXmppLoginComplete & FXmppConnectionNull::OnLoginComplete ( )
inlineoverridevirtual
Returns
login complete delegate

Implements IXmppConnection.

◆ OnLogoutComplete()

virtual FOnXmppLogoutComplete & FXmppConnectionNull::OnLogoutComplete ( )
inlineoverridevirtual
Returns
logout complete delegate

Implements IXmppConnection.

◆ OnStanzaReceived()

virtual FOnXmppStanzaReceived & FXmppConnectionNull::OnStanzaReceived ( )
inlineoverridevirtual
Returns
Stanza received delegate

Implements IXmppConnection.

◆ OnStanzaSent()

virtual FOnXmppStanzaSent & FXmppConnectionNull::OnStanzaSent ( )
inlineoverridevirtual
Returns
Stanza sent delegate

Implements IXmppConnection.

◆ Presence()

virtual IXmppPresencePtr FXmppConnectionNull::Presence ( )
inlineoverridevirtual
Returns
Presence interface if available. NULL otherwise

Implements IXmppConnection.

◆ PrivateChat()

virtual IXmppChatPtr FXmppConnectionNull::PrivateChat ( )
inlineoverridevirtual
Returns
PrivateChat interface if available. NULL otherwise

Implements IXmppConnection.

◆ PubSub()

virtual IXmppPubSubPtr FXmppConnectionNull::PubSub ( )
inlineoverridevirtual
Returns
PubSub interface if available. NULL otherwise

Implements IXmppConnection.

◆ SetServer()

virtual void FXmppConnectionNull::SetServer ( const FXmppServer Server)
inlineoverridevirtual

Configure the connection with server details

Parameters
Serverserver details

Implements IXmppConnection.


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