Template Class Slot

Class Documentation

template<typename Data = Void>
class Slot

Function loading component of a callback system.

Anywhere that a callback is required can be implemented with a slot. These can be placed anywhere in your code and are initialised with either a free (static or global) function, or a member function. Once initialised, they can be hooked up to a signal.

Usage examples are provided in the main page’s documentation for this package.

See also

Signal<Void>, Slot.

Public Functions

inline Slot(void (*f)(Data))

Load with a global/static function.

Note that the function must have exactly one argument and it must be of the same type as the slot. It also must return void.

Parameters:

f – : the global/static function.

inline Slot(void (*f)(Data), const std::string &topic)

Load with a global/static function and connect.

Note that the function must have exactly one argument and it must be of the same type as the slot. It also must return void.

It additionally connects to the specified topic rapi style.

Parameters:

  • f – : the global/static function.

  • topic – : the slot topic name to connect to.

template<typename C>
inline Slot(void (C::* f)(Data), C &c)

Load with a member function.

Note that the function must have exactly one argument and it must be of the same type as the slot. It also must return void.

Parameters:

  • f – : the member function.

  • c – : the class instance.

template<typename C>
inline Slot(void (C::* f)(Data), C &c, const std::string &topic)

Load with a member function and connect.

Note that the function must have exactly one argument and it must be of the same type as the slot. It also must return void.

It additionally connects to the specified topic rapi style.

Parameters:

  • f – : the member function.

  • c – : the class instance.

  • topic – : the slot topic name to connect to.

inline Slot(const Slot<Data> &slot)

Copy constructor.

This is specially designed so that copying a slot is perfectly acceptable. Copies do not increase the number of callbacks that are fired - they just preserve the slot when used with things like stl containers. When the last copy disappears, the object destroys its connection automagically.

Parameters:

slot – : the object to be copied.

inline ~Slot()

Default destructor.

This handles the cleanup operation, first decrementing and then checking if its the last of its instance. If it is, it cleans up the sigslot connection with the sigslots manager.

inline void operator=(const Slot<Data> &slot)

Default assignment operator.

inline const std::set<std::string> &connections()

Lists the topics this slot is connected to.

Useful for debugging.

Returns:

set<string> : a set of topic names this slot is listening to.

inline void connect(const std::string &topic)

Make a connection to the specified topic.

This contacts the sigslots manager to connect the signal to the specified topic - creating the topic if it is not yet existing.

Parameters:

topic – : the topic to connect to.

inline void disconnect()

Disconnect the slot from all topics.

This completely disconnects the slot.