基于libevent库服务器搭建经验

基于libevent库服务器搭建经验

1. libevnet库介绍

  • 优点:开源、精简、跨平台(Windows、Linux、maxos、unix等)、专注于网络通信。

  • 安装:

    1. ./configure 检查安装环境和生成makefile

    2. make 生成.o和可执行文件

    3. sudo make install 将必要的资源拷贝至系统指定目录

    4. 进入sample目录,运行demo验证库的安装情况

    5. 编译使用库的.c需要添加-levent选项

    6. 查看库 libevent.so → /usr/local/lib

  • 特征:基于“事件”异步通信模型。→ 回调机制。

2. libevent库的框架

  1. 创建event_base(可以理解为乐高玩具的底座)

    • struct event_base* event_base_new(void);
    • struct event_base* base = event_base_new();
  2. 创建事件event(可以理解为乐高玩具的插件)

    • 常规事件event → event_new()
    • 带缓冲区的事件bufferevent → bufferevent_socket_new()
  3. 将事件添加到base上(把插件插上乐高玩具底座)

    • int event_add(struct event* ev, const struct timeval* tv)
  4. 循环监听事件满足(启动玩具)

    • int event_base_dispatch(struct event_base* base)
    • event_base_dispatch(base)
    • 只有event_new中指定了EV_PERSIST才能持续触发,否则只触发一次,就跳出循环
      • 通常采用EV_WRITE|EV_PERSIST、EV_READ|EV_PERSIST
  5. 释放event_base

    • event_base_free(base);

3. 其他函数

  • 查看支持哪些多路IO

    const char** event_get_supported_methods(void);
    
  • 查看当前使用的多路IO

    const char* event_base_get_method(const struct event_base* base);
    
  • 查看fork后子进程使用的event_base

    int event_reinit(struct event_base* base);
    //成功0,失败1,使用该函数后父进程创建的base才能在子进程中生效
    

4. 常规事件

4.1 相关函数

struct event* event_new(struct event_base* base, evutil_socket_t fd, short what, 							event_callback_fn cb, void* arg);
int event_add(struct event* ev, const struct timeval* tv);
int event_del(struct event* ev);
int event_free(struct event* ev);
  • event_new函数

    • 功能:创建event对象

    • 参数:

      base:event_base_new()的返回值

      fd:绑定到事件上的文件描述符

      what:文件描述符对应的事件,读事件、写事件和异常事件

      ​ EV_WRITE、EV_READ、EV_PERSIST、EV_SIGNAL、EV_ET

      cb:一旦满足监听条件,回调的函数

      typedef void (*event_callback_fn)(evutil_socket_t, short, void*);
      

      arg:回调函数传入的参数

    • 返回:

      成功创建的event事件指针

  • event_add函数

    • 功能:将even事件添加到base上

    • 参数:

      ev:event_new()的返回值

      tv:时间

      1. null,不会超时,一直等待到事件触发了才调用回调函数

      2. 非null,等待一段时间,如果事件没有被触发也会调用回调函数

    • 返回:

      0成功,-1失败

  • event_del函数

    • 功能:将event的事件从base上拿下

    • 参数:

      ev:event_new()的返回值

    • 返回:

      0成功,-1失败

  • event_free函数

    • 功能:将event对象释放掉

    • 参数:

      ev:event_new()的返回值

    • 返回:

      0成功,-1失败

4.2 未决和非未决

  • 概念:未决指的是有资格被处理但还没有被处理,非未决指的是没有资格被处理

  • 状态转换图:

    在这里插入图片描述

5. 带缓冲区的事件

  • bufferevent有两个缓冲区:也是采用队列来实现的,先进先出并且不能重复读取
    • 读:有数据 → 读回调函数被调用 → 使用bufferevent_read() → 读数据
    • 写:使用bufferevent_write() → 向写缓冲中写数据 → 写缓冲有数据将自动刷新 → 写操作完成后将调用写回调函数

5.1 带缓冲区事件的创建和释放

struct bufferevent* bufferevent_socket_new(struct event_base* base, evutil_event_socket_t fd, enum bufferevent_options options);
void bufferevent_free(struct bufferevent* bev);
  • bufferevent_socket_new函数

    • 功能:创建

    • 参数:

      base:event_base_new()的返回值

      fd:绑定到事件上的文件描述符

      options:只需要记住BEV_OPT_CLOSE_ON_FREE 目的是关闭的时候释放底层套接字

    • 返回:

      成功创建的bufferevent事件对象

  • bufferevent_free函数

    • 功能:释放bufferevent对象

    • 参数:

      bev:bufferevent_socket_new()的返回值,bufferevent对象

    • 返回值:

5.2 设置读写缓冲区回调函数

void bufferevent_setcb(struct bufferevent* bufev, bufferevent_data_cb readcb, bufferevent_data_cb writecb, bufferevent_event_cb eventcb, void* cbarg);
size_t bufferevent_read(struct bufferevent* bufev, void* data, size_t size);
size_t bufferevent_write(struct bufferevent* bufev, const void* data, size_t size);
  • bufferevent_setcb函数

    • 功能:设置bufferevent对象的回调函数

    • 参数:

      bufev:bufferevent对象

      readcb:设置bufferevent读缓冲对应回调,通常用bufferevent_read函数读数据

      typedef void(*bufferevent_data_cb)(struct bufferevent* bev, void* ctx);
      

      writecb:设置bufferevent写缓冲对应回调,给调用者发送写成功的通知

      eventcb:设置事件回调,通常可以传NULL如果不需要对事件进行处理

      typedef void (*bufferevent_event_cb)(struct bufferevent* bev, short events, void* ctx);
      /*
      event的取值:
      	BEV_EVENT_READING:读取操作时发生某事件,具体是哪种事件请看其他标志。
      	BEV_EVENT_WRITING:写入操作时发生某事件,具体是哪种事件请看其他标志。
      	BEV_EVENT_ERROR :操作时发生错误。关于错误的更多信息,请调 用EVUTIL_SOCKET_ERROR()。	 BEV_EVENT_TIMEOUT:发生超时。
      	BEV_EVENT_EOF:遇到文件结束指示。
      	BEV_EVENT_CONNECTED:请求的连接过程已经完成,实现客户端时可以用。
      */
      

      cbarg:上述回调函数使用的参数

  • bufferevent_read函数

    • 功能:代替read函数

    • 参数:

      bufev:bufferevent对象

      data:存放读到数据的变量,传入传出参数

      size:data的大小

    • 返回:

      实际读出的数据长度

  • bufferevent_write函数

    • 功能:代替write函数

    • 参数

      bufev:bufferevent对象

      data:待写数据,传入参数

      size:待写数据的大小

    • 返回:

      实际写入的数据长度

5.3 禁用、启用缓冲区

void bufferevent_enable(struct bufferevent* bufev, short events);
void bufferevent_disable(struct bufferevent* bufev, short events);
short bufferevent_get_enable(struct bufferevent* bufev);
  • 注意:新建的bufferevent的默认情况下的写缓冲是使能的,而读缓冲是不使能的

  • bufferevent_enable函数

    • 功能:启用缓冲区

    • 参数:

      bufev:bufferevent对象

      events:EV_READ、EV_WRITE和EV_READ|EV_WRITE

  • bufferevent_disable函数

    • 功能:禁用缓冲区

    • 参数:

      bufev:bufferevent对象

      events:EV_READ、EV_WRITE和EV_READ|EV_WRITE

  • bufferevent_get_enable函数

    • 功能:查看bufferevent当前缓冲区的开启状态

    • 参数:

      bufev:bufferevent对象

    • 返回:

      events:EV_READ、EV_WRITE和EV_READ|EV_WRITE

6. libevent封装的socket函数

//客户端的函数
//对应于connect()函数
int bufferevent_socket_connect(struct bufferevent* bev, struct sockaddr* address, int addrlen);

//服务器的函数
//创建监听器
struct evconnlistener* evconnlistener_new(struct event_base* base, evconnlistener_Cb cb, void* ptr, unsigned flags, int backlog, evutil_socket_t fd);

struct evconnlistener* evconnlistener_new_bind(struct event_base* base, evconnlistener_Cb cb, void* ptr, unsigned flags, int backlog, const struct sockaddr* sa, int socklen);

//释放监听器
void evconnlistenner_free(struct evconnlistener* lev);
  • evconnlistener_new_bind函数

    • 功能:可以完成socket()、bind()、listen()和accept()的功能

    • 参数:

      base:event_base基座对象

      cb:监听回调函数,接收连接后用户要做的操作,一旦被回调说明在其内部应该与客户端完成数据读写操作。

      typedef void (*evconnlistener_cb)(struct evconnlistener* listener, evutil_socket_t sock, struct sockaddr* addr, int len, void* ptr);
      
      /*
      回调条件:监听事件满足之后将会回调
      回调作用:通过套接字跟对端进行通信
      
      listener:创建的监听器对象
      sock:客户端的套接字
      addr:客户端的地址结构
      len:客户端地址结构的长度
      ptr:回调函数的参数
      */
      

      ptr:回调函数的参数

      flags:可识别的标志

      ​ LEV_OPT_CLOSE_ON_FREE:释放evconnlistener_new的时候将关闭底层传输端口,关闭底层套 接字、释放底层bufferevent等

      ​ LEV_OPT_REUSEABLE:端口复用

      backlog:listen()函数的第二个参数,-1表示使用默认最大值

      sa:服务器的IP+PORT地址结构

      socklen:sa的长度

    • 返回:

      evconnlistener对象指针,监听器对象指针

7. libevent服务器框架

  1. 创建一个event_base
  2. 创建一个监听器,调用evconnlistener_new_bind()
  3. 设置监听器回调函数listener_cb(),当客户端连接时回调函数就会被调用,得到一个新的fd用于与客户端通信
  4. 创建一个bufferevent事件对象,buffevent_socket_new()将接收到的fd封装到事件对象中
  5. 使用bufferevent_setcb()函数给bufferevent的read、write、event设置回调函数
  6. 设置bufferevent的读写缓冲区enable/disable
  7. 接收和发送数据,bufferevent_read()/bufferevent_write()
  8. 启动循环监听,event_base_dispatch()
  9. 释放资源,释放监听器和event_base

8. libevent客户端框架

  1. 创建一个event_base
  2. 使用bufferevent_socket_new()创建一个用于跟服务器通信的bufferevent事件对象
  3. 使用bufferevent_socket_connect()连接到服务器
  4. 使用bufferevent_setcb()给bufferevent对象的read、write和event设置回调
  5. 设置bufferevent对象的读写缓冲区enable/disable
  6. 接收和发送数据bufferevent_read()/bufferevent_write()
  7. 启动循环监听,event_base_dispatch()
  8. 释放资源,释放bufferevent和event_base
  • 2
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值