Apache Portable Runtime Utility Library
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
apr_queue.h
Go to the documentation of this file.
1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2  * contributor license agreements. See the NOTICE file distributed with
3  * this work for additional information regarding copyright ownership.
4  * The ASF licenses this file to You under the Apache License, Version 2.0
5  * (the "License"); you may not use this file except in compliance with
6  * the License. You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef APR_QUEUE_H
18 #define APR_QUEUE_H
19 
28 #include "apu.h"
29 #include "apr_errno.h"
30 #include "apr_pools.h"
31 
32 #if APR_HAS_THREADS
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif /* __cplusplus */
37 
47 typedef struct apr_queue_t apr_queue_t;
48 
55 APU_DECLARE(apr_status_t) apr_queue_create(apr_queue_t **queue,
56  unsigned int queue_capacity,
57  apr_pool_t *a);
58 
68 APU_DECLARE(apr_status_t) apr_queue_push(apr_queue_t *queue, void *data);
69 
79 APU_DECLARE(apr_status_t) apr_queue_pop(apr_queue_t *queue, void **data);
80 
91 APU_DECLARE(apr_status_t) apr_queue_trypush(apr_queue_t *queue, void *data);
92 
103 APU_DECLARE(apr_status_t) apr_queue_trypop(apr_queue_t *queue, void **data);
104 
113 APU_DECLARE(unsigned int) apr_queue_size(apr_queue_t *queue);
114 
120 APU_DECLARE(apr_status_t) apr_queue_interrupt_all(apr_queue_t *queue);
121 
128 APU_DECLARE(apr_status_t) apr_queue_term(apr_queue_t *queue);
129 
130 #ifdef __cplusplus
131 }
132 #endif
133 
136 #endif /* APR_HAS_THREADS */
137 
138 #endif /* APRQUEUE_H */