PVROBeacon.h

Go to the documentation of this file.

// Copyright(c) 2023 PixoVR, LLC. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "OnlineSubsystemTypes.h"
#include "OnlineDelegateMacros.h"
#include "Misc/ConfigCacheIni.h"
#if ENGINE_MAJOR_VERSION >= 5
#include "Online/LANBeacon.h"
#endif
 
#define PIXOVR_BEACON_PACKET_VERSION (uint8)10
#define PIXOVR_BEACON_PACKET_HEADER_SIZE 16
#define PIXOVR_SERVER_QUERY1 (uint8)'S'
#define PIXOVR_SERVER_QUERY2 (uint8)'Q'
#define PIXOVR_SERVER_RESPONSE1 (uint8)'S'
#define PIXOVR_SERVER_RESPONSE2 (uint8)'R'
 
class FInternetAddr;
class FNboSerializeToBuffer;
 
DECLARE_MULTICAST_DELEGATE_ThreeParams(FOnValidQueryPacket, uint8*, int32, uint64);
typedef FOnValidQueryPacket::FDelegate FOnValidQueryPacketDelegate;
 
DECLARE_MULTICAST_DELEGATE_TwoParams(FOnValidResponsePacket, uint8*, int32);
typedef FOnValidResponsePacket::FDelegate FOnValidResponsePacketDelegate;
 
DECLARE_MULTICAST_DELEGATE(FOnSearchingTimeout);
typedef FOnSearchingTimeout::FDelegate FOnSearchingTimeoutDelegate;
 
DECLARE_MULTICAST_DELEGATE_OneParam(FOnPortChanged, int32);
typedef FOnPortChanged::FDelegate FOnPortChangedDelegate;
 
class PIXOVRMULTIPLAYER_API FPVROBeacon
{
    TSharedPtr<class FInternetAddr> BroadcastAddr;
    class FSocket* ListenSocket;
    TSharedPtr<class FInternetAddr> ListenAddr;
    TSharedRef<class FInternetAddr> SockAddr;
 
public:
    FPVROBeacon();
 
    virtual ~FPVROBeacon();
 
    bool IsListenSocketValid() const;
 
    bool Init(int32 Port);
 
    bool InitHost(int32 Port);
 
    bool InitClient(int32 IP, int32 Port, int32 ListenPort);
 
    int32 ReceivePacket(uint8* PacketData, int32 BufferSize);
 
    bool BroadcastPacket(uint8* Packet, int32 Length);
 
    bool BroadcastPacketFromSocket(uint8* Packet, int32 Length);
    
    DEFINE_ONLINE_DELEGATE_ONE_PARAM(OnPortChanged, int32);
};
 
#define PIXOVR_ANNOUNCE_PORT 14001
#define PIXOVR_UNIQUE_ID 9999
#define PIXOVR_QUERY_TIMEOUT 5
#define PIXOVR_PLATFORMMASK 0xffffffff
 
class PIXOVRMULTIPLAYER_API FPVROSession
{
protected:
    bool IsValidLanQueryPacket(const uint8* Packet, uint32 Length, uint64& ClientNonce);
 
    bool IsValidLanResponsePacket(const uint8* Packet, uint32 Length);
 
public:
 
    int32 LanAnnouncePort;
 
    int32 HostSessionAddress;
 
    int32 HostSessionPort;
 
    int32 ClientSessionPort;
 
    bool IsLANMatch;
 
    int32 LanGameUniqueId;
 
    int32 LanPacketPlatformMask;
 
    float LanQueryTimeout;
 
    class FPVROBeacon* LanBeacon;
 
    ELanBeaconState::Type LanBeaconState;
 
    uint64 LanNonce;
 
    float LanQueryTimeLeft;
 
    FPVROSession() :
        LanAnnouncePort(PIXOVR_ANNOUNCE_PORT),
        LanGameUniqueId(PIXOVR_UNIQUE_ID),
        LanPacketPlatformMask(PIXOVR_PLATFORMMASK),
        LanQueryTimeout(PIXOVR_QUERY_TIMEOUT),
        LanBeacon(NULL),
        LanBeaconState(ELanBeaconState::NotUsingLanBeacon),
        LanNonce(0),
        LanQueryTimeLeft(0.0f)
    {
        if (!GConfig->GetInt(TEXT("LANSession"), TEXT("LanAnnouncePort"), LanAnnouncePort, GEngineIni))
        {
            LanAnnouncePort = PIXOVR_ANNOUNCE_PORT;
        }
        if (!GConfig->GetInt(TEXT("LANSession"), TEXT("LanGameUniqueId"), LanGameUniqueId, GEngineIni))
        {
            LanGameUniqueId = PIXOVR_UNIQUE_ID;
        }
    }
 
    virtual ~FPVROSession()
    {
        StopLANSession();
    }
 
    bool Host(FOnValidQueryPacketDelegate& QueryDelegate, int32 Port = -1);
 
    bool Search(class FNboSerializeToBuffer& Packet, FOnValidResponsePacketDelegate& ResponseDelegate, FOnSearchingTimeoutDelegate& TimeoutDelegate);
 
    void StopLANSession();
 
    void Tick(float DeltaTime);
 
    void CreateHostResponsePacket(FNboSerializeToBuffer& Packet, uint64 ClientNonce);
    void CreateClientQueryPacket(FNboSerializeToBuffer& Packet, uint64 ClientNonce);
 
    bool BroadcastPacket(uint8* Packet, int32 Length);
 
    bool BroadcastPacketFromSocket(uint8* Packet, int32 Length);
 
    ELanBeaconState::Type GetBeaconState() const
    {
        return LanBeaconState;
    }
 
    DEFINE_ONLINE_DELEGATE_THREE_PARAM(OnValidQueryPacket, uint8*, int32, uint64);
    DEFINE_ONLINE_DELEGATE_TWO_PARAM(OnValidResponsePacket, uint8*, int32);
    DEFINE_ONLINE_DELEGATE(OnSearchingTimeout);
};