locking.h
01fd8ca6
 /*
  *
53c7e0f1
  * Copyright (C) 2001-2003 FhG Fokus
01fd8ca6
  *
2266bb9c
  * This file is part of Kamailio, a free SIP server.
01fd8ca6
  *
2266bb9c
  * Kamailio is free software; you can redistribute it and/or modify
01fd8ca6
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version
  *
2266bb9c
  * Kamailio is distributed in the hope that it will be useful,
01fd8ca6
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License 
  * along with this program; if not, write to the Free Software 
9e1ff448
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
01fd8ca6
  */
 
2266bb9c
 /*!
 * \file
 * \brief Kamailio core :: Kamailio locking library
 * \ingroup core
 * \author andrei
 * Module: \ref core
c751da14
  *
  *
ba98af46
 Implements (in lock_ops.h & lock_alloc.h):
 
 	simple locks:
 	-------------
56c2dabd
 	type: gen_lock_t
ba98af46
 	gen_lock_t* lock_alloc();                - allocates a lock in shared mem.
 	gen_lock_t* lock_init(gen_lock_t* lock); - inits the lock
 	void    lock_destroy(gen_lock_t* lock);  - removes the lock (e.g sysv rmid)
 	void    lock_dealloc(gen_lock_t* lock);  - deallocates the lock's shared m.
 	void    lock_get(gen_lock_t* lock);      - lock (mutex down)
 	void    lock_release(gen_lock_t* lock);  - unlock (mutex up)
 	
56c2dabd
 	lock sets:
ba98af46
 	----------
194b6a35
 	type: gen_lock_set_t
 	gen_lock_set_t* lock_set_alloc(no)               - allocs a lock set in shm.
 	gen_lock_set_t* lock_set_init(gen_lock_set_t* set);  - inits the lock set
 	void lock_set_destroy(gen_lock_set_t* s);        - removes the lock set
 	void lock_set_dealloc(gen_lock_set_t* s);        - deallocs the lock set shm.
 	void lock_set_get(gen_lock_set_t* s, int i);     - locks sem i from the set
 	void lock_set_release(gen_lock_set_t* s, int i)  - unlocks sem i from the set
ba98af46
 
6aa0ab09
 WARNING: - lock_set_init may fail for large number of sems (e.g. sysv). 
          - signals are not treated! (some locks are "awakened" by the signals)
01fd8ca6
 */
 
 #ifndef _locking_h
 #define _locking_h
 
ba98af46
 /* the order is important */
 #include "lock_ops.h"
 #include "lock_alloc.h" 
01fd8ca6
 
 #endif