Main Page | Modules | Data Structures | File List | Data Fields | Globals | Related Pages

apr_proc_mutex.h

Go to the documentation of this file.
00001 /* ====================================================================
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 2000-2003 The Apache Software Foundation.  All rights
00005  * reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  *
00014  * 2. Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  *
00019  * 3. The end-user documentation included with the redistribution,
00020  *    if any, must include the following acknowledgment:
00021  *       "This product includes software developed by the
00022  *        Apache Software Foundation (http://www.apache.org/)."
00023  *    Alternately, this acknowledgment may appear in the software itself,
00024  *    if and wherever such third-party acknowledgments normally appear.
00025  *
00026  * 4. The names "Apache" and "Apache Software Foundation" must
00027  *    not be used to endorse or promote products derived from this
00028  *    software without prior written permission. For written
00029  *    permission, please contact apache@apache.org.
00030  *
00031  * 5. Products derived from this software may not be called "Apache",
00032  *    nor may "Apache" appear in their name, without prior written
00033  *    permission of the Apache Software Foundation.
00034  *
00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00046  * SUCH DAMAGE.
00047  * ====================================================================
00048  *
00049  * This software consists of voluntary contributions made by many
00050  * individuals on behalf of the Apache Software Foundation.  For more
00051  * information on the Apache Software Foundation, please see
00052  * <http://www.apache.org/>.
00053  */
00054 
00055 #ifndef APR_PROC_MUTEX_H
00056 #define APR_PROC_MUTEX_H
00057 
00063 #include "apr.h"
00064 #include "apr_pools.h"
00065 #include "apr_errno.h"
00066 
00067 #ifdef __cplusplus
00068 extern "C" {
00069 #endif /* __cplusplus */
00070 
00082 typedef enum {
00083     APR_LOCK_FCNTL,         
00084     APR_LOCK_FLOCK,         
00085     APR_LOCK_SYSVSEM,       
00086     APR_LOCK_PROC_PTHREAD,  
00087     APR_LOCK_POSIXSEM,      
00088     APR_LOCK_DEFAULT        
00089 } apr_lockmech_e;
00090 
00092 typedef struct apr_proc_mutex_t apr_proc_mutex_t;
00093 
00094 /*   Function definitions */
00095 
00117 APR_DECLARE(apr_status_t) apr_proc_mutex_create(apr_proc_mutex_t **mutex,
00118                                                 const char *fname,
00119                                                 apr_lockmech_e mech,
00120                                                 apr_pool_t *pool);
00121 
00133 APR_DECLARE(apr_status_t) apr_proc_mutex_child_init(apr_proc_mutex_t **mutex,
00134                                                     const char *fname,
00135                                                     apr_pool_t *pool);
00136 
00142 APR_DECLARE(apr_status_t) apr_proc_mutex_lock(apr_proc_mutex_t *mutex);
00143 
00151 APR_DECLARE(apr_status_t) apr_proc_mutex_trylock(apr_proc_mutex_t *mutex);
00152 
00157 APR_DECLARE(apr_status_t) apr_proc_mutex_unlock(apr_proc_mutex_t *mutex);
00158 
00163 APR_DECLARE(apr_status_t) apr_proc_mutex_destroy(apr_proc_mutex_t *mutex);
00164 
00171 APR_DECLARE(apr_status_t) apr_proc_mutex_cleanup(void *mutex);
00172 
00178 APR_DECLARE(const char *) apr_proc_mutex_lockfile(apr_proc_mutex_t *mutex);
00179 
00185 APR_DECLARE(const char *) apr_proc_mutex_name(apr_proc_mutex_t *mutex);
00186 
00190 APR_DECLARE(const char *) apr_proc_mutex_defname(void);
00191 
00196 APR_POOL_DECLARE_ACCESSOR(proc_mutex);
00197 
00200 #ifdef __cplusplus
00201 }
00202 #endif
00203 
00204 #endif  /* ! APR_PROC_MUTEX_H */

Generated on Thu Jun 29 22:00:44 2006 for Apache Portable Runtime by  doxygen 1.3.9.1