NetworkZeroConfInterface Class Reference

#include <network_zeroconf.h>

Static Public Member Functions
static MAXON_METHOD Result< void >	GetBonjourVersion (Int &versionNumber, Int &revisionNumber, Bool &isRunning)
static MAXON_METHOD Result< NetworkZeroConfBrowserRef >	AllocBrowser (const String &serviceType, void *context, Bool thirdPartyInstance=false)
static MAXON_METHOD Result< NetworkZeroConfServiceRef >	AllocService (const String &serviceName, const String &serviceType, Int networkAdapter, Int port, const String &domainName=String(), Bool thirdPartyInstance=false)
static MAXON_METHOD Result< NetworkZeroConfServiceRef >	AnnounceServer (const NetworkIpAddrPort &serverIpAndPort, const String &serviceName, const String &serviceType, const DataDictionary &txtRecords)
static MAXON_METHOD void	ShutdownEntireZeroConfSystem ()
static MAXON_METHOD void	RemoveAllThirdPartyZeroConfTasks ()

Private Member Functions
	MAXON_INTERFACE_NONVIRTUAL (NetworkZeroConfInterface, MAXON_REFERENCE_NORMAL, "net.maxon.interface.networkzeroconf")

Member Function Documentation

MAXON_INTERFACE_NONVIRTUAL()

MAXON_INTERFACE_NONVIRTUAL ( NetworkZeroConfInterface  , MAXON_REFERENCE_NORMAL  , "net.maxon.interface.networkzeroconf"    )

private

GetBonjourVersion()

static MAXON_METHOD Result<void> GetBonjourVersion ( Int &  versionNumber, Int &  revisionNumber, Bool &  isRunning  )

static

Get the version number of the ZeroConf version.

Parameters

[out]	versionNumber	Main version number of ZeroConf.
[out]	revisionNumber	Revision number.
[out]	isRunning	TODO: (Seb), please document.

Returns

True if ZeroConf is installed, otherwise false.

AllocBrowser()

static MAXON_METHOD Result<NetworkZeroConfBrowserRef> AllocBrowser ( const String &  serviceType, void *  context, Bool  thirdPartyInstance = false  )

static

Allocates a new NetworkZeroConfBrowserRef.

Parameters

[in]	serviceType	Name of the service type to browse. e.g. "_test._tcp"_s.
[in]	context	User data pointer passed through the notification signals.
[in]	thirdPartyInstance	TODO: (Seb), please document.

Returns

If successful the return value i a new NetworkZeroConfBrowserRef object. otherwise nullptr.

AllocService()

static MAXON_METHOD Result<NetworkZeroConfServiceRef> AllocService ( const String &  serviceName, const String &  serviceType, Int  networkAdapter, Int  port, const String &  domainName = String(), Bool  thirdPartyInstance = false  )

static

Allocates a new NetworkZeroConfServiceRef.

Parameters

[in]	serviceName	Name of the service.
[in]	serviceType	Name of the service type. e.g. "_test._tcp"_s.
[in]	networkAdapter	Network adapter to bind the service on. The network adapter is returned by NetworkAdapterInterface::GetAdapterIndex(). 0 registers the service for all interfaces.
[in]	port	Network port to bind the service. The port must be > 0 and < 65535 and a valid tcp port. -1 can be set for an undefined port.
[in]	domainName	(optional) a domain name where the service is bind to.
[in]	thirdPartyInstance	TODO: (Seb), please document.

Returns

If successful the return value is a new NetworkZeroConfBrowserRef object. otherwise nullptr.

AnnounceServer()

static MAXON_METHOD Result<NetworkZeroConfServiceRef> AnnounceServer ( const NetworkIpAddrPort &  serverIpAndPort, const String &  serviceName, const String &  serviceType, const DataDictionary &  txtRecords  )

static

Announces a service for the given serverIpAndPort, serviceName with optional txtRecords.

Parameters

[in]	serverIpAndPort	Ip address and port where a server is running.
[in]	serviceName	Name of the service.
[in]	serviceType	Name of the service type to browse. e.g. "_test._tcp"_s.
[in]	txtRecords	Optional txt records.

ShutdownEntireZeroConfSystem()

static MAXON_METHOD void ShutdownEntireZeroConfSystem ( )

static

RemoveAllThirdPartyZeroConfTasks()

static MAXON_METHOD void RemoveAllThirdPartyZeroConfTasks ( )

static