HiveMindBridge
Public Member Functions | List of all members
IUserCallbackMap Class Referenceabstract

#include <IUserCallbackMap.h>

Inheritance diagram for IUserCallbackMap:
Inheritance graph
Collaboration diagram for IUserCallbackMap:
Collaboration graph

Public Member Functions

virtual bool registerCallback (std::string name, CallbackFunction callback, CallbackArgsManifest manifest)=0
 
virtual bool registerCallback (std::string name, CallbackFunction callback)=0
 
virtual std::optional< CallbackFunctiongetCallback (const std::string &name)=0
 
virtual uint32_t getLength ()=0
 
virtual std::optional< CallbackArgsManifestgetManifestAt (uint32_t index)=0
 
virtual std::optional< std::string > getNameAt (uint32_t index)=0
 

Member Function Documentation

◆ getCallback()

virtual std::optional<CallbackFunction> IUserCallbackMap::getCallback ( const std::string &  name)
pure virtual

Get an instance of a callback, if it exists.

Parameters
nameKey under which the callback was registered
Returns
The callback function if it exists.

Implemented in UserCallbackMap.

Here is the caller graph for this function:

◆ getLength()

virtual uint32_t IUserCallbackMap::getLength ( )
pure virtual

Implemented in UserCallbackMap.

Here is the caller graph for this function:

◆ getManifestAt()

virtual std::optional<CallbackArgsManifest> IUserCallbackMap::getManifestAt ( uint32_t  index)
pure virtual

Implemented in UserCallbackMap.

Here is the caller graph for this function:

◆ getNameAt()

virtual std::optional<std::string> IUserCallbackMap::getNameAt ( uint32_t  index)
pure virtual

Implemented in UserCallbackMap.

Here is the caller graph for this function:

◆ registerCallback() [1/2]

virtual bool IUserCallbackMap::registerCallback ( std::string  name,
CallbackFunction  callback 
)
pure virtual

Register a callback

Parameters
nameKey of the callback
callbackCallback function
Returns
True if an existing callback function was overwritten, false otherwise

Implemented in UserCallbackMap.

◆ registerCallback() [2/2]

virtual bool IUserCallbackMap::registerCallback ( std::string  name,
CallbackFunction  callback,
CallbackArgsManifest  manifest 
)
pure virtual

Register a callback

Parameters
nameKey of the callback
callbackCallback function
manifestA list describing the callback's expected arguments name and type
Returns
True if an existing callback function was overwritten, false otherwise

Implemented in UserCallbackMap.

Here is the caller graph for this function:

The documentation for this class was generated from the following file: