XmppPubSub.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "XmppConnection.h"
 
typedef FString FXmppPubSubId;
 
class FXmppPubSubConfig
{
public:
    FXmppPubSubConfig()
        : bPersistItems(false) 
        , bCollection(false)
        , MaxItems(1)
        , MaxPayloadSize(4*1024)
    {}
 
    bool bPersistItems;
    bool bCollection;
    int32 MaxItems;
    int32 MaxPayloadSize;
    FXmppPubSubId CollectionId;
};
 
class FXmppPubSubMessage
{
public:
    FXmppPubSubMessage()
    {}
 
    FXmppUserJid FromJid;
    FXmppUserJid ToJid;
    FString Payload;
    FString Type;
    FDateTime Timestamp;
};
 
class FXmppPubSubNode
{
public:
    FXmppPubSubNode()
    {}
 
    FXmppPubSubId Id;
    FXmppPubSubConfig Config;
};
 
class IXmppPubSub
{
public:
 
    virtual ~IXmppPubSub() {}
 
    virtual bool CreateNode(const FXmppPubSubId& NodeId, const FXmppPubSubConfig& NodeConfig) = 0;
    virtual bool ConfigureNode(const FXmppPubSubId& NodeId, const FXmppPubSubConfig& NodeConfig) = 0;
    virtual bool DestroyNode(const FXmppPubSubId& NodeId) = 0;
    virtual bool QueryNode(const FXmppPubSubId& NodeId) = 0;
    virtual bool QuerySubscriptions() = 0;
    virtual bool Subscribe(const FXmppPubSubId& NodeId) = 0;
    virtual bool Unsubscribe(const FXmppPubSubId& NodeId) = 0;
    virtual bool PublishMessage(const FXmppPubSubId& NodeId, const FXmppPubSubMessage& Message) = 0;
    virtual TArray<FXmppPubSubId> GetOwnedNodes() const = 0;
    virtual TArray<FXmppPubSubId> GetSubscribedNodes() const = 0;
    virtual TSharedPtr<FXmppPubSubNode> GetNodeInfo(const FXmppPubSubId& NodeId) const = 0;
    virtual bool GetLastMessages(const FXmppPubSubId& NodeId, int32 NumMessages, TArray< TSharedRef<FXmppPubSubMessage> >& OutMessages) const = 0;
 
    DECLARE_MULTICAST_DELEGATE_FourParams(FOnXmppPubSubCreateNodeComplete, const TSharedRef<IXmppConnection>& /*Connection*/, bool /*bSuccess*/, const FXmppPubSubId& /*NodeId*/, const FString& /*Error*/);
    virtual FOnXmppPubSubCreateNodeComplete& OnCreateNodeComplete() = 0;
 
    DECLARE_MULTICAST_DELEGATE_FourParams(FOnXmppPubSubConfigureNodeComplete, const TSharedRef<IXmppConnection>& /*Connection*/, bool /*bSuccess*/, const FXmppPubSubId& /*NodeId*/, const FString& /*Error*/);
    virtual FOnXmppPubSubConfigureNodeComplete& OnConfigureNodeComplete() = 0;
 
    DECLARE_MULTICAST_DELEGATE_FourParams(FOnXmppPubSubDestroyNodeComplete, const TSharedRef<IXmppConnection>& /*Connection*/, bool /*bSuccess*/, const FXmppPubSubId& /*NodeId*/, const FString& /*Error*/);
    virtual FOnXmppPubSubDestroyNodeComplete& OnDestroyNodeComplete() = 0;
 
    DECLARE_MULTICAST_DELEGATE_FourParams(FOnXmppPubSubQueryNodeComplete, const TSharedRef<IXmppConnection>& /*Connection*/, bool /*bSuccess*/, const FXmppPubSubId& /*NodeId*/, const FString& /*Error*/);
    virtual FOnXmppPubSubQueryNodeComplete& OnQueryNodeComplete() = 0;
 
    DECLARE_MULTICAST_DELEGATE_FourParams(FOnXmppPubSubQuerySubscriptionsComplete, const TSharedRef<IXmppConnection>& /*Connection*/, bool /*bSuccess*/, const FXmppPubSubId& /*NodeId*/, const FString& /*Error*/);
    virtual FOnXmppPubSubQuerySubscriptionsComplete& OnQuerySubscriptionsComplete() = 0;
 
    DECLARE_MULTICAST_DELEGATE_ThreeParams(FOnXmppPubSubSubscribed, const TSharedRef<IXmppConnection>& /*Connection*/, FXmppPubSubId& /*NodeId*/, const FXmppUserJid& /*UserJid*/);
    virtual FOnXmppPubSubSubscribed& OnSubscribed() = 0;
 
    DECLARE_MULTICAST_DELEGATE_ThreeParams(FOnXmppPubSubUnsubscribed, const TSharedRef<IXmppConnection>& /*Connection*/, FXmppPubSubId& /*NodeId*/, const FXmppUserJid& /*UserJid*/);
    virtual FOnXmppPubSubUnsubscribed& OnUnsubscribed() = 0;
 
    DECLARE_MULTICAST_DELEGATE_FourParams(FOnXmppPubSubMessageReceived, const TSharedRef<IXmppConnection>& /*Connection*/, FXmppPubSubId& /*NodeId*/, const FXmppUserJid& /*UserJid*/, const TSharedRef<FXmppPubSubMessage>& /*PubSubMsg*/);
    virtual FOnXmppPubSubMessageReceived& OnMessageReceived() = 0;
};