/usr/include/ncbi-vdb/kproc/queue.h is in libncbi-vdb-dev 2.8.1+dfsg-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 | /*===========================================================================
*
* PUBLIC DOMAIN NOTICE
* National Center for Biotechnology Information
*
* This software/database is a "United States Government Work" under the
* terms of the United States Copyright Act. It was written as part of
* the author's official duties as a United States Government employee and
* thus cannot be copyrighted. This software/database is freely available
* to the public for use. The National Library of Medicine and the U.S.
* Government have not placed any restriction on its use or reproduction.
*
* Although all reasonable efforts have been taken to ensure the accuracy
* and reliability of the software and data, the NLM and the U.S.
* Government do not and cannot warrant the performance or results that
* may be obtained by using this software or data. The NLM and the U.S.
* Government disclaim all warranties, express or implied, including
* warranties of performance, merchantability or fitness for any particular
* purpose.
*
* Please cite the author in any work or product based on this material.
*
* ===========================================================================
*
*/
#ifndef _h_kproc_queue_
#define _h_kproc_queue_
#include <kproc/q-extern.h>
#ifndef _h_klib_defs_
#include <klib/defs.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*--------------------------------------------------------------------------
* forwards
*/
struct timeout_t;
/*--------------------------------------------------------------------------
* KQueue
* a simple thread-safe queue structure supporting push/pop operation
* makes use of semaphore objects for synchronization
*/
typedef struct KQueue KQueue;
/* AddRef
* Release
* ignores NULL references
*/
KQ_EXTERN rc_t CC KQueueAddRef ( const KQueue *self );
KQ_EXTERN rc_t CC KQueueRelease ( const KQueue *self );
/* Make
* create an empty queue object
*
* "capacity" [ IN ] - minimum queue length
* always expands to a power of 2, i.e. providing
* a length of 10 will result in a length of 16.
*/
KQ_EXTERN rc_t CC KQueueMake ( KQueue **q, uint32_t capacity );
/* Push
* add an object to the queue
*
* "item" [ IN, OPAQUE ] - pointer to item being queued
*
* "tm" [ IN, NULL OKAY ] - pointer to system specific timeout
* structure. if the queue is full, wait for indicated period
* of time for space to become available, or return status
* code indicating a timeout. when NULL and queue is full,
* Push will time out immediately and return status code.
*/
KQ_EXTERN rc_t CC KQueuePush ( KQueue *self, const void *item, struct timeout_t *tm );
/* Pop
* pop an object from queue
*
* "item" [ OUT, OPAQUE* ] - return parameter for popped item
*
* "tm" [ IN, NULL OKAY ] - pointer to system specific timeout
* structure. if the queue is empty, wait for indicated period
* of time for an object to become available, or return status
* code indicating a timeout. when NULL and queue is empty,
* Pop will time out immediately and return status code.
*/
KQ_EXTERN rc_t CC KQueuePop ( KQueue *self, void **item, struct timeout_t *tm );
/* Sealed
* ask if the queue has been closed off
* meaning there will be no further push operations
*
* NB - if "self" is NULL, the return value is "true"
* since a NULL queue cannot accept items via push
*/
KQ_EXTERN bool CC KQueueSealed ( const KQueue *self );
/* Seal
* indicate that the queue has been closed off
* meaning there will be no further push operations
*/
KQ_EXTERN rc_t CC KQueueSeal ( KQueue *self );
#ifdef __cplusplus
}
#endif
#endif /* _h_kproc_queue_ */
|