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