Observables Declaration

Table of Contents

About

An interface can declare one or many observables. Such an observable can be used to receive a signal on certain events within that interface.

Declaration

Observables are declared within an interface:

// This example shows an interface declaring an observable.
class ObserveMeInterface : MAXON_INTERFACE_BASES(maxon::ObserverObjectInterface)
{
MAXON_INTERFACE(ObserveMeInterface, MAXON_REFERENCE_NORMAL, "net.maxonexample.interfaces.observeme");
public:
//----------------------------------------------------------------------------------------
// Function makes "Ping".
//----------------------------------------------------------------------------------------
MAXON_METHOD void Ping();
//----------------------------------------------------------------------------------------
// Signal fired when Ping() is called.
//----------------------------------------------------------------------------------------
MAXON_OBSERVABLE(void, ObservablePing, (maxon::Int32 count), maxon::ObservableCombinerRunAllComponent);
};

The MAXON_OBSERVABLE() attribute defines the following options:

  • the return value of the callback function
  • the name of the observable
  • the argument list of the callback function

Further Reading