ul_callback.h

Go to the documentation of this file.

/*
 * $Id: ul_callback.h 5003 2008-09-26 11:01:51Z henningw $
 *
 * Copyright (C) 2001-2003 FhG Fokus
 *
 * This file is part of Kamailio, a free SIP server.
 *
 * Kamailio is free software; you can redistribute it and/or modify
 * 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
 *
 * Kamailio is distributed in the hope that it will be useful,
 * 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 
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * History:
 * --------
 *  2004-03-16  created (bogdan)
 */

/*! \file
 *  \brief USRLOC - Module callbacks
 *  \ingroup usrloc
 */

#ifndef _UL_CALLBACKS_H
#define _UL_CALLBACKS_H

#include "ucontact.h"


#define UL_CONTACT_INSERT      (1<<0)
#define UL_CONTACT_UPDATE      (1<<1)
#define UL_CONTACT_DELETE      (1<<2)
#define UL_CONTACT_EXPIRE      (1<<3)
#define ULCB_MAX               ((1<<4)-1)

/*! \brief callback function prototype */
typedef void (ul_cb) (ucontact_t *c, int type, void *param);
/*! \brief register callback function prototype */
typedef int (*register_ulcb_t)( int cb_types, ul_cb f, void *param);


struct ul_callback {
   int id;                      /*!< id of this callback - useless */
   int types;                   /*!< types of events that trigger the callback*/
   ul_cb* callback;             /*!< callback function */
   void *param;                 /*!< param to be passed to callback function */
   struct ul_callback* next;
};

struct ulcb_head_list {
   struct ul_callback *first;
   int reg_types;
};


extern struct ulcb_head_list*  ulcb_list;


#define exists_ulcb_type(_types_) \
   ( (ulcb_list->reg_types)|(_types_) )


int init_ulcb_list(void);

void destroy_ulcb_list(void);


/*! \brief register a callback for several types of events */
int register_ulcb( int types, ul_cb f, void *param );

/*! \brief run all transaction callbacks for an event type */
static inline void run_ul_callbacks( int type , ucontact_t *c)
{
   struct ul_callback *cbp;

   for (cbp=ulcb_list->first; cbp; cbp=cbp->next)  {
      if(cbp->types&type) {
         LM_DBG("contact=%p, callback type %d/%d, id %d entered\n",
            c, type, cbp->types, cbp->id );
         cbp->callback( c, type, cbp->param );
      }
   }
}



#endif