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