?HAMA

Navigation

Breadcrumbs

/ / opt / cpanel / ea-apr16 / include / apr-1

Create

Create File | Create Folder | Upload Files | Run Command

Edit File Size: 3.98 KB

/opt/cpanel/ea-apr16/include/apr-1/apr_queue.h

Text Base64

/* Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef APR_QUEUE_H
#define APR_QUEUE_H

/**
 * @file apr_queue.h
 * @brief Thread Safe FIFO bounded queue
 * @note Since most implementations of the queue are backed by a condition
 * variable implementation, it isn't available on systems without threads.
 * Although condition variables are sometimes available without threads.
 */

#include "apu.h"
#include "apr_errno.h"
#include "apr_pools.h"

#if APR_HAS_THREADS

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/**
 * @defgroup APR_Util_FIFO Thread Safe FIFO bounded queue
 * @ingroup APR_Util
 * @{
 */

/**
 * opaque structure
 */
typedef struct apr_queue_t apr_queue_t;

/** 
 * create a FIFO queue
 * @param queue The new queue
 * @param queue_capacity maximum size of the queue
 * @param a pool to allocate queue from
 */
APU_DECLARE(apr_status_t) apr_queue_create(apr_queue_t **queue, 
                                           unsigned int queue_capacity, 
                                           apr_pool_t *a);

/**
 * push/add an object to the queue, blocking if the queue is already full
 *
 * @param queue the queue
 * @param data the data
 * @returns APR_EINTR the blocking was interrupted (try again)
 * @returns APR_EOF the queue has been terminated
 * @returns APR_SUCCESS on a successful push
 */
APU_DECLARE(apr_status_t) apr_queue_push(apr_queue_t *queue, void *data);

/**
 * pop/get an object from the queue, blocking if the queue is already empty
 *
 * @param queue the queue
 * @param data the data
 * @returns APR_EINTR the blocking was interrupted (try again)
 * @returns APR_EOF if the queue has been terminated
 * @returns APR_SUCCESS on a successful pop
 */
APU_DECLARE(apr_status_t) apr_queue_pop(apr_queue_t *queue, void **data);

/**
 * push/add an object to the queue, returning immediately if the queue is full
 *
 * @param queue the queue
 * @param data the data
 * @returns APR_EINTR the blocking operation was interrupted (try again)
 * @returns APR_EAGAIN the queue is full
 * @returns APR_EOF the queue has been terminated
 * @returns APR_SUCCESS on a successful push
 */
APU_DECLARE(apr_status_t) apr_queue_trypush(apr_queue_t *queue, void *data);

/**
 * pop/get an object to the queue, returning immediately if the queue is empty
 *
 * @param queue the queue
 * @param data the data
 * @returns APR_EINTR the blocking operation was interrupted (try again)
 * @returns APR_EAGAIN the queue is empty
 * @returns APR_EOF the queue has been terminated
 * @returns APR_SUCCESS on a successful pop
 */
APU_DECLARE(apr_status_t) apr_queue_trypop(apr_queue_t *queue, void **data);

/**
 * returns the size of the queue.
 *
 * @warning this is not threadsafe, and is intended for reporting/monitoring
 * of the queue.
 * @param queue the queue
 * @returns the size of the queue
 */
APU_DECLARE(unsigned int) apr_queue_size(apr_queue_t *queue);

/**
 * interrupt all the threads blocking on this queue.
 *
 * @param queue the queue
 */
APU_DECLARE(apr_status_t) apr_queue_interrupt_all(apr_queue_t *queue);

/**
 * terminate the queue, sending an interrupt to all the
 * blocking threads
 *
 * @param queue the queue
 */
APU_DECLARE(apr_status_t) apr_queue_term(apr_queue_t *queue);

#ifdef __cplusplus
}
#endif

/** @} */

#endif /* APR_HAS_THREADS */

#endif /* APRQUEUE_H */

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Directory Contents

Dirs: 0 × Files: 77

Sort:

Enable drag-to-move

Name	Size	Perms	Modified	Actions
apr-x86_64.h	17.91 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr.h	636 B	lrw-r--r--	2025-05-22 09:10:36	Edit Download recursive recursive
apr_allocator.h	6.07 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_anylock.h	4.93 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_atomic.h	6.04 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_base64.h	3.75 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_buckets.h	63.15 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_crypto.h	19.68 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_cstr.h	11.13 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_date.h	3.47 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_dbd.h	23.35 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_dbm.h	8.40 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_dso.h	2.64 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_encode.h	30.35 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_env.h	2.06 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_errno.h	53.77 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_escape.h	17.23 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_file_info.h	17.17 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_file_io.h	42.88 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_fnmatch.h	6.08 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_general.h	7.34 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_getopt.h	5.84 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_global_mutex.h	7.19 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_hash.h	10.08 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_hooks.h	12.36 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_inherit.h	2.09 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_ldap.h	5.57 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_ldap_init.h	5.64 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_ldap_option.h	8.40 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_ldap_rebind.h	3.09 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_ldap_url.h	3.71 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_lib.h	8.23 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_md4.h	4.42 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_md5.h	6.20 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_memcache.h	16.82 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_mmap.h	5.01 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_network_io.h	36.02 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_optional.h	2.71 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_optional_hooks.h	3.78 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_perms_set.h	1.86 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_poll.h	20.60 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_pools.h	30.94 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_portable.h	20.02 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_proc_mutex.h	6.85 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_queue.h	3.98 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_random.h	4.92 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_redis.h	15.62 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_reslist.h	7.01 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_ring.h	18.78 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_rmm.h	4.67 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_sdbm.h	5.97 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_sha1.h	3.79 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_shm.h	9.26 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_signal.h	2.70 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_siphash.h	6.01 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_skiplist.h	14.19 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_strings.h	14.55 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_strmatch.h	2.61 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_support.h	1.60 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_tables.h	18.90 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_thread_cond.h	5.40 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_thread_mutex.h	4.39 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_thread_pool.h	10.84 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_thread_proc.h	36.80 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_thread_rwlock.h	4.65 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_time.h	7.39 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_uri.h	6.43 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_user.h	5.19 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_uuid.h	2.05 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_version.h	5.22 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_want.h	2.89 KB	lrw-r--r--	2025-05-22 09:10:35	Edit Download recursive recursive
apr_xlate.h	6.26 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apr_xml.h	12.19 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apu.h	4.22 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apu_errno.h	5.32 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apu_version.h	4.20 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive
apu_want.h	1.45 KB	lrw-r--r--	2025-08-22 14:46:51	Edit Download recursive recursive