From 7bbf6ca7712bac9081d955c0f673691122ccbf5c Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Thu, 8 Dec 2011 14:36:32 -0500 Subject: [PATCH] Slightly clarify evbuffer_peek documentation --- include/event2/buffer.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/include/event2/buffer.h b/include/event2/buffer.h index d28cd2dc..32963568 100644 --- a/include/event2/buffer.h +++ b/include/event2/buffer.h @@ -626,8 +626,10 @@ struct evbuffer_ptr evbuffer_search_eol(struct evbuffer *buffer, the buffer does not have as much data as you asked to see). @param buffer the evbuffer to peek into, - @param len the number of bytes to try to peek. If negative, we - will try to fill as much of vec_out as we can. + @param len the number of bytes to try to peek. If len is negative, we + will try to fill as much of vec_out as we can. If len is negative + and vec_out is not provided, we return the number of evbuffer_iovecs + that would be needed to get all the data in the buffer. @param start_at an evbuffer_ptr indicating the point at which we should start looking for data. NULL means, "At the start of the buffer."