blob: 45d89bf4d202b6217b565a5c8e7730a5f6bebcfd [file] [log] [blame]
Per Lidenb97bf3f2006-01-02 19:04:38 +01001/*
Allan Stephens5b06c85c2008-05-19 13:30:13 -07002 * net/tipc/subscr.h: Include file for TIPC network topology service
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +09003 *
Per Liden9da1c8b2006-01-11 18:40:41 +01004 * Copyright (c) 2003-2006, Ericsson AB
Allan Stephens5b06c85c2008-05-19 13:30:13 -07005 * Copyright (c) 2005-2007, Wind River Systems
Per Lidenb97bf3f2006-01-02 19:04:38 +01006 * All rights reserved.
7 *
Per Liden9ea1fd32006-01-11 13:30:43 +01008 * Redistribution and use in source and binary forms, with or without
Per Lidenb97bf3f2006-01-02 19:04:38 +01009 * modification, are permitted provided that the following conditions are met:
10 *
Per Liden9ea1fd32006-01-11 13:30:43 +010011 * 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.
Per Lidenb97bf3f2006-01-02 19:04:38 +010019 *
Per Liden9ea1fd32006-01-11 13:30:43 +010020 * 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
Per Lidenb97bf3f2006-01-02 19:04:38 +010034 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37#ifndef _TIPC_SUBSCR_H
38#define _TIPC_SUBSCR_H
39
Allan Stephense15f8802008-05-19 13:27:31 -070040struct subscription;
41
42typedef void (*tipc_subscr_event) (struct subscription *sub,
43 u32 found_lower, u32 found_upper,
44 u32 event, u32 port_ref, u32 node);
45
Per Lidenb97bf3f2006-01-02 19:04:38 +010046/**
47 * struct subscription - TIPC network topology subscription object
48 * @seq: name sequence associated with subscription
49 * @timeout: duration of subscription (in ms)
50 * @filter: event filtering to be done for subscription
Allan Stephense15f8802008-05-19 13:27:31 -070051 * @event_cb: routine invoked when a subscription event is detected
Allan Stephens5b06c85c2008-05-19 13:30:13 -070052 * @timer: timer governing subscription duration (optional)
53 * @nameseq_list: adjacent subscriptions in name sequence's subscription list
54 * @subscription_list: adjacent subscriptions in subscriber's subscription list
Allan Stephens28353e72008-05-19 13:29:47 -070055 * @server_ref: object reference of server port associated with subscription
Allan Stephens8e9501f2008-05-19 13:28:32 -070056 * @swap: indicates if subscriber uses opposite endianness in its messages
Per Lidenb97bf3f2006-01-02 19:04:38 +010057 * @evt: template for events generated by subscription
Per Lidenb97bf3f2006-01-02 19:04:38 +010058 */
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090059
Per Lidenb97bf3f2006-01-02 19:04:38 +010060struct subscription {
61 struct tipc_name_seq seq;
62 u32 timeout;
63 u32 filter;
Allan Stephense15f8802008-05-19 13:27:31 -070064 tipc_subscr_event event_cb;
Allan Stephens5b06c85c2008-05-19 13:30:13 -070065 struct timer_list timer;
66 struct list_head nameseq_list;
67 struct list_head subscription_list;
Allan Stephens28353e72008-05-19 13:29:47 -070068 u32 server_ref;
Allan Stephens8e9501f2008-05-19 13:28:32 -070069 int swap;
Per Lidenb97bf3f2006-01-02 19:04:38 +010070 struct tipc_event evt;
Per Lidenb97bf3f2006-01-02 19:04:38 +010071};
72
Allan Stephens5b06c85c2008-05-19 13:30:13 -070073int tipc_subscr_overlap(struct subscription *sub,
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090074 u32 found_lower,
Per Liden4323add2006-01-18 00:38:21 +010075 u32 found_upper);
Per Lidenb97bf3f2006-01-02 19:04:38 +010076
Allan Stephens5b06c85c2008-05-19 13:30:13 -070077void tipc_subscr_report_overlap(struct subscription *sub,
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090078 u32 found_lower,
Per Liden4323add2006-01-18 00:38:21 +010079 u32 found_upper,
YOSHIFUJI Hideakic4307282007-02-09 23:25:21 +090080 u32 event,
81 u32 port_ref,
Per Liden4323add2006-01-18 00:38:21 +010082 u32 node,
83 int must_report);
Per Lidenb97bf3f2006-01-02 19:04:38 +010084
Per Liden4323add2006-01-18 00:38:21 +010085int tipc_subscr_start(void);
Per Lidenb97bf3f2006-01-02 19:04:38 +010086
Per Liden4323add2006-01-18 00:38:21 +010087void tipc_subscr_stop(void);
Per Lidenb97bf3f2006-01-02 19:04:38 +010088
89
90#endif