blob: 393e417bee3f51f8703047cdf6ac6a2a6b8654be [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
Ying Xue13a2e892013-06-17 10:54:40 -04005 * Copyright (c) 2005-2007, 2012-2013, 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
Ying Xue13a2e892013-06-17 10:54:40 -040040#include "server.h"
41
Paul Gortmakerfead3902011-12-29 20:43:44 -050042struct tipc_subscription;
Ying Xue13a2e892013-06-17 10:54:40 -040043struct tipc_subscriber;
Allan Stephense15f8802008-05-19 13:27:31 -070044
Per Lidenb97bf3f2006-01-02 19:04:38 +010045/**
Paul Gortmakerfead3902011-12-29 20:43:44 -050046 * struct tipc_subscription - TIPC network topology subscription object
Ying Xue13a2e892013-06-17 10:54:40 -040047 * @subscriber: pointer to its subscriber
Per Lidenb97bf3f2006-01-02 19:04:38 +010048 * @seq: name sequence associated with subscription
49 * @timeout: duration of subscription (in ms)
50 * @filter: event filtering to be done for subscription
Allan Stephens5b06c85c2008-05-19 13:30:13 -070051 * @timer: timer governing subscription duration (optional)
52 * @nameseq_list: adjacent subscriptions in name sequence's subscription list
53 * @subscription_list: adjacent subscriptions in subscriber's subscription list
Allan Stephens28353e72008-05-19 13:29:47 -070054 * @server_ref: object reference of server port associated with subscription
Neil Hormandb5a7532010-10-21 01:06:16 +000055 * @swap: indicates if subscriber uses opposite endianness in its messages
Per Lidenb97bf3f2006-01-02 19:04:38 +010056 * @evt: template for events generated by subscription
Per Lidenb97bf3f2006-01-02 19:04:38 +010057 */
Paul Gortmakerfead3902011-12-29 20:43:44 -050058struct tipc_subscription {
Ying Xue13a2e892013-06-17 10:54:40 -040059 struct tipc_subscriber *subscriber;
Per Lidenb97bf3f2006-01-02 19:04:38 +010060 struct tipc_name_seq seq;
61 u32 timeout;
62 u32 filter;
Allan Stephens5b06c85c2008-05-19 13:30:13 -070063 struct timer_list timer;
64 struct list_head nameseq_list;
65 struct list_head subscription_list;
Neil Hormandb5a7532010-10-21 01:06:16 +000066 int swap;
Per Lidenb97bf3f2006-01-02 19:04:38 +010067 struct tipc_event evt;
Per Lidenb97bf3f2006-01-02 19:04:38 +010068};
69
Paul Gortmakerae8509c2013-06-17 10:54:47 -040070int tipc_subscr_overlap(struct tipc_subscription *sub, u32 found_lower,
Per Liden4323add2006-01-18 00:38:21 +010071 u32 found_upper);
Per Lidenb97bf3f2006-01-02 19:04:38 +010072
Paul Gortmakerae8509c2013-06-17 10:54:47 -040073void tipc_subscr_report_overlap(struct tipc_subscription *sub, u32 found_lower,
74 u32 found_upper, u32 event, u32 port_ref,
75 u32 node, int must);
Per Lidenb97bf3f2006-01-02 19:04:38 +010076
Per Liden4323add2006-01-18 00:38:21 +010077int tipc_subscr_start(void);
Per Lidenb97bf3f2006-01-02 19:04:38 +010078
Per Liden4323add2006-01-18 00:38:21 +010079void tipc_subscr_stop(void);
Per Lidenb97bf3f2006-01-02 19:04:38 +010080
Per Lidenb97bf3f2006-01-02 19:04:38 +010081#endif