cuberite/libevent
1
0
Fork 0
mirror of https://github.com/cuberite/libevent.git synced 2025-08-05 10:16:08 -04:00
Code Issues Packages Projects Releases Wiki Activity

Improve evbuffer_ptr documentation

Browse Source
This commit is contained in:
Nick Mathewson 2011-06-13 17:07:29 -04:00
parent 9ab8ab83cd
commit 261ba63dba
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
include/event2/buffer.h
View File

@ -81,11 +81,15 @@ struct evbuffer;
through a buffer. Calls to any function that modifies or re-packs the through a buffer. Calls to any function that modifies or re-packs the
buffer contents may invalidate all evbuffer_ptrs for that buffer. Do not buffer contents may invalidate all evbuffer_ptrs for that buffer. Do not
modify these values except with evbuffer_ptr_set. modify these values except with evbuffer_ptr_set.
An evbuffer_ptr can represent any position from the start of a buffer up
to a position immediately after the end of a buffer.
*/ */
struct evbuffer_ptr { struct evbuffer_ptr {
ev_ssize_t pos; ev_ssize_t pos;
/* Do not alter the values of fields. */ /* Do not alter or rely on the values of fields: they are for internal
* use */
struct { struct {
void *chain; void *chain;
size_t pos_in_chain; size_t pos_in_chain;
@ -594,9 +598,18 @@ enum evbuffer_ptr_how {
/** /**
Sets the search pointer in the buffer to position. Sets the search pointer in the buffer to position.
If evbuffer_ptr is not initialized. This function can only be called There are two ways to use this function: you can call
evbuffer_ptr_set(buf, &pos, N, EVBUFFER_PTR_SET)
to move 'pos' to a position 'N' bytes after the start of the buffer, or
evbuffer_ptr_set(buf, &pos, N, EVBUFFER_PTR_SET)
to move 'pos' forward by 'N' bytes.
If evbuffer_ptr is not initialized, this function can only be called
with EVBUFFER_PTR_SET. with EVBUFFER_PTR_SET.
An evbuffer_ptr can represent any position from the start of the buffer to
a position immediately after the end of the buffer.
@param buffer the evbuffer to be search @param buffer the evbuffer to be search
@param ptr a pointer to a struct evbuffer_ptr @param ptr a pointer to a struct evbuffer_ptr
@param position the position at which to start the next search @param position the position at which to start the next search