Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > OnlineSubsystem > FLANSession

Light Theme

Dark Theme

FLANSession

Encapsulate functionality related to LAN broadcast data

Windows

MacOS

Linux

References

Module	OnlineSubsystem
Header	/Engine/Plugins/Online/OnlineSubsystem/Source/Public/LANBeacon.h
Include	#include "LANBeacon.h"

Syntax

class FLANSession

Remarks

Encapsulate functionality related to LAN broadcast data

Variables

	Name	Description
TSet< FGuid >	CachedResponseGuids	Cached guids already received during current search
int32	LanAnnouncePort	Port to listen on for LAN queries/responses
FLanBeacon *...	LanBeacon	LAN beacon for packet broadcast
FGuid	LanBeaconGuid	Unique identifier for this hosting/searching LAN session
ELanBeaconState...	LanBeaconState	State of the LAN beacon
int32	LanGameUniqueId	Unique id to keep UE3 games from seeing each others' LAN packets
uint64	LanNonce	Used by a client to uniquely identify itself during LAN match discovery
int32	LanPacketPlatformMask	Mask containing which platforms can cross communicate
float	LanQueryRetryTime	The amount of time to wait before resending a LAN query request
float	LanQueryRetryTimeLeft	The amount of time before the LAN query retry
float	LanQueryTimeLeft	The amount of time before the LAN query is considered done
float	LanQueryTimeout	The amount of time to wait before timing out a LAN query request
FOnSearchingTim...	OnSearchingTimeoutDelegates
FOnValidQueryPa...	OnValidQueryPacketDelegates
FOnValidRespons...	OnValidResponsePacketDelegates
TArray< uint8 >	RetryData	Cached search packet data for retries

Constructors

	Name	Description
	FLANSession()

Destructors

	Name	Description
	~FLANSession()

Functions

	Name	Description
FDelegateHan...	AddOnSearchingTimeoutDelegate_Handle ( const FOnSearchingTimeoutDelegate&... )
FDelegateHan...	AddOnValidQueryPacketDelegate_Handle ( const FOnValidQueryPacketDelegate&... )
FDelegateHan...	AddOnValidResponsePacketDelegate_Handle ( const FOnValidResponsePacketDelegat... )
bool	BroadcastPacket ( uint8* Packet, int32 Length )	Uses the cached broadcast address to send packet to a subnet
void	ClearOnSearchingTimeoutDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnSearchingTimeoutDelegates ( void* Object )
void	ClearOnValidQueryPacketDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnValidQueryPacketDelegates ( void* Object )
void	ClearOnValidResponsePacketDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnValidResponsePacketDelegates ( void* Object )
void	CreateClientQueryPacket ( FNboSerializeToBuffer& Packet, uint64 ClientNonce )
void	CreateHostResponsePacket ( FNboSerializeToBuffer& Packet, uint64 ClientNonce )	Create packet of MAX size
ELanBeaconSt...	GetBeaconState()
bool	Host ( FOnValidQueryPacketDelegate& Query... )	Creates the LAN beacon for queries/advertising servers
bool	IsValidLanQueryPacket ( const uint8* Packet, uint32 Length, uint64& ClientNonce )	Determines if the packet header is valid or not Determines if the packet header is valid or not
bool	IsValidLanResponsePacket ( const uint8* Packet, uint32 Length, FGuid& ResponseGuid )	Determines if the packet header is valid or not Determines if the packet header is valid or not
bool	Search ( FNboSerializeToBuffer& Packet, FOnValidResponsePacketDelegate& Re..., FOnSearchingTimeoutDelegate& Timeo... )	Creates the LAN beacon for queries/advertising servers
void	StopLANSession()	Stops the LAN beacon from accepting broadcasts
void	Tick ( float DeltaTime )
void	TriggerOnSearchingTimeoutDelegates()
void	TriggerOnValidQueryPacketDelegates ( uint8* Param1, int32 Param2, uint64 Param3 )
void	TriggerOnValidResponsePacketDelegates ( uint8* Param1, int32 Param2 )

Deprecated Functions

		Name	Description
	bool	IsValidLanResponsePacket ( const uint8* Packet, uint32 Length )	IsValidLanResponsePacket now takes an additional guid reference

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss