apr_proc_mutex.h

Go to the documentation of this file.

/* 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_PROC_MUTEX_H
#define APR_PROC_MUTEX_H

#include "apr.h"
#include "apr_pools.h"
#include "apr_errno.h"

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

typedef enum {
    APR_LOCK_FCNTL,         
    APR_LOCK_FLOCK,         
    APR_LOCK_SYSVSEM,       
    APR_LOCK_PROC_PTHREAD,  
    APR_LOCK_POSIXSEM,      
    APR_LOCK_DEFAULT        
} apr_lockmech_e;

typedef struct apr_proc_mutex_t apr_proc_mutex_t;

/*   Function definitions */

APR_DECLARE(apr_status_t) apr_proc_mutex_create(apr_proc_mutex_t **mutex,
                                                const char *fname,
                                                apr_lockmech_e mech,
                                                apr_pool_t *pool);

APR_DECLARE(apr_status_t) apr_proc_mutex_child_init(apr_proc_mutex_t **mutex,
                                                    const char *fname,
                                                    apr_pool_t *pool);

APR_DECLARE(apr_status_t) apr_proc_mutex_lock(apr_proc_mutex_t *mutex);

APR_DECLARE(apr_status_t) apr_proc_mutex_trylock(apr_proc_mutex_t *mutex);

APR_DECLARE(apr_status_t) apr_proc_mutex_unlock(apr_proc_mutex_t *mutex);

APR_DECLARE(apr_status_t) apr_proc_mutex_destroy(apr_proc_mutex_t *mutex);

APR_DECLARE(apr_status_t) apr_proc_mutex_cleanup(void *mutex);

APR_DECLARE(const char *) apr_proc_mutex_lockfile(apr_proc_mutex_t *mutex);

APR_DECLARE(const char *) apr_proc_mutex_name(apr_proc_mutex_t *mutex);

APR_DECLARE(const char *) apr_proc_mutex_defname(void);

APR_POOL_DECLARE_ACCESSOR(proc_mutex);

#ifdef __cplusplus
}
#endif

#endif  /* ! APR_PROC_MUTEX_H */