ServiceBusInterface Class Reference

#include <network_service_discovery.h>

Detailed Description

This class represents an access point to the service discovery bus. It manages announcements and subscriptions.


struct  Parameters

Public Member Functions

MAXON_METHOD Result< void > Start (const Parameters &props)
MAXON_METHOD Result< void > Start ()
MAXON_METHOD void Stop ()
MAXON_METHOD Result< ServiceAnnouncementRef > Announce (const ServiceAnnouncementRequestRef &request)
MAXON_METHOD Result< ServiceSubscriptionRef > Subscribe (const ServiceSubscriptionRequestRef &request)
MAXON_METHOD Uuid GetLocalUuid () const
MAXON_METHOD JobQueueRef GetSyncQueue () const

Static Public Member Functions


Private Member Functions

 MAXON_INTERFACE_NONVIRTUAL (ServiceBusInterface, MAXON_REFERENCE_NORMAL, "net.maxon.interface.servicebus")

Member Function Documentation



◆ Alloc()

◆ Start() [1/2]

MAXON_METHOD Result<void> Start ( const Parameters props)

Starts the service bus with custom parameters. After it has been started successfully, the bus broadcasts announcements and listens for subscriptions on the local network.

◆ Start() [2/2]

MAXON_METHOD Result<void> Start ( )

Starts the service bus with default parameters.

◆ Stop()

MAXON_METHOD void Stop ( )

Stops the service bus if it was running.

◆ Announce()

MAXON_METHOD Result<ServiceAnnouncementRef> Announce ( const ServiceAnnouncementRequestRef &  request)

Registers a new announcement at this service bus endpoint.

◆ Subscribe()

MAXON_METHOD Result<ServiceSubscriptionRef> Subscribe ( const ServiceSubscriptionRequestRef &  request)

Registers a new subscription at this service bus endpoint.

◆ GetLocalUuid()

MAXON_METHOD Uuid GetLocalUuid ( ) const

Returns the UUID that identifies this service bus endpoint.

◆ GetSyncQueue()

MAXON_METHOD JobQueueRef GetSyncQueue ( ) const

Returns the job queue used to synchronize events on this service bus.