6b91ca9e2419192fa14eb74de500f7abe6818b69
[linux-3.10.git] / net / tipc / subscr.h
1 /*
2  * net/tipc/subscr.h: Include file for TIPC subscription service
3  * 
4  * Copyright (c) 2003-2005, Ericsson Research Canada
5  * Copyright (c) 2005, Wind River Systems
6  * Copyright (c) 2005-2006, Ericsson AB
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. Neither the names of the copyright holders nor the names of its
18  *    contributors may be used to endorse or promote products derived from
19  *    this software without specific prior written permission.
20  *
21  * Alternatively, this software may be distributed under the terms of the
22  * GNU General Public License ("GPL") version 2 as published by the Free
23  * Software Foundation.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
26  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
29  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35  * POSSIBILITY OF SUCH DAMAGE.
36  */
37
38 #ifndef _TIPC_SUBSCR_H
39 #define _TIPC_SUBSCR_H
40
41 /**
42  * struct subscription - TIPC network topology subscription object
43  * @seq: name sequence associated with subscription
44  * @timeout: duration of subscription (in ms)
45  * @filter: event filtering to be done for subscription
46  * @evt: template for events generated by subscription
47  * @subscription_list: adjacent subscriptions in subscriber's subscription list
48  * @nameseq_list: adjacent subscriptions in name sequence's subscription list
49  * @timer_ref: reference to timer governing subscription duration (may be NULL)
50  * @owner: pointer to subscriber object associated with this subscription
51  */
52  
53 struct subscription {
54         struct tipc_name_seq seq;
55         u32 timeout;
56         u32 filter;
57         struct tipc_event evt;
58         struct list_head subscription_list;
59         struct list_head nameseq_list;
60         struct timer_list timer;
61         struct subscriber *owner;
62 };
63
64 int subscr_overlap(struct subscription * sub, 
65                    u32 found_lower, 
66                    u32 found_upper);
67
68 void subscr_report_overlap(struct subscription * sub, 
69                            u32 found_lower, 
70                            u32 found_upper,
71                            u32 event, 
72                            u32 port_ref, 
73                            u32 node,
74                            int must_report);
75
76 int subscr_start(void);
77
78 void subscr_stop(void);
79
80
81 #endif