GPLization banner introduced to *.[hc] files
[sip-router] / modules / tm / t_cancel.h
1 /*
2  * $Id$
3  *
4  *
5  * Copyright (C) 2001-2003 Fhg Fokus
6  *
7  * This file is part of ser, a free SIP server.
8  *
9  * ser is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version
13  *
14  * For a license to use the ser software under conditions
15  * other than those described here, or to purchase support for this
16  * software, please contact iptel.org by e-mail at the following addresses:
17  *    info@iptel.org
18  *
19  * ser is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License 
25  * along with this program; if not, write to the Free Software 
26  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
27  */
28
29
30 #ifndef _CANCEL_H
31 #define _CANCEL_H
32
33 /* a buffer is empty but cannot be used by anyone else;
34    particularly, we use this value in the buffer pointer
35    in local_buffer to tell "a process is already scheduled
36    to generate a CANCEL, other processes are not supposed to"
37    (which might happen if for example in a three-branch forking,
38    two 200 would enter separate processes and compete for
39    cancelling the third branch); note that to really avoid
40    race conditions, the value must be set in REPLY_LOCK
41 */
42
43 #define BUSY_BUFFER ((char *)-1)
44
45 void which_cancel( struct cell *t, branch_bm_t *cancel_bm );
46 void cancel_uacs( struct cell *t, branch_bm_t cancel_bm );
47 void cancel_branch( struct cell *t, int branch );
48
49 char *build_cancel(struct cell *Trans,unsigned int branch,
50         unsigned int *len );
51
52 inline short static should_cancel_branch( struct cell *t, int b )
53 {
54         int last_received;
55         short should;
56
57         last_received=t->uac[b].last_received;
58         /* cancel only if provisional received and noone else
59            attempted to cancel yet */
60         should=last_received>=100 && last_received<200
61                 && t->uac[b].local_cancel.buffer==0;
62         /* we'll cancel -- label it so that noone else
63                 (e.g. another 200 branch) will try to do the same */
64         if (should) t->uac[b].local_cancel.buffer=BUSY_BUFFER;
65         return should;
66 }
67
68
69 #endif