Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How and why one would use Boost signals2?

Learning c++ and trying to get familiar with some patterns. The signals2 doc clearly has a vast array of things I can do with slots and signals. What I don't understand is what types of applications (use cases) I should use it for.

I'm thinking along the lines of a state machine dispatching change events. Coming from a dynamically typed background (C#,Java etc) you'd use an event dispatcher or a static ref or a callback.

Are there difficulties in c++ with using cross-class callbacks? Is that essentially why signals2 exists?

One to the example cases is a document/view. How is this pattern better suited than say, using a vector of functions and calling each one in a loop, or say a lambda that calls state changes in registered listening class instances?

class Document { public:     typedef boost::signals2::signal<void ()>  signal_t;  public:     Document()     {}      /* Connect a slot to the signal which will be emitted whenever       text is appended to the document. */     boost::signals2::connection connect(const signal_t::slot_type &subscriber)     {         return m_sig.connect(subscriber);     }      void append(const char* s)     {         m_text += s;         m_sig();     }      const std::string& getText() const     {         return m_text;     }  private:     signal_t    m_sig;     std::string m_text; }; 

and

class TextView { public:     TextView(Document& doc): m_document(doc)     {         m_connection = m_document.connect(boost::bind(&TextView::refresh, this));     }      ~TextView()     {         m_connection.disconnect();     }      void refresh() const     {         std::cout << "TextView: " << m_document.getText() << std::endl;     } private:     Document&               m_document;     boost::signals2::connection  m_connection; }; 
like image 656
FlavorScape Avatar asked Sep 06 '13 17:09

FlavorScape


People also ask

What are boost signals?

The Boost. Signals library is an implementation of a managed signals and slots system. Signals represent callbacks with multiple targets, and are also called publishers or events in similar systems.

Is boost Signals2 thread safe?

Signals2 are thread safe and can be used in multithreaded applications.


1 Answers

Boost.Signals2 is not just "an array of callbacks", it has a lot of added value. IMO, the most important points are:

  1. Thread-safety: several threads may connect/disconnect/invoke the same signal concurrently, without introducing race conditions. This is especially useful when communicating with an asynchronous subsystem, like an Active Object running in its own thread.
  2. connection and scoped_connection handles that allow disconnection without having direct access to the signal. Note that this is the only way to disconnect incomparable slots, like boost::function (or std::function).
  3. Temporary slot blocking. Provides a clean way to temporarily disable a listening module (eg. when a user requests to pause receiving messages in a view).
  4. Automatic slot lifespan tracking: a signal disconnects automatically from "expired" slots. Consider the situation when a slot is a binder referencing a non-copyable object managed by shared_ptrs:

    shared_ptr<listener> l = listener::create(); auto slot = bind(&listener::listen, l.get()); // we don't want aSignal_ to affect `listener` lifespan aSignal_.connect(your_signal_type::slot_type(slot).track(l)); // but do want to disconnect automatically when it gets destroyed 

Certainly, one can re-implement all the above functionality on his own "using a vector of functions and calling each one in a loop" etc, but the question is how it would be better than Boost.Signals2. Re-inventing the wheel is rarely a good idea.

like image 80
Igor R. Avatar answered Sep 19 '22 14:09

Igor R.