C++ 开源网络库之libevent的使用_c++ libevent

系列文章目录

linux下 C++ 开源网络库之libevent的使用

---

前言

libevent作为一个轻量级的网络模块开源库，在网络学习和应用开发中得到广泛的应用， 本文就libevent库下载、编译及C++项目使用进行记录和学习。

一、libevent下载

官网：https://libevent.org/

版本：libevent-2.1.12-stable.tar
可以直接这里下载：
链接：https://pan.baidu.com/s/1EZy6EhAf-W_n9Hyr8FWsdQ
提取码：gvf0

二、编译安装

1. 安装

下载到本地后，上传到linux上，这里采用虚拟机。

# 上传
put C:\Soft\libevent-2.1.12-stable.tar.gz /root/usr/local/src

# 解压：
tar -zxvf libevent-2.1.12-stable.tar.gz

# 进入压缩目录：
cd libevent-2.1.12-stable

# 进行配置：
./configure

# 编译
make

# 安装
make install
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

2. 测试

# 进入sample目录
cd /usr/local/src/libevent-2.1.12-stable/sample
# gcc 编译
gcc hello-world.c -o hello -levent
# 执行   出现错误，见下一章的常见错误
./hello
# 另起一个中端  执行
nc 127.0.0.1 9995
1
2
3
4
5
6
7
8

3. 常见错误

./hello: error while loading shared libraries: libevent-2.1.so.7: cannot open shared object file: No such file or directory
1

产生原因：
在运行时，程序无法找到libevent-2.1.so.7这个动态库，因为该动态库在默认安装时，存放的路径在/usr/local/lib下，不在系统的默认查找路径内。

解决办法：

# 将该路径放在系统查找路径内。
sudo echo "/usr/local/lib" >> /etc/ld.so.conf
# 使该配置生效
ldconfig
1
2
3
4

二、使用步骤

1.项目结构

/usr/local/include存放的是libevent三方库的头文件

/usr/local/lib存放的是libevent的库文件，包括静态库、动态库文件等文件。

目录结构如下：

[root@localhost day02]# tree
.
├── bin
│   └── event_rpcgen.py
├── include
│   ├── evdns.h
│   ├── event2
│   │   ├── buffer_compat.h
│   │   ├── bufferevent_compat.h
│   │   ├── bufferevent.h
│   │   ├── bufferevent_ssl.h
│   │   ├── bufferevent_struct.h
│   │   ├── buffer.h
│   │   ├── dns_compat.h
│   │   ├── dns.h
│   │   ├── dns_struct.h
│   │   ├── event_compat.h
│   │   ├── event-config.h
│   │   ├── event.h
│   │   ├── event_struct.h
│   │   ├── http_compat.h
│   │   ├── http.h
│   │   ├── http_struct.h
│   │   ├── keyvalq_struct.h
│   │   ├── listener.h
│   │   ├── rpc_compat.h
│   │   ├── rpc.h
│   │   ├── rpc_struct.h
│   │   ├── tag_compat.h
│   │   ├── tag.h
│   │   ├── thread.h
│   │   ├── util.h
│   │   └── visibility.h
│   ├── event.h
│   ├── evhttp.h
│   ├── evrpc.h
│   └── evutil.h
├── lib
│   ├── libevent-2.1.so.7 -> libevent-2.1.so.7.0.1
│   ├── libevent-2.1.so.7.0.1
│   ├── libevent.a
│   ├── libevent_core-2.1.so.7 -> libevent_core-2.1.so.7.0.1
│   ├── libevent_core-2.1.so.7.0.1
│   ├── libevent_core.a
│   ├── libevent_core.la
│   ├── libevent_core.so -> libevent_core-2.1.so.7.0.1
│   ├── libevent_extra-2.1.so.7 -> libevent_extra-2.1.so.7.0.1
│   ├── libevent_extra-2.1.so.7.0.1
│   ├── libevent_extra.a
│   ├── libevent_extra.la
│   ├── libevent_extra.so -> libevent_extra-2.1.so.7.0.1
│   ├── libevent.la
│   ├── libevent_openssl-2.1.so.7 -> libevent_openssl-2.1.so.7.0.1
│   ├── libevent_openssl-2.1.so.7.0.1
│   ├── libevent_openssl.a
│   ├── libevent_openssl.la
│   ├── libevent_openssl.so -> libevent_openssl-2.1.so.7.0.1
│   ├── libevent_pthreads-2.1.so.7 -> libevent_pthreads-2.1.so.7.0.1
│   ├── libevent_pthreads-2.1.so.7.0.1
│   ├── libevent_pthreads.a
│   ├── libevent_pthreads.la
│   ├── libevent_pthreads.so -> libevent_pthreads-2.1.so.7.0.1
│   ├── libevent.so -> libevent-2.1.so.7.0.1
│   └── pkgconfig
│       ├── libevent_core.pc
│       ├── libevent_extra.pc
│       ├── libevent_openssl.pc
│       ├── libevent.pc
│       └── libevent_pthreads.pc
└── src
    ├── Client
    ├── Client.c
    ├── Server
    └── Server.c

6 directories, 70 files
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
73
74
75
76

Client.c和Server.c的代码来自《linux下libevent的安装和使用例子：数据回显》
https://blog.csdn.net/ljp1919/article/details/48163091

2.代码实例

服务端

//文件名：server.c
#include <stdio.h>
#include <stdlib.h>
#include <errno.h>
#include <assert.h>
#include <unistd.h>
#include <string.h>
 
#include <event2/event.h>
#include <event2/bufferevent.h>
 
#define LISTEN_PORT 9999
#define LISTEN_BACKLOG 32
#define MAX_LINE    256
 
void do_accept(evutil_socket_t listener, short event, void *arg);
void read_cb(struct bufferevent *bev, void *arg);
void error_cb(struct bufferevent *bev, short event, void *arg);
void write_cb(struct bufferevent *bev, void *arg);
 
int main()
{
    //int ret;
    evutil_socket_t listener;//用于跨平台表示socket的ID（在Linux下表示的是其文件描述符）
    listener = socket(AF_INET, SOCK_STREAM, 0);
    assert(listener > 0);
    //用于跨平台将socket设置为可重用（实际上是将端口设为可重用
    evutil_make_listen_socket_reuseable(listener);
 
    struct sockaddr_in sin;
    sin.sin_family = AF_INET;
    sin.sin_addr.s_addr = 0;
    sin.sin_port = htons(LISTEN_PORT);
 
    if (bind(listener, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
        perror("bind");
        return 1;
    }
 
    if (listen(listener, LISTEN_BACKLOG) < 0) {
        perror("listen");
        return 1;
    }
 
    printf ("Listening...\n");
    /* 用于跨平台将socket设置为非阻塞,使用bufferevent需要 */
    evutil_make_socket_nonblocking(listener);
    //主要记录事件的相关属性
    struct event_base *base = event_base_new();
    assert(base != NULL);
    /* Register listen event. */
    struct event *listen_event;
    listen_event = event_new(base, listener, EV_READ|EV_PERSIST, do_accept, (void*)base);
    event_add(listen_event, NULL);
    /* Start the event loop. */
    event_base_dispatch(base);
 
    printf("The End.");
    //close(listener);
    return 0;
}
 
void do_accept(evutil_socket_t listener, short event, void *arg)
{
    struct event_base *base = (struct event_base *)arg;
    evutil_socket_t fd;
    struct sockaddr_in sin;
    socklen_t slen = sizeof(sin);
    fd = accept(listener, (struct sockaddr *)&sin, &slen);
    if (fd < 0) {
        perror("accept");
        return;
    }
    if (fd > FD_SETSIZE) { //这个if是参考了那个ROT13的例子，貌似是官方的疏漏，从select-based例子里抄过来忘了改
        perror("fd > FD_SETSIZE\n");
        return;
    }
 
    printf("ACCEPT: fd = %u\n", fd);
    //关联该sockfd，托管给event_base.
    struct bufferevent *bev = bufferevent_socket_new(base, fd, BEV_OPT_CLOSE_ON_FREE);
    //设置读写对应的回调函数
    bufferevent_setcb(bev, read_cb, NULL, error_cb, arg);
    //启用读写事件,其实是调用了event_add将相应读写事件加入事件监听队列poll.
    //如果相应事件不置为true，bufferevent是不会读写数据的
    bufferevent_enable(bev, EV_READ|EV_PERSIST);
//    进入bufferevent_setcb回调函数：
//    在readcb里面从input中读取数据，处理完毕后填充到output中；
//    writecb对于服务端程序，只需要readcb就可以了，可以置为NULL；
//    errorcb用于处理一些错误信息
}
 
void read_cb(struct bufferevent *bev, void *arg)
{
    char line[MAX_LINE+1];
    int n;
    evutil_socket_t fd = bufferevent_getfd(bev);
 
    while (n = bufferevent_read(bev, line, MAX_LINE), n > 0)
    {
        line[n] = '\0';
        printf("fd=%u, Server gets the message from client read line: %s\n", fd, line);
	//直接将读取的结果,不做任何修改(本文是跳过前两个字符),直接返回给客户端
	bufferevent_write(bev, line+2, n);//方案1
    }
}
 
void write_cb(struct bufferevent *bev, void *arg)
{
 printf("HelloWorld\n");//直接空代码即可，因为这里并不会被触发调用
}
 
void error_cb(struct bufferevent *bev, short event, void *arg)
{
    evutil_socket_t fd = bufferevent_getfd(bev);
    printf("fd = %u, ", fd);
    if (event & BEV_EVENT_TIMEOUT) {
        printf("Timed out\n"); //if bufferevent_set_timeouts() called
    }
    else if (event & BEV_EVENT_EOF) {
        printf("connection closed\n");
    }
    else if (event & BEV_EVENT_ERROR) {
        printf("some other error\n");
    }
    bufferevent_free(bev);
}

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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

客户端：

//客户端代码  文件名：client.c
#include <stdio.h>
#include <stdlib.h>
#include <errno.h>
#include <unistd.h>
#include <string.h>
#include <netinet/in.h>
#include <sys/socket.h>
#include <arpa/inet.h>
#include <sys/types.h>
 
#include <event2/event.h>
#include <event2/bufferevent.h>
 
#define SERV_PORT 9999
#define MAX_LINE 1024
 
void cmd_msg_cb(int fd, short event, void *arg);
void read_cb(struct bufferevent *bev, void *arg);
void error_cb(struct bufferevent *bev, short event, void *arg);
 
int main(int argc, char *argv[])
{
    if(argc < 2)
    {
        perror("usage: echocli <IPadress>");
        return 1;
    }
 
    evutil_socket_t sockfd;
    if((sockfd = socket(AF_INET, SOCK_STREAM, 0)) < 0)
    {
        perror("socket\n");
        return 1;
    }
 
    struct sockaddr_in servaddr;
    bzero(&servaddr, sizeof(servaddr));
    servaddr.sin_family = AF_INET;
    servaddr.sin_port = htons(SERV_PORT);
    if(inet_pton(AF_INET, argv[1], &servaddr.sin_addr) < 1)
    {
        perror("inet_ntop\n");
        return 1;
    }
    if(connect(sockfd, (struct sockaddr *) &servaddr, sizeof(servaddr)) < 0)
    {
        perror("connect\n");
        return 1;
    }
    evutil_make_socket_nonblocking(sockfd);
 
    printf("Connect to server sucessfully!\n");
    // build event base
    struct event_base *base = event_base_new();
    if(base == NULL)
    {
        perror("event_base\n");
        return 1;
    }
    const char *eventMechanism = event_base_get_method(base);
    printf("Event mechanism used is %s\n", eventMechanism);
    printf("sockfd = %d\n", sockfd);
 
    struct bufferevent *bev = bufferevent_socket_new(base, sockfd, BEV_OPT_CLOSE_ON_FREE);
    
    struct event *ev_cmd;
    ev_cmd = event_new(base, STDIN_FILENO, EV_READ | EV_PERSIST, cmd_msg_cb, (void *)bev);
    event_add(ev_cmd, NULL);
    
    bufferevent_setcb(bev, read_cb, NULL, error_cb, (void *)ev_cmd);
    bufferevent_enable(bev, EV_READ | EV_PERSIST);
    
    event_base_dispatch(base);
 
    printf("The End.");
    return 0;
}
 
void cmd_msg_cb(int fd, short event, void *arg)
{
    char msg[MAX_LINE];
    int nread = read(fd, msg, sizeof(msg));
    if(nread < 0)
    {
        perror("stdio read fail\n");
        return;
    }
 
    struct bufferevent *bev = (struct bufferevent *)arg;
    bufferevent_write(bev, msg, nread);
}
 
void read_cb(struct bufferevent *bev, void *arg)
{
    char line[MAX_LINE + 1];
    int n;
    evutil_socket_t fd = bufferevent_getfd(bev);
 
    while((n = bufferevent_read(bev, line, MAX_LINE)) > 0)
    {
        line[n] = '\0';
        printf("fd = %u, read from server: %s", fd, line);
    }
}
 
void error_cb(struct bufferevent *bev, short event, void *arg)
{
    evutil_socket_t fd = bufferevent_getfd(bev);
    printf("fd = %u, ", fd);
    if(event & BEV_EVENT_TIMEOUT)
        printf("Time out.\n");  // if bufferevent_set_timeouts() is called
    else if(event & BEV_EVENT_EOF)
        printf("Connection closed.\n");
    else if(event & BEV_EVENT_ERROR)
        printf("Some other error.\n");
    bufferevent_free(bev);
 
    struct event *ev = (struct event *)arg;
    event_free(ev);
}
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

3. 编译运行

# ----------------------服务端----------------------------------- 
# 
# 上传
put C:/Soft/code/Server.c /code/day02/src
# 编译
gcc Server.c -o Server -I ../code/day02/include/ -L ../code/day02/lib/ -levent
# 运行
./Server

#----------------------客户端-----------------------------------
# 
# 上传
put C:/Soft/code/Client.c /code/day02/src
# 编译
gcc Client.c -o Client -I ../code/day02/include/ -L ../code/day02/lib/ -levent
# 运行
./Client 127.0.0.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

总结

后续补充c++的代码以及cmake的编写。

文章代码摘自如下文章，对我学习很有帮助，故贴上保留学习使用，非常感谢作者。

《linux下libevent的安装和使用例子：数据回显》
https://blog.csdn.net/ljp1919/article/details/48163091