ServiceAnnouncementRequestInterface Class Reference

#include <network_service_discovery.h>

Detailed Description

A service announcement request to be passed to NetworkServiceBusInterface::Announce. Contains a service identifier and optionally custom data in the form of key-value pairs.


struct  TimingProperties

Public Member Functions

MAXON_METHOD ResourceIdentifier GetServiceIdentifier () const
MAXON_METHOD void SetTimingProperties (TimingProperties props)
MAXON_METHOD TimingProperties GetTimingProperties () const
MAXON_METHOD void SetCustomData (ServiceDiscovery::DataMap &&customData)
MAXON_METHOD const ServiceDiscovery::DataMapGetCustomData () const

Static Public Member Functions

static MAXON_METHOD ServiceAnnouncementRequestInterfaceAlloc (MAXON_SOURCE_LOCATION_DECLARATION, const ResourceIdentifier &identifier)

Private Member Functions

 MAXON_INTERFACE_NONVIRTUAL (ServiceAnnouncementRequestInterface, MAXON_REFERENCE_NORMAL, "net.maxon.interface.serviceannouncementrequest")

Member Function Documentation


MAXON_INTERFACE_NONVIRTUAL ( ServiceAnnouncementRequestInterface  ,

◆ Alloc()

Allocates a service announcement request for a service described by the given identifier.

◆ GetServiceIdentifier()

MAXON_METHOD ResourceIdentifier GetServiceIdentifier ( ) const

Returns the service identifier of this request.

◆ SetTimingProperties()

MAXON_METHOD void SetTimingProperties ( TimingProperties  props)

Sets the timing properties of this request.

◆ GetTimingProperties()

MAXON_METHOD TimingProperties GetTimingProperties ( ) const

Returns the timing properties of this request.

◆ SetCustomData()

MAXON_METHOD void SetCustomData ( ServiceDiscovery::DataMap &&  customData)

Sets custom data associated with this announcement request, provided as key/value pairs.

◆ GetCustomData()

MAXON_METHOD const ServiceDiscovery::DataMap& GetCustomData ( ) const

Returns the custom data of this request.