Document a change in the semantics of event_get_struct_event_size()

This commit is contained in:
Nick Mathewson 2010-06-19 18:21:40 -04:00
parent 8a44062308
commit e21f5d15eb

View File

@ -605,9 +605,13 @@ void event_get_assignment(const struct event *event, struct event_base **base_ou
Return the size of struct event that the Libevent library was compiled
with.
This will be the same as sizeof(struct event) if you're running with the
same version of Libevent that your application was built with, but
This will be NO GREATER than sizeof(struct event) if you're running with
the same version of Libevent that your application was built with, but
otherwise might not.
Note that it might be SMALLER than sizeof(struct event) if some future
version of Libevent adds extra buffer space to the end of struct event
to ensure
*/
size_t event_get_struct_event_size(void);