XmppConnection.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/UnrealString.h"
#include "CoreTypes.h"
#include "Delegates/Delegate.h"
#include "Templates/SharedPointer.h"
 
class IXmppChat;
class IXmppMessages;
class IXmppMultiUserChat;
class IXmppPresence;
class IXmppPubSub;
class IXmppStanza;
 
namespace EXmppLoginStatus
{
    enum Type
    {
        NotStarted,
        ProcessingLogin,
        ProcessingLogout,
        LoggedIn,
        LoggedOut
    };
 
    inline const TCHAR* ToString(EXmppLoginStatus::Type EnumVal)
    {
        switch (EnumVal)
        {
            case NotStarted:
                return TEXT("NotStarted");
            case ProcessingLogin:
                return TEXT("ProcessingLogin");
            case ProcessingLogout:
                return TEXT("ProcessingLogout");
            case LoggedIn:
                return TEXT("LoggedIn");
            case LoggedOut:
                return TEXT("LoggedOut");
        };
        return TEXT("Unknown");
    }
};
 
class FXmppServer
{
public:
    FXmppServer() 
        : ServerPort(5222) 
        , bUseSSL(true)
        , bUsePlainTextAuth(false)
        , PingInterval(60.0f)
        , PingTimeout(30.0f)
        , MaxPingRetries(1)
        , bPrivateChatFriendsOnly(false)
        , bResetPingTimeoutOnReceiveStanza(true)
    {}
 
    FString ServerAddr;
    int32 ServerPort;
    FString PlatformUserId;
    FString Domain;
    FString ClientResource;
    FString AppId;
    FString Platform;
    bool bUseSSL;
    bool bUsePlainTextAuth;
    float PingInterval;
    float PingTimeout;
    int32 MaxPingRetries;
    bool bPrivateChatFriendsOnly;
    bool bResetPingTimeoutOnReceiveStanza;
};
 
class FXmppUserJid
{
public:
 
    explicit FXmppUserJid(
        FString InId = FString(),
        FString InDomain = FString(),
        FString InResource = FString()
        )
        : Id(MoveTemp(InId))
        , Domain(MoveTemp(InDomain))
        , Resource(MoveTemp(InResource))
    {
    }
 
    static XMPP_API FXmppUserJid FromFullJid(const FString& JidString);
 
    FString Id;
    FString Domain;
    FString Resource;
 
    static XMPP_API bool ParseResource(const FString& InResource, FString& OutAppId, FString& OutPlatform, FString& OutPlatformUserId);
 
    static XMPP_API FString CreateResource(const FString& AppId, const FString& Platform, const FString& PlatformUserId);
 
    bool ParseResource(FString& OutAppId, FString& OutPlatform, FString& OutPlatformUserId) const
    {
        return ParseResource(Resource, OutAppId, OutPlatform, OutPlatformUserId);
    }
 
    static XMPP_API FString ParseMucUserResource(const FString& InResource);
 
    bool operator==(const FXmppUserJid& Other) const
    {
        return 
            Other.Id == Id && 
            Other.Domain == Domain && 
            Other.Resource == Resource;
    }
 
    bool operator!=(const FXmppUserJid& Other) const
    {
        return !operator==(Other);
    }
 
    FString GetFullPath() const
    {
        FString Result(Id);
        if (!Domain.IsEmpty())
        {
            Result += TEXT("@") + Domain;
 
            if (!Resource.IsEmpty())
            {
                Result += TEXT("/") + Resource;
            }
        }
 
        return Result;
    }
 
    FString GetBareId() const
    {
        return FString::Printf(TEXT("%s@%s"), *Id, *Domain);
    }
 
    bool IsValid() const
    {
        return !Id.IsEmpty() && !Domain.IsEmpty();
    }
 
    XMPP_API FString ToDebugString() const;
};
 
typedef TSharedPtr<IXmppPresence, ESPMode::ThreadSafe> IXmppPresencePtr;
typedef TSharedPtr<IXmppPubSub, ESPMode::ThreadSafe> IXmppPubSubPtr;
typedef TSharedPtr<IXmppMessages, ESPMode::ThreadSafe> IXmppMessagesPtr;
typedef TSharedPtr<IXmppMultiUserChat, ESPMode::ThreadSafe> IXmppMultiUserChatPtr;
typedef TSharedPtr<IXmppChat, ESPMode::ThreadSafe> IXmppChatPtr;
 
class IXmppConnection 
    : public TSharedFromThis<IXmppConnection>
{
public:
 
    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& /*UserJid*/, bool /*bWasSuccess*/, const FString& /*Error*/);
 
    DECLARE_MULTICAST_DELEGATE_ThreeParams(FOnXmppLogoutComplete, const FXmppUserJid& /*UserJid*/, bool /*bWasSuccess*/, const FString& /*Error*/);
 
    DECLARE_MULTICAST_DELEGATE_TwoParams(FOnXmppLoginChanged, const FXmppUserJid& /*UserJid*/, EXmppLoginStatus::Type /*LoginState*/);
 
    using FOnXmppLogingChanged UE_DEPRECATED(4.23, "Please update usages of 'FOnXmppLogingChanged' to 'FOnXmppLoginChanged'") = FOnXmppLoginChanged;
    DECLARE_MULTICAST_DELEGATE_OneParam(FOnXmppStanzaReceived, const IXmppStanza& /* Stanza */);
 
    DECLARE_MULTICAST_DELEGATE_OneParam(FOnXmppStanzaSent, const IXmppStanza& /* Stanza */);
 
    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;
};