diff options
| author | Nick Mathewson <nickm@torproject.org> | 2013-04-26 11:36:43 -0400 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2013-04-26 12:18:38 -0400 |
| commit | a800b913ac473b6c9bd4b1765f4efbea4bae1393 (patch) | |
| tree | c8f53430ec4f4eb8dcdc1d50f658d03da3d2e7c4 /bufferevent-internal.h | |
| parent | 4ea4c6a93e32f15a41799771b14510a9be33552f (diff) | |
| download | libevent-a800b913ac473b6c9bd4b1765f4efbea4bae1393.tar.gz | |
More documentation for finalization feature
Diffstat (limited to 'bufferevent-internal.h')
| -rw-r--r-- | bufferevent-internal.h | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/bufferevent-internal.h b/bufferevent-internal.h index 09cdb351..9ecede17 100644 --- a/bufferevent-internal.h +++ b/bufferevent-internal.h @@ -252,11 +252,13 @@ struct bufferevent_ops { */ int (*disable)(struct bufferevent *, short); - /** DOCUMENT */ + /** Detatches the bufferevent from related data structures. Called as + * soon as its reference count reaches 0. */ void (*unlink)(struct bufferevent *); /** Free any storage and deallocate any extra data or structures used - in this implementation. DOCUMENT + in this implementation. Called when the bufferevent is + finalized. */ void (*destruct)(struct bufferevent *); |