Skip to content

Commit

Permalink
Expand documentation of equeue
Browse files Browse the repository at this point in the history
  • Loading branch information
Tharazi97 committed Sep 16, 2019
1 parent dc5b9fb commit 05d6f25
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions events/equeue.h
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,9 @@ typedef struct equeue {
//
// If the event queue creation fails, equeue_create returns a negative,
// platform-specific error code.
//
// If queues are chained, it is needed to unchain them first, before calling destroy,
// or call the destroy function on queues in order that chained queues are destroyed first.
int equeue_create(equeue_t *queue, size_t size);
int equeue_create_inplace(equeue_t *queue, size_t size, void *buffer);
void equeue_destroy(equeue_t *queue);
Expand Down

0 comments on commit 05d6f25

Please sign in to comment.