APICallBack Class Reference

#include <apicomponent.h>

Public Member Functions
	APICallBack ()=delete
	~APICallBack ()
	APICallBack (APICallBack &)=delete
APICallBack &	operator= (const APICallBack &)=delete
	APICallBack (APICallBack &&)=delete
APICallBack &	operator= (APICallBack &&)=delete
	APICallBack (const APISignature &signature)

Public Attributes
Signal< const APIEvent & >	messageReceived
	called when this callback receives an API message More...

Description

Helper class, allows for binding a callback to an api signature. This object is created and managed by the APIComponent. Listen to the messageReceived signal to receive api events that target a specific api signature. Use APIComponent::getOrCreateCallback() to acquire a callback based on an API signature.

Collaboration diagram for APICallBack:

Constructor & Destructor Documentation

APICallBack() [1/4]

APICallBack ( )

delete

~APICallBack()

~APICallBack

(

)

APICallBack() [2/4]

APICallBack ( APICallBack &  )

delete

Copy is not allowed

APICallBack() [3/4]

APICallBack ( APICallBack &&  )

delete

Move is not allowed

APICallBack() [4/4]

APICallBack

(

const APISignature &

signature

)

Creates a callback based on the given api signature

Parameters

signature

the method signature to create a callback for

Member Function Documentation

operator=() [1/2]

APICallBack& operator= ( APICallBack &&  )

delete

operator=() [2/2]

APICallBack& operator= ( const APICallBack &  )

delete

Member Data Documentation

messageReceived

Signal<const APIEvent&> messageReceived

called when this callback receives an API message