Navigation
API > API/Plugins > API/Plugins/DiscoveryBeaconReceiver
Receives beacon messages on a multicast endpoint and replies with information to connect to the engine. This allows remote apps to detect compatible Unreal instances on the local network.
| Name | FDiscoveryBeaconReceiver |
| Type | class |
| Header File | /Engine/Plugins/DiscoveryBeaconReceiver/Source/DiscoveryBeaconReceiver/Public/DiscoveryBeaconReceiver.h |
| Include Path | #include "DiscoveryBeaconReceiver.h" |
Syntax
class FDiscoveryBeaconReceiver : public FRunnable
Inheritance Hierarchy
- FRunnable → FDiscoveryBeaconReceiver
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Creates and initializes a new beacon receiver. | DiscoveryBeaconReceiver.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FDiscoveryBeaconReceiver() |
Destroy the beacon receiver. | DiscoveryBeaconReceiver.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsRunning | TAtomic< bool > | Flag indicating that the beacon thread should be running. | DiscoveryBeaconReceiver.h | |
| Description | FString | A short name for this beacon for debugging purposes. | DiscoveryBeaconReceiver.h | |
| Guid | FGuid | Identifier for this engine instance. | DiscoveryBeaconReceiver.h | |
| ProtocolIdentifier | TArray< uint8 > | A series of bytes that uniquely identify messages intended for this beacon receiver. | DiscoveryBeaconReceiver.h | |
| ProtocolVersion | uint8 | The protocol version number with which to reply to beacon messages. | DiscoveryBeaconReceiver.h | |
| Socket | FSocket * | Socket used to listen for and reply to beacon messages. | DiscoveryBeaconReceiver.h | |
| Thread | TUniquePtr< FRunnableThread > | The thread to receive beacon messages on. | DiscoveryBeaconReceiver.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Shutdown() |
Close the socket and kill the listening thread. | DiscoveryBeaconReceiver.h | |
virtual void Startup () |
Open a socket and start a thread listening for beacon messages. | DiscoveryBeaconReceiver.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool GetDiscoveryAddress
(
FIPv4Address& OutAddress |
Get the IP address on which to listen for beacon messages. | DiscoveryBeaconReceiver.h | |
int32 GetDiscoveryPort() |
Get the port on which to listen for beacon messages. | DiscoveryBeaconReceiver.h | |
bool MakeBeaconResponse
(
uint8 BeaconProtocolVersion, |
Make a response to a beacon message. | DiscoveryBeaconReceiver.h |