sl_cb.h

Go to the documentation of this file.

/*
 * $Id: sl_cb.h 5003 2008-09-26 11:01:51Z henningw $
 *
 * Copyright (C) 2006 Voice Sistem SRL
 *
 * 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:
 * ---------
 *  2006-03-29  first version (bogdan)
 */

/*!
 * \file
 * \brief SL :: callbacks
 * \ingroup sl
 * - Module: \ref sl
 */

#ifndef SL_CB_H_
#define SL_CB_H_

#include "../../str.h"
#include "../../ip_addr.h"
#include "../../parser/msg_parser.h"


struct sl_cb_param {
   str  *buffer;
   int  code;
   str  *reason;
   union sockaddr_union *dst;
   void *param;
};

/*! callback function prototype */
typedef void (sl_cb_t) (unsigned int types, struct sip_msg* req,
      struct sl_cb_param *sl_param);
/*! register callback function prototype */
typedef int (*register_slcb_t)(unsigned int types, sl_cb_t f, void *param);



/*! SL callback definition */
struct sl_callback {
   int id;                    /* id of this callback - useless */
   unsigned int types;        /* maks of types */
   sl_cb_t* callback;         /* callback function */
   void* param;               /* param to be passed to callback function */
   struct sl_callback* next;  /* next callback element*/
};


#define SLCB_REPLY_OUT       (1<<0)
#define SLCB_ACK_IN          (1<<1)

/*! cleanup callback list */
void destroy_slcb_lists(void);


/*! register a SL callback */
int register_slcb(unsigned int types, sl_cb_t f, void *param );

/*! run SL callbacks */
void run_sl_callbacks( unsigned int types, struct sip_msg *req, str *buffer,
      int code, str *reason, union sockaddr_union *to);


#endif