一、简介
Libevent库的特点:开源。精简。跨平台(Windows、Linux、maxos、unix)。专注于网络通信。
二、安装
- 进入官网下载安装包后拖入虚拟机,压缩包名为 libevent-2.1.11-stable.tar.gz
- 解压:使用命令tar -zxvf libevent-2.1.11-stable.tar.gz
- ./configure
- make
- sudo make install
- cd sample,里面有demo 可以检测是否安装成功
- 编译使用库的.c文件时,需要加 -levent
特性:基于“事件”异步通信模型。--- 回调。
库名 libevent.so --> /usr/local/lib 查看的到
头文件 --> /usr/local/include 查看的到
验证:执行gcc hello-world.c -o hello -levent生成hello可执行文件,执行./hello命令出现如下错误:
./hello: error while loading shared libraries: libevent-2.1.so.6: cannot open shared object file: No such file or directory
产生原因及解决办法:
产生原因:在运行时,程序无法找到
libevent-2.1.so.6
这个动态库,因为该动态库在默认安装时,存放的路径在/usr/local/lib
下,不在系统的默认查找路径内。解决办法:将该路径放在系统查找路径内。
第一步:
sudo echo "/usr/local/lib" >> /etc/ld.so.conf
报如下错误:
-bash: /etc/ld.so.conf: Permission denied
在该文件末尾加上/usr/local/lib,
件末通过一些命令:
sudo vim /etc/ld.so.conf
最终配置如下所示:
include /etc/ld.so.conf.d/*.conf
/usr/local/lib
第二步:更新一下,使该配置生效
sudo ldconfig
重新执行gcc hello-world.c -o hello -levent生成hello(服务器)可执行文件,执行./hello命令,再另开一个终端进行服务器连接,结果如下所示:
三、常规事件event
1. 创建底座:
struct event_base *base = event_base_new()/bufferevent_socket_new();
2. 创建事件:
struct event *event_new(struct event_base *base, evutil_socket_t fd, short what, event_callback_fn callback, void *arg)
参数:
base:event_base_new的返回值,也就是底座
fd:绑定到事件上的文件描述符
what:监听的对应的事件,(r、w、e--->读、写、异常)
EV_READ:一次读事件
EV_WRITE:一次写事件
EV_PERSIST:持续触发。结合 event_base_dispatch 函数使用,生效。
callback:一旦事件满足监听条件,回调的函数;typedef void (*event_callback_fn函数名)(evutil_socket_t fd,short what ,void *arg)
arg:回调函数的参数
返回值:成功-->返回创建的 event
3. 添加事件到底座base上:
int event_add(struct event *ev, const struct timeval *tv);
ev: event_new的返回值
tv:为NULL:一直等到事件被触发 回调函数会被调用;为非0:没有事件触发,时间到了,回调函数依旧被调用
4. 启动循环:
int event_base_dispatch(struct event_base *base); 内部就是while(1){epoll}
5. 释放事件:
int event_free(struct event *ev);
ev: event_new的返回值
event实现本地通信:
fifo的读端myread.c
#include <stdio.h>
#include <unistd.h>
#include <stdlib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <string.h>
#include <fcntl.h>
#include <event2/event.h>
// 对操作处理函数
void read_cb(evutil_socket_t fd, short what, void *arg)
{
// 读管道
char buf[1024] = {0};
int len = read(fd, buf, sizeof(buf));
printf("read event: %s \n", what & EV_READ ? "Yes" : "No");
printf("data len = %d, buf = %s\n", len, buf);
sleep(1);
}
// 读管道
int main(int argc, const char* argv[])
{
unlink("myfifo");
//创建有名管道
mkfifo("myfifo", 0664);
// open file
//int fd = open("myfifo", O_RDONLY | O_NONBLOCK);
int fd = open("myfifo", O_RDONLY);
if(fd == -1)
{
perror("open error");
exit(1);
}
// 创建个event_base
struct event_base* base = NULL;
base = event_base_new();
// 创建事件
struct event* ev = NULL;
ev = event_new(base, fd, EV_READ | EV_PERSIST, read_cb, NULL);
// 添加事件
event_add(ev, NULL);
// 事件循环
event_base_dispatch(base); // while(1) { epoll();}
// 释放资源
event_free(ev);
event_base_free(base);
close(fd);
return 0;
}
fifo的写端mywrite.c
#include <stdio.h>
#include <unistd.h>
#include <stdlib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <string.h>
#include <fcntl.h>
#include <event2/event.h>
// 对操作处理函数
void write_cb(evutil_socket_t fd, short what, void *arg)
{
// write管道
char buf[1024] = {0};
static int num = 0;
sprintf(buf, "hello,world-%d\n", num++);
write(fd, buf, strlen(buf)+1);
sleep(1);
}
// 写管道
int main(int argc, const char* argv[])
{
// open file
//int fd = open("myfifo", O_WRONLY | O_NONBLOCK);
int fd = open("myfifo", O_WRONLY);
if(fd == -1)
{
perror("open error");
exit(1);
}
// 写管道
struct event_base* base = NULL;
base = event_base_new();
// 创建事件
struct event* ev = NULL;
// 检测的写缓冲区是否有空间写
//ev = event_new(base, fd, EV_WRITE , write_cb, NULL);
ev = event_new(base, fd, EV_WRITE | EV_PERSIST, write_cb, NULL);
// 添加事件
event_add(ev, NULL);
// 事件循环
event_base_dispatch(base);
// 释放资源
event_free(ev);
event_base_free(base);
close(fd);
return 0;
}
6. 事件的未决和非未决
未决:有资格被处理,但尚未被处理
非未决:没有资格被处理
从event_base上摘下事件 【了解】
int event_del(struct event *ev ) ;
ev : event_ne()的返回值。event_new --> event ---> 非未决 --> event_add --> 未决 --> dispatch() && 监听事件被触发 --> 激活态 --> 执行回调函数 --> 处理态 --> 非未决 event_add && EV_PERSIST --> 未决 --> event_del --> 非未决
四、带缓冲区的事件bufferevent
1. 原理
头文件:
#include <event2/bufferevent.h>
bufferevent有两个缓冲区:也是队列实现,数据只能读一次,先进先出(管道)
读:有数据-->读回函数被调用-->使用bufferevent_read()-->读数据
写:使用bufferevent_write()-->向写缓冲区中写数据-->写完后回调函数被调用(通知写数据成功了,比较鸡肋)
2. bufferevent的创建和释放
1. 创建
struct bufferevent *bufferevent_socket_new(struct event_base *base, evutil_socket_t fd, enum bufferevent_options options);
参数:
base:event_base(底座)
fd:文件描述符(用于连接的描述符cfd)
options:BEV_OPT_CLOSE_ON_FREE
返回值:成功创建的 bufferevent事件对象
struct bufferevent *bev = bufferevent_socket_new(base,fd,BEV_OPT_CLOSE_ON_FREE)
2. 释放
void bufferevent_socket_free(struct bufferevent *bev);
参数:
bev:bufferevent_socket_new的返回值(bufferevent事件对象)
3. 给bufferevent读写缓冲区设置回调
void bufferevent_setcb(struct bufferevent * bufev,
bufferevent_data_cb readcb,
bufferevent_data_cb writecb,
bufferevent_event_cb eventcb,
void *cbarg );
参数:
bufev:bufferevent_socket_new的返回值(bufferevent事件对象)
readcb:设置buffeverent读缓冲的对应回调 read_cb { bufferevent_read() 读数据 }
writecb:设置buffeverent写缓冲的对应回调 write_cb {} -->给调用者发送写成功的通知,可传NULL
eventcb:设置事件回调,也可传NULL
cbarg:上述回调函数的参数
read回调函数(readcb)类型
typedef void (*bufferevent_data_cb)(struct bufferevent *bev, void*ctx);
void read_cb(struct bufferevent *bev, void *cbarg )
{
.....
bufferevent_read(); --- read();
}bufferevent_read()函数的原型:
size_t bufferevent_read(struct bufferevent *bev, void *buf, size_t bufsize);
write 回调函数(writecb)类型
int bufferevent_write(struct bufferevent *bufev, const void *data, size_t size);
event 回调函数(eventcb)类型
typedef void (*bufferevent_event_cb)(struct bufferevent *bev, short events, void *ctx);
void event_cb(struct bufferevent *bev, short events, void *ctx)
{......
}events: BEV_EVENT_CONNECTED
4. 启动、关闭 bufferevent的 缓冲区
默认∶新建的 bufferevent写缓冲是enable的,而读缓冲是disable的。
void bufferevent_enable(struct bufferevent *bufev, short events); 启动缓冲区
通常用来启用bufferevent的 read 缓冲
void bufferevent_disable(struct bufferevent *bufev, short events); 禁用缓冲区
events: EV_READ、EV_WRITE、EV_READ|EV_WRITE
bufferevent_enable(evev, EV_READ); ---- 开启读缓冲。
short bufferevent_get_enabled(struct bufferevent *bufev);
获取缓冲区的禁用状态,需要借助&来得到
5. bufferevent实现网络通信
连接客户端:socket(),connect();
int bufferevent_socket_connect(struct bufferevent *bev, struct sockaddr *address, int addrlen);
参数:
bev: bufferevent 事件对象(封装了fd)
address、len:等同于 connect()的参2和参3
创建监听服务器:完成socket()、bind()、listen()、accept() 这四个函数的作用
加头文件:#include <event2/listener.h>
struct evconnlistener * listner
struct evconnlistener *evconnlistener_new_bind (
struct event_base *base,
evconnlistener_cb cb,
void *ptr,
unsigned flags,
int backlog,
const struct sockaddr *sa,
int socklen);参数:
base: event_base
cb: 回调函数,一旦被回调,说明在其内部应该与客户端完成数据读写操作进行通信。
ptr: 回调函数的参数
flags: LEV_OPT_CLOSE_ON_FREE | LEV_OPT_REUSEABLE
backlog: listen() 2参。 -1 表最大值
sa:服务器自己的地址结构体
socklen:服务器自己的地址结构体大小。
返回值:成功创建的监听器。
释放监听服务器:
void evconnlistener_free(struct evconnlistener *lev);
6. 通信流程分析
服务器:
- 创建event_base(底座)
- 创建服务器连接监听器 evconnlistener_new_bind();它内部会监听客户端的连接,有的话就调用回调
- 在evconnlistener_new_bind()的回调函数中,处理接受与客户端连接后的操作
- 监听器回调函数被调用,说明有一个新客户端连接上来,会得到一个新的cfd,用于跟客户端通信
- 在监听器的回调中使用 bufferevent_socket_new() 创建一个新 bufferevent事件,将cfd封装到这个事件对象中
- 在监听器的回调中使用 bufferevent_setcb() 给这个事件对象的 read、write、event设置回调
- 在监听器的回调中设置 bufferevent的读写缓冲区 enable/disable
- 接受、发送数据 bufferevent_read()/bufferevent_write()-->在bufferevent的读写回调中进行
- 启动循环监听 event_base_dispatch(base)
- 释放资源 free
客户端:
- 创建event_base(底座)
- 使用 bufferevnet_socket_new() 创建一个用于和服务器通信的 bufferevnet 事件对象
- 使用bufferevnet_socket_connect()连接服务器
- 使用bufferevent_setcb()给bufferevnet对象的read、write、event设置回调
- 设置bufferevnet对象的读写缓冲区enable / disable
- 接受、发送数据bufferevent_read() / bufferevent_write()
- 启动循环监听event_base_dispath()
- 释放资源
代码实现:
server.c
#include <stdio.h>
#include <unistd.h>
#include <stdlib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <string.h>
#include <event2/event.h>
#include <event2/listener.h>
#include <event2/bufferevent.h>
// 读缓冲区回调
void read_cb(struct bufferevent *bev, void *arg)
{
char buf[1024] = {0};
bufferevent_read(bev, buf, sizeof(buf));
printf("client say: %s\n", buf);
char *p = "我是服务器, 已经成功收到你发送的数据!";
// 发数据给客户端
bufferevent_write(bev, p, strlen(p)+1);
sleep(1);
}
// 写缓冲区回调
void write_cb(struct bufferevent *bev, void *arg)
{
printf("I'm服务器, 成功写数据给客户端,写缓冲区回调函数被回调...\n");
}
// 事件
void event_cb(struct bufferevent *bev, short events, void *arg)
{
if (events & BEV_EVENT_EOF)
{
printf("connection closed\n");
}
else if(events & BEV_EVENT_ERROR)
{
printf("some other error\n");
}
bufferevent_free(bev);
printf("buffevent 资源已经被释放...\n");
}
void cb_listener(
struct evconnlistener *listener,
evutil_socket_t fd,
struct sockaddr *addr,
int len, void *ptr)
{
printf("connect new client\n");
struct event_base* base = (struct event_base*)ptr;
// 通信操作
// 添加新事件
struct bufferevent *bev;
bev = bufferevent_socket_new(base, fd, BEV_OPT_CLOSE_ON_FREE);
// 给bufferevent缓冲区设置回调
bufferevent_setcb(bev, read_cb, write_cb, event_cb, NULL);
bufferevent_enable(bev, EV_READ);
}
int main(int argc, const char* argv[])
{
// init server
struct sockaddr_in serv;
memset(&serv, 0, sizeof(serv));
serv.sin_family = AF_INET;
serv.sin_port = htons(9876);
serv.sin_addr.s_addr = htonl(INADDR_ANY);
struct event_base* base;
base = event_base_new();
// 创建套接字
// 绑定
// 接收连接请求
struct evconnlistener* listener;
listener = evconnlistener_new_bind(base, cb_listener, base,
LEV_OPT_CLOSE_ON_FREE | LEV_OPT_REUSEABLE,
-1, (struct sockaddr*)&serv, sizeof(serv));
event_base_dispatch(base);
evconnlistener_free(listener);
event_base_free(base);
return 0;
}
client.c
#include <stdio.h>
#include <unistd.h>
#include <stdlib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <string.h>
#include <event2/bufferevent.h>
#include <event2/event.h>
#include <arpa/inet.h>
void read_cb(struct bufferevent *bev, void *arg)
{
char buf[1024] = {0};
bufferevent_read(bev, buf, sizeof(buf));
printf("fwq say:%s\n", buf);
bufferevent_write(bev, buf, strlen(buf)+1);
sleep(1);
}
void write_cb(struct bufferevent *bev, void *arg)
{
printf("----------我是客户端的写回调函数,没啥用\n");
}
void event_cb(struct bufferevent *bev, short events, void *arg)
{
if (events & BEV_EVENT_EOF)
{
printf("connection closed\n");
}
else if(events & BEV_EVENT_ERROR)
{
printf("some other error\n");
}
else if(events & BEV_EVENT_CONNECTED)
{
printf("已经连接服务器...\\(^o^)/...\n");
return;
}
// 释放资源
bufferevent_free(bev);
}
// 客户端与用户交互,从终端读取数据写给服务器
void read_terminal(evutil_socket_t fd, short what, void *arg)
{
// 读数据
char buf[1024] = {0};
int len = read(fd, buf, sizeof(buf));
struct bufferevent* bev = (struct bufferevent*)arg;
// 发送数据
bufferevent_write(bev, buf, len+1);
}
int main(int argc, const char* argv[])
{
struct event_base* base = NULL;
base = event_base_new();
int fd = socket(AF_INET, SOCK_STREAM, 0);
// 通信的fd放到bufferevent中
struct bufferevent* bev = NULL;
bev = bufferevent_socket_new(base, fd, BEV_OPT_CLOSE_ON_FREE);
// init server info
struct sockaddr_in serv;
memset(&serv, 0, sizeof(serv));
serv.sin_family = AF_INET;
serv.sin_port = htons(9876);
inet_pton(AF_INET, "127.0.0.1", &serv.sin_addr.s_addr);
// 连接服务器
bufferevent_socket_connect(bev, (struct sockaddr*)&serv, sizeof(serv));
// 设置回调
bufferevent_setcb(bev, read_cb, write_cb, event_cb, NULL);
// 设置读回调生效
bufferevent_enable(bev, EV_READ);
// 创建事件
struct event* ev = event_new(base, STDIN_FILENO, EV_READ | EV_PERSIST,
read_terminal, bev);
// 添加事件
event_add(ev, NULL);
// 启动循环监听
event_base_dispatch(base);
// 销毁
event_free(ev);
event_base_free(base);
return 0;
}