libevent学习笔记 -evbuffer

ｅｖｂｕｆｆｅｒ用来存储从网络接收到和将要向网络发送的数据，它是一个连续的内存区域，处理数据的方式如同队列操作一样，设置指针指示读出和写入位置，结构体定义如下：

struct evbuffer{
  // 当前有效缓冲区的内存起始地址
 u_char *buffer; 
  // 整个分配(realloc)用来缓冲的内存起始地址
  u_char *orig_buffer; 
  // origin_buffer和buffer之间的字节数
 size_t misalign; 
  // 整个分配用来缓冲的内存字节数
 size_t totallen; 
  // 当前有效缓冲区的长度(字节数)
 size_t off; 
  //回到函数，当缓冲区有变化的时候会被调用
 void (*cb)(struct evbuffer *, size_t, size_t, void *);
  //回调函数的参数
 void *cbarg; 
};

在libevent中对ｅｖｂｕｆｆｅｒ的操作主要有以下函数方法：

void evbuffer_drain(struct evbuffer *buf, size_t len)

//该函数用于调整缓冲队列的前向指标。

int evbuffer_expand(struct evbuffer *buf, size_t datlen)

//用于扩充evbuffer的容量。每次向evbuffer写数据时，都是将数据写到buffer+off后，buffer到buffer+off之间已被使用，保存的是有效数据，而orig_buffer和buffer之间则是因为读取数据移动指标而形成的无效区域。evbuffer_expand的扩充策略在于，首先判断如果让出orig_buffer和buffer之间的空闲区域是否可以容纳添加的数据，如果可以，则移动buffer和buffer+off之间的数据到orig_buffer和orig_buffer+off之间(有可能发生内存重叠，所以这里移动调用的是memmove)，然后把新的数据拷贝到orig_buffer+off之后；如果不可以容纳，那么重新分配更大的空间(realloc)，同样会移动数据。 扩充内存的策略为：确保新的内存区域最小尺寸为256，且以乘以2的方式逐步扩大(256、512、1024、...)

int evbuffer_add(struct evbuffer *buf, const void *data, size_t datlen)

//用于添加一段用户数据到evbuffer中。很简单，就是先判断是否有足够的空闲内存，如果没有则调用evbuffer_expand扩充之，然后直接memcpy，更新off指标。

int evbuffer_remove(struct evbuffer *buf, void *data, size_t datlen)

//用于将evbuffer中的数据复制给用户空间(读数据)。简单地将数据memcpy，然后调用evbuffer_drain移动相关指标。

struct evbuffer* evbuffer_new(void)

//动态分配一个struct evbuffer结构，需要调用evbuffer_free释放内存。

void evbuffer_free(struct evbuffer *buffer)

//释放buffer所占用的内存

int evbuffer_add_buffer(struct evbuffer *outbuf, struct evbuffer *inbuf)

//移动数据从一个evbuffer到另一个evbuffer。实际上还是调用了evbuffer_add添加数据到outbuf中。但会清除inbuf中的数据。返回值：成功返回0， 失败返回-1。

int evbuffer_add_printf( struct evbuffer *, const char* fmt, )

//添加一个格式化的字符串到evbuffer尾部。

u_char *evbuffer_find(struct evbuffer *buffer, const u_char *what, size_t len)

//查找缓冲区中是否存在指定的字符串what。注意这里使用的是u_char类型，说明有可能查找的数据不是以’\0’结尾.如果存在返回指向字符串what的指针，没有则返回NULL。

int evbuffer_read(struct evbuffer *buf, int fd, int howmuch)

//调用read/recv函数，从文件描述符fd上读取数据到evbuffer中。如果缓冲区不够，调用evbuffer_expand扩充缓冲区。

int evbuffer_write(struct evbuffer *buffer, int fd)

//把缓冲区中的数据，调用send/write函数写入文件描述符fd上， 如果send/write函数写入的字节数大于0，则调用evbuffer_drain删除已写的数据。

char *evbuffer_readline(struct evbuffer *buffer)

//读取数据以"\r\n","\n\r", "\r" 或者 "\n"结尾。返回动态分配内存，需要调用者自己使用free来释放内存。返回一个以“\0”结尾的字符串。

void evbuffer_setcb(struct evbuffer *buffer,void (*cb)(struct evbuffer *, size_t, size_t, void *), void *cbarg)

//设置回调函数。当缓冲区中发生变化时， 调用设置的回调函数。