[TIPC] Avoid polluting the global namespace
[linux-2.6.git] / net / tipc / node_subscr.h
1 /*
2  * net/tipc/node_subscr.h: Include file for TIPC "node down" subscription handling
3  * 
4  * Copyright (c) 1995-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_NODE_SUBSCR_H
38 #define _TIPC_NODE_SUBSCR_H
39
40 #include "addr.h"
41
42 typedef void (*net_ev_handler) (void *usr_handle);
43
44 /**
45  * struct node_subscr - "node down" subscription entry
46  * @node: ptr to node structure of interest (or NULL, if none)
47  * @handle_node_down: routine to invoke when node fails
48  * @usr_handle: argument to pass to routine when node fails
49  * @nodesub_list: adjacent entries in list of subscriptions for the node
50  */
51
52 struct node_subscr {
53         struct node *node;
54         net_ev_handler handle_node_down;
55         void *usr_handle;
56         struct list_head nodesub_list;
57 };
58
59 void tipc_nodesub_subscribe(struct node_subscr *node_sub, u32 addr,
60                             void *usr_handle, net_ev_handler handle_down);
61 void tipc_nodesub_unsubscribe(struct node_subscr *node_sub);
62
63 #endif