Navigation
API > API/Plugins > API/Plugins/OnlineBase
Encapsulate functionality related to LAN broadcast data
| Name | FLANSession |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineBase/Source/Public/Online/LANBeacon.h |
| Include Path | #include "Online/LANBeacon.h" |
Syntax
class FLANSession
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FLANSession() |
Online/LANBeacon.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FLANSession() |
Online/LANBeacon.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CachedResponseGuids | TSet< FGuid > | Cached guids already received during current search | Online/LANBeacon.h | |
| LanAnnouncePort | int32 | Port to listen on for LAN queries/responses | Online/LANBeacon.h | |
| LanBeacon | FLanBeacon * | LAN beacon for packet broadcast | Online/LANBeacon.h | |
| LanBeaconGuid | FGuid | Unique identifier for this hosting/searching LAN session | Online/LANBeacon.h | |
| LanBeaconState | ELanBeaconState::Type | State of the LAN beacon | Online/LANBeacon.h | |
| LanGameUniqueId | int32 | Unique id to keep UE games from seeing each others' LAN packets | Online/LANBeacon.h | |
| LanNonce | uint64 | Used by a client to uniquely identify itself during LAN match discovery | Online/LANBeacon.h | |
| LanPacketPlatformMask | int32 | Mask containing which platforms can cross communicate | Online/LANBeacon.h | |
| LanQueryRetryTime | float | The amount of time to wait before resending a LAN query request | Online/LANBeacon.h | |
| LanQueryRetryTimeLeft | float | The amount of time before the LAN query retry | Online/LANBeacon.h | |
| LanQueryTimeLeft | float | The amount of time before the LAN query is considered done | Online/LANBeacon.h | |
| LanQueryTimeout | float | The amount of time to wait before timing out a LAN query request | Online/LANBeacon.h | |
| OnSearchTimeoutDelegates | FOnSearchingTimeout | Online/LANBeacon.h | ||
| OnValidQueryPacketDelegates | FOnValidQueryPacket | Online/LANBeacon.h | ||
| OnValidResponsePacketDelegates | FOnValidResponsePacket | Online/LANBeacon.h | ||
| RetryData | TArray< uint8 > | Cached search packet data for retries | Online/LANBeacon.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool BroadcastPacket
(
uint8* Packet, |
Uses the cached broadcast address to send packet to a subnet | Online/LANBeacon.h | |
void CreateClientQueryPacket
(
FNboSerializeToBuffer& Packet, |
Online/LANBeacon.h | ||
void CreateHostResponsePacket
(
FNboSerializeToBuffer& Packet, |
Create packet of MAX size | Online/LANBeacon.h | |
ELanBeaconState::Type GetBeaconState() |
Online/LANBeacon.h | ||
bool Host
(
FOnValidQueryPacketDelegate& QueryDelegate |
Creates the LAN beacon for queries/advertising servers | Online/LANBeacon.h | |
bool Search
(
FNboSerializeToBuffer& Packet, |
Creates the LAN beacon for queries/advertising servers | Online/LANBeacon.h | |
void StopLANSession() |
Stops the LAN beacon from accepting broadcasts | Online/LANBeacon.h | |
void Tick
(
float DeltaTime |
Online/LANBeacon.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool IsValidLanQueryPacket
(
const uint8* Packet, |
Determines if the packet header is valid or notDetermines if the packet header is valid or not | Online/LANBeacon.h | |
bool IsValidLanResponsePacket
(
const uint8* Packet, |
Determines if the packet header is valid or notDetermines if the packet header is valid or not | Online/LANBeacon.h |