NetworkZeroConfServiceInterface Class Reference

#include <network_zeroconf.h>

Detailed Description

NetworkZeroConfServiceInterface allows to broadcast a new network service. Objects for this class will be created using NetworkZeroConfInterface::AllocService().

Public Member Functions

MAXON_METHOD Result< void > Start ()
 
MAXON_METHOD Result< void > Stop ()
 
MAXON_METHOD Result< void > SetTXTRecord (const DataDictionary &values)
 
MAXON_METHOD Result< void > RemoveTXTRecord ()
 

Private Member Functions

 MAXON_INTERFACE_NONVIRTUAL (NetworkZeroConfServiceInterface, MAXON_REFERENCE_NORMAL, "net.maxon.interface.networkzeroconfservice")
 

Member Function Documentation

◆ MAXON_INTERFACE_NONVIRTUAL()

MAXON_INTERFACE_NONVIRTUAL ( NetworkZeroConfServiceInterface  ,
MAXON_REFERENCE_NORMAL  ,
"net.maxon.interface.networkzeroconfservice"   
)
private

◆ Start()

MAXON_METHOD Result<void> Start ( )

Starts the Service. Other machines will be able to detect this service on the current machine.

Returns
OK on success.

◆ Stop()

MAXON_METHOD Result<void> Stop ( )

Stops the Service. Other machines are not longer able to detect this service on the current machine.

Returns
OK on success. @MAXON_ANNOTATION{default=OK}

◆ SetTXTRecord()

MAXON_METHOD Result<void> SetTXTRecord ( const DataDictionary &  values)

Adds/Updates the TXT records for the Service. Other machines will see this keys/values when they browse this service.

Parameters
[in]valuesDataDictionary of values. The ids of the values should be strings. Otherwise the ids are converted into strings using ToString().
Returns
OK on success.

◆ RemoveTXTRecord()

MAXON_METHOD Result<void> RemoveTXTRecord ( )

Remove all TXT records for the Service. Other machines will not longer see additional informations when they browse this service.

Returns
OK on success.