Navigation
API > API/Plugins > API/Plugins/NetworkServiceDiscovery
Module interface for cross-platform mDNS/DNS-SD service discovery.
Supports two primary operations:
Service Registration (host side) - Advertise a service on the local network
Service Discovery (client side) - Browse for and resolve services on the local network
Platform implementations:
- Apple (iOS/Mac): NSNetServiceBrowser / NSNetService
- Android: NsdManager
- Windows: Native DNS-SD via windns.h / dnsapi.dll (Windows 10 1803+)
| Name | INetworkServiceDiscoveryModule |
| Type | class |
| Header File | /Engine/Plugins/Experimental/NetworkServiceDiscovery/Source/NetworkServiceDiscovery/Public/INetworkServiceDiscovery.h |
| Include Path | #include "INetworkServiceDiscovery.h" |
Syntax
class INetworkServiceDiscoveryModule : public IModuleInterface
Implements Interfaces
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TArray< FNetworkServiceInfo > GetDiscoveredServices() |
Get a snapshot of all currently discovered services. | INetworkServiceDiscovery.h | |
bool IsDiscovering() |
Returns true if currently browsing for services. | INetworkServiceDiscovery.h | |
bool IsServiceRegistered
(
const FString& ServiceName |
Returns true if the named service (or any service, if empty) is currently registered. | INetworkServiceDiscovery.h | |
FOnDiscoveryError & OnDiscoveryError() |
INetworkServiceDiscovery.h | ||
FOnServiceFound & OnServiceFound() |
Delegates | INetworkServiceDiscovery.h | |
FOnServiceLost & OnServiceLost() |
INetworkServiceDiscovery.h | ||
FOnServiceRegistered & OnServiceRegistered () |
Fires once for each successful registration. | INetworkServiceDiscovery.h | |
FOnServiceResolved & OnServiceResolved() |
INetworkServiceDiscovery.h | ||
| Service Registration (Host side - e.g. editor on Win/Mac) | INetworkServiceDiscovery.h | ||
void ResolveService
(
const FNetworkServiceInfo& Service |
Resolve a discovered service to obtain its IP address and port. | INetworkServiceDiscovery.h | |
bool StartDiscovery
(
const FString& ServiceType |
Service Discovery (Client side - e.g. iOS/Android app) | INetworkServiceDiscovery.h | |
void StopDiscovery() |
Stop browsing for services. | INetworkServiceDiscovery.h | |
void UnregisterService
(
const FString& ServiceName |
Unregister (stop advertising) a previously registered service. | INetworkServiceDiscovery.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static INetworkServiceDiscoveryModule * Get() |
INetworkServiceDiscovery.h |