signals2基于Boost的另一个库signals,实现了线程安全的观察者模式。在signals2库中,观察者模式被称为信号/插槽(signals and slots),他是一种函数回调机制,一个信号关联了多个插槽,当信号发出时,所有关联它的插槽都会被调用。

许多成熟的软件系统都用到了这种信号/插槽机制(另一个常用的名称是事件处理机制:event/event handler),它可以很好地解耦一组互相协作的类,有的语言设置直接内建了对它的支持(如c#),signals2以库的形式为c++增加了这个重要的功能。

操作函数

signal最重要的操作函数是插槽管理connect()函数,它把插槽连接到信号上,相当于为信号(事件)增加了一个处理的handler。

插槽可以是任意的可调用对象,包括函数指针、函数对象、以及它们的bind表达式和function对象,signal内部使用function作为容器来保存这些可调用对象。连接时可以指定组号也可以不指定组号,当信号发生时将依据组号的排序准则依次调用插槽函数。

如果连接成功connect()将返回一个connection,表示了信号与插槽之间的连接关系,它是一个轻量级的对象,可以处理两者间的连接,如断开、重连接、或者测试连接状态。

成员函数disconnect()可以断开插槽与信号的连接,它有两种形式:传递组号将断开该组的所有插槽,传递一个插槽对象将仅断开该插槽。函数disconnect_all_slots()可以一次性断开信号的所有插槽连接。

插槽的连接于使用

signal就像一个增强的function对象,它可以容纳(使用connect())多个符合模板参数中函数签名类型的函数(插槽),形成一个插槽链表,然后在信号发生时一起调用:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
#include"stdafx.h"
#include"boost/utility/result_of.hpp"
#include"boost/typeof/typeof.hpp"
#include"boost/assign.hpp"
#include"boost/ref.hpp"
#include"boost/bind.hpp"
#include"boost/function.hpp"
#include"boost/signals2.hpp"
#include"iostream"

using namespace std;

void slots1()
{
    cout << "slots1 call" << endl;
}

void slots2()
{
    cout << "slots2 call" << endl;
}

struct Hello
{
    void operator()()const
    {
        std::cout << "Hello";
    }
}; 

int _tmain(int argc, _TCHAR *argv[])
{
    boost::signals2::signal<void()> sig;
    sig.connect(&slots1);
    sig.connect(&slots2);
    sig();
    boost::signals2::signal<void ()> sig1;
    sig1.connect(Hello());
    sig1();
    return 0;
}

注:编译这个程序的时候,确保已经在stdafx.h中加入#define _SCL_SECURE_NO_WARNINGS或者,在C/C++—-预处理器—-预处理器定义中加上了_SCL_SECURE_NO_WARNINGS,否则会引发错误(或不能正确输出),下同。

在连接插槽时省了了connect()的第二个参数connect_position,它的缺省值是at_back,表示插槽将插入到信号插槽链表的尾部,因此slot2将在slot1之后被调用。

下面是使用和组号的情况:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
#include"stdafx.h"
#include"boost/utility/result_of.hpp"
#include"boost/typeof/typeof.hpp"
#include"boost/assign.hpp"
#include"boost/ref.hpp"
#include"boost/bind.hpp"
#include"boost/function.hpp"
#include"boost/signals2.hpp"
#include"iostream"

using namespace std;

template<int N>
struct Slot
{
    void operator()()
    {
        cout << "Slot current N value is : " << N << endl;
    }
};

int _tmain(int argc, _TCHAR *argv[])
{
    boost::signals2::signal<void()> sig;
    sig.connect(Slot<1>(), boost::signals2::at_back);	 // 最后一个被调用
    sig.connect(Slot<99>(), boost::signals2::at_front);  // 第一个被调用
    sig.connect(5, Slot<55>(), boost::signals2::at_back); // 组号5的最后一个
    sig.connect(5, Slot<57>(), boost::signals2::at_front);// 组号5的第一个
    sig.connect(10, Slot<100>());// 组号10该组只有一个
    sig();
    return 0;
}

信号的返回值

signal如function一样,不仅可以把输入参数转发给所以插槽,也可以传回插槽的返回值。默认情况下signal使用合并器optional_last_value,它将使用optional对象返回最后被调用的插槽的返回值。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
#include"stdafx.h"
#include"boost/utility/result_of.hpp"
#include"boost/typeof/typeof.hpp"
#include"boost/assign.hpp"
#include"boost/ref.hpp"
#include"boost/bind.hpp"
#include"boost/function.hpp"
#include"boost/signals2.hpp"
#include"iostream"

using namespace std;

template<int N>
struct Slot
{
    int operator()(int x)
    {
        cout << "Slot current N * x value is : " << endl;
        return (N * x);
    }
};

int _tmain(int argc, _TCHAR *argv[])
{
    boost::signals2::signal<int(int)> sig;
    sig.connect(Slot<10>());
    sig.connect(Slot<100>());
    cout << *sig(2) << endl;;
    return 0;
}

signal的operator()调用这时需要传入一个整数参数,这个参数会被signal存储一个拷贝,然后转发给各个插槽。最后signal将返回插槽链表末尾slots<100>()的计算结果,它是一个optional对象,必须用接引用操作符*来获得值(但你可以发现Slotcurrent N * x value is是输出了两次的)。

合并器

大多数时候,插槽的返回值都是有意义的,需要以某种方式处理多个插槽的返回值。

signal允许用户自定义合并器来处理插槽的返回值,把多个插槽的返回值合并为一个结果返回给用户。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
#include"stdafx.h"
#include"boost/utility/result_of.hpp"
#include"boost/typeof/typeof.hpp"
#include"boost/assign.hpp"
#include"boost/ref.hpp"
#include"boost/bind.hpp"
#include"boost/function.hpp"
#include"boost/signals2.hpp"
#include"numeric"
#include"iostream"

using namespace std;

template<int N>
struct Slot
{
    int operator()(int x)
    {
        cout << "Slot current N * x value is : " << endl;
        return (N * x);
    }
};

template<typename T>
class combiner
{
public:
    typedef pair result_type;
    combiner(T t = T()) : v(t)
    {
    }
    template<typename InputIterator>
    result_type operator()(InputIterator begin, InputIterator end)const
    {
        if (begin == end)
        {
            return result_type();
        }
        vector vec(begin, end);
        T sum = accumulate(vec.begin(), vec.end(), v);
        T max = *max_element(vec.begin(), vec.end());
        return result_type(sum, max);
    }
private:
    T v;
};

int _tmain(int argc, _TCHAR *argv[])
{
    boost::signals2::signal<int(int), combiner<int> > sig;
    sig.connect(Slot<10>());
    sig.connect(Slot<20>());
    sig.connect(Slot<3>());
    BOOST_AUTO(x, sig(2));
    cout << x.first << ", " << x.second << endl;
    return 0;
}

combiner类的调用操作符operator()的返回值类型可以是任意类型,完全由用户指定,不一定必须是optional或者是插槽的返回值类型。operator()的模板参数InputIterator是插槽链表的返回值迭代器,可以使用它来遍历所有插槽的返回值,进行所需的处理。

当信号被调用时,signal会自动把引用操作转换为插槽调用,将调用给定的合并器的operator()逐个处理插槽的返回值,并最终返回合并器operator()的结果。

如果我们不适用signal的缺省构造函数,而是在构造signal时传入一个合并器的实例,那么signal将使用逐个合并器(的拷贝)处理返回值。例如,下面的代码使用了一个有初值的合并器对象,累加值从100开始:

signal > sig(combiner(100));

管理信号的连接

信号与插槽的链接并不要求是永久的,当信号调用玩插槽后,有可能需要把插槽从信号中断开,再连接到其他的信号上去。

signal可以用成员函数disconnect()断开一个或一组插槽,或者使用disconnect_all_slots()断开所有插槽连接,函数empty()和num_slots()用来检测信号当前插槽的连接状态。

要断开一个插槽,插槽必须能够进行登记等价比较,对于函数对象来说就是重载一个等价语义的operator==。下面对slots增加一个等价比较:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
#include"stdafx.h"
#include"boost/utility/result_of.hpp"
#include"boost/typeof/typeof.hpp"
#include"boost/assign.hpp"
#include"boost/ref.hpp"
#include"boost/bind.hpp"
#include"boost/function.hpp"
#include"boost/signals2.hpp"
#include"numeric"
#include"iostream"

using namespace std;

template<int N>
struct Slot
{
    int operator()(int x)
    {
        cout << "Slot current N * x value is : " << endl;
        return (N * x);
    }
};

template<int N>
bool operator == (const Slot &a, const Slot &b)
{
    returntrue;
}

template<typename T>
class combiner
{
public:
    typedef pair result_type;
    combiner(T t = T()) : v(t)
    {
    }
    
    template<typename InputIterator>
    result_type operator()(InputIterator begin, InputIterator end)const
    {
        if (begin == end)
        {
            return result_type();
        }
        vector vec(begin, end);
        T sum = accumulate(vec.begin(), vec.end(), v);
        T max = *max_element(vec.begin(), vec.end());
        return result_type(sum, max);
    }
private:
    T v;
};

int _tmain(int argc, _TCHAR *argv[])
{
    boost::signals2::signal<int(int)> sig;
    //	assert(sig.empty());
    sig.connect(0, Slot<10>());
    sig.connect(Slot<20>());
    sig.connect(1, Slot<30>());
    assert(sig.num_slots() == 3);
    sig.disconnect(0);
    //	assert(sig.num_slots() == 1);
    sig.disconnect(Slot<30>());
    //	assert(sig.empty());
    sig(2);
    return 0;
}

更灵活的管理信号连接

signals2库提供另外一种较为灵活的连接管理方式:使用connection对象。

每当signal使用connect()连接插槽时,他就会返回一个connection对象。connection对象像是信号与插槽连接关系的一个句柄(handle),可以管理链接:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
#include"stdafx.h"
#include"boost/utility/result_of.hpp"
#include"boost/typeof/typeof.hpp"
#include"boost/assign.hpp"
#include"boost/ref.hpp"
#include"boost/bind.hpp"
#include"boost/function.hpp"
#include"boost/signals2.hpp"
#include"numeric"
#include"iostream"

using namespace std;

template<int N>
struct Slot
{
    int operator()(int x)
    {
        cout << "Slot current N * x value is : " << endl;
        return (N * x);
    }
};

template<int N>
bool operator == (const Slot &a, const Slot &b)
{
    return true;
}

template<typename T>
class combiner
{
public:
    typedef pair result_type;
    combiner(T t = T()) : v(t)
    {
    }
    
    template<typename InputIterator>
    result_type operator()(InputIterator begin, InputIterator end)const
    {
        if (begin == end)
        {
            return result_type();
        }
        vector vec(begin, end);
        T sum = accumulate(vec.begin(), vec.end(), v);
        T max = *max_element(vec.begin(), vec.end());
        return result_type(sum, max);
    }
private:
    T v;
};

int _tmain(int argc, _TCHAR *argv[])
{
    boost::signals2::signal<int(int)> sig;
    boost::signals2::connection c1 = sig.connect(0, Slot<10>());
    boost::signals2::connection c2 = sig.connect(0, Slot<10>());
    boost::signals2::connection c3 = sig.connect(0, Slot<10>());
    c1.disconnect();
    assert(sig.num_slots() == 2);
    assert(!c1.connected());
    assert(c2.connected());
    return 0;
}

另外一种连接管理对象是scoped_connection,它是connection的种类,提供类似scoped_ptr的RAII功能:插槽与信号的连接仅在作用域内生效,当离开作用域时连接就会自动断开。当需要临时连接信号时scoped_connection会非常有用:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
#include"stdafx.h"
#include"boost/utility/result_of.hpp"
#include"boost/typeof/typeof.hpp"
#include"boost/assign.hpp"
#include"boost/ref.hpp"
#include"boost/bind.hpp"
#include"boost/function.hpp"
#include"boost/signals2.hpp"
#include"numeric"
#include"iostream"

using namespace std;

template<int N>
struct Slot
{
    int operator()(int x)
    {
        cout << "Slot current N * x value is : " << endl;
        return (N * x);
    }
};

template<int N>
bool operator == (const Slot &a, const Slot &b)
{
    return true;
}

template<typename T>
class combiner
{
public:
    typedef pair result_type;
    combiner(T t = T()) : v(t)
    {
    }
    
    template<typename InputIterator>
    result_type operator()(InputIterator begin, InputIterator end)const
    {
        if (begin == end)
        {
            return result_type();
        }
        vector vec(begin, end);
        T sum = accumulate(vec.begin(), vec.end(), v);
        T max = *max_element(vec.begin(), vec.end());
        return result_type(sum, max);
    }
private:
    T v;
};

int _tmain(int argc, _TCHAR *argv[])
{
    boost::signals2::signal<int(int)> sig;
    sig.connect(0, Slot<10>());
    assert(sig.num_slots() == 1);
    {
        boost::signals2::scoped_connection sc = sig.connect(0, Slot<20>());
        assert(sig.num_slots() == 2);
    }
    assert(sig.num_slots() == 1);
    return 0;
}

插槽与信号的连接一旦断开就不能再连接起来,connection不提供reconnet()这样的函数。但可以暂时地阻塞插槽与信号的连接,当信号发生时被阻塞的插槽将不会被调用,connection对象的blocked()函数可以检查插槽是否被阻塞。但被阻塞的插槽并没有断开与信号的链接,在需要的时候可以随时解除阻塞。

connection对象自身没有阻塞的功能,他需要一个辅助类shared_connection_block,它将阻塞connection对象,知道它被析构或者显式调用unblock()函数:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
#include"stdafx.h"
#include"boost/utility/result_of.hpp"
#include"boost/typeof/typeof.hpp"
#include"boost/assign.hpp"
#include"boost/ref.hpp"
#include"boost/bind.hpp"
#include"boost/function.hpp"
#include"boost/signals2.hpp"
#include"numeric"
#include"iostream"

using namespace std;

template<int N>
struct Slot
{
    void operator()(int x)
    {
        cout << "Slot current N is : " << N << endl;
    }
};

template<int N>
bool operator == (const Slot &a, const Slot &b)
{
    return true;
}

template<typename T>
class combiner
{
public:
    typedef pair result_type;
    combiner(T t = T()) : v(t)
    {
    }
    
    template<typename InputIterator>
    result_type operator()(InputIterator begin, InputIterator end)const
    {
        if (begin == end)
        {
            return result_type();
        }
        vector vec(begin, end);
        T sum = accumulate(vec.begin(), vec.end(), v);
        T max = *max_element(vec.begin(), vec.end());
        return result_type(sum, max);
    }
private:
    T v;
};

int _tmain(int argc, _TCHAR *argv[])
{
    boost::signals2::signal<void(int)> sig;
    boost::signals2::connection c1 = sig.connect(0, Slot<10>());
    boost::signals2::connection c2 = sig.connect(0, Slot<20>());
    assert(sig.num_slots() == 2);
    sig(2);
    cout << "begin blocking..." << endl;
    {
        boost::signals2::shared_connection_block block(c1);
        assert(sig.num_slots() == 2);
        assert(c1.blocked());
        sig(2);
    }
    cout << "end blocking.." << endl;
    assert(!c1.blocked());
    sig(2);
    return 0;
}